net.rim.device.api.ui.accessibility
Interface AccessibleState


public interface AccessibleState

Interface AccessibleState describes a component's particular state. The actual state of the component is defined as an AccessibleStateSet, which is a composed set of AccessibleStates. The constants in this interface present a strongly typed enumeration of common object roles.

Since:
BlackBerry API 4.6.1

Field Summary
static int ACTIVE
          For screens and dialogs.
static int AVAILABLE
          For any element that has finished loading and is available for reading.
static int BUSY
          For any element that is busy or loading and is about to change soon.
static int CHECKED
          For CheckboxField
static int COLLAPSED
          For expandable fields, such as tree field, choice field, combo field.
static int EDITABLE
          For text fields, date and duration fields
static int EDITING
          For fields that can be in the editing and non-editing state, such as Date Field.
static int EXPANDABLE
          For expandable fields, such as tree field, choice field, combo field.
static int EXPANDED
          For expandable fields, such as tree field, choice field, combo field.
static int FOCUSABLE
          For any field that can gain focus
static int FOCUSED
          Used for any field that can gain focus
static int HORIZONTAL
          For any element that has horizontal orientation
static int MODAL
          For modal dialogs
static int MOUSE_OVER
          For html page elements.
static int MULTI_LINE
          For text fields
static int MULTI_SELECTABLE
          For lists and tables.
static int PUSHED
          For button fields, they have this state when user pushes the button.
static int SELECTABLE
          For any field that can be selected
static int SELECTED
          For text and complex fields (Menu, ListField, ComboField, ChoiceField, TreeField) which can have a descendant selected.
static int SINGLE_LINE
          For text fields
static int TRUNCATED
          for all fields that display text within them
static int UNSET
          No accessible state is defined for a field.
static int VERTICAL
          For any element that has vertical orientation
 



Field Detail

UNSET

static final int UNSET
No accessible state is defined for a field. Field is visible, non focusable and read-only.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

FOCUSED

static final int FOCUSED
Used for any field that can gain focus

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

SELECTED

static final int SELECTED
For text and complex fields (Menu, ListField, ComboField, ChoiceField, TreeField) which can have a descendant selected. Also used by RadioButtonField to specify which button is currently selected in the group.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

ACTIVE

static final int ACTIVE
For screens and dialogs. When one gains this state this means it was pushed onto screen.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

PUSHED

static final int PUSHED
For button fields, they have this state when user pushes the button.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

BUSY

static final int BUSY
For any element that is busy or loading and is about to change soon. This may be a web browser page or other fields that load asynchronously after being displayed. The opposite state is AccessibleState.AVAILABLE.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

CHECKED

static final int CHECKED
For CheckboxField

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

EDITABLE

static final int EDITABLE
For text fields, date and duration fields

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

EXPANDABLE

static final int EXPANDABLE
For expandable fields, such as tree field, choice field, combo field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

EXPANDED

static final int EXPANDED
For expandable fields, such as tree field, choice field, combo field. The opposite value is AccessibleState.COLLAPSED.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

COLLAPSED

static final int COLLAPSED
For expandable fields, such as tree field, choice field, combo field. The opposite value is AccessibleState.EXPANDED.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

FOCUSABLE

static final int FOCUSABLE
For any field that can gain focus

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

MODAL

static final int MODAL
For modal dialogs

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

EDITING

static final int EDITING
For fields that can be in the editing and non-editing state, such as Date Field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.7.0

MULTI_SELECTABLE

static final int MULTI_SELECTABLE
For lists and tables. Defines whether user can select multiple rows or cells.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

SELECTABLE

static final int SELECTABLE
For any field that can be selected

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

VERTICAL

static final int VERTICAL
For any element that has vertical orientation

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

HORIZONTAL

static final int HORIZONTAL
For any element that has horizontal orientation

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

SINGLE_LINE

static final int SINGLE_LINE
For text fields

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

MULTI_LINE

static final int MULTI_LINE
For text fields

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

TRUNCATED

static final int TRUNCATED
for all fields that display text within them

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

AVAILABLE

static final int AVAILABLE
For any element that has finished loading and is available for reading. This may be a web browser page or other fields that load asynchronously after being displayed. The opposite state is AccessibleState.BUSY.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1

MOUSE_OVER

static final int MOUSE_OVER
For html page elements. Specifies that user has mouse over the specified element.

See Also:
Constant Field Values
Since:
BlackBerry API 4.6.1





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.