nsIAccessible

A cross-platform interface that supports platform-specific
accessibility APIs like MSAA and ATK. Contains the sum of what’s needed
to support IAccessible as well as ATK’s generic accessibility objects.
Can also be used by in-process accessibility clients to get information
about objects in the accessible tree. The accessible tree is a subset of
nodes in the DOM tree – such as documents, focusable elements and text.
Mozilla creates the implementations of nsIAccessible on demand.
See http://www.mozilla.org/projects/ui/accessibility for more information.

Methods

getState(aState, aExtraState)

Accessible states – bit fields which describe boolean properties of node.
Many states are only valid given a certain role attribute that supports
them.

Parameters

aState - the first bit field (see nsIAccessibleStates::STATE_* constants)
aExtraState - the second bit field (see nsIAccessibleStates::EXT_STATE_* constants)

groupPosition(aGroupLevel, aSimilarItemsInGroup, aPositionInGroup)

Returns grouping information. Used for tree items, list items, tab panel
labels, radio buttons, etc. Also used for collectons of non-text objects.

Parameters

groupLevel - 1-based, similar to ARIA 'level' property
similarItemsInGroup - 1-based, similar to ARIA 'setsize' property, inclusive of the current item
positionInGroup - 1-based, similar to ARIA 'posinset' property

getChildAtPoint(x, y)

Accessible child which contains the coordinate at (x, y) in screen pixels.
If the point is in the current accessible but not in a child, the
current accessible will be returned.
If the point is in neither the current accessible or a child, then
null will be returned.

Parameters

x screen's x coordinate
y screen's y coordinate

Returns

the deepest accessible child containing the given point

getDeepestChildAtPoint(x, y)

Deepest accessible child which contains the coordinate at (x, y) in screen
pixels. If the point is in the current accessible but not in a child, the
current accessible will be returned. If the point is in neither the current
accessible or a child, then null will be returned.

Parameters

x screen's x coordinate
y screen's y coordinate

Returns

the deepest accessible child containing the given point

getChildAt(aChildIndex)

Nth accessible child using zero-based index or last child if index less than zero

getRelationByType(aRelationType)

Return accessible relation by the given relation type (see.
constants defined in nsIAccessibleRelation).

getRelations()

Returns multiple accessible relations for this object.

getBounds(x, y, width, height)

Return accessible’s x and y coordinates relative to the screen and
accessible’s width and height.

setSelected(isSelected)

Add or remove this accessible to the current selection

extendSelection()

Extend the current selection from its current accessible anchor node
to this accessible

takeSelection()

Select this accessible node only

takeFocus()

Focus this accessible node,
The state STATE_FOCUSABLE indicates whether this node is normally focusable.
It is the callers responsibility to determine whether this node is focusable.
accTakeFocus on a node that is not normally focusable (such as a table),
will still set focus on that node, although normally that will not be visually
indicated in most style sheets.

getActionName(index)

The name of the accessible action at the given zero-based index

getActionDescription(aIndex)

The description of the accessible action at the given zero-based index

doAction(index)

Perform the accessible action at the given zero-based index
Action number 0 is the default action

scrollTo(aScrollType)

Makes an object visible on screen.

Parameters

scrollType - defines where the object should be placed on the screen (see nsIAccessibleScrollType for available constants).

scrollToPoint(coordinateType, x, y)

Moves the top left of an object to a specified location.

Parameters

coordinateType [in] - specifies whether the coordinates are relative to the screen or the parent object (for available constants refer to nsIAccessibleCoordinateType)
x [in] - defines the x coordinate
y [in] - defines the y coordinate

Attributes

parent

Parent node in accessible tree.

nextSibling

Next sibling in accessible tree

previousSibling

Previous sibling in accessible tree

firstChild

First child in accessible tree

lastChild

Last child in accessible tree

children

Array of all this element’s children.

childCount

Number of accessible children

indexInParent

The 0-based index of this accessible in its parent’s list of children,
or -1 if this accessible does not have a parent.

DOMNode

The DOM node this nsIAccessible is associated with.

document

The document accessible that this access node resides in.

rootDocument

The root document accessible that this access node resides in.

language

The language for the current DOM node, e.g. en, de, etc.

name

Accessible name – the main text equivalent for this node. The name is
specified by ARIA or by native markup. Example of ARIA markup is
aria-labelledby attribute placed on element of this accessible. Example
of native markup is HTML label linked with HTML element of this accessible.

Value can be string or null. A null value indicates that AT may attempt to
compute the name. Any string value, including the empty string, should be
considered author-intentional, and respected.

value

Accessible value – a number or a secondary text equivalent for this node
Widgets that use role attribute can force a value using the valuenow attribute

description

Accessible description – long text associated with this node

accessKey

Provides localized string of accesskey name, such as Alt+D.
The modifier may be affected by user and platform preferences.
Usually alt+letter, or just the letter alone for menu items.

keyboardShortcut

Provides localized string of global keyboard accelerator for default
action, such as Ctrl+O for Open file

role

Enumerated accessible role (see the constants defined in nsIAccessibleRole).

@note The values might depend on platform because of variations. Widgets
can use ARIA role attribute to force the final role.

help

Help text associated with node

focusedChild

Focused accessible child of node

attributes

Attributes of accessible

actionCount

The number of accessible actions associated with this accessible