Enum Class Position
- All Implemented Interfaces:
Serializable
,Comparable<Position>
,java.lang.constant.Constable
An ENUM that provides values for the various anchors that
may be used for text, customgraphics, etc.
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.
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>
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescription -
Method Summary
Modifier and TypeMethodDescriptionReturn a sorted list containing all of the display names for all of the Position anchors.getName()
Return the display name of this anchor position.Return the short name of this anchor position.static Position
Parse a string that contains either the short name or the display name for an anchor and return the corresponding enum valuestatic Position
Returns the enum constant of this class with the specified name.static Position[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NORTH_WEST
-
NORTH
-
NORTH_EAST
-
WEST
-
CENTER
-
EAST
-
SOUTH_WEST
-
SOUTH
-
SOUTH_EAST
-
NONE
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
getName
Return the display name of this anchor position.- Returns:
- display name
-
getShortName
Return the short name of this anchor position.- Returns:
- short name
-
parse
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
Return a sorted list containing all of the display names for all of the Position anchors.- Returns:
- sorted list of display names
-