:: com :: sun :: star :: accessibility ::
|
interface XAccessibleAction |
|
- Description
- Implement this interface to give access to actions that can be executed
for accessible objects.
Every accessible object that can be manipulated beyond its methods
exported over the accessibility API should support this interface to
expose all actions that it can perform. Each action can be performed or
be queried for a description or associated key bindings.
- Since
- OOo 1.1.2
- Developers Guide
- Accessibility - XAccessibleAction
|
Methods' Details |
getAccessibleActionCount
long |
getAccessibleActionCount(); |
- Description
- Returns the number of accessible actions available in this object.
If there are more than one, the first one is considered the
"default" action of the object.
- Returns
- The returned value of the number of actions is zero if there are
no actions.
|
|
doAccessibleAction
- Description
- Perform the specified Action on the object.
- Parameter nIndex
- This index specifies the action to perform. If it lies outside
the valid range false is returned and no action is performed.
- Returns
- Returns true if the action was successfully performed. If
the action could not be performed successfully false is
returned.
- Throws
- IndexOutOfBoundsException
If no action with the given index exists then an
::com::sun::star::lang::IndexOutOfBoundsException
exception is thrown.
|
|
getAccessibleActionDescription
- Description
- Returns a description of the specified action of the object.
- Parameter nIndex
- This index specifies the action of which to return a
description. If it lies outside the valid range an empty string
is returned.
- Returns
- The returned value is a localized string of the specified action.
- Throws
- IndexOutOfBoundsException
If the given index lies not in the valid range then an
::com::sun::star::lang::IndexOutOfBoundsException
exception is thrown.
|
|
getAccessibleActionKeyBinding
- Description
- Returns a key binding object, if there is one, associated with the
specified action. Note that there can be several alternative key
bindings for an action. See XAccessibleKeyBinding for
more information about how key bindings are represented.
- Parameter nIndex
- This index specifies the action of which to return the key
binding.
- Returns
- The returned object describes a set of key bindings associated
with the specified action.
- Throws
- IndexOutOfBoundsException
if the given index is not valid.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.