java.awt

Class TextComponent.AccessibleAWTTextComponent

Enclosing Class:
TextComponent
Implemented Interfaces:
AccessibleComponent, AccessibleText, EventListener, Serializable, TextListener
Known Direct Subclasses:
TextArea.AccessibleAWTTextArea, TextField.AccessibleAWTTextField

protected class TextComponent.AccessibleAWTTextComponent
extends Component.AccessibleAWTComponent
implements AccessibleText, TextListener

See Also:
Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Component.AccessibleAWTComponent

Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler

Field Summary

Fields inherited from class java.awt.Component.AccessibleAWTComponent

accessibleAWTComponentHandler, accessibleAWTFocusHandler

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

AccessibleAWTTextComponent()
Default constructor.

Method Summary

AccessibleRole
getAccessibleRole()
Gets the role of this object.
AccessibleStateSet
getAccessibleStateSet()
Gets the state set of this object.
AccessibleText
getAccessibleText()
Get any supported accessible text.
String
getAfterIndex(int part, int index)
Returns the section of text after the index, or null if the index or part is invalid.
String
getAtIndex(int part, int index)
Returns the section of text at the index, or null if the index or part is invalid.
String
getBeforeIndex(int part, int index)
Returns the section of text before the index, or null if the index or part is invalid.
int
getCaretPosition()
Return the offset of the character.
int
getCharCount()
Return the number of characters.
AttributeSet
getCharacterAttribute(int index)
Returns the attributes of a character at an index, or null if the index is out of bounds.
Rectangle
getCharacterBounds(int index)
Determines the bounding box of the indexed character.
int
getIndexAtPoint(Point point)
Given a point in the coordinate system of this object, return the 0-based index of the character at that point, or -1 if there is none.
String
getSelectedText()
Returns the selected text.
int
getSelectionEnd()
Returns the end index of the selection.
int
getSelectionStart()
Returns the start index of the selection.
void
textValueChanged(TextEvent event)

Methods inherited from class java.awt.Component.AccessibleAWTComponent

addFocusListener, addPropertyChangeListener, contains, getAccessibleAt, getAccessibleChild, getAccessibleChildrenCount, getAccessibleComponent, getAccessibleDescription, getAccessibleIndexInParent, getAccessibleName, getAccessibleParent, getAccessibleRole, getAccessibleStateSet, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, removePropertyChangeListener, 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

AccessibleAWTTextComponent

public AccessibleAWTTextComponent()
Default constructor.

Method Details

getAccessibleRole

public AccessibleRole getAccessibleRole()
Gets the role of this object. For example, a button serves the role of AccessibleRole.PUSH_BUTTON. This allows assistive technologies to funnel similar objects into the same assistance classes. Note that the class is extensible, to define new roles if necessary.
Overrides:
getAccessibleRole in interface Component.AccessibleAWTComponent
Returns:
the role of the object

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()
Gets the state set of this object. A change in the state of the object will fire a PropertyChangeEvent for ACCESSIBLE_STATE_PROPERTY.
Overrides:
getAccessibleStateSet in interface Component.AccessibleAWTComponent
Returns:
the current state of the object

getAccessibleText

public AccessibleText getAccessibleText()
Get any supported accessible text. The default implementation returns null.
Overrides:
getAccessibleText in interface AccessibleContext
Returns:
the supported text, or null

getAfterIndex

public String getAfterIndex(int part,
                            int index)
Returns the section of text after the index, or null if the index or part is invalid.
Specified by:
getAfterIndex in interface AccessibleText
Parameters:
part - AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE
index - the 0-based character index
Returns:
the selection of text after that index, or null

getAtIndex

public String getAtIndex(int part,
                         int index)
Returns the section of text at the index, or null if the index or part is invalid.
Specified by:
getAtIndex in interface AccessibleText
Parameters:
part - AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE
index - the 0-based character index
Returns:
the selection of text at that index, or null

getBeforeIndex

public String getBeforeIndex(int part,
                             int index)
Returns the section of text before the index, or null if the index or part is invalid.
Specified by:
getBeforeIndex in interface AccessibleText
Parameters:
part - AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE
index - the 0-based character index
Returns:
the selection of text before that index, or null

getCaretPosition

public int getCaretPosition()
Return the offset of the character. The offset matches the index of the character to the right, since the carat lies between characters.
Specified by:
getCaretPosition in interface AccessibleText
Returns:
the 0-based caret position

getCharCount

public int getCharCount()
Return the number of characters.
Specified by:
getCharCount in interface AccessibleText
Returns:
the character count

getCharacterAttribute

public AttributeSet getCharacterAttribute(int index)
Returns the attributes of a character at an index, or null if the index is out of bounds.
Specified by:
getCharacterAttribute in interface AccessibleText
Parameters:
index - the 0-based character index
Returns:
the character's attributes

getCharacterBounds

public Rectangle getCharacterBounds(int index)
Determines the bounding box of the indexed character. Returns an empty rectangle if the index is out of bounds.
Specified by:
getCharacterBounds in interface AccessibleText
Parameters:
index - the 0-based character index
Returns:
the bounding box, may be empty

getIndexAtPoint

public int getIndexAtPoint(Point point)
Given a point in the coordinate system of this object, return the 0-based index of the character at that point, or -1 if there is none.
Specified by:
getIndexAtPoint in interface AccessibleText
Parameters:
point - the point to look at
Returns:
the character index, or -1

getSelectedText

public String getSelectedText()
Returns the selected text. This may be null or "" if no text is selected.
Specified by:
getSelectedText in interface AccessibleText
Returns:
the selected text

getSelectionEnd

public int getSelectionEnd()
Returns the end index of the selection. If there is no selection, this is the same as the caret location.
Specified by:
getSelectionEnd in interface AccessibleText
Returns:
the 0-based character index of the selection end

getSelectionStart

public int getSelectionStart()
Returns the start index of the selection. If there is no selection, this is the same as the caret location.
Specified by:
getSelectionStart in interface AccessibleText
Returns:
the 0-based character index of the selection start

textValueChanged

public void textValueChanged(TextEvent event)
Specified by:
textValueChanged in interface TextListener

TextComponent.java -- Widgets for entering text Copyright (C) 1999, 2002, 2003, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.