Package org.cytoscape.view.presentation.property.values

Enum Position

  • All Implemented Interfaces:
    Serializable, Comparable<Position>
    public enum Position
extends Enum<Position>
    An ENUM that provides values for the various anchors that may be used for text, customgraphics, etc.

    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 (Enum): This class is an enum therefore can't be extended by users. This means that we may add methods or enum values for minor version updates. Methods or enum values will only be removed for major version updates.

    • Enum Constant Detail

      • NORTH_WEST

        public static final Position NORTH_WEST

      • NORTH

        public static final Position NORTH

      • NORTH_EAST

        public static final Position NORTH_EAST

      • WEST

        public static final Position WEST

      • CENTER

        public static final Position CENTER

      • EAST

        public static final Position EAST

      • SOUTH_WEST

        public static final Position SOUTH_WEST

      • SOUTH

        public static final Position SOUTH

      • SOUTH_EAST

        public static final Position SOUTH_EAST

      • NONE

        public static final Position NONE

    • Method Detail

      • values

        public static Position[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Position c : Position.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Position valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getName

        public String getName()
        Return the display name of this anchor position.
        Returns:
        display name

      • getShortName

        public String getShortName()
        Return the short name of this anchor position.
        Returns:
        short name

      • parse

        public static Position parse​(String value)
        Parse a string that contains either the short name or the display name for an anchor and return the corresponding enum value
        Parameters:
        value - the String containing the text to be parsed
        Returns:
        Position corresponding to the string

      • getDisplayNames

        public static SortedSet<String> getDisplayNames()
        Return a sorted list containing all of the display names for all of the Position anchors.
        Returns:
        sorted list of display names