Package org.cytoscape.application.swing

Enum CytoPanelName

  • All Implemented Interfaces:
    Serializable, Comparable<CytoPanelName>
    public enum CytoPanelName
extends Enum<CytoPanelName>
    An enum that describes CytoPanels uses compass directions to describe their location within the application. Fields may be added to this enum in the future.

    Module: swing-application-api

    To use this in your app, include the following dependency in your POM:

    <dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>swing-application-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

      • SOUTH

        public static final CytoPanelName SOUTH
        The south or bottom panel.

      • EAST

        public static final CytoPanelName EAST
        The east or right-hand panel.

      • WEST

        public static final CytoPanelName WEST
        The west or left-hand panel.

      • SOUTH_WEST

        public static final CytoPanelName SOUTH_WEST
        The south-west or bottom left panel.

    • Method Detail

      • values

        public static CytoPanelName[] 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 (CytoPanelName c : CytoPanelName.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CytoPanelName 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

      • getTitle

        public String getTitle()
        Returns the human readable title used for labeling this CytoPanel.
        Returns:
        The human readable title used for labeling this CytoPanel.