de.starface.integration.uci.java.v30.values
Enum FunctionKeyState

java.lang.Object
  extended by java.lang.Enum<FunctionKeyState>
      extended by de.starface.integration.uci.java.v30.values.FunctionKeyState
All Implemented Interfaces:
Serializable, Comparable<FunctionKeyState>

public enum FunctionKeyState
extends Enum<FunctionKeyState>

This enum defines the different states a funktion key can take. The constants are used for the funktion key property FunctionKeyProperties.state. The meaning of the different states depends on the FunctionKeyType of the function key and is documented per type.


Enum Constant Summary
ACTIVE
          This function key is currently in an active state.
FLASHY
          This function key is currently in a flashy state.
INACTIVE
          This function key is currently in an inactive state.
INVALID
          This function key is no longer assigned to a function due to a configuration change.
QUEUE_PAUSE
          This function key is currently in an queue pause state.
UNAVAILABLE
          This function key's function is currently unavailable.
 
Method Summary
static FunctionKeyState valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FunctionKeyState[] 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

INVALID

public static final FunctionKeyState INVALID
This function key is no longer assigned to a function due to a configuration change. This means that the function key is permanently unusable


UNAVAILABLE

public static final FunctionKeyState UNAVAILABLE
This function key's function is currently unavailable. This means that the function key is temporarily unusable


INACTIVE

public static final FunctionKeyState INACTIVE
This function key is currently in an inactive state.


FLASHY

public static final FunctionKeyState FLASHY
This function key is currently in a flashy state.


ACTIVE

public static final FunctionKeyState ACTIVE
This function key is currently in an active state.


QUEUE_PAUSE

public static final FunctionKeyState QUEUE_PAUSE
This function key is currently in an queue pause state.

Method Detail

values

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

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

valueOf

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


Copyright © 2012 STARFACE GmbH. All rights reserved.