Package org.cytoscape.view.presentation.property

Class LineTypeVisualProperty

java.lang.Object

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

org.cytoscape.view.presentation.property.LineTypeVisualProperty

All Implemented Interfaces:

VisualProperty<LineType>

public final class LineTypeVisualProperty
extends AbstractVisualProperty<LineType>

Visual Property for LineType values. This class provide basic default line types. Others will be provided by rendering engines.

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>

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

Modifier and Type	Field	Description
static LineType	DASH_DOT	Dash space dot space dash, etc.
static LineType	DOT	Dot space dot, etc.
static LineType	EQUAL_DASH	Equal dash and space
static LineType	LONG_DASH	Long dash followed by short space
static LineType	SOLID	Solid line

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

shouldIgnoreDefault

Constructor Summary

Constructors

Constructor	Description
LineTypeVisualProperty(LineType defaultValue, String id, String displayName, Class<? extends CyIdentifiable> modelDataType)	Constructor.

Method Summary

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

Field Detail

SOLID

public static final LineType SOLID

Solid line

LONG_DASH

public static final LineType LONG_DASH

Long dash followed by short space

EQUAL_DASH

public static final LineType EQUAL_DASH

Equal dash and space

DASH_DOT

public static final LineType DASH_DOT

Dash space dot space dash, etc.

DOT

public static final LineType DOT

Dot space dot, etc.

Constructor Detail

LineTypeVisualProperty

public LineTypeVisualProperty(LineType defaultValue,
                              String id,
                              String displayName,
                              Class<? extends CyIdentifiable> modelDataType)

Constructor.

Parameters:

defaultValue - The default LineType value.

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(LineType 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 LineType parseSerializableString(String value)

Description copied from interface: VisualProperty

Returns an object of type T given a string serialized from the getSerializableString(T value) method.

Parameters:

value - 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.