Cytoscape 3.0.0-alpha8-SNAPSHOT API

org.cytoscape.view.presentation.property
Class StringVisualProperty

java.lang.Object
  extended by org.cytoscape.view.model.AbstractVisualProperty<String>
      extended by 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.

Field Summary
 
Fields inherited from class org.cytoscape.view.model.AbstractVisualProperty
shouldIgnoreDefault
 
Constructor Summary
StringVisualProperty(String def, Range<String> range, String id, String name, boolean ignoreDefault, Class<?> targetDataType)
           
StringVisualProperty(String def, Range<String> range, String id, String name, Class<?> targetDataType)
           
 
Method Summary
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringVisualProperty

public StringVisualProperty(String def,
                            Range<String> range,
                            String id,
                            String name,
                            Class<?> targetDataType)

StringVisualProperty

public StringVisualProperty(String def,
                            Range<String> range,
                            String id,
                            String name,
                            boolean ignoreDefault,
                            Class<?> targetDataType)
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.

Cytoscape 3.0.0-alpha8-SNAPSHOT API

Copyright 2011 Cytoscape Consortium. All rights reserved.