| Properties |
| public Accessible |
getAccessibleChild(int i) Details
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.
|
| public int |
getAccessibleChildrenCount() Details
Returns the number of accessible children of the object.
| return | the number of accessible children of the object. |
|
| public AccessibleComponent |
getAccessibleComponent() Details
Gets the AccessibleComponent associated with this object that has a
graphical representation.
|
| public String |
getAccessibleDescription() Details
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.'
| return | the localized description of the object; null if
this object does not have a description |
| See also | setAccessibleDescription |
|
| public int |
getAccessibleIndexInParent() Details
Gets the 0-based index of this object in its accessible parent.
|
| public String |
getAccessibleName() Details
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.'
| return | the localized name of the object; null if this
object does not have a name |
| See also | setAccessibleName |
|
| public Accessible |
getAccessibleParent() Details
Gets the Accessible parent of this object.
| return | the Accessible parent of this object; null if this
object does not have an Accessible parent |
|
| public AccessibleRole |
getAccessibleRole() Details
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.
|
| public AccessibleStateSet |
getAccessibleStateSet() Details
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.
|
| public AccessibleText |
getAccessibleText() Details
Gets the AccessibleText associated with this object presenting
text on the display.
|
| public AccessibleValue |
getAccessibleValue() Details
Gets the AccessibleValue associated with this object that supports a
Numerical value.
|
| public String |
getAfterIndex(int part, int index) Details
Returns the String after a given index.
| part | the CHARACTER, WORD, or SENTENCE to retrieve |
| index | an index within the text |
| return | the letter, word, or sentence |
|
| public String |
getAtIndex(int part, int index) Details
Returns the String at a given index.
| part | the CHARACTER, WORD, or SENTENCE to retrieve |
| index | an index within the text |
| return | the letter, word, or sentence |
|
| public String |
getBeforeIndex(int part, int index) Details
Returns the String before a given index.
| part | the CHARACTER, WORD, or SENTENCE to retrieve |
| index | an index within the text |
| return | the letter, word, or sentence |
|
| public int |
getCaretPosition() Details
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).
| return | the zero-based offset of the caret. |
|
| public AttributeSet |
getCharacterAttribute(int i) Details
Returns the AttributeSet for a given character at a given index
| i | the zero-based index into the text |
| return | the AttributeSet of the character |
|
| public Rectangle |
getCharacterBounds(int i) Details
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.
| i | the index into the String |
| return | the screen coordinates of the character's bounding box,
if index is invalid return an empty rectangle. |
|
| public int |
getCharCount() Details
Returns the number of characters (valid indicies)
| return | the number of characters |
|
| public int |
getIndexAtPoint(Point p) Details
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.
| p | the Point in local coordinates |
| return | the zero-based index of the character under Point p; if
Point is invalid return -1. |
|
| public Locale |
getLocale() throws IllegalComponentStateException Details
Gets the locale of the component. If the component does not have a
locale, then the locale of its parent is returned.
| return | 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() Details
Returns the portion of the text that is selected.
| return | the String portion of the text that is selected |
|
| public int |
getSelectionEnd() Details
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.
| return | the index into teh text of the end of the selection |
|
| public int |
getSelectionStart() Details
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.
| return | the index into the text of the start of the selection |
|