Interface VisualPropertyValueEditor<V>
- Type Parameters:
V
- target data type for this editor.
public interface VisualPropertyValueEditor<V>
Provides a GUI Editor for a data type.
To support new data type, this should be implemented.
This interface is an exact copy of
ValueEditor
, but with
the additional parameter for showEditor
that informs the
VisualPropertyValueEditor
instance of the visual property
that is being edited. This is useful for editors that need to know
the boundaries of the visual property.Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.
Module: vizmap-gui-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>vizmap-gui-api</artifactId> </dependency>
-
Method Summary
Modifier and TypeMethodDescriptionGet type of the value to be edited.showEditor
(Component parent, S initialValue, VisualProperty<S> vizPropBeingEdited) Display the editor and get a new value.
-
Method Details
-
showEditor
Display the editor and get a new value.- Parameters:
parent
- the parent Component of this editor.initialValue
- the initial value for the value editor dialogue.vizPropBeingEdited
- The visual property whose value is being edited--useful for determining the visual property's boundaries.- Returns:
- the value generated from the value editor dialogue or null.
-
getValueType
Get type of the value to be edited.- Returns:
- the type of value returned by the value editor.
-