javax.swing.JSpinner.AccessibleJSpinner

JSpinner.AccessibleJSpinner

Java SE 6

Extends: AccessibleContext > Component.AccessibleAWTComponent > Container.AccessibleAWTContainer > JComponent.AccessibleJComponent

Implements: AccessibleValue, AccessibleAction, AccessibleText, AccessibleEditableText, ChangeListener

Contained within: JSpinner

AccessibleJSpinner implements accessibility support for the JSpinner class.

since

1.5

Constructors

protected

JSpinner.AccessibleJSpinner()
AccessibleJSpinner constructor

Methods

public void

cut(int startIndex, int endIndex)
Cuts the text between two indices into the system clipboard.

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

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

i	zero-based index of actions. The first action (index 0) is AccessibleAction.INCREMENT and the second action (index 1) is AccessibleAction.DECREMENT.
return	true if the action was performed; otherwise false.
See also	getAccessibleActionCount

public void

insertTextAtIndex(int index, String s)
Inserts the specified string at the given index/

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.

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.

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.

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

public void

stateChanged(ChangeEvent e)
Invoked when the target of the listener has changed its state.

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

Properties

public AccessibleAction

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

return	AccessibleAction if supported by object; else return null
See also	javax.accessibility.AccessibleAction

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

return

the zero-based number of Actions in this object

public String

getAccessibleActionDescription(int i)
Returns a description of the specified action of the object.

i	zero-based index of the actions
return	a String description of the action
See also	getAccessibleActionCount

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.

i	zero-based index of child
return	the Accessible child of the object
See also	getAccessibleChildrenCount

public int

getAccessibleChildrenCount()
Returns the number of accessible children of the object.

return

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.

return an instance of AccessibleRole describing the role of the object

See also javax.accessibility.AccessibleRole

public AccessibleText

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

return	AccessibleText if supported by object; else return null
See also	javax.accessibility.AccessibleText

public AccessibleValue

getAccessibleValue()
Gets the AccessibleValue associated with this object.

return	AccessibleValue if supported by object; else return null
See also	javax.accessibility.AccessibleValue

public String

getAfterIndex(int part, int index)
Returns the String after a given index.

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

public String

getAtIndex(int part, int index)
Returns the String at a given index.

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

public void

setAttributes(int startIndex, int endIndex, AttributeSet as)
Sets attributes for the text between two indices.

startIndex	the starting index in the text
endIndex	the ending index in the text
as	the attribute set
See also	javax.swing.text.AttributeSet

public String

getBeforeIndex(int part, int index)
Returns the String before a given index.

part	the CHARACTER, WORD, or SENTENCE to retrieve
index	an index within the text
return	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).

return

the zero-based offset of the caret.

public AttributeSet

getCharacterAttribute(int i)
Returns the AttributeSet for a given character at a given index

i	the zero-based index into the text
return	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.

i	the index into the String
return	the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle.

public int

getCharCount()
Returns the number of characters (valid indicies)

return

the number of characters

public boolean

setCurrentAccessibleValue(Number n)
Set the value of this object as a Number.

n	the value to set for this object
return	true if the value was set; else False
See also	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.

return	value of the object
See also	setCurrentAccessibleValue

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.

p	the Point in local coordinates
return	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.

return	Maximum value of the object; null if this object does not have a maximum value
See also	getMinimumAccessibleValue

public Number

getMinimumAccessibleValue()
Get the minimum value of this object as a Number.

return	Minimum value of the object; null if this object does not have a minimum value
See also	getMaximumAccessibleValue

public String

getSelectedText()
Returns the portion of the text that is selected.

return

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.

return

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.

return

the index into the text of the start of the selection

public void

setTextContents(String s)
Sets the text contents to the specified string.

s	the string to set the text contents

public String

getTextRange(int startIndex, int endIndex)
Returns the text string between two indices.

startIndex	the starting index in the text
endIndex	the ending index in the text
return	the text string between the indices

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6