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:
JDE 4.7.0

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, RadioButtonField
static int COLLAPSED
          For expandable fields, such as tree field, choice field, combo field and date 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 and date 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

ACTIVE

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

AVAILABLE

public 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 BUSY.
Since:
JDE 4.7.0

BUSY

public 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 AVAILABLE.
Since:
JDE 4.7.0

CHECKED

public static final int CHECKED
For CheckboxField, RadioButtonField
Since:
JDE 4.7.0

COLLAPSED

public static final int COLLAPSED
For expandable fields, such as tree field, choice field, combo field and date field. The expanded date field means that user is editing it and scrolling up and down will change its value not navigate to next field. The opposite value is EXPANDED.
Since:
JDE 4.7.0

EDITABLE

public static final int EDITABLE
For text fields, date and duration fields
Since:
JDE 4.7.0

EDITING

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

EXPANDABLE

public static final int EXPANDABLE
For expandable fields, such as tree field, choice field, combo field.
Since:
JDE 4.7.0

EXPANDED

public static final int EXPANDED
For expandable fields, such as tree field, choice field, combo field and date field. The expanded date field means that user is editing it and scrolling up and down will change its value not navigate to next field. The opposite value is COLLAPSED.
Since:
JDE 4.7.0

FOCUSABLE

public static final int FOCUSABLE
For any field that can gain focus
Since:
JDE 4.7.0

FOCUSED

public static final int FOCUSED
Used for any field that can gain focus
Since:
JDE 4.7.0

HORIZONTAL

public static final int HORIZONTAL
For any element that has horizontal orientation
Since:
JDE 4.7.0

MODAL

public static final int MODAL
For modal dialogs
Since:
JDE 4.7.0

MOUSE_OVER

public static final int MOUSE_OVER
For html page elements. Specifies that user has mouse over the specified element.
Since:
JDE 4.7.0

MULTI_LINE

public static final int MULTI_LINE
For text fields
Since:
JDE 4.7.0

MULTI_SELECTABLE

public static final int MULTI_SELECTABLE
For lists and tables. Defines whether user can select multiple rows or cells.
Since:
JDE 4.7.0

PUSHED

public static final int PUSHED
For button fields, they have this state when user pushes the button.
Since:
JDE 4.7.0

SELECTABLE

public static final int SELECTABLE
For any field that can be selected
Since:
JDE 4.7.0

SELECTED

public static final int SELECTED
For text and complex fields (Menu, ListField, ComboField, ChoiceField, TreeField) which can have a descendant selected
Since:
JDE 4.7.0

SINGLE_LINE

public static final int SINGLE_LINE
For text fields
Since:
JDE 4.7.0

TRUNCATED

public static final int TRUNCATED
for all fields that display text within them
Since:
JDE 4.7.0

UNSET

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

VERTICAL

public static final int VERTICAL
For any element that has vertical orientation
Since:
JDE 4.7.0



Copyright 1999-2009 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.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.