javax.accessibility
Class AccessibleState

java.lang.Object
  extended by javax.accessibility.AccessibleBundle
      extended by javax.accessibility.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

Field Summary
static AccessibleState ACTIVE
          Indicates an active window, as well as an active child in a list or other collection.
static AccessibleState ARMED
          Indicates an armed object, usually a button which has been pushed and the mouse has not left the button area.
static AccessibleState BUSY
          Indicates an object is busy, such as a slider, scroll bar, or progress bar in transition.
static AccessibleState CHECKED
          Indicates an object is checked.
static AccessibleState COLLAPSED
          Indicates that the object is collapsed, usually in a tree.
static AccessibleState EDITABLE
          Indicates the user can edit the component contents.
static AccessibleState ENABLED
          Indicates that an object is enabled.
static AccessibleState EXPANDABLE
          Indicates the object allows progressive disclosure of its children, usually in a collapsible tree or other hierachical object.
static AccessibleState EXPANDED
          Indicates that the object is expanded, usually in a tree.
static AccessibleState FOCUSABLE
          Indicates that an object can accept focus, which means it will process keyboard events when focused.
static AccessibleState FOCUSED
          Indicates that an object has keyboard focus.
static AccessibleState HORIZONTAL
          Indicates that an object has horizontal orientation.
static AccessibleState ICONIFIED
          Indicates that an object is minimized to an icon.
static AccessibleState INDETERMINATE
          Indicates that the state of this particular object is indeterminate.
static AccessibleState MANAGES_DESCENDANTS
          Indicates that this particular object manages a number of subcomponents.
static AccessibleState MODAL
          Indicates that something must be done in the current object before interaction is allowed on other windows, usually for dialogs.
static AccessibleState MULTI_LINE
          Indicates that this text object can hold multiple lines.
static AccessibleState MULTISELECTABLE
          Indicates that multiple children can be selected at once.
static AccessibleState OPAQUE
          Indicates that all pixels in the object are painted.
static AccessibleState PRESSED
          Indicates a pushed button, usually when the mouse has been pressed but not released.
static AccessibleState RESIZABLE
          Indicates the size of this object is not fixed.
static AccessibleState SELECTABLE
          Indicates that this child is one which can be selected from its parent.
static AccessibleState SELECTED
          Indicates that this child has been selected from its parent.
static AccessibleState SHOWING
          Indicates that this object and all its parents are visible, so that it is on the screen.
static AccessibleState SINGLE_LINE
          Indicates that this text object can only hold a single line.
static AccessibleState TRANSIENT
          Indicates that this object is transient.
static AccessibleState TRUNCATED
          Indicates that this particular object is truncated when displayed visually.
static AccessibleState VERTICAL
          Indicates that an object has vertical orientation.
static AccessibleState VISIBLE
          Indicates that this object intends to be visible.
 
Fields inherited from class javax.accessibility.AccessibleBundle
key
 
Constructor Summary
protected AccessibleState(String key)
          Create a new constant with a locale independent key.
 
Method Summary
 
Methods inherited from class javax.accessibility.AccessibleBundle
toDisplayString, toDisplayString, toDisplayString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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:
AccessibleRole.WINDOW, AccessibleRole.FRAME, AccessibleRole.DIALOG

PRESSED

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

See Also:
AccessibleRole.PUSH_BUTTON

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:
AccessibleRole.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:
AccessibleRole.PROGRESS_BAR, AccessibleRole.SCROLL_BAR, AccessibleRole.SLIDER

CHECKED

public static final AccessibleState CHECKED
Indicates an object is checked.

See Also:
AccessibleRole.TOGGLE_BUTTON, AccessibleRole.RADIO_BUTTON, AccessibleRole.CHECK_BOX

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

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, AccessibleRole.TREE

COLLAPSED

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

See Also:
EXPANDABLE, EXPANDED, AccessibleRole.TREE

EXPANDED

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

See Also:
EXPANDABLE, COLLAPSED, AccessibleRole.TREE

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.


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

ICONIFIED

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

See Also:
AccessibleRole.FRAME, AccessibleRole.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:
AccessibleRole.DIALOG

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:
Accessible.getAccessibleContext(), AccessibleContext.getAccessibleComponent(), AccessibleComponent.getBounds()

RESIZABLE

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

See Also:
Accessible.getAccessibleContext(), AccessibleContext.getAccessibleComponent(), AccessibleComponent.getSize(), AccessibleComponent.setSize(Dimension)

MULTISELECTABLE

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

See Also:
Accessible.getAccessibleContext(), AccessibleContext.getAccessibleSelection(), AccessibleSelection

SELECTABLE

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

See Also:
SELECTED, Accessible.getAccessibleContext(), AccessibleContext.getAccessibleSelection(), AccessibleSelection

SELECTED

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

See Also:
SELECTABLE, Accessible.getAccessibleContext(), AccessibleContext.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

TRUNCATED

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

Since:
1.5

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

VERTICAL

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

See Also:
HORIZONTAL, AccessibleRole.SCROLL_BAR, AccessibleRole.SLIDER, AccessibleRole.PROGRESS_BAR

HORIZONTAL

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

See Also:
VERTICAL, AccessibleRole.SCROLL_BAR, AccessibleRole.SLIDER, AccessibleRole.PROGRESS_BAR

SINGLE_LINE

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

See Also:
MULTI_LINE

MULTI_LINE

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

See Also:
SINGLE_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.

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:
AccessibleBundle.toDisplayString(String, Locale)