Package org.cytoscape.view.presentation.property

Class EdgeBendVisualProperty

java.lang.Object

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

org.cytoscape.view.presentation.property.EdgeBendVisualProperty

All Implemented Interfaces:

VisualProperty<Bend>

public class EdgeBendVisualProperty
extends AbstractVisualProperty<Bend>

Visual Property for Edge Bend values.

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 Bend	DEFAULT_EDGE_BEND	The default edge bend.

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

shouldIgnoreDefault

Constructor Summary

Constructors

Constructor	Description
EdgeBendVisualProperty(Bend defaultValue, String id, String displayName)	Constructor.

Method Summary

Modifier and Type	Method	Description
Bend	parseSerializableString(String value)	Returns an object of type T given a string serialized from the getSerializableString(T value) method.
void	setBendFactory(BendFactory bendFactory)	Sets the bend factory that is used behind the scenes to create bend objects.
String	toSerializableString(Bend 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

DEFAULT_EDGE_BEND

public static final Bend DEFAULT_EDGE_BEND

The default edge bend. This "bend" is empty and contains no actual bend.

Constructor Detail

EdgeBendVisualProperty

public EdgeBendVisualProperty(Bend defaultValue,
                              String id,
                              String displayName)

Constructor.

Parameters:

defaultValue - The default bend to use.

id - A machine readable string identifying this visual property used for XML serialization.

displayName - A human readable string used for displays and user interfaces.

Method Detail

setBendFactory

public void setBendFactory(BendFactory bendFactory)

Sets the bend factory that is used behind the scenes to create bend objects.

Parameters:

bendFactory - The bend factory to use for this instance.

toSerializableString

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