A11yState

Since: BlackBerry 10.2.0

#include <bb/cascades/A11yState>

Represents different accessible states which specifies the state of an accessible control through its accessibility object.


Overview

Public Types Index

enum Type

Active = 0, Animated = 1, Busy = 2, Checkable = 3, Checked = 4, DefaultControl = 5, Defunct = 6, Disabled = 7, Expandable = 8, Expanded = 9, Focusable = 10, Focused = 11, HasPopup = 12, Hidden = 13, Invalid = 14, Iconified = 15, Mixed = 16, ManagesDescendants = 17, Modal = 18, MultiLine = 19, MultiSelectable = 20, OffScreen = 21, OrientationHorizontal = 22, OrientationVertical = 23, Pinned = 24, ReadOnly = 25, Required = 26, Selectable = 27, SelectableText = 28, Selected = 29, SupportsAutocompletion = 30, ManagedChild = 31, Truncated = 32, Visited = 33, PasswordProtected = 34

Public Types

Type

Specifies the different accessible control states for an accessibility object.

Since:

BlackBerry 10.2.0

Active = 0

The accessible control is currently the active window.

Unless it has this state, the window is assumed to not be the active window.

Since:

BlackBerry 10.2.0

Animated = 1

The accessible control's appearance changes rapidly or constantly.

Unless it has this state, the accessible control is assumed to be not animated.

Since:

BlackBerry 10.2.0

Busy = 2

The accessible control cannot accept input at this time.

For example, a browser might be busy loading a page or a form might be busy with a database query. Unless it has this state, the accessible control is assumed to not be busy.

Since:

BlackBerry 10.2.0

Checkable = 3

The accessible control is checkable.

The standard checkable objects are check boxes, radio buttons, check box menu items, radio menu items and toggle buttons. Unless it has this state, the accessible control is assumed to not be checkable. If the accessible control has state bb::cascades::A11yState::Checkable, but neither bb::cascades::A11yState::Checked nor bb::cascades::A11yState::Mixed, it is assumed to be unchecked.

Since:

BlackBerry 10.2.0

Checked = 4

The accessible control's check box is checked (and must also be bb::cascades::A11yState::Checkable).

If the accessible control has state bb::cascades::A11yState::Checkable, but neither bb::cascades::A11yState::Checked nor bb::cascades::A11yState::Mixed, it is assumed to be unchecked.

Since:

BlackBerry 10.2.0

DefaultControl = 5

The accessible control is the default control for the focused window.

The default control is the control that is activated when some common user input event (e.g., pressing the "return" key) happens. Unless it has this state, the accessible control is assumed to not be the default control.

Since:

BlackBerry 10.2.0

Defunct = 6

The accessible control is no longer usable in the framework and making any method calls using this accessible control could result in a crash or unexpected behavior.

Since:

BlackBerry 10.2.0

Disabled = 7

The accessible control is disabled (i.e., grayed out).

The absence of this state implies the control is enabled. Do not confuse this with bb::cascades::A11yState::ReadOnly.

Since:

BlackBerry 10.2.0

Expandable = 8

The accessible control can be expanded or collapsed, such as with a progressive disclosure container or a tree node.

Unless this state is present, it is assumed the accessible control is not expandable.

Since:

BlackBerry 10.2.0

Expanded = 9

The accessible control is expanded (and must also be bb::cascades::A11yState::Expandable).

Unless this state is present, it is assumed the accessible control is not expanded.

Since:

BlackBerry 10.2.0

Focusable = 10

The accessible control is on the active window and is ready to receive keyboard focus.

Unless this state is present, it is assumed the accessible control is not focusable.

Since:

BlackBerry 10.2.0

Focused = 11

The accessible control has the keyboard focus (and must also be bb::cascades::A11yState::Focusable).

Do not confuse focus with selection: focus is the object that will change with keyboard events whereas selection is if the object is selected, as in a list item being selected in a list.

Since:

BlackBerry 10.2.0

HasPopup = 12

Object displays a pop-up menu or window when invoked.

Since:

BlackBerry 10.2.0

Hidden = 13

The accessible control is programmatically hidden.

For example, menu items are programmatically hidden until a user activates the menu. Unless this state is present, the accessible control is not assumed to be programmatically hidden (thought it might be bb::cascades::A11yState::OffScreen).

Since:

BlackBerry 10.2.0

Invalid = 14

The accessible control is showing an input validation failure, as in a form entry field where the user typed something invalid.

Unless this state is present, the accessible control value is assumed to be valid.

Since:

BlackBerry 10.2.0

Iconified = 15

The accessible control is minimized and represented by an icon.

Unless it has this state, the accessible control is assumed to not be iconified.

Since:

BlackBerry 10.2.0

Mixed = 16

The accessible control is bb::cascades::A11yState::Checkable, but it is a three-state check whose state is currently not determined (i.e., the check box is neither checked nor unchecked and is therefore in the third or mixed state).

If the accessible control has state bb::cascades::A11yState::Checkable, but neither bb::cascades::A11yState::Checked nor bb::cascades::A11yState::Mixed, it is assumed to be unchecked.

Since:

BlackBerry 10.2.0

ManagesDescendants = 17

The children of this accessible control are all bb::cascades::A11yState::ManagedChild.

This is a hint to the assistive technology that hanging onto handles for the children of this accessible control is not supported. A typical example is a list widget that reuses widget instances to draw list items: there will typically be more list items than there are widgets.

Since:

BlackBerry 10.2.0

Modal = 18

Something must be done with this accessible control before the user can interact with objects in another window.

Unless this state is present, it is assumed the accessible control is not modal.

Since:

BlackBerry 10.2.0

MultiLine = 19

The accessible control can contain multiple lines of text, as in a text entry field where the user can enter comments.

Unless it is present, it is assumed this accessible control can only show a single line of text.

Since:

BlackBerry 10.2.0

MultiSelectable = 20

The accessible control allows more than one child to be selected at a time.

The presence of this state implies (and does not require) that the accessible control also is bb::cascades::A11yState::Selectable.

Since:

BlackBerry 10.2.0

OffScreen = 21

The accessible control is clipped or scrolled out of view, but not bb::cascades::A11yState::Hidden.

Unless it is bb::cascades::A11yState::OffScreen or bb::cascades::A11yState::Hidden, the accessible control is assumed to be showing on the screen.

Since:

BlackBerry 10.2.0

OrientationHorizontal = 22

The accessible control is laid out horizontally (as in a scroll bar or slider).

If neither this state nor bb::cascades::A11yState::OrientationVertical are present, it is not assumed that the accessible control distinguishes between horizontal and vertical layout.

Since:

BlackBerry 10.2.0

OrientationVertical = 23

The accessible control is laid out vertically (as in a scroll bar or slider).

If neither this state nor bb::cascades::A11yState::OrientationHorizontal are present, it is not assumed that the accessible control distinguishes between horizontal and vertical layout.

Since:

BlackBerry 10.2.0

Pinned = 24

The accessible control is fixed at a certain location.

One example is a browser tab that when pinned cannot be moved until unpinned. Another example is a movable or floating object that when pinned remains in its pinned location until being unpinned.

Since:

BlackBerry 10.2.0

ReadOnly = 25

The accessible control cannot be edited, as in the content on a web page.

The bb::cascades::A11yState::ReadOnly state is typically used on text areas that are navigable and allow selection/copying, but which do not allow the user to make changes. A11ys that do not have this state are assumed to be interactive objects.

Since:

BlackBerry 10.2.0

Required = 26

The accessible control requires user input/interaction, such as a field in a form.

Unless this state is present, it is assumed that interaction is not required.

Since:

BlackBerry 10.2.0

Selectable = 27

The accessible control allows its children to be selected.

Unless this state is present, it is assumed the accessible control does not allow its children to be selected.

SelectableText = 28

The text of the accessible control is selectable.

Note:

This is different from bb::cascades::A11yState::Selectable, which indicates the children are selectable.

Since:

BlackBerry 10.2.0

Selected = 29

The accessible control is the child of an accessible control that allows its children to be selected and that this child is one of those children that has been selected.

Since:

BlackBerry 10.2.0

SupportsAutocompletion = 30

The accessible control supports auto completion.

Unless this state is present, it is assumed the accessible control does not support auto completion.

Since:

BlackBerry 10.2.0

ManagedChild = 31

The accessible control is not guaranteed to live beyond the current event.

This is a hint to the assistive technology that hanging onto handles for the children of a11ys that bb::cascades::A11yState::ManagesDescendants is not supported. A typical example is a list widget that reuses widget instances to draw list items: there will typically be far more list items than there are widgets.

Since:

BlackBerry 10.2.0

Truncated = 32

The accessible control is displaying text that has been truncated visually, such as with ellipses.

Unless this state is present, the accessible control's text is assumed to not be truncated.

Since:

BlackBerry 10.2.0

Visited = 33

The object is a hyperlink that has been visited (previously clicked) by a user.

Since:

BlackBerry 10.2.0

PasswordProtected = 34

The object is a password-protected edit control.

This state is used to indicate that a text entry field will mask the input when the user types. This should only be present when the masking feature is enabled on the text entry field.

Since:

BlackBerry 10.2.0

Last modified: 2014-03-13

comments powered by Disqus