JSpinner.AccessibleJSpinner
Class JSpinner.AccessibleJSpinner
- java.lang.Object
-
- javax.accessibility.AccessibleContext
-
- java.awt.Component.AccessibleAWTComponent
-
- java.awt.Container.AccessibleAWTContainer
-
- javax.swing.JComponent.AccessibleJComponent
-
- javax.swing.JSpinner.AccessibleJSpinner
- All Implemented Interfaces:
- Serializable, EventListener, AccessibleAction, AccessibleComponent, AccessibleEditableText, AccessibleExtendedComponent, AccessibleText, AccessibleValue, ChangeListener
- Enclosing class:
- JSpinner
protected class JSpinner.AccessibleJSpinner extends JComponent.AccessibleJComponent implements AccessibleValue, AccessibleAction, AccessibleText, AccessibleEditableText, ChangeListener
AccessibleJSpinner
implements accessibility support for the JSpinner
class.
- Since:
- 1.5
Nested Classes
Nested classes/interfaces inherited from class javax.swing.JComponent.AccessibleJComponent
JComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandler
Nested classes/interfaces inherited from class java.awt.Component.AccessibleAWTComponent
Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler
Fields
Fields inherited from class javax.swing.JComponent.AccessibleJComponent
accessibleFocusHandler
Fields inherited from class java.awt.Container.AccessibleAWTContainer
accessibleContainerHandler
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.AccessibleAction
CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUP
Fields inherited from interface javax.accessibility.AccessibleText
CHARACTER, SENTENCE, WORD
Constructors
AccessibleJSpinner
protected AccessibleJSpinner()
AccessibleJSpinner constructor
Methods
stateChanged
public void stateChanged(ChangeEvent e)
Invoked when the target of the listener has changed its state.
- Specified by:
-
stateChanged
in interfaceChangeListener
- Parameters:
-
e
- aChangeEvent
object. Must not be null. - Throws:
-
NullPointerException
- if the parameter is null.
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 subclasses 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 classJComponent.AccessibleJComponent
- Returns:
- an instance of AccessibleRole describing the role of the object
- See Also:
AccessibleRole
getAccessibleChildrenCount
public int getAccessibleChildrenCount()
Returns the number of accessible children of the object.
- Overrides:
-
getAccessibleChildrenCount
in classJComponent.AccessibleJComponent
- Returns:
- the number of accessible children of the object.
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 classJComponent.AccessibleJComponent
- Parameters:
-
i
- zero-based index of child - Returns:
- the Accessible child of the object
- See Also:
getAccessibleChildrenCount()
getAccessibleAction
public AccessibleAction getAccessibleAction()
Gets the AccessibleAction associated with this object that supports one or more actions.
- Overrides:
-
getAccessibleAction
in classAccessibleContext
- Returns:
- AccessibleAction if supported by object; else return null
- See Also:
AccessibleAction
getAccessibleText
public AccessibleText getAccessibleText()
Gets the AccessibleText associated with this object presenting text on the display.
- Overrides:
-
getAccessibleText
in classAccessibleContext
- Returns:
- AccessibleText if supported by object; else return null
- See Also:
AccessibleText
getAccessibleValue
public AccessibleValue getAccessibleValue()
Gets the AccessibleValue associated with this object.
- Overrides:
-
getAccessibleValue
in classAccessibleContext
- Returns:
- AccessibleValue if supported by object; else return null
- See Also:
AccessibleValue
getCurrentAccessibleValue
public Number getCurrentAccessibleValue()
Get the value of this object as a Number. If the value has not been set, the return value will be null.
- Specified by:
-
getCurrentAccessibleValue
in interfaceAccessibleValue
- Returns:
- value of the object
- See Also:
setCurrentAccessibleValue(java.lang.Number)
setCurrentAccessibleValue
public boolean setCurrentAccessibleValue(Number n)
Set the value of this object as a Number.
- Specified by:
-
setCurrentAccessibleValue
in interfaceAccessibleValue
- Parameters:
-
n
- the value to set for this object - Returns:
- true if the value was set; else False
- See Also:
getCurrentAccessibleValue()
getMinimumAccessibleValue
public Number getMinimumAccessibleValue()
Get the minimum value of this object as a Number.
- Specified by:
-
getMinimumAccessibleValue
in interfaceAccessibleValue
- Returns:
- Minimum value of the object; null if this object does not have a minimum value
- See Also:
getMaximumAccessibleValue()
getMaximumAccessibleValue
public Number getMaximumAccessibleValue()
Get the maximum value of this object as a Number.
- Specified by:
-
getMaximumAccessibleValue
in interfaceAccessibleValue
- Returns:
- Maximum value of the object; null if this object does not have a maximum value
- See Also:
getMinimumAccessibleValue()
getAccessibleActionCount
public int getAccessibleActionCount()
Returns the number of accessible actions available in this object If there are more than one, the first one is considered the "default" action of the object. Two actions are supported: AccessibleAction.INCREMENT which increments the spinner value and AccessibleAction.DECREMENT which decrements the spinner value
- Specified by:
-
getAccessibleActionCount
in interfaceAccessibleAction
- Returns:
- the zero-based number of Actions in this object
getAccessibleActionDescription
public String getAccessibleActionDescription(int i)
Returns a description of the specified action of the object.
- Specified by:
-
getAccessibleActionDescription
in interfaceAccessibleAction
- Parameters:
-
i
- zero-based index of the actions - Returns:
- a String description of the action
- See Also:
getAccessibleActionCount()
doAccessibleAction
public boolean doAccessibleAction(int i)
Performs the specified Action on the object
- Specified by:
-
doAccessibleAction
in interfaceAccessibleAction
- Parameters:
-
i
- zero-based index of actions. The first action (index 0) is AccessibleAction.INCREMENT and the second action (index 1) is AccessibleAction.DECREMENT. - Returns:
- true if the action was performed; otherwise false.
- See Also:
getAccessibleActionCount()
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 interfaceAccessibleText
- Parameters:
-
p
- the Point in local coordinates - Returns:
- the zero-based index of the character under Point p; if Point is invalid return -1.
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.
- Specified by:
-
getCharacterBounds
in interfaceAccessibleText
- 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)
- Specified by:
-
getCharCount
in interfaceAccessibleText
- Returns:
- the number of characters
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).
- Specified by:
-
getCaretPosition
in interfaceAccessibleText
- Returns:
- the zero-based offset of the caret.
getAtIndex
public String getAtIndex(int part, int index)
Returns the String at a given index.
- Specified by:
-
getAtIndex
in interfaceAccessibleText
- Parameters:
-
part
- the CHARACTER, WORD, or SENTENCE to retrieve -
index
- an index within the text - Returns:
- the letter, word, or sentence
getAfterIndex
public String getAfterIndex(int part, int index)
Returns the String after a given index.
- Specified by:
-
getAfterIndex
in interfaceAccessibleText
- 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.
- Specified by:
-
getBeforeIndex
in interfaceAccessibleText
- Parameters:
-
part
- the CHARACTER, WORD, or SENTENCE to retrieve -
index
- an index within the text - Returns:
- the letter, word, or sentence
getCharacterAttribute
public AttributeSet getCharacterAttribute(int i)
Returns the AttributeSet for a given character at a given index
- Specified by:
-
getCharacterAttribute
in interfaceAccessibleText
- Parameters:
-
i
- the zero-based index into the text - Returns:
- the AttributeSet of the character
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 interfaceAccessibleText
- Returns:
- the index into the text of the start of the selection
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 interfaceAccessibleText
- Returns:
- the index into the text of the end of the selection
getSelectedText
public String getSelectedText()
Returns the portion of the text that is selected.
- Specified by:
-
getSelectedText
in interfaceAccessibleText
- Returns:
- the String portion of the text that is selected
setTextContents
public void setTextContents(String s)
Sets the text contents to the specified string.
- Specified by:
-
setTextContents
in interfaceAccessibleEditableText
- Parameters:
-
s
- the string to set the text contents
insertTextAtIndex
public void insertTextAtIndex(int index, String s)
Inserts the specified string at the given index/
- Specified by:
-
insertTextAtIndex
in interfaceAccessibleEditableText
- Parameters:
-
index
- the index in the text where the string will be inserted -
s
- the string to insert in the text
getTextRange
public String getTextRange(int startIndex, int endIndex)
Returns the text string between two indices.
- Specified by:
-
getTextRange
in interfaceAccessibleEditableText
- Parameters:
-
startIndex
- the starting index in the text -
endIndex
- the ending index in the text - Returns:
- the text string between the indices
delete
public void delete(int startIndex, int endIndex)
Deletes the text between two indices
- Specified by:
-
delete
in interfaceAccessibleEditableText
- Parameters:
-
startIndex
- the starting index in the text -
endIndex
- the ending index in the text
cut
public void cut(int startIndex, int endIndex)
Cuts the text between two indices into the system clipboard.
- Specified by:
-
cut
in interfaceAccessibleEditableText
- Parameters:
-
startIndex
- the starting index in the text -
endIndex
- the ending index in the text
paste
public void paste(int startIndex)
Pastes the text from the system clipboard into the text starting at the specified index.
- Specified by:
-
paste
in interfaceAccessibleEditableText
- Parameters:
-
startIndex
- the starting index in the text
replaceText
public void replaceText(int startIndex, int endIndex, String s)
Replaces the text between two indices with the specified string.
- Specified by:
-
replaceText
in interfaceAccessibleEditableText
- Parameters:
-
startIndex
- the starting index in the text -
endIndex
- the ending index in the text -
s
- the string to replace the text between two indices
selectText
public void selectText(int startIndex, int endIndex)
Selects the text between two indices.
- Specified by:
-
selectText
in interfaceAccessibleEditableText
- Parameters:
-
startIndex
- the starting index in the text -
endIndex
- the ending index in the text
setAttributes
public void setAttributes(int startIndex, int endIndex, AttributeSet as)
Sets attributes for the text between two indices.
- Specified by:
-
setAttributes
in interfaceAccessibleEditableText
- Parameters:
-
startIndex
- the starting index in the text -
endIndex
- the ending index in the text -
as
- the attribute set - See Also:
AttributeSet
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.