Class ProgressMonitor.AccessibleProgressMonitor

java.lang.Object

javax.accessibility.AccessibleContext

javax.swing.ProgressMonitor.AccessibleProgressMonitor

All Implemented Interfaces:: PropertyChangeListener, EventListener, AccessibleText, ChangeListener

Enclosing class:: ProgressMonitor

protected class ProgressMonitor.AccessibleProgressMonitor extends AccessibleContext implements AccessibleText, ChangeListener, PropertyChangeListener

AccessibleProgressMonitor implements accessibility support for the ProgressMonitor class.

Since:: 1.5

Field Summary

Fields declared in class AccessibleContext

ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_COMPONENT_BOUNDS_CHANGED, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_INVALIDATE_CHILDREN, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent

Modifier and Type	Field	Description
`static final String`	`ACCESSIBLE_ACTION_PROPERTY`	Constant used to indicate that the supported set of actions has changed.
`static final String`	`ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY`	Constant used to determine when the active descendant of a component has changed.
`static final String`	`ACCESSIBLE_CARET_PROPERTY`	Constant used to determine when the `accessibleText` caret has changed.
`static final String`	`ACCESSIBLE_CHILD_PROPERTY`	Constant used to determine when `Accessible` children are added/removed from the object.
`static final String`	`ACCESSIBLE_COMPONENT_BOUNDS_CHANGED`	`PropertyChangeEvent` which indicates that a change has occurred in a component's bounds.
`static final String`	`ACCESSIBLE_DESCRIPTION_PROPERTY`	Constant used to determine when the `AccessibleContext.accessibleDescription` property has changed.
`static final String`	`ACCESSIBLE_HYPERTEXT_OFFSET`	Constant used to indicate that a hypertext element has received focus.
`static final String`	`ACCESSIBLE_INVALIDATE_CHILDREN`	`PropertyChangeEvent` which indicates that a significant change has occurred to the children of a component like a tree or text.
`static final String`	`ACCESSIBLE_NAME_PROPERTY`	Constant used to determine when the `AccessibleContext.accessibleName` property has changed.
`static final String`	`ACCESSIBLE_SELECTION_PROPERTY`	Constant used to determine when the `accessibleSelection` has changed.
`static final String`	`ACCESSIBLE_STATE_PROPERTY`	Constant used to determine when the `accessibleStateSet` property has changed.
`static final String`	`ACCESSIBLE_TABLE_CAPTION_CHANGED`	Constant used to indicate that the table caption has changed.
`static final String`	`ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED`	Constant used to indicate that the column description has changed.
`static final String`	`ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED`	Constant used to indicate that the column header has changed.
`static final String`	`ACCESSIBLE_TABLE_MODEL_CHANGED`	Constant used to indicate that table data has changed.
`static final String`	`ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED`	Constant used to indicate that the row description has changed.
`static final String`	`ACCESSIBLE_TABLE_ROW_HEADER_CHANGED`	Constant used to indicate that the row header has changed.
`static final String`	`ACCESSIBLE_TABLE_SUMMARY_CHANGED`	Constant used to indicate that the table summary has changed.
`static final String`	`ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED`	`PropertyChangeEvent` which indicates that text attributes have changed.
`static final String`	`ACCESSIBLE_TEXT_PROPERTY`	`PropertyChangeEvent` which indicates that text has changed.
`static final String`	`ACCESSIBLE_VALUE_PROPERTY`	Constant used to determine when the `accessibleValue` property has changed.
`static final String`	`ACCESSIBLE_VISIBLE_DATA_PROPERTY`	Constant used to determine when the visual appearance of the object has changed.
`protected String`	`accessibleDescription`	A localized String containing the description of the object.
`protected String`	`accessibleName`	A localized String containing the name of the object.
`protected Accessible`	`accessibleParent`	The accessible parent of this object.

Fields declared in interface AccessibleText

CHARACTER, SENTENCE, WORD

Modifier and Type	Field	Description
`static final int`	`CHARACTER`	Constant used to indicate that the part of the text that should be retrieved is a character.
`static final int`	`SENTENCE`	Constant used to indicate that the part of the text that should be retrieved is a sentence.
`static final int`	`WORD`	Constant used to indicate that the part of the text that should be retrieved is a word.

Constructor Summary

AccessibleProgressMonitor()

Modifier	Constructor	Description
`protected`	AccessibleProgressMonitor constructor

Method Summary

Modifier and Type	Method	Description
`Accessible`	`getAccessibleChild(int i)`	Returns the specified Accessible child of the object.
`int`	`getAccessibleChildrenCount()`	Returns the number of accessible children of the object.
`AccessibleComponent`	`getAccessibleComponent()`	Gets the AccessibleComponent associated with this object that has a graphical representation.
`String`	`getAccessibleDescription()`	Gets the accessibleDescription property of this object.
`int`	`getAccessibleIndexInParent()`	Gets the 0-based index of this object in its accessible parent.
`String`	`getAccessibleName()`	Gets the accessibleName property of this object.
`Accessible`	`getAccessibleParent()`	Gets the Accessible parent of this object.
`AccessibleRole`	`getAccessibleRole()`	Gets the role of this object.
`AccessibleStateSet`	`getAccessibleStateSet()`	Gets the state set of this object.
`AccessibleText`	`getAccessibleText()`	Gets the AccessibleText associated with this object presenting text on the display.
`AccessibleValue`	`getAccessibleValue()`	Gets the AccessibleValue associated with this object that supports a Numerical value.
`String`	`getAfterIndex(int part, int index)`	Returns the String after a given index.
`String`	`getAtIndex(int part, int index)`	Returns the String at a given index.
`String`	`getBeforeIndex(int part, int index)`	Returns the String before a given index.
`int`	`getCaretPosition()`	Returns the zero-based offset of the caret.
`AttributeSet`	`getCharacterAttribute(int i)`	Returns the AttributeSet for a given character at a given index
`Rectangle`	`getCharacterBounds(int i)`	Determines the bounding box of the character at the given index into the string.
`int`	`getCharCount()`	Returns the number of characters (valid indices)
`int`	`getIndexAtPoint(Point p)`	Given a point in local coordinates, return the zero-based index of the character under that Point.
`Locale`	`getLocale()`	Gets the locale of the component.
`String`	`getSelectedText()`	Returns the portion of the text that is selected.
`int`	`getSelectionEnd()`	Returns the end offset within the selected text.
`int`	`getSelectionStart()`	Returns the start offset within the selected text.
`void`	`propertyChange(PropertyChangeEvent e)`	This method gets called when a bound property is changed.
`void`	`stateChanged(ChangeEvent e)`	Invoked when the target of the listener has changed its state.

Methods declared in class AccessibleContext

addPropertyChangeListener, firePropertyChange, getAccessibleAction, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, removePropertyChangeListener, setAccessibleDescription, setAccessibleName, setAccessibleParent

Modifier and Type	Method	Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)`	Adds a `PropertyChangeListener` to the listener list.
`void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)`	Support for reporting bound property changes.
`AccessibleAction`	`getAccessibleAction()`	Gets the `AccessibleAction` associated with this object that supports one or more actions.
`AccessibleEditableText`	`getAccessibleEditableText()`	Gets the `AccessibleEditableText` associated with this object presenting editable text on the display.
`AccessibleIcon[]`	`getAccessibleIcon()`	Gets the `AccessibleIcons` associated with an object that has one or more associated icons.
`AccessibleRelationSet`	`getAccessibleRelationSet()`	Gets the `AccessibleRelationSet` associated with an object.
`AccessibleSelection`	`getAccessibleSelection()`	Gets the `AccessibleSelection` associated with this object which allows its `Accessible` children to be selected.
`AccessibleTable`	`getAccessibleTable()`	Gets the `AccessibleTable` associated with an object.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)`	Removes a `PropertyChangeListener` from the listener list.
`void`	`setAccessibleDescription(String s)`	Sets the accessible description of this object.
`void`	`setAccessibleName(String s)`	Sets the localized accessible name of this object.
`void`	`setAccessibleParent(Accessible a)`	Sets the `Accessible` parent of this object.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

AccessibleProgressMonitor

protected AccessibleProgressMonitor()

AccessibleProgressMonitor constructor

Method Details

stateChanged

public void stateChanged(ChangeEvent e)

Invoked when the target of the listener has changed its state.

Specified by:: stateChanged in interface ChangeListener
Parameters:: e - a ChangeEvent object. Must not be null.
Throws:: NullPointerException - if the parameter is null.

propertyChange

public void propertyChange(PropertyChangeEvent e)

This method gets called when a bound property is changed.

Specified by:: propertyChange in interface PropertyChangeListener
Parameters:: e - A PropertyChangeEvent object describing the event source and the property that has changed. Must not be null.
Throws:: NullPointerException - if the parameter is null.

getAccessibleName

public String getAccessibleName()

Gets the accessibleName property of this object. The accessibleName property of an object is a localized String that designates the purpose of the object. For example, the accessibleName property of a label or button might be the text of the label or button itself. In the case of an object that doesn't display its name, the accessibleName should still be set. For example, in the case of a text field used to enter the name of a city, the accessibleName for the en_US locale could be 'city.'

Overrides:

getAccessibleName in class AccessibleContext

Returns:

the localized name of the object; null if this object does not have a name

See Also:

getAccessibleDescription

public String getAccessibleDescription()

Gets the accessibleDescription property of this object. The accessibleDescription property of this object is a short localized phrase describing the purpose of the object. For example, in the case of a 'Cancel' button, the accessibleDescription could be 'Ignore changes and close dialog box.'

Overrides:

getAccessibleDescription in class AccessibleContext

Returns:

the localized description of the object; null if this object does not have a description

See Also:

getAccessibleRole

public AccessibleRole getAccessibleRole()

Gets the role of this object. The role of the object is the generic purpose or use of the class of this object. For example, the role of a push button is AccessibleRole.PUSH_BUTTON. The roles in AccessibleRole are provided so component developers can pick from a set of predefined roles. This enables assistive technologies to provide a consistent interface to various tweaked subclasses of components (e.g., use AccessibleRole.PUSH_BUTTON for all components that act like a push button) as well as distinguish between subclasses that behave differently (e.g., AccessibleRole.CHECK_BOX for check boxes and AccessibleRole.RADIO_BUTTON for radio buttons).

Note that the AccessibleRole class is also extensible, so custom component developers can define their own AccessibleRole's if the set of predefined roles is inadequate.

Specified by:

getAccessibleRole in class AccessibleContext

Returns:

an instance of AccessibleRole describing the role of the object

See Also:

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()

Gets the state set of this object. The AccessibleStateSet of an object is composed of a set of unique AccessibleStates. A change in the AccessibleStateSet of an object will cause a PropertyChangeEvent to be fired for the ACCESSIBLE_STATE_PROPERTY property.

Specified by:

getAccessibleStateSet in class AccessibleContext

Returns:

an instance of AccessibleStateSet containing the current state set of the object

See Also:

getAccessibleParent

public Accessible getAccessibleParent()

Gets the Accessible parent of this object.

Overrides:: getAccessibleParent in class AccessibleContext
Returns:: the Accessible parent of this object; null if this object does not have an Accessible parent

getAccessibleIndexInParent

public int getAccessibleIndexInParent()

Gets the 0-based index of this object in its accessible parent.

Specified by:

getAccessibleIndexInParent in class AccessibleContext

Returns:

the 0-based index of this object in its parent; -1 if this object does not have an accessible parent.

See Also:

getAccessibleChildrenCount

public int getAccessibleChildrenCount()

Returns the number of accessible children of the object.

Specified by:: getAccessibleChildrenCount in class AccessibleContext
Returns:: the number of accessible children of the object.

getAccessibleChild

public Accessible getAccessibleChild(int i)

Returns the specified Accessible child of the object. The Accessible children of an Accessible object are zero-based, so the first child of an Accessible child is at index 0, the second child is at index 1, and so on.

Specified by:

getAccessibleChild in class AccessibleContext

Parameters:

i - zero-based index of child

Returns:

the Accessible child of the object

See Also:

getLocale

public Locale getLocale() throws IllegalComponentStateException

Gets the locale of the component. If the component does not have a locale, then the locale of its parent is returned.

Specified by:: getLocale in class AccessibleContext
Returns:: this component's locale. If this component does not have a locale, the locale of its parent is returned.
Throws:: IllegalComponentStateException - If the Component does not have its own locale and has not yet been added to a containment hierarchy such that the locale can be determined from the containing parent.

getAccessibleComponent

public AccessibleComponent getAccessibleComponent()

Gets the AccessibleComponent associated with this object that has a graphical representation.

Overrides:

getAccessibleComponent in class AccessibleContext

Returns:

AccessibleComponent if supported by object; else return null

See Also:

getAccessibleValue

public AccessibleValue getAccessibleValue()

Gets the AccessibleValue associated with this object that supports a Numerical value.

Overrides:

getAccessibleValue in class AccessibleContext

Returns:

AccessibleValue if supported by object; else return null

See Also:

getAccessibleText

public AccessibleText getAccessibleText()

Gets the AccessibleText associated with this object presenting text on the display.

Overrides:

getAccessibleText in class AccessibleContext

Returns:

AccessibleText if supported by object; else return null

See Also:

getIndexAtPoint

public int getIndexAtPoint(Point p)

Given a point in local coordinates, return the zero-based index of the character under that Point. If the point is invalid, this method returns -1.

Specified by:: getIndexAtPoint in interface AccessibleText
Parameters:: p - the Point in local coordinates
Returns:: the zero-based index of the character under Point p; if Point is invalid return -1.

getCharacterBounds

public Rectangle getCharacterBounds(int i)

Determines the bounding box of the character at the given index into the string. The bounds are returned in local coordinates. If the index is invalid an empty rectangle is returned.

Specified by:: getCharacterBounds in interface AccessibleText
Parameters:: i - the index into the String
Returns:: the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle.

getCharCount

public int getCharCount()

Returns the number of characters (valid indices)

Specified by:: getCharCount in interface AccessibleText
Returns:: the number of characters

getCaretPosition

public int getCaretPosition()

Returns the zero-based offset of the caret. Note: That to the right of the caret will have the same index value as the offset (the caret is between two characters).

Specified by:: getCaretPosition in interface AccessibleText
Returns:: the zero-based offset of the caret.

getAtIndex

public String getAtIndex(int part, int index)

Returns the String at a given index.

Specified by:: getAtIndex in interface AccessibleText
Parameters:: part - the CHARACTER, WORD, or SENTENCE to retrieve; index - an index within the text
Returns:: the letter, word, or sentence

getAfterIndex

public String getAfterIndex(int part, int index)

Returns the String after a given index.

Specified by:: getAfterIndex in interface AccessibleText
Parameters:: part - the CHARACTER, WORD, or SENTENCE to retrieve; index - an index within the text
Returns:: the letter, word, or sentence

getBeforeIndex

public String getBeforeIndex(int part, int index)

Returns the String before a given index.

Specified by:: getBeforeIndex in interface AccessibleText
Parameters:: part - the CHARACTER, WORD, or SENTENCE to retrieve; index - an index within the text
Returns:: the letter, word, or sentence

getCharacterAttribute

public AttributeSet getCharacterAttribute(int i)

Returns the AttributeSet for a given character at a given index

Specified by:: getCharacterAttribute in interface AccessibleText
Parameters:: i - the zero-based index into the text
Returns:: the AttributeSet of the character

getSelectionStart

public int getSelectionStart()

Returns the start offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.

Specified by:: getSelectionStart in interface AccessibleText
Returns:: the index into the text of the start of the selection

getSelectionEnd

public int getSelectionEnd()

Returns the end offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.

Specified by:: getSelectionEnd in interface AccessibleText
Returns:: the index into the text of the end of the selection

getSelectedText

public String getSelectedText()

Returns the portion of the text that is selected.

Specified by:: getSelectedText in interface AccessibleText
Returns:: the String portion of the text that is selected

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.