org.cytoscape.view.presentation.property

Class PaintVisualProperty

java.lang.Object

org.cytoscape.view.model.AbstractVisualProperty<Paint>

org.cytoscape.view.presentation.property.PaintVisualProperty

All Implemented Interfaces:

VisualProperty<Paint>

public final class PaintVisualProperty
extends AbstractVisualProperty<Paint>

Visual Property for Paint values. Usually, this will be used for Color.

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

Fields inherited from class org.cytoscape.view.model.AbstractVisualProperty

shouldIgnoreDefault

Constructor Summary

Constructors

Constructor and Description
PaintVisualProperty(Paint def, Range<Paint> range, String id, String displayName, Class<? extends CyIdentifiable> modelDataType) Constructor.

Method Summary

Modifier and Type	Method and Description
Paint	parseSerializableString(String text) Returns an object of type T given a string serialized from the getSerializableString(T value) method.
String	toSerializableString(Paint paint) 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PaintVisualProperty

public PaintVisualProperty(Paint def,
                           Range<Paint> range,
                           String id,
                           String displayName,
                           Class<? extends CyIdentifiable> modelDataType)

Constructor.

Parameters:

def - The default paint value.

range - The range of possible values for this visual property

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 Detail

toSerializableString

public String toSerializableString(Paint paint)

Description copied from interface: VisualProperty

Returns a string of the specified value suitable for serializing to XML other text output.

Parameters:

paint - the specified value.

Returns:

a string of the specified value suitable for serializing to XML other text output.

parseSerializableString

public Paint 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.