java.lang.Object
   ↳ javax.accessibility.AccessibleContext
     ↳ java.awt.Component.AccessibleAWTComponent
       ↳ java.awt.Container.AccessibleAWTContainer
         ↳ javax.swing.JComponent.AccessibleJComponent
           ↳ javax.swing.JSpinner.AccessibleJSpinner

Class Overview

AccessibleJSpinner implements accessibility support for the JSpinner class.

Summary

[Expand]
Inherited Constants
From class javax.accessibility.AccessibleContext
From interface javax.accessibility.AccessibleText
[Expand]
Inherited Fields
From class javax.swing.JComponent.AccessibleJComponent
From class java.awt.Container.AccessibleAWTContainer
From class java.awt.Component.AccessibleAWTComponent
From class javax.accessibility.AccessibleContext
From interface javax.accessibility.AccessibleAction
Protected Constructors
JSpinner.AccessibleJSpinner()
AccessibleJSpinner constructor
Public Methods
void cut(int startIndex, int endIndex)
Cuts the text between two indices into the system clipboard.
void delete(int startIndex, int endIndex)
Deletes the text between two indices
boolean doAccessibleAction(int i)
Performs the specified Action on the object
AccessibleAction getAccessibleAction()
Gets the AccessibleAction associated with this object that supports one or more actions.
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.
String getAccessibleActionDescription(int i)
Returns a description of the specified action of the object.
Accessible getAccessibleChild(int i)
Returns the specified Accessible child of the object.
int getAccessibleChildrenCount()
Returns the number of accessible children of the object.
AccessibleRole getAccessibleRole()
Gets the role of this object.
AccessibleText getAccessibleText()
Gets the AccessibleText associated with this object presenting text on the display.
AccessibleValue getAccessibleValue()
Gets the AccessibleValue associated with this object.
String getAfterIndex(int part, int index)
Returns the String after a given index.
String getAtIndex(int part, int index)
Returns the String at a given index.
String getBeforeIndex(int part, int index)
Returns the String before a given index.
int getCaretPosition()
Returns the zero-based offset of the caret.
int getCharCount()
Returns the number of characters (valid indicies)
AttributeSet getCharacterAttribute(int i)
Returns the AttributeSet for a given character at a given index
Rectangle getCharacterBounds(int i)
Determines the bounding box of the character at the given index into the string.
Number getCurrentAccessibleValue()
Get the value of this object as a Number.
int getIndexAtPoint(Point p)
Given a point in local coordinates, return the zero-based index of the character under that Point.
Number getMaximumAccessibleValue()
Get the maximum value of this object as a Number.
Number getMinimumAccessibleValue()
Get the minimum value of this object as a Number.
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.
String getTextRange(int startIndex, int endIndex)
Returns the text string between two indices.
void insertTextAtIndex(int index, String s)
Inserts the specified string at the given index/
void paste(int startIndex)
Pastes the text from the system clipboard into the text starting at the specified index.
void replaceText(int startIndex, int endIndex, String s)
Replaces the text between two indices with the specified string.
void selectText(int startIndex, int endIndex)
Selects the text between two indices.
void setAttributes(int startIndex, int endIndex, AttributeSet as)
Sets attributes for the text between two indices.
boolean setCurrentAccessibleValue(Number n)
Set the value of this object as a Number.
void setTextContents(String s)
Sets the text contents to the specified string.
void stateChanged(ChangeEvent e)
Invoked when the target of the listener has changed its state.
[Expand]
Inherited Methods
From class javax.swing.JComponent.AccessibleJComponent
From class java.awt.Container.AccessibleAWTContainer
From class java.awt.Component.AccessibleAWTComponent
From class javax.accessibility.AccessibleContext
From class java.lang.Object
From interface javax.accessibility.AccessibleAction
From interface javax.accessibility.AccessibleComponent
From interface javax.accessibility.AccessibleEditableText
From interface javax.accessibility.AccessibleExtendedComponent
From interface javax.accessibility.AccessibleText
From interface javax.accessibility.AccessibleValue
From interface javax.swing.event.ChangeListener

Protected Constructors

protected JSpinner.AccessibleJSpinner ()

AccessibleJSpinner constructor

Public Methods

public void cut (int startIndex, int endIndex)

Cuts the text between two indices into the system clipboard.

Parameters
startIndex the starting index in the text
endIndex the ending index in the text

public void delete (int startIndex, int endIndex)

Deletes the text between two indices

Parameters
startIndex the starting index in the text
endIndex the ending index in the text

public boolean doAccessibleAction (int i)

Performs the specified Action on the object

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.

public AccessibleAction getAccessibleAction ()

Gets the AccessibleAction associated with this object that supports one or more actions.

Returns
  • AccessibleAction if supported by object; else return null
See Also

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

Returns
  • the zero-based number of Actions in this object

public String getAccessibleActionDescription (int i)

Returns a description of the specified action of the object.

Parameters
i zero-based index of the actions
Returns
  • a String description of the action

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.

Parameters
i zero-based index of child
Returns
  • the Accessible child of the object

public int getAccessibleChildrenCount ()

Returns the number of accessible children of the object.

Returns
  • the number of accessible children of the object.

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.

Returns
  • an instance of AccessibleRole describing the role of the object
See Also

public AccessibleText getAccessibleText ()

Gets the AccessibleText associated with this object presenting text on the display.

Returns
  • AccessibleText if supported by object; else return null
See Also

public AccessibleValue getAccessibleValue ()

Gets the AccessibleValue associated with this object.

Returns
  • AccessibleValue if supported by object; else return null
See Also

public String getAfterIndex (int part, int index)

Returns the String after a given index.

Parameters
part the CHARACTER, WORD, or SENTENCE to retrieve
index an index within the text
Returns
  • the letter, word, or sentence

public String getAtIndex (int part, int index)

Returns the String at a given index.

Parameters
part the CHARACTER, WORD, or SENTENCE to retrieve
index an index within the text
Returns
  • the letter, word, or sentence

public String getBeforeIndex (int part, int index)

Returns the String before a given index.

Parameters
part the CHARACTER, WORD, or SENTENCE to retrieve
index an index within the text
Returns
  • the letter, word, or sentence

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).

Returns
  • the zero-based offset of the caret.

public int getCharCount ()

Returns the number of characters (valid indicies)

Returns
  • the number of characters

public AttributeSet getCharacterAttribute (int i)

Returns the AttributeSet for a given character at a given index

Parameters
i the zero-based index into the text
Returns
  • the AttributeSet of the character

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.

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.

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.

Returns
  • value of the object

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.

Parameters
p the Point in local coordinates
Returns
  • the zero-based index of the character under Point p; if Point is invalid return -1.

public Number getMaximumAccessibleValue ()

Get the maximum value of this object as a Number.

Returns
  • Maximum value of the object; null if this object does not have a maximum value

public Number getMinimumAccessibleValue ()

Get the minimum value of this object as a Number.

Returns
  • Minimum value of the object; null if this object does not have a minimum value

public String getSelectedText ()

Returns the portion of the text that is selected.

Returns
  • the String 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.

Returns
  • the index into teh text of the end of the selection

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.

Returns
  • the index into the text of the start of the selection

public String getTextRange (int startIndex, int endIndex)

Returns the text string between two indices.

Parameters
startIndex the starting index in the text
endIndex the ending index in the text
Returns
  • the text string between the indices

public void insertTextAtIndex (int index, String s)

Inserts the specified string at the given index/

Parameters
index the index in the text where the string will be inserted
s the string to insert in the text

public void paste (int startIndex)

Pastes the text from the system clipboard into the text starting at the specified index.

Parameters
startIndex the starting index in the text

public void replaceText (int startIndex, int endIndex, String s)

Replaces the text between two indices with the specified string.

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

public void selectText (int startIndex, int endIndex)

Selects the text between two indices.

Parameters
startIndex the starting index in the text
endIndex the ending index in the text

public void setAttributes (int startIndex, int endIndex, AttributeSet as)

Sets attributes for the text between two indices.

Parameters
startIndex the starting index in the text
endIndex the ending index in the text
as the attribute set
See Also

public boolean setCurrentAccessibleValue (Number n)

Set the value of this object as a Number.

Parameters
n the value to set for this object
Returns
  • true if the value was set; else False

public void setTextContents (String s)

Sets the text contents to the specified string.

Parameters
s the string to set the text contents

public void stateChanged (ChangeEvent e)

Invoked when the target of the listener has changed its state.

Parameters
e a ChangeEvent object. Must not be null.
Throws
NullPointerException if the parameter is null.