ButtonData.Action (hyperLib 1.0.2-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<ButtonData.Action>
- - org.hyperonline.hyperlib.oi.ButtonData.Action

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ButtonData.Action>

Enclosing class:

ButtonData
```
public static enum ButtonData.Action
extends java.lang.Enum<ButtonData.Action>
```
An Action describes what action on a button (pressed, released, held) should trigger a command to run.

Enum Constant Summary

Enum Constants
Enum Constant Description

WHEN_PRESSED

WHEN_RELEASED

WHILE_HELD

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`desc()`	Get a short string description of the action
`static ButtonData.Action`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static ButtonData.Action[]`	`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
  - WHEN_PRESSED
```
public static final ButtonData.Action WHEN_PRESSED
```
  - WHEN_RELEASED
```
public static final ButtonData.Action WHEN_RELEASED
```
  - WHILE_HELD
```
public static final ButtonData.Action WHILE_HELD
```
- Method Detail
  - values
```
public static ButtonData.Action[] 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 (ButtonData.Action c : ButtonData.Action.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ButtonData.Action 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
  - desc
```
public java.lang.String desc()
```
    Get a short string description of the action
    
    Returns:
    
    A string description of the action