org.cytoscape.application.swing
Enum CytoPanelState

java.lang.Object
  java.lang.Enum<CytoPanelState>
      org.cytoscape.application.swing.CytoPanelState

All Implemented Interfaces:

Serializable, Comparable<CytoPanelState>

public enum CytoPanelState
extends Enum<CytoPanelState>

The different display states available for a CytoPanel.

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 Summary

DOCK
The CytoPanel will be open and appear as a nested frame within the application.

FLOAT
The CytoPanel will be open and appear as a separate frame independent of the application.

HIDE
The CytoPanel will be hidden and only appear as a menu item.

Method Summary

static CytoPanelState	valueOf(String name) Returns the enum constant of this type with the specified name.
static CytoPanelState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HIDE

public static final CytoPanelState HIDE

The CytoPanel will be hidden and only appear as a menu item.

FLOAT

public static final CytoPanelState FLOAT

The CytoPanel will be open and appear as a separate frame independent of the application.

DOCK

public static final CytoPanelState DOCK

The CytoPanel will be open and appear as a nested frame within the application.

Method Detail

values

public static CytoPanelState[] 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 (CytoPanelState c : CytoPanelState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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