Package org.cytoscape.view.presentation.property

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

    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 Detail

      • NONE

        public static final ArrowShape NONE
        No arrow

      • DIAMOND

        public static final ArrowShape DIAMOND
        Diamond shaped arrow

      • OPEN_DIAMOND

        public static final ArrowShape OPEN_DIAMOND
        Unfilled Diamond shaped arrow

      • DELTA

        public static final ArrowShape DELTA
        Triangle shaped arrow

      • OPEN_DELTA

        public static final ArrowShape OPEN_DELTA
        Unfilled triangle shaped arrow

      • CROSS_DELTA

        public static final ArrowShape CROSS_DELTA
        Triangle shaped arrow with a cross hatch

      • CROSS_OPEN_DELTA

        public static final ArrowShape CROSS_OPEN_DELTA
        Unfilled triangle shaped arrow with a cross hatch

      • 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

      • OPEN_CIRCLE

        public static final ArrowShape OPEN_CIRCLE
        Unfilled Circle shaped arrow

      • HALF_CIRCLE

        public static final ArrowShape HALF_CIRCLE
        Half-Circle shaped arrow

      • OPEN_HALF_CIRCLE

        public static final ArrowShape OPEN_HALF_CIRCLE
        Unfilled Half-Circle shaped arrow

      • SQUARE

        public static final ArrowShape SQUARE
        Square shaped arrow

      • OPEN_SQUARE

        public static final ArrowShape OPEN_SQUARE
        Unfilled square 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)