javax.accessibility

Class AccessibleState

public class AccessibleState extends AccessibleBundle

A state portion of an accessible object. A combination of states represent the entire object state, in an AccessibleStateSet. For example, this could be "active" or "selected". This strongly typed "enumeration" supports localized strings. If the constants of this class are not adequate, new ones may be added in a similar matter, while avoiding a public constructor.

Since: 1.2

UNKNOWN: updated to 1.4

Field Summary
static AccessibleStateACTIVE
Indicates an active window, as well as an active child in a list or other collection.
static AccessibleStateARMED
Indicates an armed object, usually a button which has been pushed and the mouse has not left the button area.
static AccessibleStateBUSY
Indicates an object is busy, such as a slider, scroll bar, or progress bar in transition.
static AccessibleStateCHECKED
Indicates an object is checked.
static AccessibleStateCOLLAPSED
Indicates that the object is collapsed, usually in a tree.
static AccessibleStateEDITABLE
Indicates the user can edit the component contents.
static AccessibleStateENABLED
Indicates that an object is enabled.
static AccessibleStateEXPANDABLE
Indicates the object allows progressive disclosure of its children, usually in a collapsible tree or other hierachical object.
static AccessibleStateEXPANDED
Indicates that the object is expanded, usually in a tree.
static AccessibleStateFOCUSABLE
Indicates that an object can accept focus, which means it will process keyboard events when focused.
static AccessibleStateFOCUSED
Indicates that an object has keyboard focus.
static AccessibleStateHORIZONTAL
Indicates that an object has horizontal orientation.
static AccessibleStateICONIFIED
Indicates that an object is minimized to an icon.
static AccessibleStateINDETERMINATE
Indicates that the state of this particular object is indeterminate.
static AccessibleStateMANAGES_DESCENDANTS
Indicates that this particular object manages a number of subcomponents.
static AccessibleStateMODAL
Indicates that something must be done in the current object before interaction is allowed on other windows, usually for dialogs.
static AccessibleStateMULTISELECTABLE
Indicates that multiple children can be selected at once.
static AccessibleStateMULTI_LINE
Indicates that this text object can hold multiple lines.
static AccessibleStateOPAQUE
Indicates that all pixels in the object are painted.
static AccessibleStatePRESSED
Indicates a pushed button, usually when the mouse has been pressed but not released.
static AccessibleStateRESIZABLE
Indicates the size of this object is not fixed.
static AccessibleStateSELECTABLE
Indicates that this child is one which can be selected from its parent.
static AccessibleStateSELECTED
Indicates that this child has been selected from its parent.
static AccessibleStateSHOWING
Indicates that this object and all its parents are visible, so that it is on the screen.
static AccessibleStateSINGLE_LINE
Indicates that this text object can only hold a single line.
static AccessibleStateTRANSIENT
Indicates that this object is transient.
static AccessibleStateTRUNCATED
Indicates that this particular object is truncated when displayed visually.
static AccessibleStateVERTICAL
Indicates that an object has vertical orientation.
static AccessibleStateVISIBLE
Indicates that this object intends to be visible.
Constructor Summary
protected AccessibleState(String key)
Create a new constant with a locale independent key.

Field Detail

ACTIVE

public static final AccessibleState ACTIVE
Indicates an active window, as well as an active child in a list or other collection.

See Also: WINDOW FRAME DIALOG

ARMED

public static final AccessibleState ARMED
Indicates an armed object, usually a button which has been pushed and the mouse has not left the button area.

See Also: PUSH_BUTTON

BUSY

public static final AccessibleState BUSY
Indicates an object is busy, such as a slider, scroll bar, or progress bar in transition.

See Also: PROGRESS_BAR SCROLL_BAR SLIDER

CHECKED

public static final AccessibleState CHECKED
Indicates an object is checked.

See Also: TOGGLE_BUTTON RADIO_BUTTON CHECK_BOX

COLLAPSED

public static final AccessibleState COLLAPSED
Indicates that the object is collapsed, usually in a tree.

See Also: EXPANDABLE EXPANDED TREE

EDITABLE

public static final AccessibleState EDITABLE
Indicates the user can edit the component contents. This is usually for text, as other objects like scroll bars are automatically editable.

See Also: ENABLED

ENABLED

public static final AccessibleState ENABLED
Indicates that an object is enabled. In the absence of this state, graphics are often grayed out, and cannot be manipulated.

EXPANDABLE

public static final AccessibleState EXPANDABLE
Indicates the object allows progressive disclosure of its children, usually in a collapsible tree or other hierachical object.

See Also: EXPANDED COLLAPSED TREE

EXPANDED

public static final AccessibleState EXPANDED
Indicates that the object is expanded, usually in a tree.

See Also: EXPANDABLE COLLAPSED TREE

FOCUSABLE

public static final AccessibleState FOCUSABLE
Indicates that an object can accept focus, which means it will process keyboard events when focused.

See Also: FOCUSED

FOCUSED

public static final AccessibleState FOCUSED
Indicates that an object has keyboard focus.

See Also: FOCUSABLE

HORIZONTAL

public static final AccessibleState HORIZONTAL
Indicates that an object has horizontal orientation.

See Also: VERTICAL SCROLL_BAR SLIDER PROGRESS_BAR

ICONIFIED

public static final AccessibleState ICONIFIED
Indicates that an object is minimized to an icon.

See Also: FRAME INTERNAL_FRAME

INDETERMINATE

public static final AccessibleState INDETERMINATE
Indicates that the state of this particular object is indeterminate. This commonly occurs when an object is incapable of representing the state by a single value.

Since: 1.5

MANAGES_DESCENDANTS

public static final AccessibleState MANAGES_DESCENDANTS
Indicates that this particular object manages a number of subcomponents. This is a common property of structures such as trees and tables, which have a number of sub-elements such as rows and columns. The subcomponents should be left to the object, and not managed by the application.

Since: 1.5

MODAL

public static final AccessibleState MODAL
Indicates that something must be done in the current object before interaction is allowed on other windows, usually for dialogs.

See Also: DIALOG

MULTISELECTABLE

public static final AccessibleState MULTISELECTABLE
Indicates that multiple children can be selected at once.

See Also: getAccessibleContext getAccessibleSelection AccessibleSelection

MULTI_LINE

public static final AccessibleState MULTI_LINE
Indicates that this text object can hold multiple lines.

See Also: SINGLE_LINE

OPAQUE

public static final AccessibleState OPAQUE
Indicates that all pixels in the object are painted. If this state is not present, then the object has some degree of transparency, letting lower panes show through.

See Also: getAccessibleContext getAccessibleComponent getBounds

PRESSED

public static final AccessibleState PRESSED
Indicates a pushed button, usually when the mouse has been pressed but not released.

See Also: PUSH_BUTTON

RESIZABLE

public static final AccessibleState RESIZABLE
Indicates the size of this object is not fixed.

See Also: getAccessibleContext getAccessibleComponent getSize setSize

SELECTABLE

public static final AccessibleState SELECTABLE
Indicates that this child is one which can be selected from its parent.

See Also: SELECTED getAccessibleContext getAccessibleSelection AccessibleSelection

SELECTED

public static final AccessibleState SELECTED
Indicates that this child has been selected from its parent.

See Also: SELECTABLE getAccessibleContext getAccessibleSelection AccessibleSelection

SHOWING

public static final AccessibleState SHOWING
Indicates that this object and all its parents are visible, so that it is on the screen. However, something opaque may be on top of it.

See Also: VISIBLE

SINGLE_LINE

public static final AccessibleState SINGLE_LINE
Indicates that this text object can only hold a single line.

See Also: MULTI_LINE

TRANSIENT

public static final AccessibleState TRANSIENT
Indicates that this object is transient. This means the object is generated for method queries, but will never generate events, because its container (such as a tree, list, or table) does all the work.

TRUNCATED

public static final AccessibleState TRUNCATED
Indicates that this particular object is truncated when displayed visually.

Since: 1.5

VERTICAL

public static final AccessibleState VERTICAL
Indicates that an object has vertical orientation.

See Also: HORIZONTAL SCROLL_BAR SLIDER PROGRESS_BAR

VISIBLE

public static final AccessibleState VISIBLE
Indicates that this object intends to be visible. However, if its parent is invisible, this object is as well.

See Also: SHOWING

Constructor Detail

AccessibleState

protected AccessibleState(String key)
Create a new constant with a locale independent key. Follow the example, keep the constructor private and make public constants instead.

Parameters: key the name of the state

See Also: AccessibleState