org.cytoscape.view.model.events

Class ViewChangeRecord<T>

java.lang.Object

org.cytoscape.view.model.events.ViewChangeRecord<T>

public final class ViewChangeRecord<T>
extends Object

A utility class used to describe one change to a View.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: viewmodel-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>viewmodel-api</artifactId>
</dependency>

Constructor Summary

Constructors

Constructor and Description
ViewChangeRecord(View<T> view, VisualProperty<?> vp, Object value) Constructor.
ViewChangeRecord(View<T> view, VisualProperty<?> vp, Object value, boolean lockedValue)

Method Summary

Modifier and Type	Method and Description
Object	getValue() Returns the value that the visual property has been changed to.
View<T>	getView() Returns the view that has been changed.
VisualProperty<?>	getVisualProperty() Returns the visual property that has been changed.
boolean	isLockedValue()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViewChangeRecord

public ViewChangeRecord(View<T> view,
                        VisualProperty<?> vp,
                        Object value)

Constructor.

Parameters:

view - The View that has changed.

vp - The VisualProperty that has changed.

value - The value to which the visual property has been set.

ViewChangeRecord

public ViewChangeRecord(View<T> view,
                        VisualProperty<?> vp,
                        Object value,
                        boolean lockedValue)

Method Detail

getView

public View<T> getView()

Returns the view that has been changed.

Returns:

the view that has been changed.

getVisualProperty

public VisualProperty<?> getVisualProperty()

Returns the visual property that has been changed.

Returns:

the visual property that has been changed.

getValue

public Object getValue()

Returns the value that the visual property has been changed to.

Returns:

the value that the visual property has been changed to.

isLockedValue

public boolean isLockedValue()