Java Doc for AccessibleState.java in  » 6.0-JDK-Core » accessibility » javax » accessibility » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » accessibility » javax.accessibility 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.accessibility.AccessibleBundle
      javax.accessibility.AccessibleState

AccessibleState
public class AccessibleState extends AccessibleBundle (Code)

Class AccessibleState describes a component's particular state. The actual state of the component is defined as an AccessibleStateSet, which is a composed set of AccessibleStates.

The toDisplayString method allows you to obtain the localized string for a locale independent key from a predefined ResourceBundle for the keys defined in this class.

The constants in this class present a strongly typed enumeration of common object roles. A public constructor for this class has been purposely omitted and applications should use one of the constants from this class. If the constants in this class are not sufficient to describe the role of an object, a subclass should be generated from this class and it should provide constants in a similar manner.
version:
   1.45 05/05/07
author:
   Willie Walker
author:
   Peter Korn



Field Summary
final public static  AccessibleStateACTIVE
     Indicates a window is currently the active window.
final public static  AccessibleStateARMED
     Indicates that the object is armed.
final public static  AccessibleStateBUSY
     Indicates the current object is busy.
final public static  AccessibleStateCHECKED
     Indicates this object is currently checked.
final public static  AccessibleStateCOLLAPSED
     Indicates this object is collapsed.
final public static  AccessibleStateEDITABLE
     Indicates the user can change the contents of this object.
final public static  AccessibleStateENABLED
     Indicates this object is enabled.
final public static  AccessibleStateEXPANDABLE
     Indicates this object allows progressive disclosure of its children.
final public static  AccessibleStateEXPANDED
     Indicates this object is expanded.
final public static  AccessibleStateFOCUSABLE
     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.
final public static  AccessibleStateFOCUSED
     Indicates this object currently has the keyboard focus.
final public static  AccessibleStateHORIZONTAL
     Indicates the orientation of this object is horizontal.
final public static  AccessibleStateICONIFIED
     Indicates this object is minimized and is represented only by an icon.
final public static  AccessibleStateINDETERMINATE
     Indicates that the object state is indeterminate.
final public static  AccessibleStateMANAGES_DESCENDANTS
     Indicates this object is responsible for managing its subcomponents.
final public static  AccessibleStateMODAL
     Indicates something must be done with this object before the user can interact with an object in a different window.
final public static  AccessibleStateMULTISELECTABLE
     Indicates this object allows more than one of its children to be selected at the same time.
final public static  AccessibleStateMULTI_LINE
    
final public static  AccessibleStateOPAQUE
     Indicates this object paints every pixel within its rectangular region.
final public static  AccessibleStatePRESSED
     Indicates this object is currently pressed.
final public static  AccessibleStateRESIZABLE
     Indicates the size of this object is not fixed.
final public static  AccessibleStateSELECTABLE
     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.
final public static  AccessibleStateSELECTED
     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.
final public static  AccessibleStateSHOWING
     Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible.
final public static  AccessibleStateSINGLE_LINE
    
final public static  AccessibleStateTRANSIENT
     Indicates this object is transient.
final public static  AccessibleStateTRUNCATED
     A state indicating that text is truncated by a bounding rectangle and that some of the text is not displayed on the screen.
final public static  AccessibleStateVERTICAL
     Indicates the orientation of this object is vertical.
final public static  AccessibleStateVISIBLE
     Indicates this object is visible.

Constructor Summary
protected  AccessibleState(String key)
     Creates a new AccessibleState using the given locale independent key. This should not be a public method.


Field Detail
ACTIVE
final public static AccessibleState ACTIVE(Code)
Indicates a window is currently the active window. This includes windows, dialogs, frames, etc. In addition, this state is used to indicate the currently active child of a component such as a list, table, or tree. For example, the active child of a list is the child that is drawn with a rectangle around it.
See Also:   AccessibleRole.WINDOW
See Also:   AccessibleRole.FRAME
See Also:   AccessibleRole.DIALOG


ARMED
final public static AccessibleState ARMED(Code)
Indicates that the object is armed. This is usually used on buttons that have been pressed but not yet released, and the mouse pointer is still over the button.
See Also:   AccessibleRole.PUSH_BUTTON


BUSY
final public static AccessibleState BUSY(Code)
Indicates the current object is busy. This is usually used on objects such as progress bars, sliders, or scroll bars to indicate they are in a state of transition.
See Also:   AccessibleRole.PROGRESS_BAR
See Also:   AccessibleRole.SCROLL_BAR
See Also:   AccessibleRole.SLIDER


CHECKED
final public static AccessibleState CHECKED(Code)
Indicates this object is currently checked. This is usually used on objects such as toggle buttons, radio buttons, and check boxes.
See Also:   AccessibleRole.TOGGLE_BUTTON
See Also:   AccessibleRole.RADIO_BUTTON
See Also:   AccessibleRole.CHECK_BOX


COLLAPSED
final public static AccessibleState COLLAPSED(Code)
Indicates this object is collapsed. This is usually paired with the EXPANDABLE state and is used on objects that provide progressive disclosure such as trees.
See Also:   AccessibleState.EXPANDABLE
See Also:   AccessibleState.EXPANDED
See Also:   AccessibleRole.TREE


EDITABLE
final public static AccessibleState EDITABLE(Code)
Indicates the user can change the contents of this object. This is usually used primarily for objects that allow the user to enter text. Other objects, such as scroll bars and sliders, are automatically editable if they are enabled.
See Also:   AccessibleState.ENABLED


ENABLED
final public static AccessibleState ENABLED(Code)
Indicates this object is enabled. The absence of this state from an object's state set indicates this object is not enabled. An object that is not enabled cannot be manipulated by the user. In a graphical display, it is usually grayed out.


EXPANDABLE
final public static AccessibleState EXPANDABLE(Code)
Indicates this object allows progressive disclosure of its children. This is usually used with hierarchical objects such as trees and is often paired with the EXPANDED or COLLAPSED states.
See Also:   AccessibleState.EXPANDED
See Also:   AccessibleState.COLLAPSED
See Also:   AccessibleRole.TREE


EXPANDED
final public static AccessibleState EXPANDED(Code)
Indicates this object is expanded. This is usually paired with the EXPANDABLE state and is used on objects that provide progressive disclosure such as trees.
See Also:   AccessibleState.EXPANDABLE
See Also:   AccessibleState.COLLAPSED
See Also:   AccessibleRole.TREE


FOCUSABLE
final public static AccessibleState FOCUSABLE(Code)
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.
See Also:   AccessibleState.FOCUSED


FOCUSED
final public static AccessibleState FOCUSED(Code)
Indicates this object currently has the keyboard focus.
See Also:   AccessibleState.FOCUSABLE


HORIZONTAL
final public static AccessibleState HORIZONTAL(Code)
Indicates the orientation of this object is horizontal. This is usually associated with objects such as scrollbars, sliders, and progress bars.
See Also:   AccessibleState.HORIZONTAL
See Also:   AccessibleRole.SCROLL_BAR
See Also:   AccessibleRole.SLIDER
See Also:   AccessibleRole.PROGRESS_BAR


ICONIFIED
final public static AccessibleState ICONIFIED(Code)
Indicates this object is minimized and is represented only by an icon. This is usually only associated with frames and internal frames.
See Also:   AccessibleRole.FRAME
See Also:   AccessibleRole.INTERNAL_FRAME


INDETERMINATE
final public static AccessibleState INDETERMINATE(Code)
Indicates that the object state is indeterminate. An example is selected text that is partially bold and partially not bold. In this case the attributes associated with the selected text are indeterminate.
since:
   1.5


MANAGES_DESCENDANTS
final public static AccessibleState MANAGES_DESCENDANTS(Code)
Indicates this object is responsible for managing its subcomponents. This is typically used for trees and tables that have a large number of subcomponents and where the objects are created only when needed and otherwise remain virtual. The application should not manage the subcomponents directly.
since:
   1.5


MODAL
final public static AccessibleState MODAL(Code)
Indicates something must be done with this object before the user can interact with an object in a different window. This is usually associated only with dialogs.
See Also:   AccessibleRole.DIALOG


MULTISELECTABLE
final public static AccessibleState MULTISELECTABLE(Code)
Indicates this object allows more than one of its children to be selected at the same time.
See Also:   Accessible.getAccessibleContext
See Also:   AccessibleContext.getAccessibleSelection
See Also:   AccessibleSelection


MULTI_LINE
final public static AccessibleState MULTI_LINE(Code)
Indicates this (text) object can contain multiple lines of text


OPAQUE
final public static AccessibleState OPAQUE(Code)
Indicates this object paints every pixel within its rectangular region. A non-opaque component paints only some of its pixels, allowing the pixels underneath it to "show through". A component that does not fully paint its pixels therefore provides a degree of transparency.
See Also:   Accessible.getAccessibleContext
See Also:   AccessibleContext.getAccessibleComponent
See Also:   AccessibleComponent.getBounds


PRESSED
final public static AccessibleState PRESSED(Code)
Indicates this object is currently pressed. This is usually associated with buttons and indicates the user has pressed a mouse button while the pointer was over the button and has not yet released the mouse button.
See Also:   AccessibleRole.PUSH_BUTTON


RESIZABLE
final public static AccessibleState RESIZABLE(Code)
Indicates the size of this object is not fixed.
See Also:   Accessible.getAccessibleContext
See Also:   AccessibleContext.getAccessibleComponent
See Also:   AccessibleComponent.getSize
See Also:   AccessibleComponent.setSize


SELECTABLE
final public static AccessibleState SELECTABLE(Code)
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.
See Also:   AccessibleState.SELECTED
See Also:   Accessible.getAccessibleContext
See Also:   AccessibleContext.getAccessibleSelection
See Also:   AccessibleSelection


SELECTED
final public static AccessibleState SELECTED(Code)
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.
See Also:   AccessibleState.SELECTABLE
See Also:   Accessible.getAccessibleContext
See Also:   AccessibleContext.getAccessibleSelection
See Also:   AccessibleSelection


SHOWING
final public static AccessibleState SHOWING(Code)
Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible. Note that this does not necessarily mean the object is painted on the screen. It might be occluded by some other showing object.
See Also:   AccessibleState.VISIBLE


SINGLE_LINE
final public static AccessibleState SINGLE_LINE(Code)
Indicates this (text) object can contain only a single line of text


TRANSIENT
final public static AccessibleState TRANSIENT(Code)
Indicates this object is transient. An assistive technology should not add a PropertyChange listener to an object with transient state, as that object will never generate any events. Transient objects are typically created to answer Java Accessibility method queries, but otherwise do not remain linked to the underlying object (for example, those objects underneath lists, tables, and trees in Swing, where only one actual UI Component does shared rendering duty for all of the data objects underneath the actual list/table/tree elements).
since:
   1.5


TRUNCATED
final public static AccessibleState TRUNCATED(Code)
A state indicating that text is truncated by a bounding rectangle and that some of the text is not displayed on the screen. An example is text in a spreadsheet cell that is truncated by the bounds of the cell.
since:
   1.5


VERTICAL
final public static AccessibleState VERTICAL(Code)
Indicates the orientation of this object is vertical. This is usually associated with objects such as scrollbars, sliders, and progress bars.
See Also:   AccessibleState.VERTICAL
See Also:   AccessibleRole.SCROLL_BAR
See Also:   AccessibleRole.SLIDER
See Also:   AccessibleRole.PROGRESS_BAR


VISIBLE
final public static AccessibleState VISIBLE(Code)
Indicates this object is visible. Note: this means that the object intends to be visible; however, it may not in fact be showing on the screen because one of the objects that this object is contained by is not visible.
See Also:   AccessibleState.SHOWING



Constructor Detail
AccessibleState
protected AccessibleState(String key)(Code)
Creates a new AccessibleState using the given locale independent key. This should not be a public method. Instead, it is used to create the constants in this file to make it a strongly typed enumeration. Subclasses of this class should enforce similar policy.

The key String should be a locale independent key for the state. It is not intended to be used as the actual String to display to the user. To get the localized string, use toDisplayString.
Parameters:
  key - the locale independent name of the state.
See Also:   AccessibleBundle.toDisplayString




Fields inherited from javax.accessibility.AccessibleBundle
protected String key(Code)(Java Doc)

Methods inherited from javax.accessibility.AccessibleBundle
protected String toDisplayString(String resourceBundleName, Locale locale)(Code)(Java Doc)
public String toDisplayString(Locale locale)(Code)(Java Doc)
public String toDisplayString()(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.