:: com :: sun :: star :: accessibility ::
|
interface XAccessibleRelationSet |
|
- Description
- Implement this interface to give access to an object's set of relations.
Such relation are modeled with the AccessibleRelation
structure. This interface is used for representing sets of relations
between Accessible objects. Most of the convenience
methods of the corresponding AccessibleRelationSet interface of the Java
Accessibility API have been removed from this interface in order to
clean it up. These methods are add,
addAll, clear, and
remove. The other methods have been renamed to achieve
a geater conformance with the other accessibility interfaces.
- Since
- OOo 1.1.2
- Developers Guide
- Accessibility - XAccessibleRelationSet
|
Methods' Summary |
getRelationCount |
Returns the number of relations in this relation set.
|
getRelation |
Returns the relation of this relation set that is specified by
the given index.
|
containsRelation |
Tests whether the relation set contains a relation matching the
specified key.
|
getRelationByType |
Retrieve and return the relation with the given relation type.
|
Methods' Details |
getRelationCount
- Description
- Returns the number of relations in this relation set.
- Returns
- Returns the number of relations or zero if there are none.
|
|
getRelation
- Description
- Returns the relation of this relation set that is specified by
the given index.
- Parameter nIndex
- This index specifies the relatio to return.
- Returns
- For a valid index, i.e. inside the range 0 to the number of
relations minus one, the returned value is the requested
relation. If the index is invalid then the returned relation
has the type INVALID.
|
|
containsRelation
boolean |
containsRelation( |
[in] short |
aRelationType ); |
- Description
- Tests whether the relation set contains a relation matching the
specified key.
- Parameter aRelationType
- The type of relation to look for in this set of relations. This
has to be one of the constants of
AccessibleRelationType.
- Returns
- Returns true if there is a (at least one) relation of the
given type and false if there is no such relation in the set.
|
|
getRelationByType
- Description
- Retrieve and return the relation with the given relation type.
- Parameter aRelationType
- The type of the relation to return. This has to be one of the
constants of AccessibleRelationType.
- Returns
- If a relation with the given type could be found than (a copy
of) this relation is returned. Otherwise a relation with the
type INVALID is returned.
|
|
Top of Page
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.