Cytoscape 3.0.1 API

org.cytoscape.view.presentation.property
Class IntegerVisualProperty

java.lang.Object
  extended by org.cytoscape.view.model.AbstractVisualProperty<Integer>
      extended by org.cytoscape.view.presentation.property.IntegerVisualProperty
All Implemented Interfaces:
VisualProperty<Integer>

public final class IntegerVisualProperty
extends AbstractVisualProperty<Integer>

Visual Property for Integer 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
IntegerVisualProperty(Integer def, Range<Integer> range, String id, String displayName, Class<? extends CyIdentifiable> modelDataType)
          Constructor.
 
Method Summary
 Integer parseSerializableString(String text)
          Returns an object of type T given a string serialized from the getSerializableString(T value) method.
 String toSerializableString(Integer 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

IntegerVisualProperty

public IntegerVisualProperty(Integer def,
                             Range<Integer> range,
                             String id,
                             String displayName,
                             Class<? extends CyIdentifiable> modelDataType)
Constructor.

Parameters:
def - The default Integer value.
range - The allowable range for Integer values of 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(Integer 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 Integer 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.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.