protected class

ProgressMonitor.AccessibleProgressMonitor

extends AccessibleContext
implements PropertyChangeListener AccessibleText ChangeListener
java.lang.Object
   ↳ javax.accessibility.AccessibleContext
     ↳ javax.swing.ProgressMonitor.AccessibleProgressMonitor

Class Overview

AccessibleProgressMonitor implements accessibility support for the ProgressMonitor class.

Summary

[Expand]
Inherited Constants
From class javax.accessibility.AccessibleContext
From interface javax.accessibility.AccessibleText
[Expand]
Inherited Fields
From class javax.accessibility.AccessibleContext
Protected Constructors
ProgressMonitor.AccessibleProgressMonitor()
AccessibleProgressMonitor constructor
Public Methods
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.
int getCharCount()
Returns the number of characters (valid indicies)
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 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.
[Expand]
Inherited Methods
From class javax.accessibility.AccessibleContext
From class java.lang.Object
From interface java.beans.PropertyChangeListener
From interface javax.accessibility.AccessibleText
From interface javax.swing.event.ChangeListener

Protected Constructors

protected ProgressMonitor.AccessibleProgressMonitor ()

AccessibleProgressMonitor constructor

Public Methods

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.

Parameters
i zero-based index of child
Returns
  • the Accessible child of the object
See Also

public int getAccessibleChildrenCount ()

Returns the number of accessible children of the object.

Returns
  • the number of accessible children of the object.

public AccessibleComponent getAccessibleComponent ()

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

Returns
  • AccessibleComponent if supported by object; else return null
See Also

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.'

Returns
  • the localized description of the object; null if this object does not have a description
See Also

public int getAccessibleIndexInParent ()

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

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

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.'

Returns
  • the localized name of the object; null if this object does not have a name
See Also

public Accessible getAccessibleParent ()

Gets the Accessible parent of this object.

Returns
  • the Accessible parent of this object; null if this object does not have an Accessible parent

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 sublasses 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.

Returns
  • an instance of AccessibleRole describing the role of the object
See Also

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.

Returns
  • an instance of AccessibleStateSet containing the current state set of the object
See Also

public AccessibleText getAccessibleText ()

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

Returns
  • AccessibleText if supported by object; else return null
See Also

public AccessibleValue getAccessibleValue ()

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

Returns
  • AccessibleValue if supported by object; else return null
See Also

public String getAfterIndex (int part, int index)

Returns the String after a given index.

Parameters
part the CHARACTER, WORD, or SENTENCE to retrieve
index an index within the text
Returns
  • the letter, word, or sentence

public String getAtIndex (int part, int index)

Returns the String at a given index.

Parameters
part the CHARACTER, WORD, or SENTENCE to retrieve
index an index within the text
Returns
  • the letter, word, or sentence

public String getBeforeIndex (int part, int index)

Returns the String before a given index.

Parameters
part the CHARACTER, WORD, or SENTENCE to retrieve
index an index within the text
Returns
  • the letter, word, or sentence

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).

Returns
  • the zero-based offset of the caret.

public int getCharCount ()

Returns the number of characters (valid indicies)

Returns
  • the number of characters

public AttributeSet getCharacterAttribute (int i)

Returns the AttributeSet for a given character at a given index

Parameters
i the zero-based index into the text
Returns
  • the AttributeSet of the character

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.

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.

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.

Parameters
p the Point in local coordinates
Returns
  • the zero-based index of the character under Point p; if Point is invalid return -1.

public Locale getLocale ()

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

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.

public String getSelectedText ()

Returns the portion of the text that is selected.

Returns
  • the String portion of the text that is selected

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.

Returns
  • the index into teh text of the end of the selection

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.

Returns
  • the index into the text of the start of the selection

public void propertyChange (PropertyChangeEvent e)

This method gets called when a bound property is changed.

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.

public void stateChanged (ChangeEvent e)

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

Parameters
e a ChangeEvent object. Must not be null.
Throws
NullPointerException if the parameter is null.