Class NodeShapeVisualProperty
java.lang.Object
org.cytoscape.view.model.AbstractVisualProperty<NodeShape>
org.cytoscape.view.presentation.property.NodeShapeVisualProperty
- All Implemented Interfaces:
VisualProperty<NodeShape>
Visual Property for
NodeShape
values.
This implementation provides basic default shapes. Other shapes can be
provided by the rendering engine.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 NodeShape
Diamond shape.static final NodeShape
Ellipse shape.static final NodeShape
Hexagonal shape.static final NodeShape
Octagonal shape.static final NodeShape
Parallelogram shape.static final NodeShape
Rectangular shape.static final NodeShape
Rectangular shape with rounded corners.static final NodeShape
Triangular shape.Fields inherited from class org.cytoscape.view.model.AbstractVisualProperty
shouldIgnoreDefault
-
Constructor Summary
ConstructorDescriptionNodeShapeVisualProperty
(NodeShape defaultValue, String id, String displayName, Class<? extends CyIdentifiable> modelDataType) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
isDefaultShape
(NodeShape shape) 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.toSerializableString
(NodeShape 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
-
Field Details
-
RECTANGLE
Rectangular shape. -
ROUND_RECTANGLE
Rectangular shape with rounded corners. -
TRIANGLE
Triangular shape. -
PARALLELOGRAM
Parallelogram shape. -
DIAMOND
Diamond shape. -
ELLIPSE
Ellipse shape. -
HEXAGON
Hexagonal shape. -
OCTAGON
Octagonal shape.
-
-
Constructor Details
-
NodeShapeVisualProperty
public NodeShapeVisualProperty(NodeShape 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.
-