Home » openjdk-7 » javax » accessibility » [javadoc | source]
javax.accessibility
public interface: AccessibleText [javadoc | source]

All Known Implementing Classes:
    JEditorPaneAccessibleHypertextSupport, AccessibleProgressMonitor, AccessibleEditableText, AccessibleJTextComponent, AccessibleJSpinner, AccessibleJLabel, AccessibleAWTTextComponent, AccessibleAbstractButton, TextAccessibleContext, AccessibleHypertext

The AccessibleText interface should be implemented by all classes that present textual information on the display. This interface provides the standard mechanism for an assistive technology to access that text via its content, attributes, and spatial location. Applications can determine if an object supports the AccessibleText interface by first obtaining its AccessibleContext (see Accessible ) and then calling the AccessibleContext#getAccessibleText method of AccessibleContext. If the return value is not null, the object supports this interface.

Field Summary
public static final  int CHARACTER    Constant used to indicate that the part of the text that should be retrieved is a character. 
public static final  int WORD    Constant used to indicate that the part of the text that should be retrieved is a word. 
public static final  int SENTENCE    Constant used to indicate that the part of the text that should be retrieved is a sentence. A sentence is a string of words which expresses an assertion, a question, a command, a wish, an exclamation, or the performance of an action. In English locales, the string usually begins with a capital letter and concludes with appropriate end punctuation; such as a period, question or exclamation mark. Other locales may use different capitalization and/or punctuation. 
Method from javax.accessibility.AccessibleText Summary:
getAfterIndex,   getAtIndex,   getBeforeIndex,   getCaretPosition,   getCharCount,   getCharacterAttribute,   getCharacterBounds,   getIndexAtPoint,   getSelectedText,   getSelectionEnd,   getSelectionStart
Method from javax.accessibility.AccessibleText Detail:
 public String getAfterIndex(int part,
    int index)
    Returns the String after a given index.
 public String getAtIndex(int part,
    int index)
    Returns the String at a given index.
 public String getBeforeIndex(int part,
    int index)
    Returns the String before a given index.
 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).
 public int getCharCount()
    Returns the number of characters (valid indicies)
 public AttributeSet getCharacterAttribute(int i)
    Returns the AttributeSet for a given character at a given index
 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.
 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.
 public String getSelectedText()
    Returns the 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.
 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.