org.peace_tools.core
Enum AbstractMenuHelper.HelperType

java.lang.Object
  extended by java.lang.Enum<AbstractMenuHelper.HelperType>
      extended by org.peace_tools.core.AbstractMenuHelper.HelperType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AbstractMenuHelper.HelperType>
Enclosing class:
AbstractMenuHelper

public static enum AbstractMenuHelper.HelperType
extends java.lang.Enum<AbstractMenuHelper.HelperType>

Enumeration to enable convenient identification/classification of menu helper objects. The following enumerations provide a convenient mechanism to identify a menu helper directly from the base class. Each menu helper in the system has a unique enumerated identifier associated with it. Typically, each menu in the main menu has its own menu helper. However, the system may have additional menu helpers that may be associated with a sub-menu or possibly not associated with a menu at all (as they are used in other spots in the system).

See Also:
AbstractMenuHelper.getHelperType()

Enum Constant Summary
FILE_MENU
           
HELP_MENU
           
JOB_MENU
           
SERVER_MENU
           
VIEW_MENU
           
WORKSPACE_MENU
           
 
Method Summary
static AbstractMenuHelper.HelperType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AbstractMenuHelper.HelperType[] 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

FILE_MENU

public static final AbstractMenuHelper.HelperType FILE_MENU

WORKSPACE_MENU

public static final AbstractMenuHelper.HelperType WORKSPACE_MENU

SERVER_MENU

public static final AbstractMenuHelper.HelperType SERVER_MENU

JOB_MENU

public static final AbstractMenuHelper.HelperType JOB_MENU

VIEW_MENU

public static final AbstractMenuHelper.HelperType VIEW_MENU

HELP_MENU

public static final AbstractMenuHelper.HelperType HELP_MENU
Method Detail

values

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

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

valueOf

public static AbstractMenuHelper.HelperType valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null