Cytoscape 3.0.0-beta1 API

org.cytoscape.view.presentation.property
Class DoubleVisualProperty

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

public final class DoubleVisualProperty
extends AbstractVisualProperty<Double>

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

DoubleVisualProperty

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

Parameters:
def - The double value.
range - The allowable range of values for specified doubles.
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.

DoubleVisualProperty

public DoubleVisualProperty(Double def,
                            Range<Double> range,
                            String id,
                            String displayName,
                            boolean ignoreDefault,
                            Class<? extends CyIdentifiable> modelDataType)
Constructor.

Parameters:
def - The double value.
range - The allowable range of values for specified doubles.
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.
modelDataType - The model data type associated with this visual property, e.g. CyNode, CyEdge, or CyNetwork.
Method Detail

toSerializableString

public String toSerializableString(Double 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 Double 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-beta1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.