pl.mbdev.openstage
Enum IppCommand.DisplayOn

java.lang.Object
  extended by java.lang.Enum<IppCommand.DisplayOn>
      extended by pl.mbdev.openstage.IppCommand.DisplayOn
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<IppCommand.DisplayOn>
Enclosing class:
IppCommand

public static enum IppCommand.DisplayOn
extends java.lang.Enum<IppCommand.DisplayOn>

Defines places where the IppCommand will be displayed. In some cases, the context in which the command is used may forbid some options. Read the documentation of entities to which you want to add the command to know more.

Author:
Mateusz Bysiek

Enum Constant Summary
BOTH
          Displays command in both global options list and specific item list.
LISTITEM
          Displays command in a command list attached to a specific item.
OPTIONS
          Command will be displayed
 
Method Summary
static IppCommand.DisplayOn valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static IppCommand.DisplayOn[] 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

OPTIONS

public static final IppCommand.DisplayOn OPTIONS
Command will be displayed


LISTITEM

public static final IppCommand.DisplayOn LISTITEM
Displays command in a command list attached to a specific item. Useful when we add IppCommand to an IppItem.


BOTH

public static final IppCommand.DisplayOn BOTH
Displays command in both global options list and specific item list. In other words, BOTH = LISTITEM and OPTIONS.

Method Detail

values

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

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

valueOf

public static IppCommand.DisplayOn 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