ProgressMonitor.AccessibleProgressMonitor (Java 2 Platform SE 5.0) (original) (raw)

javax.swing

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

ProgressMonitor.AccessibleProgressMonitor

protected ProgressMonitor.AccessibleProgressMonitor()

AccessibleProgressMonitor constructor

stateChanged

public void stateChanged(ChangeEvent e)

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

Specified by:

[stateChanged](../../javax/swing/event/ChangeListener.html#stateChanged%28javax.swing.event.ChangeEvent%29) in interface [ChangeListener](../../javax/swing/event/ChangeListener.html "interface in javax.swing.event")

Parameters:

e - a ChangeEvent object. Must not be null.

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if the parameter is null.

propertyChange

public void propertyChange(PropertyChangeEvent e)

This method gets called when a bound property is changed.

Specified by:

[propertyChange](../../java/beans/PropertyChangeListener.html#propertyChange%28java.beans.PropertyChangeEvent%29) in interface [PropertyChangeListener](../../java/beans/PropertyChangeListener.html "interface in java.beans")

Parameters:

e - A PropertyChangeEvent object describing the event source and the property that has changed. Must not be null.

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - 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](../../javax/accessibility/AccessibleContext.html#getAccessibleName%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

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

See Also:

AccessibleContext.setAccessibleName(java.lang.String)

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](../../javax/accessibility/AccessibleContext.html#getAccessibleDescription%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

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

See Also:

AccessibleContext.setAccessibleDescription(java.lang.String)

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

Specified by:

[getAccessibleRole](../../javax/accessibility/AccessibleContext.html#getAccessibleRole%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

an instance of AccessibleRole describing the role of the object

See Also:

AccessibleRole

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](../../javax/accessibility/AccessibleContext.html#getAccessibleStateSet%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

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

See Also:

AccessibleStateSet, AccessibleState, AccessibleContext.addPropertyChangeListener(java.beans.PropertyChangeListener)

getAccessibleParent

public Accessible getAccessibleParent()

Gets the Accessible parent of this object.

Overrides:

[getAccessibleParent](../../javax/accessibility/AccessibleContext.html#getAccessibleParent%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

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](../../javax/accessibility/AccessibleContext.html#getAccessibleIndexInParent%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

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

See Also:

getAccessibleParent(), getAccessibleChildrenCount(), getAccessibleChild(int)

getAccessibleChildrenCount

public int getAccessibleChildrenCount()

Returns the number of accessible children of the object.

Specified by:

[getAccessibleChildrenCount](../../javax/accessibility/AccessibleContext.html#getAccessibleChildrenCount%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

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](../../javax/accessibility/AccessibleContext.html#getAccessibleChild%28int%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Parameters:

i - zero-based index of child

Returns:

the Accessible child of the object

See Also:

getAccessibleChildrenCount()

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](../../javax/accessibility/AccessibleContext.html#getLocale%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

this component's locale. If this component does not have a locale, the locale of its parent is returned.

Throws:

[IllegalComponentStateException](../../java/awt/IllegalComponentStateException.html "class in java.awt") - 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](../../javax/accessibility/AccessibleContext.html#getAccessibleComponent%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

AccessibleComponent if supported by object; else return null

See Also:

AccessibleComponent

getAccessibleValue

public AccessibleValue getAccessibleValue()

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

Overrides:

[getAccessibleValue](../../javax/accessibility/AccessibleContext.html#getAccessibleValue%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

AccessibleValue if supported by object; else return null

See Also:

AccessibleValue

getAccessibleText

public AccessibleText getAccessibleText()

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

Overrides:

[getAccessibleText](../../javax/accessibility/AccessibleContext.html#getAccessibleText%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

AccessibleText if supported by object; else return null

See Also:

AccessibleText

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](../../javax/accessibility/AccessibleText.html#getIndexAtPoint%28java.awt.Point%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleText.html#getCharacterBounds%28int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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

Specified by:

[getCharCount](../../javax/accessibility/AccessibleText.html#getCharCount%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleText.html#getCaretPosition%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleText.html#getAtIndex%28int, int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleText.html#getAfterIndex%28int, int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleText.html#getBeforeIndex%28int, int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleText.html#getCharacterAttribute%28int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleText.html#getSelectionStart%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleText.html#getSelectionEnd%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

Returns:

the index into teh text of the end of the selection

getSelectedText

public String getSelectedText()

Returns the portion of the text that is selected.

Specified by:

[getSelectedText](../../javax/accessibility/AccessibleText.html#getSelectedText%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

Returns:

the String portion of the text that is selected

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.