org.cytoscape.view.presentation.property

Class ArrowShapeVisualProperty

java.lang.Object

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

org.cytoscape.view.presentation.property.ArrowShapeVisualProperty

All Implemented Interfaces:

VisualProperty<ArrowShape>

public final class ArrowShapeVisualProperty
extends AbstractVisualProperty<ArrowShape>

Visual Property for ArrowShape values. This implementation provides basic default shapes. Rendering Engines can provide others.

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.

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>

Field Summary

Fields

Modifier and Type	Field and Description
static ArrowShape	ARROW Pointy triangle shaped arrow
static ArrowShape	ARROW_SHORT Shorter pointy triangle shaped arrow
static ArrowShape	CIRCLE Circle shaped arrow
static ArrowShape	DELTA Triangle shaped arrow
static ArrowShape	DELTA_SHORT_1 Shorter triangle shaped arrow
static ArrowShape	DELTA_SHORT_2 Even shorter triangle shaped arrow
static ArrowShape	DIAMOND Diamond shaped arrow
static ArrowShape	DIAMOND_SHORT_1 Sorter diamond shaped arrow
static ArrowShape	DIAMOND_SHORT_2 Even shorter diamond shaped arrow
static ArrowShape	HALF_BOTTOM Bottom Half of a triangle shaped arrow
static ArrowShape	HALF_TOP Top Half of a triangle shaped arrow
static ArrowShape	NONE No arrow
static ArrowShape	T T shaped arrow

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

shouldIgnoreDefault

Constructor Summary

Constructors

Constructor and Description
ArrowShapeVisualProperty(ArrowShape defaultValue, String id, String displayName, Class<? extends CyIdentifiable> modelDataType) Constructor.

Method Summary

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

NONE

public static final ArrowShape NONE

No arrow

DIAMOND

public static final ArrowShape DIAMOND

Diamond shaped arrow

DELTA

public static final ArrowShape DELTA

Triangle shaped arrow

ARROW

public static final ArrowShape ARROW

Pointy triangle shaped arrow

T

public static final ArrowShape T

T shaped arrow

CIRCLE

public static final ArrowShape CIRCLE

Circle shaped arrow

HALF_TOP

public static final ArrowShape HALF_TOP

Top Half of a triangle shaped arrow

HALF_BOTTOM

public static final ArrowShape HALF_BOTTOM

Bottom Half of a triangle shaped arrow

DELTA_SHORT_1

public static final ArrowShape DELTA_SHORT_1

Shorter triangle shaped arrow

DELTA_SHORT_2

public static final ArrowShape DELTA_SHORT_2

Even shorter triangle shaped arrow

ARROW_SHORT

public static final ArrowShape ARROW_SHORT

Shorter pointy triangle shaped arrow

DIAMOND_SHORT_1

public static final ArrowShape DIAMOND_SHORT_1

Sorter diamond shaped arrow

DIAMOND_SHORT_2

public static final ArrowShape DIAMOND_SHORT_2

Even shorter diamond shaped arrow

Constructor Detail

ArrowShapeVisualProperty

public ArrowShapeVisualProperty(ArrowShape defaultValue,
                                String id,
                                String displayName,
                                Class<? extends CyIdentifiable> modelDataType)

Constructor.

Parameters:

defaultValue - The default arrow shape.

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(ArrowShape 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 ArrowShape 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.

isDefaultShape

public static boolean isDefaultShape(ArrowShape shape)