Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: accessibility ::

interface XAccessibleStateSet
Description
Implement this interface to represent a set of states.

The interface XAccessibleStateSet represents a set of states of an accessible object. It can hold any combination of states defined by the constants collection AccessibleStateType.

Since
OOo 1.1.2
Developers Guide
Accessibility - XAccessibleStateSet

Methods' Summary
isEmpty Checks whether the current state set is empty.  
contains Checks if the given state is a member of the state set of the called object.  
containsAll Checks if all of the given states are in the state set of the called object.  
getStates Get all currently set states as a sequence of state ids.  
Methods' Details
isEmpty
boolean
isEmpty();

Description
Checks whether the current state set is empty.
Returns
Returns true if there is no state in this state set and false if there is at least one set state in it.
contains
boolean
contains( [in] short  aState );

Description
Checks if the given state is a member of the state set of the called object.
Parameter aState
The state for which to check membership. This has to be one of the constants of AccessibleStateType.
Returns
Returns true if the given state is a memeber of this object's state set and false otherwise.
containsAll
boolean
containsAll( [in] sequence< short >  aStateSet );

Description
Checks if all of the given states are in the state set of the called object.
Parameter aStateSet
This sequence of states is interpreted as set and every of its members, duplicates are ignored, is checked for membership in this object's state set. Each state has to be one of the constants of AccessibleStateType.
Returns
Returns true if all states of the given state set are members of this object's state set. false is returned if at least one of the states in the given state is not a member of this object's state set.
getStates
sequence< short >
getStates();

Description
Get all currently set states as a sequence of state ids.

The purpose of this function is to reduce the communication between accessibility objects and AT. Without this function an AT-Tool had to call contains() for every state type. Now a single call is sufficient.

Returns
The returned sequence contains one entry for every currently set state. This entry is the id of that state. The order of the states in the sequence is undefined.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.