org.cytoscape.view.presentation.property

Class StringVisualProperty

java.lang.Object

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

org.cytoscape.view.presentation.property.StringVisualProperty

All Implemented Interfaces:

VisualProperty<String>

public final class StringVisualProperty
extends AbstractVisualProperty<String>

Visual Property for String values.

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
StringVisualProperty(String def, Range<String> range, String id, String displayName, boolean ignoreDefault, Class<? extends CyIdentifiable> modelDataType) Constructor.
StringVisualProperty(String def, Range<String> range, String id, String displayName, Class<? extends CyIdentifiable> modelDataType) Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StringVisualProperty

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

Constructor.

Parameters:

def - The default String value.

range - The allowable range of Strings 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.

StringVisualProperty

public StringVisualProperty(String def,
                            Range<String> range,
                            String id,
                            String displayName,
                            boolean ignoreDefault,
                            Class<? extends CyIdentifiable> modelDataType)

Constructor.

Parameters:

def - The default String value.

range - The allowable range of Strings 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.

ignoreDefault - Whether the default value should be ignored or not.

modelDataType - The model data type associated with this visual property, e.g. CyNode, CyEdge, or CyNetwork.

Method Detail

toSerializableString

public String toSerializableString(String 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 String 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.