Methods' Details |
getAccessibleChildCount
long |
getAccessibleChildCount(); |
- Description
- Return the number of children.
Returns the number of accessible children of the object.
- Returns
- The returned value is non-negative.
|
|
getAccessibleChild
- Description
- Returns the i-th child of this object.
The order in which the children are enumerated is implementation
dependend.
- Parameter i
- The index may have any value. If it is outside the range from 0
to n-1, with n being the number of children as returned by
XAccessibleContext::getAccessibleChild an empty
reference is returned.
- Returns
- If the object has an i-th child the returned value is a
reference to that child. Otherwise an empty reference is
returned.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
If no child with the given index exists then an
::com::sun::star::lang::IndexOutOfBoundsException
exception is thrown.
|
|
getAccessibleParent
- Description
- Returns the parent of this object.
This function may be called for every node, including the root
node, of the accessible tree.
- Returns
- The returned reference points to a valid object for all but the
root node. If called for the root node an empty reference is
returned.
|
|
getAccessibleIndexInParent
long |
getAccessibleIndexInParent(); |
- Description
- Returns the index of this object in its accessible parent.
If you call getAccessibeChild on the object's parent with the
index returned by this function you get a reference to this
object.
- Returns
- The returned index is zero based.
|
|
getAccessibleRole
short |
getAccessibleRole(); |
- Description
- Returns the role of this object.
The role is a generic description of an objects function. The
relation between role and name is similar to the relation between
class and object.
- Returns
- The returned value is a role defined in the enumeration
AccessibleRole.
- See also
- AccessibleRole
for a list of the available roles.
|
|
getAccessibleDescription
string |
getAccessibleDescription(); |
- Description
- Returns the object's description.
Returns the object's localized description. The description should
complement the more generic descriptions given by an object's role
and name.
- Returns
- The returned string is the object's localized description.
|
|
getAccessibleName
string |
getAccessibleName(); |
- Description
- Return the object's localized name.
See XAccessibleContext::getAccessibleRole's
documentation for the relation between an object's name and role.
Names should be unique, at least between children of the same
parent, although the uniqueness is neither enforced nor used inside
the API.
- Returns
- The returned string is the object's localized name.
|
|
getAccessibleRelationSet
- Description
- Returns the set of relations defined for this object.
The returned set of relations is a copy of this objects relation
set: changing the returned object does not change this objects
relations.
aThere are two ways to represent an empty list of relations:
Return an empty reference or return a valid object that contains an
empty list.
- Returns
- The returned value is either an empty referece or a reference to
a valid object that represents a copy of the objects list of
relations.
|
|
getAccessibleStateSet
- Description
- Returns the set of states that are currently active for this
object.
The returned state set is a copy: Changing the returned state set
will not be refelected by changing the object's set of states. See
the documentation of XAccessibleStateSet for a
description of the individual states.
- Returns
- A reference to this object's state set or an empty reference if
states are not supported.
- See also
- XAccessibleStateSet
|
|
getLocale
- Description
- Returns the locale of the component.
This locale is used for example to determine the language to use
for the name and description texts.
- Returns
- If this object does not have a locale, the locale of its parent
is returned. If it does not have (yet) a parent it throws the
exception IllegalAccessibleComponentStateException.
- Throws
- IllegalAccessibleComponentStateException
when this object does not (yet) have a parent.
|
|
Copyright © 2012, 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.