This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.swing
class ProgressMonitor.AccessibleProgressMonitor
- All Implemented Interfaces:
- PropertyChangeListener, AccessibleText, ChangeListener
- Enclosing class:
- ProgressMonitor
protected class ProgressMonitor.AccessibleProgressMonitor
extends AccessibleContext
implements AccessibleText, ChangeListener, PropertyChangeListener
AccessibleProgressMonitor
implements accessibility
support for the ProgressMonitor
class.
Fields inherited from class javax.accessibility.AccessibleContext |
accessibleDescription, accessibleName, accessibleParent, 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 |
Constructor Summary |
protected |
AccessibleProgressMonitor constructor
|
Method Summary |
Accessible |
Returns the specified Accessible child of the object.
|
int |
Returns the number of accessible children of the object.
|
AccessibleComponent |
Gets the AccessibleComponent associated with this object that has a
graphical representation.
|
String |
Gets the accessibleDescription property of this object.
|
int |
Gets the 0-based index of this object in its accessible parent.
|
String |
Gets the accessibleName property of this object.
|
Accessible |
Gets the Accessible parent of this object.
|
AccessibleRole |
Gets the role of this object.
|
AccessibleStateSet |
Gets the state set of this object.
|
AccessibleText |
Gets the AccessibleText associated with this object presenting
text on the display.
|
AccessibleValue |
Gets the AccessibleValue associated with this object that supports a
Numerical value.
|
String |
Returns the String after a given index.
|
String |
Returns the String at a given index.
|
String |
Returns the String before a given index.
|
int |
Returns the zero-based offset of the caret.
|
AttributeSet |
Returns the AttributeSet for a given character at a given index
|
Rectangle |
Determines the bounding box of the character at the given
index into the string.
|
int |
Returns the number of characters (valid indicies)
|
int |
Given a point in local coordinates, return the zero-based index
of the character under that Point.
|
Locale |
Gets the locale of the component.
|
String |
Returns the portion of the text that is selected.
|
int |
Returns the end offset within the selected text.
|
int |
Returns the start offset within the selected text.
|
void |
This method gets called when a bound property is changed.
|
void |
Invoked when the target of the listener has changed its state.
|
Methods inherited from class javax.accessibility.AccessibleContext |
addPropertyChangeListener, firePropertyChange, getAccessibleAction, getAccessibleChild, getAccessibleChildrenCount, getAccessibleComponent, getAccessibleDescription, getAccessibleEditableText, getAccessibleIcon, getAccessibleIndexInParent, getAccessibleName, getAccessibleParent, getAccessibleRelationSet, getAccessibleRole, getAccessibleSelection, getAccessibleStateSet, getAccessibleTable, getAccessibleText, getAccessibleValue, getLocale, removePropertyChangeListener, setAccessibleDescription, setAccessibleName, setAccessibleParent |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ProgressMonitor.AccessibleProgressMonitor
protected ProgressMonitor.AccessibleProgressMonitor()
-
AccessibleProgressMonitor constructor
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.
- Overrides:
getAccessibleChild
in class AccessibleContext
- Parameters:
i
- zero-based index of child
- Returns:
- the Accessible child of the object
getAccessibleChildrenCount
public int getAccessibleChildrenCount()
-
Returns the number of accessible children of the object.
- Overrides:
getAccessibleChildrenCount
in class AccessibleContext
- Returns:
- the number of accessible children of the object.
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
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
getAccessibleIndexInParent
public int getAccessibleIndexInParent()
-
Gets the 0-based index of this object in its accessible parent.
- Overrides:
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.
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
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
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.
- Overrides:
getAccessibleRole
in class AccessibleContext
- Returns:
- an instance of AccessibleRole describing the role of the object
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.
- Overrides:
getAccessibleStateSet
in class AccessibleContext
- Returns:
- an instance of AccessibleStateSet containing the
current state set of the object
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
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
getAfterIndex
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
getAtIndex
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
getBeforeIndex
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
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).
- Returns:
- the zero-based offset of the caret.
getCharacterAttribute
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
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.
- 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)
- Returns:
- the number of characters
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.
- Parameters:
p
- the Point in local coordinates
- Returns:
- the zero-based index of the character under Point p; if
Point is invalid return -1.
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.
- Overrides:
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.
getSelectedText
public String getSelectedText()
-
Returns the portion of the text that is selected.
- Returns:
- the String portion of the text that is selected
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.
- Returns:
- the index into teh text of the end of the selection
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.
- Returns:
- the index into the text of the start of the selection
propertyChange
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.
stateChanged
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.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.