<html> <head> <title>Constants' Group AccessibleStateType</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimainnone">Use</td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleStateSet" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#Constants" class="navisub">Constants</a></td> <td class="navisub"><a href="#ConstantDetails" class="navisub">Constants' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">accessibility</a> :: </p> </td> </tr> <tr> <td class="title">constants group AccessibleStateType</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Collection of state types. </dd> <dd><p>This list of constants defines the available set of states that an object that implements <a href="XAccessibleContext.html">XAccessibleContext</a> can be in.</p> <p>The comments describing the states is taken verbatim from the Java Accessibility API 1.4 documentation.</p> <p>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.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleStateSet">Accessibility - XAccessibleStateSet</a></dd> </dl> </td> </tr> </table> <hr> <a name="Constants"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constants</td> </tr> <tr> <td class="imsum_left"><a href="#INVALID">INVALID</a></td> <td class="imsum_right">Indicates an invalid state. </td> </tr> <tr> <td class="imsum_left"><a href="#ACTIVE">ACTIVE</a></td> <td class="imsum_right">Indicates a window is currently the active window. </td> </tr> <tr> <td class="imsum_left"><a href="#ARMED">ARMED</a></td> <td class="imsum_right">Indicates that the object is armed. </td> </tr> <tr> <td class="imsum_left"><a href="#BUSY">BUSY</a></td> <td class="imsum_right">Indicates the current object is busy. </td> </tr> <tr> <td class="imsum_left"><a href="#CHECKED">CHECKED</a></td> <td class="imsum_right">Indicates this object is currently checked. </td> </tr> <tr> <td class="imsum_left"><a href="#DEFUNC">DEFUNC</a></td> <td class="imsum_right">User interface object corresponding to this object no longer exists. </td> </tr> <tr> <td class="imsum_left"><a href="#EDITABLE">EDITABLE</a></td> <td class="imsum_right">Indicates the user can change the contents of this object. </td> </tr> <tr> <td class="imsum_left"><a href="#ENABLED">ENABLED</a></td> <td class="imsum_right">Indicates this object is enabled. </td> </tr> <tr> <td class="imsum_left"><a href="#EXPANDABLE">EXPANDABLE</a></td> <td class="imsum_right">Indicates this object allows progressive disclosure of its children. </td> </tr> <tr> <td class="imsum_left"><a href="#EXPANDED">EXPANDED</a></td> <td class="imsum_right">Indicates this object is expanded. </td> </tr> <tr> <td class="imsum_left"><a href="#FOCUSABLE">FOCUSABLE</a></td> <td class="imsum_right">Object can accept the keyboard focus. </td> </tr> <tr> <td class="imsum_left"><a href="#FOCUSED">FOCUSED</a></td> <td class="imsum_right">Indicates this object currently has the keyboard focus. </td> </tr> <tr> <td class="imsum_left"><a href="#HORIZONTAL">HORIZONTAL</a></td> <td class="imsum_right">Indicates the orientation of this object is horizontal. </td> </tr> <tr> <td class="imsum_left"><a href="#ICONIFIED">ICONIFIED</a></td> <td class="imsum_right">Indicates this object is minimized and is represented only by an icon. </td> </tr> <tr> <td class="imsum_left"><a href="#INDETERMINATE">INDETERMINATE</a></td> <td class="imsum_right">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. </td> </tr> <tr> <td class="imsum_left"><a href="#MANAGES_DESCENDANTS">MANAGES_DESCENDANTS</a></td> <td class="imsum_right">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. </td> </tr> <tr> <td class="imsum_left"><a href="#MODAL">MODAL</a></td> <td class="imsum_right">Object is modal. </td> </tr> <tr> <td class="imsum_left"><a href="#MULTI_LINE">MULTI_LINE</a></td> <td class="imsum_right">Indicates this (text) object can contain multiple lines of text </td> </tr> <tr> <td class="imsum_left"><a href="#MULTI_SELECTABLE">MULTI_SELECTABLE</a></td> <td class="imsum_right">More than one child may be selected at the same time. </td> </tr> <tr> <td class="imsum_left"><a href="#OPAQUE">OPAQUE</a></td> <td class="imsum_right">Indicates this object paints every pixel within its rectangular region. </td> </tr> <tr> <td class="imsum_left"><a href="#PRESSED">PRESSED</a></td> <td class="imsum_right">Indicates this object is currently pressed. </td> </tr> <tr> <td class="imsum_left"><a href="#RESIZABLE">RESIZABLE</a></td> <td class="imsum_right">Indicates the size of this object is not fixed. </td> </tr> <tr> <td class="imsum_left"><a href="#SELECTABLE">SELECTABLE</a></td> <td class="imsum_right">Object is selectable. </td> </tr> <tr> <td class="imsum_left"><a href="#SELECTED">SELECTED</a></td> <td class="imsum_right">Object is selected. </td> </tr> <tr> <td class="imsum_left"><a href="#SENSITIVE">SENSITIVE</a></td> <td class="imsum_right">Indicates this object is sensitive. </td> </tr> <tr> <td class="imsum_left"><a href="#SHOWING">SHOWING</a></td> <td class="imsum_right">Object is displayed on the screen. </td> </tr> <tr> <td class="imsum_left"><a href="#SINGLE_LINE">SINGLE_LINE</a></td> <td class="imsum_right">Indicates this (text) object can contain only a single line of text </td> </tr> <tr> <td class="imsum_left"><a href="#STALE">STALE</a></td> <td class="imsum_right">??? </td> </tr> <tr> <td class="imsum_left"><a href="#TRANSIENT">TRANSIENT</a></td> <td class="imsum_right">Indicates this object is transient. </td> </tr> <tr> <td class="imsum_left"><a href="#VERTICAL">VERTICAL</a></td> <td class="imsum_right">Indicates the orientation of this object is vertical. </td> </tr> <tr> <td class="imsum_left"><a href="#VISIBLE">VISIBLE</a></td> <td class="imsum_right">Object wants to be displayed on the screen. </td> </tr> </table> <a name="ConstantDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Constants' Details</td> </tr> <tr> <td class="imdetail"><a name="INVALID" class="membertitle">INVALID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>INVALID</b> = 0;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates an invalid state. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ACTIVE" class="membertitle">ACTIVE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>ACTIVE</b> = 1;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates a window is currently the active window. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ARMED" class="membertitle">ARMED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>ARMED</b> = 2;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates that the object is armed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BUSY" class="membertitle">BUSY</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>BUSY</b> = 3;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates the current object is busy. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CHECKED" class="membertitle">CHECKED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>CHECKED</b> = 4;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object is currently checked. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DEFUNC" class="membertitle">DEFUNC</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>DEFUNC</b> = 5;<hr> <dl> <dt><b>Description</b></dt> <dd>User interface object corresponding to this object no longer exists. </dd> <dd><p>Indicates the user interface object corresponding to this object no longer exists.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EDITABLE" class="membertitle">EDITABLE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>EDITABLE</b> = 6;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates the user can change the contents of this object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ENABLED" class="membertitle">ENABLED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>ENABLED</b> = 7;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object is enabled. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EXPANDABLE" class="membertitle">EXPANDABLE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>EXPANDABLE</b> = 8;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object allows progressive disclosure of its children. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EXPANDED" class="membertitle">EXPANDED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>EXPANDED</b> = 9;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object is expanded. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FOCUSABLE" class="membertitle">FOCUSABLE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>FOCUSABLE</b> = 10;<hr> <dl> <dt><b>Description</b></dt> <dd>Object can accept the keyboard focus. </dd> <dd><p>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.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FOCUSED" class="membertitle">FOCUSED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>FOCUSED</b> = 11;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object currently has the keyboard focus. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HORIZONTAL" class="membertitle">HORIZONTAL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>HORIZONTAL</b> = 12;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates the orientation of this object is horizontal. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ICONIFIED" class="membertitle">ICONIFIED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>ICONIFIED</b> = 13;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object is minimized and is represented only by an icon. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="INDETERMINATE" class="membertitle">INDETERMINATE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>INDETERMINATE</b> = 14;<hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MANAGES_DESCENDANTS" class="membertitle">MANAGES_DESCENDANTS</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MANAGES_DESCENDANTS</b> = 15;<hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MODAL" class="membertitle">MODAL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MODAL</b> = 16;<hr> <dl> <dt><b>Description</b></dt> <dd>Object is modal. </dd> <dd><p>Indicates something must be done with this object before the user can interact with an object in a different window.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MULTI_LINE" class="membertitle">MULTI_LINE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MULTI_LINE</b> = 17;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this (text) object can contain multiple lines of text </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MULTI_SELECTABLE" class="membertitle">MULTI_SELECTABLE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MULTI_SELECTABLE</b> = 18;<hr> <dl> <dt><b>Description</b></dt> <dd>More than one child may be selected at the same time. </dd> <dd><p>Indicates this object allows more than one of its children to be selected at the same time.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="OPAQUE" class="membertitle">OPAQUE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>OPAQUE</b> = 19;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object paints every pixel within its rectangular region. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PRESSED" class="membertitle">PRESSED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>PRESSED</b> = 20;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object is currently pressed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RESIZABLE" class="membertitle">RESIZABLE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>RESIZABLE</b> = 21;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates the size of this object is not fixed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SELECTABLE" class="membertitle">SELECTABLE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>SELECTABLE</b> = 22;<hr> <dl> <dt><b>Description</b></dt> <dd>Object is selectable. </dd> <dd><p>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.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SELECTED" class="membertitle">SELECTED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>SELECTED</b> = 23;<hr> <dl> <dt><b>Description</b></dt> <dd>Object is selected. </dd> <dd><p>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.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SENSITIVE" class="membertitle">SENSITIVE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>SENSITIVE</b> = 24;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object is sensitive. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SHOWING" class="membertitle">SHOWING</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>SHOWING</b> = 25;<hr> <dl> <dt><b>Description</b></dt> <dd>Object is displayed on the screen. </dd> <dd><p>An object has set the <b>SHOWING</b> state if itself and all of its parents have set the <b>VISIBLE</b> 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.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SINGLE_LINE" class="membertitle">SINGLE_LINE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>SINGLE_LINE</b> = 26;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this (text) object can contain only a single line of text </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="STALE" class="membertitle">STALE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>STALE</b> = 27;<hr> <dl> <dt><b>Description</b></dt> <dd>??? </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TRANSIENT" class="membertitle">TRANSIENT</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>TRANSIENT</b> = 28;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates this object is transient. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="VERTICAL" class="membertitle">VERTICAL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>VERTICAL</b> = 29;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates the orientation of this object is vertical. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="VISIBLE" class="membertitle">VISIBLE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>VISIBLE</b> = 30;<hr> <dl> <dt><b>Description</b></dt> <dd>Object wants to be displayed on the screen. </dd> <dd><p>A set <b>VISIBLE</b> state indicates that an object wants to be displayed on the screen. It is displayed, as indicated by a set <b>SHOWING</b> state, if all of its parents have also set the <b>VISIBLE</b> state and the object lies at least partly in the visible area of its parent.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2009 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>