javax.swing.text.html

Class AccessibleHTML.TextElementInfo.TextAccessibleContext

Enclosing Class:
javax.swing.text.html.AccessibleHTML.TextElementInfo
Implemented Interfaces:
Accessible, AccessibleComponent, AccessibleText

public class AccessibleHTML.TextElementInfo.TextAccessibleContext
extends AccessibleHTML.HTMLAccessibleContext
implements AccessibleText

Field Summary

Fields inherited from class javax.swing.text.html.AccessibleHTML.HTMLAccessibleContext

elementInfo

Fields inherited from class javax.accessibility.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

Fields inherited from interface javax.accessibility.AccessibleText

CHARACTER, SENTENCE, WORD

Constructor Summary

TextAccessibleContext(javax.swing.text.html.AccessibleHTML.ElementInfo elementInfo)

Method Summary

String
getAccessibleDescription()
Gets the accessibleDescription property of this object.
String
getAccessibleName()
Gets the accessibleName property of this object.
AccessibleRole
getAccessibleRole()
Gets the role of this object.
AccessibleText
getAccessibleText()
Gets the AccessibleText associated with this object presenting text on the display.
String
getAfterIndex(int part, int index)
String
getAtIndex(int part, int index)
String
getBeforeIndex(int part, int index)
int
getCaretPosition()
Return the zero-based offset of the caret.
int
getCharCount()
Return the number of characters (valid indicies)
AttributeSet
getCharacterAttribute(int i)
Return the AttributeSet for a given character at a given index
Rectangle
getCharacterBounds(int i)
Determine 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.
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.

Methods inherited from class javax.swing.text.html.AccessibleHTML.HTMLAccessibleContext

addFocusListener, contains, getAccessibleAt, getAccessibleChild, getAccessibleChildrenCount, getAccessibleComponent, getAccessibleContext, getAccessibleIndexInParent, getAccessibleStateSet, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible

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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TextAccessibleContext

public TextAccessibleContext(javax.swing.text.html.AccessibleHTML.ElementInfo elementInfo)

Method Details

getAccessibleDescription

public String getAccessibleDescription()
Gets the accessibleDescription property of this object. If this property isn't set, returns the content type of this JEditorPane instead (e.g. "plain/text", "html/text").
Overrides:
getAccessibleDescription in interface AccessibleContext
Returns:
the localized description of the object; null if this object does not have a description
See Also:
AccessibleHTML.TextElementInfo.TextAccessibleContext

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 interface AccessibleContext
Returns:
the localized name of the object; null if this object does not have a name
See Also:
AccessibleHTML.TextElementInfo.TextAccessibleContext

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 interface AccessibleContext
Returns:
an instance of AccessibleRole describing the role of the object

getAccessibleText

public AccessibleText getAccessibleText()
Gets the AccessibleText associated with this object presenting text on the display.
Overrides:
getAccessibleText in interface AccessibleContext
Returns:
AccessibleText if supported by object; else return null

getAfterIndex

public String getAfterIndex(int part,
                            int index)
Specified by:
getAfterIndex in interface AccessibleText

getAtIndex

public String getAtIndex(int part,
                         int index)
Specified by:
getAtIndex in interface AccessibleText

getBeforeIndex

public String getBeforeIndex(int part,
                             int index)
Specified by:
getBeforeIndex in interface AccessibleText

getCaretPosition

public int getCaretPosition()
Return 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.

getCharCount

public int getCharCount()
Return the number of characters (valid indicies)
Specified by:
getCharCount in interface AccessibleText
Returns:
the number of characters

getCharacterAttribute

public AttributeSet getCharacterAttribute(int i)
Return 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

getCharacterBounds

public Rectangle getCharacterBounds(int i)
Determine 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 the bounding box, if index is invalid returns an empty rectangle.

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

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

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 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.
Specified by:
getSelectionStart in interface AccessibleText
Returns:
the index into the text of the start of the selection