The pivot interface encapsulates a reference to a single place in an accessible
subtree. The pivot is a point or a range in the accessible tree. This interface
provides traversal methods to move the pivot to next/prev state that complies
to a given rule.
Set the pivot’s text range in a text accessible.
| aTextAccessible | [in] the text accessible that contains the desired range. |
| aStartOffset | [in] the start offset to set. |
| aEndOffset | [in] the end offset to set. |
| aIsFromUserInput | [in] the pivot changed because of direct user input (default is true). @throws NS_ERROR_INVALID_ARG when the offset exceeds the accessible's character count. |
Move pivot to next object, from current position or given anchor,
complying to given traversal rule.
| aRule | [in] traversal rule to use. |
| aAnchor | [in] accessible to start search from, if not provided, current position will be used. |
| aIncludeStart | [in] include anchor accessible in search. |
| aIsFromUserInput | [in] the pivot changed because of direct user input (default is true). |
| true on success, false if there are no new nodes to traverse to. |
Move pivot to previous object, from current position or given anchor,
complying to given traversal rule.
| aRule | [in] traversal rule to use. |
| aAnchor | [in] accessible to start search from, if not provided, current position will be used. |
| aIncludeStart | [in] include anchor accessible in search. |
| aIsFromUserInput | [in] the pivot changed because of direct user input (default is true). |
| true on success, false if there are no new nodes to traverse to. |
Move pivot to first object in subtree complying to given traversal rule.
| aRule | [in] traversal rule to use. |
| aIsFromUserInput | [in] the pivot changed because of direct user input (default is true). |
| true on success, false if there are no new nodes to traverse to. |
Move pivot to last object in subtree complying to given traversal rule.
| aRule | [in] traversal rule to use. |
| aIsFromUserInput | [in] the pivot changed because of direct user input (default is true). |
Move pivot to next text range.
| aBoundary | [in] type of boundary for next text range, character, word, etc. |
| aIsFromUserInput | [in] the pivot changed because of direct user input (default is true). |
| true on success, false if there are is no more text. |
Move pivot to previous text range.
| aBoundary | [in] type of boundary for next text range, character, word, etc. |
| aIsFromUserInput | [in] the pivot changed because of direct user input (default is true). |
| true on success, false if there are is no more text. |
Move pivot to given coordinate in screen pixels.
| aRule | [in] raversal rule to use. |
| aX | [in] screen's x coordinate |
| aY | [in] screen's y coordinate |
| aIgnoreNoMatch | [in] don't unset position if no object was found at point. |
| aIsFromUserInput | [in] the pivot changed because of direct user input (default is true). |
| true on success, false if the pivot has not been moved. |
Add an observer for pivot changes.
| aObserver | [in] the observer object to be notified of pivot changes. |
Remove an observer for pivot changes.
| aObserver | [in] the observer object to remove from being notified. |
The accessible the pivot is currently pointed at.
The root of the subtree in which the pivot traverses.
The temporary modal root to which traversal is limited to.
The start offset of the text range the pivot points at, otherwise -1.
The end offset of the text range the pivot points at, otherwise -1.