jdk/src/java.desktop/share/classes/javax/accessibility/package.html
changeset 32283 1a96ab120a48
parent 25859 3317bb8137f4
equal deleted inserted replaced
32282:9c9ff2c42e0d 32283:1a96ab120a48
    41 below.
    41 below.
    42 <H3>
    42 <H3>
    43 <A NAME="Accessible"></A><A HREF="Accessible.html">Interface Accessible</A></H3>
    43 <A NAME="Accessible"></A><A HREF="Accessible.html">Interface Accessible</A></H3>
    44 <A HREF="Accessible.html">Interface Accessible</A> is the main interface
    44 <A HREF="Accessible.html">Interface Accessible</A> is the main interface
    45 of the Java Accessibility API. All components that support the Java Accessibility
    45 of the Java Accessibility API. All components that support the Java Accessibility
    46 API must implement this interface. It contains a single method, <TT>getAccessibleContext</TT>,
    46 API must implement this interface. It contains a single method, <code>getAccessibleContext</code>,
    47 that returns an instance of the class <A HREF="#AccessibleContext">AccessibleContext</A>.
    47 that returns an instance of the class <A HREF="#AccessibleContext">AccessibleContext</A>.
    48 Sun thinks that implementing this interface is the absolute minimum requirement
    48 Sun thinks that implementing this interface is the absolute minimum requirement
    49 of every object that is part of the user interface of a Java application,
    49 of every object that is part of the user interface of a Java application,
    50 if that program is to be compatible with assistive technologies.
    50 if that program is to be compatible with assistive technologies.
    51 <H3>
    51 <H3>
    52 <A NAME="AccessibleContext"></A><A HREF="AccessibleContext.html">Class
    52 <A NAME="AccessibleContext"></A><A HREF="AccessibleContext.html">Class
    53 AccessibleContext</A></H3>
    53 AccessibleContext</A></H3>
    54 <A HREF="AccessibleContext.html">AccessibleContext</A> represents the minimum
    54 <A HREF="AccessibleContext.html">AccessibleContext</A> represents the minimum
    55 information all accessible objects return and is obtained by calling the
    55 information all accessible objects return and is obtained by calling the
    56 <TT>getAccessibleContext</TT> method on an object that implements the <A HREF="#Accessible">Accessible</A>
    56 <code>getAccessibleContext</code> method on an object that implements the <A HREF="#Accessible">Accessible</A>
    57 interface. This information includes the accessible name, description,
    57 interface. This information includes the accessible name, description,
    58 <A HREF="#AccessibleRole">role</A>, and <A HREF="#AccessibleState">state</A>
    58 <A HREF="#AccessibleRole">role</A>, and <A HREF="#AccessibleState">state</A>
    59 of the object, as well as information about the parent and children of
    59 of the object, as well as information about the parent and children of
    60 the object.&nbsp; In addition, JavaBeans <SUP><FONT SIZE=-2>TM</FONT></SUP>
    60 the object.&nbsp; In addition, JavaBeans <SUP><FONT SIZE=-2>TM</FONT></SUP>
    61 property change support is also included to allow assisitive technologies
    61 property change support is also included to allow assisitive technologies
    67 <LI>
    67 <LI>
    68 <B><A HREF="#AccessibleAction">AccessibleAction</A></B> - the object can
    68 <B><A HREF="#AccessibleAction">AccessibleAction</A></B> - the object can
    69 perform one or more actions. This interface provides the standard mechanism
    69 perform one or more actions. This interface provides the standard mechanism
    70 for an assistive technology to determine what those actions are and tell
    70 for an assistive technology to determine what those actions are and tell
    71 the object to perform those actions. Any object that can be manipulated
    71 the object to perform those actions. Any object that can be manipulated
    72 should return an object that implements this interface when the <TT>getAccessibleAction</TT>
    72 should return an object that implements this interface when the <code>getAccessibleAction</code>
    73 method is called on an AccessibleContext.</LI>
    73 method is called on an AccessibleContext.</LI>
    74 
    74 
    75 <LI>
    75 <LI>
    76 <B><A HREF="#AccessibleComponent">AccessibleComponent</A></B> - the object
    76 <B><A HREF="#AccessibleComponent">AccessibleComponent</A></B> - the object
    77 has a graphical representation. This interface provides the standard mechanism
    77 has a graphical representation. This interface provides the standard mechanism
    78 for an assistive technology to determine and set the graphical representation
    78 for an assistive technology to determine and set the graphical representation
    79 of the object. Any object that is rendered on the screen should return
    79 of the object. Any object that is rendered on the screen should return
    80 an object that implements this interface when the <TT>getAccessibleComponent</TT>
    80 an object that implements this interface when the <code>getAccessibleComponent</code>
    81 method is called on an AccessibleContext.</LI>
    81 method is called on an AccessibleContext.</LI>
    82 
    82 
    83 <LI>
    83 <LI>
    84 <B><A HREF="#AccessibleSelection">AccessibleSelection</A></B> - the object
    84 <B><A HREF="#AccessibleSelection">AccessibleSelection</A></B> - the object
    85 allows its children to be selected. This interface provides the standard
    85 allows its children to be selected. This interface provides the standard
    86 mechanism for an assistive technology to determine the currently selected
    86 mechanism for an assistive technology to determine the currently selected
    87 children as well as modify the selection set. Any object that has children
    87 children as well as modify the selection set. Any object that has children
    88 that can be selected should return an object that implements this interface
    88 that can be selected should return an object that implements this interface
    89 when the <TT>getAccessibleSelection</TT> method is called on an AccessibleContext.</LI>
    89 when the <code>getAccessibleSelection</code> method is called on an AccessibleContext.</LI>
    90 
    90 
    91 <LI>
    91 <LI>
    92 <B><A HREF="#AccessibleText">AccessibleText</A></B> - the object presents
    92 <B><A HREF="#AccessibleText">AccessibleText</A></B> - the object presents
    93 editable textual information on the display. This interface provides the
    93 editable textual information on the display. This interface provides the
    94 standard mechanism for an assistive technology to access that text via
    94 standard mechanism for an assistive technology to access that text via
    95 its content, attributes, and spatial location. Any object that contains
    95 its content, attributes, and spatial location. Any object that contains
    96 editable text should return an object that implements this interface when
    96 editable text should return an object that implements this interface when
    97 the <TT>getAccessibleText</TT> method is called on an AccessibleContext.</LI>
    97 the <code>getAccessibleText</code> method is called on an AccessibleContext.</LI>
    98 
    98 
    99 <LI>
    99 <LI>
   100 <B><A HREF="#AccessibleHypertext">AccessibleHypertext</A></B> - the object
   100 <B><A HREF="#AccessibleHypertext">AccessibleHypertext</A></B> - the object
   101 presents hypertext information on the display. This interface provides
   101 presents hypertext information on the display. This interface provides
   102 the standard mechanism for an assistive technology to access that hypertext
   102 the standard mechanism for an assistive technology to access that hypertext
   103 via its content, attributes, and spatial location. Any object that contains
   103 via its content, attributes, and spatial location. Any object that contains
   104 hypertext should return an object that implements this interface when the
   104 hypertext should return an object that implements this interface when the
   105 <TT>getAccessibleText</TT> method is called on an AccessibleContext.</LI>
   105 <code>getAccessibleText</code> method is called on an AccessibleContext.</LI>
   106 
   106 
   107 <LI>
   107 <LI>
   108 <B><A HREF="#AccessibleValue">AccessibleValue</A></B> - the object supports
   108 <B><A HREF="#AccessibleValue">AccessibleValue</A></B> - the object supports
   109 a numerical value. This interface provides the standard mechanism for an
   109 a numerical value. This interface provides the standard mechanism for an
   110 assistive technology to determine and set the current value of the object,
   110 assistive technology to determine and set the current value of the object,
   111 as well as the minimum and maximum values. Any object that supports a numerical
   111 as well as the minimum and maximum values. Any object that supports a numerical
   112 value should return an object that implements this interface when the <TT>getAccessibleValue</TT>
   112 value should return an object that implements this interface when the <code>getAccessibleValue</code>
   113 method is called on an AccessibleContext.</LI>
   113 method is called on an AccessibleContext.</LI>
   114 </UL>
   114 </UL>
   115 
   115 
   116 <H3>
   116 <H3>
   117 <A NAME="AccessibleRole"></A><A HREF="AccessibleRole.html">Class AccessibleRole</A></H3>
   117 <A NAME="AccessibleRole"></A><A HREF="AccessibleRole.html">Class AccessibleRole</A></H3>
   118 This class encapsulates the Accessible object's role in the user interface
   118 This class encapsulates the Accessible object's role in the user interface
   119 and is obtained by calling the <TT>getAccessibleRole</TT> method on an
   119 and is obtained by calling the <code>getAccessibleRole</code> method on an
   120 <A HREF="#AccessibleContext">AccessibleContext</A>. Accessible roles include
   120 <A HREF="#AccessibleContext">AccessibleContext</A>. Accessible roles include
   121 "Check box", "Menu Item", "Panel", etc. These roles are identified by the
   121 "Check box", "Menu Item", "Panel", etc. These roles are identified by the
   122 constants in this class such as <TT>AccessibleRole.CHECK_BOX, AccessibleRole.MENU_ITEM,</TT>
   122 constants in this class such as <code>AccessibleRole.CHECK_BOX, AccessibleRole.MENU_ITEM,</code>
   123 and <TT>AccessibleRole.PANEL</TT>. The constants in this class present
   123 and <code>AccessibleRole.PANEL</code>. The constants in this class present
   124 a strongly typed enumeration of common object roles. A public constructor
   124 a strongly typed enumeration of common object roles. A public constructor
   125 for this class has been purposely omitted and applications should use one
   125 for this class has been purposely omitted and applications should use one
   126 of the constants from this class. Although this class pre-defines a large
   126 of the constants from this class. Although this class pre-defines a large
   127 list of standard roles, it is extensible so additional programmer-defined
   127 list of standard roles, it is extensible so additional programmer-defined
   128 roles can be added in the future without needing to modify the base class.
   128 roles can be added in the future without needing to modify the base class.
   129 
   129 
   130 <H3>
   130 <H3>
   131 <A NAME="AccessibleState"></A><A HREF="AccessibleState.html">Class AccessibleState</A></H3>
   131 <A NAME="AccessibleState"></A><A HREF="AccessibleState.html">Class AccessibleState</A></H3>
   132 This class encapsulates a particular state of the Accessible object. Accessible
   132 This class encapsulates a particular state of the Accessible object. Accessible
   133 states include things like "Armed", "Busy", "Checked", "Focused", etc.
   133 states include things like "Armed", "Busy", "Checked", "Focused", etc.
   134 These roles are identified by the constants in this class such as <TT>AccessibleState.ARMED,
   134 These roles are identified by the constants in this class such as <code>AccessibleState.ARMED,
   135 AccessibleState.BUSY, AccessibleState.CHECKED,</TT> and <TT>AccessibleState.FOCUSED</TT>.
   135 AccessibleState.BUSY, AccessibleState.CHECKED,</code> and <code>AccessibleState.FOCUSED</code>.
   136 The sum of all the states of an Accessible object is called the <A HREF="#AccessibleStateSet">AccessibleStateSet</A>,
   136 The sum of all the states of an Accessible object is called the <A HREF="#AccessibleStateSet">AccessibleStateSet</A>,
   137 and can be obtained by calling the <TT>getAccessibleStateSet</TT> method
   137 and can be obtained by calling the <code>getAccessibleStateSet</code> method
   138 on an <A HREF="#AccessibleContext">AccessibleContext</A>.
   138 on an <A HREF="#AccessibleContext">AccessibleContext</A>.
   139 
   139 
   140 <P>The constants in this class present a strongly typed enumeration of
   140 <P>The constants in this class present a strongly typed enumeration of
   141 common object roles. A public constructor for this class has been purposely
   141 common object roles. A public constructor for this class has been purposely
   142 omitted and applications should use one of the constants from this class.
   142 omitted and applications should use one of the constants from this class.
   146 
   146 
   147 <H3>
   147 <H3>
   148 <A NAME="AccessibleStateSet"></A><A HREF="AccessibleStateSet.html">Class
   148 <A NAME="AccessibleStateSet"></A><A HREF="AccessibleStateSet.html">Class
   149 AccessibleStateSet</A></H3>
   149 AccessibleStateSet</A></H3>
   150 This class encapsulates a collection of states of the Accessible object
   150 This class encapsulates a collection of states of the Accessible object
   151 and is obtained by calling the <TT>getAccessibleStateSet</TT> method on
   151 and is obtained by calling the <code>getAccessibleStateSet</code> method on
   152 an <A HREF="#AccessibleContext">AccessibleContext</A>. Since an object
   152 an <A HREF="#AccessibleContext">AccessibleContext</A>. Since an object
   153 might have multiple states (e.g. it might be both "Checked" and "Focused"),
   153 might have multiple states (e.g. it might be both "Checked" and "Focused"),
   154 this class is needed to encapsulate a collection of these states. Methods
   154 this class is needed to encapsulate a collection of these states. Methods
   155 in the class provide for retrieving the individual <A HREF="#AccessibleState">AccessibleStates</A>
   155 in the class provide for retrieving the individual <A HREF="#AccessibleState">AccessibleStates</A>
   156 on the state set.
   156 on the state set.
   171 what those actions are as well as tell the object to perform those actions.
   171 what those actions are as well as tell the object to perform those actions.
   172 Any object that can be manipulated should support this interface.
   172 Any object that can be manipulated should support this interface.
   173 
   173 
   174 <P>Applications can determine if an object supports the AccessibleAction
   174 <P>Applications can determine if an object supports the AccessibleAction
   175 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   175 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   176 (see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleAction</TT>
   176 (see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleAction</code>
   177 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   177 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   178 value is not null, the object supports this interface.
   178 value is not null, the object supports this interface.
   179 <H3>
   179 <H3>
   180 <A NAME="AccessibleComponent"></A><A HREF="AccessibleComponent.html">Interface
   180 <A NAME="AccessibleComponent"></A><A HREF="AccessibleComponent.html">Interface
   181 AccessibleComponent</A></H3>
   181 AccessibleComponent</A></H3>
   184 interface provides the standard mechanism for an assistive technology to
   184 interface provides the standard mechanism for an assistive technology to
   185 determine and set the graphical representation of an object.
   185 determine and set the graphical representation of an object.
   186 
   186 
   187 <P>Applications can determine if an object supports the AccessibleComponent
   187 <P>Applications can determine if an object supports the AccessibleComponent
   188 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   188 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   189 (see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleComponent</TT>
   189 (see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleComponent</code>
   190 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   190 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   191 value is not null, the object supports this interface.
   191 value is not null, the object supports this interface.
   192 <H3>
   192 <H3>
   193 <A NAME="AccessibleSelection"></A><A HREF="AccessibleSelection.html">Interface
   193 <A NAME="AccessibleSelection"></A><A HREF="AccessibleSelection.html">Interface
   194 AccessibleSelection</A></H3>
   194 AccessibleSelection</A></H3>
   198 set. Any object that has children that can be selected should support this
   198 set. Any object that has children that can be selected should support this
   199 the AccessibleSelection interface.
   199 the AccessibleSelection interface.
   200 
   200 
   201 <P>Applications can determine if an object supports the AccessibleSelection
   201 <P>Applications can determine if an object supports the AccessibleSelection
   202 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   202 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   203 (see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleSelection</TT>
   203 (see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleSelection</code>
   204 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   204 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   205 value is not null, the object supports this interface.
   205 value is not null, the object supports this interface.
   206 <H3>
   206 <H3>
   207 <A NAME="AccessibleText"></A><A HREF="AccessibleText.html">Interface AccessibleText</A></H3>
   207 <A NAME="AccessibleText"></A><A HREF="AccessibleText.html">Interface AccessibleText</A></H3>
   208 Interface <A HREF="AccessibleText.html">AccessibleText</A> is the contract
   208 Interface <A HREF="AccessibleText.html">AccessibleText</A> is the contract
   220 the selected text (if any), the length of the text, and the location of
   220 the selected text (if any), the length of the text, and the location of
   221 the text caret.
   221 the text caret.
   222 
   222 
   223 <P>Applications can determine if an object supports the AccessibleText
   223 <P>Applications can determine if an object supports the AccessibleText
   224 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   224 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   225 (see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleText</TT>
   225 (see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleText</code>
   226 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   226 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   227 value is not null, the object supports this interface.
   227 value is not null, the object supports this interface.
   228 <H3><A NAME="AccessibleHypertext"></A>
   228 <H3><A NAME="AccessibleHypertext"></A>
   229 <A HREF="AccessibleHypertext.html">Interface AccessibleHypertext</A></H3>
   229 <A HREF="AccessibleHypertext.html">Interface AccessibleHypertext</A></H3>
   230 The <A HREF="AccessibleHypertext.html">AccessibleHypertext</A> interface
   230 The <A HREF="AccessibleHypertext.html">AccessibleHypertext</A> interface
   254 to determine and set the numerical value as well as get the minimum and
   254 to determine and set the numerical value as well as get the minimum and
   255 maximum values.
   255 maximum values.
   256 
   256 
   257 <P>Applications can determine if an object supports the AccessibleValue
   257 <P>Applications can determine if an object supports the AccessibleValue
   258 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   258 interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
   259 (see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleValue</TT>
   259 (see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleValue</code>
   260 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   260 method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
   261 value is not null, the object supports this interface.
   261 value is not null, the object supports this interface.
   262 
   262 
   263 @since 1.2
   263 @since 1.2
   264 </BODY>
   264 </BODY>