Class BooleanVisualProperty
- java.lang.Object
-
- org.cytoscape.view.model.AbstractVisualProperty<Boolean>
-
- org.cytoscape.view.presentation.property.BooleanVisualProperty
-
- All Implemented Interfaces:
VisualProperty<Boolean>
public final class BooleanVisualProperty extends AbstractVisualProperty<Boolean>
Visual Property forBoolean
values.Module:
presentation-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>presentation-api</artifactId> </dependency>
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.
-
-
Field Summary
-
Fields inherited from class org.cytoscape.view.model.AbstractVisualProperty
shouldIgnoreDefault
-
-
Constructor Summary
Constructors Constructor Description BooleanVisualProperty(Boolean def, String id, String displayName, Boolean ignoreDefault, Class<? extends CyIdentifiable> modelDataType)
Constructor.BooleanVisualProperty(Boolean def, String id, String displayName, Class<? extends CyIdentifiable> modelDataType)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
parseSerializableString(String text)
Returns an object of type T given a string serialized from the getSerializableString(T value) method.String
toSerializableString(Boolean value)
Returns a string of the specified value suitable for serializing to XML other text output.-
Methods inherited from class org.cytoscape.view.model.AbstractVisualProperty
getDefault, getDisplayName, getIdString, getRange, getTargetDataType, shouldIgnoreDefault, toString
-
-
-
-
Constructor Detail
-
BooleanVisualProperty
public BooleanVisualProperty(Boolean def, String id, String displayName, Class<? extends CyIdentifiable> modelDataType)
Constructor.- Parameters:
def
- The boolean value.id
- A machine readable string identifying this visual property used for XML serialization.displayName
- A human readable string used for displays and user interfaces.modelDataType
- The model data type associated with this visual property, e.g. CyNode, CyEdge, or CyNetwork.
-
BooleanVisualProperty
public BooleanVisualProperty(Boolean def, String id, String displayName, Boolean ignoreDefault, Class<? extends CyIdentifiable> modelDataType)
Constructor.- Parameters:
def
- The boolean value.id
- A machine readable string identifying this visual property used for XML serialization.displayName
- A human readable string used for displays and user interfaces.ignoreDefault
- Whether the default value should be ignored.modelDataType
- The model data type associated with this visual property, e.g. CyNode, CyEdge, or CyNetwork.
-
-
Method Detail
-
toSerializableString
public String toSerializableString(Boolean value)
Description copied from interface:VisualProperty
Returns a string of the specified value suitable for serializing to XML other text output.- Parameters:
value
- the specified value.- Returns:
- a string of the specified value suitable for serializing to XML other text output.
-
parseSerializableString
public Boolean parseSerializableString(String text)
Description copied from interface:VisualProperty
Returns an object of type T given a string serialized from the getSerializableString(T value) method.- Parameters:
text
- a string serialized from the getSerializableString(T value) method.- Returns:
- an object of type T given a string serialized from the getSerializableString(T value) method.
-
-