English:

The Free and Open Productivity Suite
New: Apache OpenOffice 4.1.1 released!

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

constants group AccessibleStateType
Description
Collection of state types.

This list of constants defines the available set of states that an object that implements XAccessibleContext can be in.

The comments describing the states is taken verbatim from the Java Accessibility API 1.4 documentation.

We are using constants instead of a more typesafe enum. The reason for this is that IDL enums may not be extended. Therefore, in order to include future extensions to the set of roles we have to use constants here.

Since
OOo 1.1.2
Developers Guide
Accessibility - XAccessibleStateSet

Constants
INVALID Indicates an invalid state.  
ACTIVE Indicates a window is currently the active window.  
ARMED Indicates that the object is armed.  
BUSY Indicates the current object is busy.  
CHECKED Indicates this object is currently checked.  
DEFUNC User interface object corresponding to this object no longer exists.  
EDITABLE Indicates the user can change the contents of this object.  
ENABLED Indicates this object is enabled.  
EXPANDABLE Indicates this object allows progressive disclosure of its children.  
EXPANDED Indicates this object is expanded.  
FOCUSABLE Object can accept the keyboard focus.  
FOCUSED Indicates this object currently has the keyboard focus.  
HORIZONTAL Indicates the orientation of this object is horizontal.  
ICONIFIED Indicates this object is minimized and is represented only by an icon.  
INDETERMINATE Sometimes UI elements can have a state indeterminate. This can happen e.g. if a check box reflects the bold state of text in a text processor. When the current selection contains text which is bold and also text which is not bold, the state is indeterminate.  
MANAGES_DESCENDANTS Indicates the most (all) children are transient and it is not necessary to add listener to the children. Only the active descendant (given by the event) should be not transient to make it possible to add listener to this object and recognize changes in this object. The state is added to make a performance improvment. Now it is no longer necessary to iterate over all children to find out whether they are transient or not to decide whether to add listener or not. If there is a object with this state no one should iterate over the children to add listener. Only the active descendant should get listener if it is not transient.  
MODAL Object is modal.  
MULTI_LINE Indicates this (text) object can contain multiple lines of text  
MULTI_SELECTABLE More than one child may be selected at the same time.  
OPAQUE Indicates this object paints every pixel within its rectangular region.  
PRESSED Indicates this object is currently pressed.  
RESIZABLE Indicates the size of this object is not fixed.  
SELECTABLE Object is selectable.  
SELECTED Object is selected.  
SENSITIVE Indicates this object is sensitive.  
SHOWING Object is displayed on the screen.  
SINGLE_LINE Indicates this (text) object can contain only a single line of text  
STALE ???  
TRANSIENT Indicates this object is transient.  
VERTICAL Indicates the orientation of this object is vertical.  
VISIBLE Object wants to be displayed on the screen.  
Constants' Details
INVALID
const short INVALID = 0;
Description
Indicates an invalid state.
ACTIVE
const short ACTIVE = 1;
Description
Indicates a window is currently the active window.
ARMED
const short ARMED = 2;
Description
Indicates that the object is armed.
BUSY
const short BUSY = 3;
Description
Indicates the current object is busy.
CHECKED
const short CHECKED = 4;
Description
Indicates this object is currently checked.
DEFUNC
const short DEFUNC = 5;
Description
User interface object corresponding to this object no longer exists.

Indicates the user interface object corresponding to this object no longer exists.

EDITABLE
const short EDITABLE = 6;
Description
Indicates the user can change the contents of this object.
ENABLED
const short ENABLED = 7;
Description
Indicates this object is enabled.
EXPANDABLE
const short EXPANDABLE = 8;
Description
Indicates this object allows progressive disclosure of its children.
EXPANDED
const short EXPANDED = 9;
Description
Indicates this object is expanded.
FOCUSABLE
const short FOCUSABLE = 10;
Description
Object can accept the keyboard focus.

Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus.

FOCUSED
const short FOCUSED = 11;
Description
Indicates this object currently has the keyboard focus.
HORIZONTAL
const short HORIZONTAL = 12;
Description
Indicates the orientation of this object is horizontal.
ICONIFIED
const short ICONIFIED = 13;
Description
Indicates this object is minimized and is represented only by an icon.
INDETERMINATE
const short INDETERMINATE = 14;
Description
Sometimes UI elements can have a state indeterminate. This can happen e.g. if a check box reflects the bold state of text in a text processor. When the current selection contains text which is bold and also text which is not bold, the state is indeterminate.
MANAGES_DESCENDANTS
const short MANAGES_DESCENDANTS = 15;
Description
Indicates the most (all) children are transient and it is not necessary to add listener to the children. Only the active descendant (given by the event) should be not transient to make it possible to add listener to this object and recognize changes in this object. The state is added to make a performance improvment. Now it is no longer necessary to iterate over all children to find out whether they are transient or not to decide whether to add listener or not. If there is a object with this state no one should iterate over the children to add listener. Only the active descendant should get listener if it is not transient.
MODAL
const short MODAL = 16;
Description
Object is modal.

Indicates something must be done with this object before the user can interact with an object in a different window.

MULTI_LINE
const short MULTI_LINE = 17;
Description
Indicates this (text) object can contain multiple lines of text
MULTI_SELECTABLE
const short MULTI_SELECTABLE = 18;
Description
More than one child may be selected at the same time.

Indicates this object allows more than one of its children to be selected at the same time.

OPAQUE
const short OPAQUE = 19;
Description
Indicates this object paints every pixel within its rectangular region.
PRESSED
const short PRESSED = 20;
Description
Indicates this object is currently pressed.
RESIZABLE
const short RESIZABLE = 21;
Description
Indicates the size of this object is not fixed.
SELECTABLE
const short SELECTABLE = 22;
Description
Object is selectable.

Indicates this object is the child of an object that allows its children to be selected, and that this child is one of those children that can be selected.

SELECTED
const short SELECTED = 23;
Description
Object is selected.

Indicates this object is the child of an object that allows its children to be selected, and that this child is one of those children that has been selected.

SENSITIVE
const short SENSITIVE = 24;
Description
Indicates this object is sensitive.
SHOWING
const short SHOWING = 25;
Description
Object is displayed on the screen.

An object has set the SHOWING state if itself and all of its parents have set the VISIBLE state and it lies at least partly inside the visible area of its parent. It is, though, not necessarily visible on the screen because it may be ocluded by other objects.

SINGLE_LINE
const short SINGLE_LINE = 26;
Description
Indicates this (text) object can contain only a single line of text
STALE
const short STALE = 27;
Description
???
TRANSIENT
const short TRANSIENT = 28;
Description
Indicates this object is transient.
VERTICAL
const short VERTICAL = 29;
Description
Indicates the orientation of this object is vertical.
VISIBLE
const short VISIBLE = 30;
Description
Object wants to be displayed on the screen.

A set VISIBLE state indicates that an object wants to be displayed on the screen. It is displayed, as indicated by a set SHOWING state, if all of its parents have also set the VISIBLE state and the object lies at least partly in the visible area of its parent.

Top of Page

Apache Software Foundation

Apache Software Foundation

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

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. 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.