Package com.hp.lft.sdk.uiapro

Enum Class ToggleState

java.lang.Object

java.lang.Enum<ToggleState>

com.hp.lft.sdk.uiapro.ToggleState

All Implemented Interfaces:

com.hp.lft.sdk.internal.EnumValueProvider<String>, Serializable, Comparable<ToggleState>, java.lang.constant.Constable

public enum ToggleState
extends Enum<ToggleState>
implements com.hp.lft.sdk.internal.EnumValueProvider<String>

The possible states of a toggleable object.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Indeterminate	The UI Automation element is in an indeterminate state.
Off	The UIA Pro element is not selected, checked, marked, or otherwise activated.
On	The UIA Pro element is selected, checked, marked, or otherwise activated.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the String value representing the ToggleState value.
static ToggleState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ToggleState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Off

public static final ToggleState Off

The UIA Pro element is not selected, checked, marked, or otherwise activated.

On

public static final ToggleState On

The UIA Pro element is selected, checked, marked, or otherwise activated.

Indeterminate

public static final ToggleState Indeterminate

The UI Automation element is in an indeterminate state. Can be used to indicate whether the user has acted on a control. For example, a checkbox can appear checked and dimmed, indicating an indeterminate state. Creating an indeterminate state is different from disabling the control. Consequently, a checkbox in the indeterminate state can still receive the focus. When the user clicks an indeterminate control, the ToggleState cycles to its next value.

Method Details

values

public static ToggleState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ToggleState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Returns the String value representing the ToggleState value.

Specified by:

getValue in interface com.hp.lft.sdk.internal.EnumValueProvider<String>

Returns:

the String value representing the ToggleState value.