Package org.cytoscape.application.swing
Class AbstractViewUpdater<S>
- java.lang.Object
-
- org.cytoscape.application.swing.AbstractViewUpdater<S>
-
- Type Parameters:
S
- The generic type of this ViewUpdater.
- All Implemented Interfaces:
CyListener
,RowsSetListener
public abstract class AbstractViewUpdater<S> extends Object implements RowsSetListener
A utility class that provides an implementation ofRowsSetListener
for a particular column andVisualProperty
.Module:
swing-application-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>swing-application-api</artifactId> </dependency>
Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.
-
-
Field Summary
Fields Modifier and Type Field Description protected String
columnName
The name of the column that theRowsSetListener
is provided for.protected VisualProperty<S>
vp
TheVisualProperty
that theRowsSetListener
is provided for.
-
Constructor Summary
Constructors Constructor Description AbstractViewUpdater(VisualProperty<S> vp, String columnName, Map<CyRow,View<?>> rowViewMap)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
handleEvent(RowsSetEvent e)
Called wheneverCyRow
s are changed.
-
-
-
Field Detail
-
vp
protected final VisualProperty<S> vp
TheVisualProperty
that theRowsSetListener
is provided for.
-
columnName
protected final String columnName
The name of the column that theRowsSetListener
is provided for.
-
-
Constructor Detail
-
AbstractViewUpdater
public AbstractViewUpdater(VisualProperty<S> vp, String columnName, Map<CyRow,View<?>> rowViewMap)
Constructor.- Parameters:
vp
- The visual property that should be set on the view when the row is changed.columnName
- The name of the column within the row that is being listened to.rowViewMap
- a map between the row that is being listened to and the view that the visual property should be set when the row is changed.
-
-
Method Detail
-
handleEvent
public void handleEvent(RowsSetEvent e)
Called wheneverCyRow
s are changed. Will attempt to set the visual property on the view with the new value that has been set in the row.- Specified by:
handleEvent
in interfaceRowsSetListener
- Parameters:
e
- TheRowsSetEvent
to be processed.
-
-