Class LabelBackgroundShapeVisualProperty
java.lang.Object
org.cytoscape.view.model.AbstractVisualProperty<LabelBackgroundShape>
org.cytoscape.view.presentation.property.LabelBackgroundShapeVisualProperty
- All Implemented Interfaces:
VisualProperty<LabelBackgroundShape>
public final class LabelBackgroundShapeVisualProperty
extends AbstractVisualProperty<LabelBackgroundShape>
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: 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>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final LabelBackgroundShape
No label background.static final LabelBackgroundShape
Rectangular shape.static final LabelBackgroundShape
Rectangular shape with rounded corners.Fields inherited from class org.cytoscape.view.model.AbstractVisualProperty
shouldIgnoreDefault
-
Constructor Summary
ConstructorDescriptionLabelBackgroundShapeVisualProperty
(LabelBackgroundShape defaultValue, String id, String displayName, Class<? extends CyIdentifiable> modelDataType) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
Returns true if the specified shape is one of the possible default shape values.parseSerializableString
(String value) Returns an object of type T given a string serialized from the getSerializableString(T value) method.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
-
Field Details
-
NONE
No label background. -
RECTANGLE
Rectangular shape. -
ROUND_RECTANGLE
Rectangular shape with rounded corners.
-
-
Constructor Details
-
LabelBackgroundShapeVisualProperty
public LabelBackgroundShapeVisualProperty(LabelBackgroundShape defaultValue, String id, String displayName, Class<? extends CyIdentifiable> modelDataType) Constructor.- Parameters:
defaultValue
- The default NodeShape 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.
-
-
Method Details
-
toSerializableString
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
Description copied from interface:VisualProperty
Returns an object of type T given a string serialized from the getSerializableString(T value) method.- Parameters:
value
- 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.
-
isDefaultShape
Returns true if the specified shape is one of the possible default shape values.- Parameters:
shape
- the node shape to be checked.- Returns:
- True if the specified shape is one of the possible default shape values.
-