java.lang.Object
javax.accessibility.AccessibleContext
javax.swing.JList.AccessibleJList.AccessibleJListChild
- All Implemented Interfaces:
Accessible
,AccessibleAction
,AccessibleComponent
- Enclosing class:
JList.AccessibleJList
protected class JList.AccessibleJList.AccessibleJListChild
extends AccessibleContext
implements Accessible, AccessibleComponent, AccessibleAction
This class implements accessibility support appropriate
for list children.
-
Field Summary
Fields declared in 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 declared in interface javax.accessibility.AccessibleAction
CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUP
-
Constructor Summary
ConstructorDescriptionAccessibleJListChild
(JList<E> parent, int indexInParent) Constructs anAccessibleJListChild
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the specified focus listener to receive focus events from this component.boolean
Checks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object.boolean
doAccessibleAction
(int i) Performs the specified action on the object.Gets theAccessibleAction
associated with this object that supports one or more actions.int
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.Returns a description of the specified action of the object.Returns theAccessible
child, if one exists, contained at the local coordinatePoint
.getAccessibleChild
(int i) Returns the specifiedAccessible
child of the object.int
Returns the number of accessible children of the object.Get the AccessibleComponent associated with this object.Get the AccessibleContext for this object.Returns the icon for the element renderer, as the only item of an array ofAccessibleIcon
s or anull
array if the renderer component contains no icons.int
Gets the 0-based index of this object in its accessible parent.Gets the role of this object.Gets the state set of this object.Gets the background color of this object.Gets the bounds of this object in the form of aRectangle
object.Gets the cursor of this object.getFont()
Gets the font of this object.Gets theFontMetrics
of this object.Gets the foreground color of this object.Gets the locale of the component.Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.Returns the location of the object on the screen.getSize()
Returns the size of this object in the form of aDimension
object.boolean
Determines if the object is enabled.boolean
Returns whether this object can accept focus or not.boolean
Determines if the object is showing.boolean
Determines if the object is visible.void
Removes the specified focus listener so it no longer receives focus events from this component.void
Requests focus for this object.void
Sets the accessible description of this object.void
Sets the localized accessible name of this object.void
Sets the background color of this object.void
Sets the bounds of this object in the form of aRectangle
object.void
Sets the cursor of this object.void
setEnabled
(boolean b) Sets the enabled state of the object.void
Sets the font of this object.void
Sets the foreground color of this object.void
setLocation
(Point p) Sets the location of the object relative to the parent.void
Resizes this object so that it has width and height.void
setVisible
(boolean b) Sets the visible state of the object.Methods declared in class javax.accessibility.AccessibleContext
addPropertyChangeListener, firePropertyChange, getAccessibleDescription, getAccessibleEditableText, getAccessibleName, getAccessibleParent, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleText, getAccessibleValue, removePropertyChangeListener, setAccessibleParent
-
Constructor Details
-
AccessibleJListChild
Constructs anAccessibleJListChild
.- Parameters:
parent
- the parentindexInParent
- the index in the parent
-
-
Method Details
-
getAccessibleContext
Get the AccessibleContext for this object. In the implementation of the Java Accessibility API for this class, returns this object, which is its own AccessibleContext.- Specified by:
getAccessibleContext
in interfaceAccessible
- Returns:
- this object
-
setAccessibleName
Description copied from class:AccessibleContext
Sets the localized accessible name of this object. Changing the name will cause aPropertyChangeEvent
to be fired for theACCESSIBLE_NAME_PROPERTY
property.- Overrides:
setAccessibleName
in classAccessibleContext
- Parameters:
s
- the new localized name of the object- See Also:
-
setAccessibleDescription
Description copied from class:AccessibleContext
Sets the accessible description of this object. Changing the name will cause aPropertyChangeEvent
to be fired for theACCESSIBLE_DESCRIPTION_PROPERTY
property.- Overrides:
setAccessibleDescription
in classAccessibleContext
- Parameters:
s
- the new localized description of the object- See Also:
-
getAccessibleRole
Description copied from class:AccessibleContext
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 isAccessibleRole.PUSH_BUTTON
. The roles inAccessibleRole
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., useAccessibleRole.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 andAccessibleRole.RADIO_BUTTON
for radio buttons).Note that the
AccessibleRole
class is also extensible, so custom component developers can define their ownAccessibleRole
's if the set of predefined roles is inadequate.- Specified by:
getAccessibleRole
in classAccessibleContext
- Returns:
- an instance of
AccessibleRole
describing the role of the object - See Also:
-
getAccessibleStateSet
Description copied from class:AccessibleContext
Gets the state set of this object. TheAccessibleStateSet
of an object is composed of a set of uniqueAccessibleStates
. A change in theAccessibleStateSet
of an object will cause aPropertyChangeEvent
to be fired for theACCESSIBLE_STATE_PROPERTY
property.- Specified by:
getAccessibleStateSet
in classAccessibleContext
- Returns:
- an instance of
AccessibleStateSet
containing the current state set of the object - See Also:
-
getAccessibleIndexInParent
public int getAccessibleIndexInParent()Description copied from class:AccessibleContext
Gets the 0-based index of this object in its accessible parent.- Specified by:
getAccessibleIndexInParent
in classAccessibleContext
- Returns:
- the 0-based index of this object in its parent; -1 if this object does not have an accessible parent.
- See Also:
-
getAccessibleChildrenCount
public int getAccessibleChildrenCount()Description copied from class:AccessibleContext
Returns the number of accessible children of the object.- Specified by:
getAccessibleChildrenCount
in classAccessibleContext
- Returns:
- the number of accessible children of the object.
-
getAccessibleChild
Description copied from class:AccessibleContext
Returns the specifiedAccessible
child of the object. TheAccessible
children of anAccessible
object are zero-based, so the first child of anAccessible
child is at index 0, the second child is at index 1, and so on.- Specified by:
getAccessibleChild
in classAccessibleContext
- Parameters:
i
- zero-based index of child- Returns:
- the
Accessible
child of the object - See Also:
-
getLocale
Description copied from class:AccessibleContext
Gets the locale of the component. If the component does not have a locale, then the locale of its parent is returned.- Specified by:
getLocale
in classAccessibleContext
- Returns:
- this component's locale. If this component does not have a locale, the locale of its parent is returned.
-
getAccessibleComponent
Get the AccessibleComponent associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleComponent interface on behalf of itself.- Overrides:
getAccessibleComponent
in classAccessibleContext
- Returns:
- this object
- See Also:
-
getBackground
Description copied from interface:AccessibleComponent
Gets the background color of this object.- Specified by:
getBackground
in interfaceAccessibleComponent
- Returns:
- the background color, if supported, of the object; otherwise,
null
- See Also:
-
setBackground
Description copied from interface:AccessibleComponent
Sets the background color of this object.- Specified by:
setBackground
in interfaceAccessibleComponent
- Parameters:
c
- the new color for the background- See Also:
-
getForeground
Description copied from interface:AccessibleComponent
Gets the foreground color of this object.- Specified by:
getForeground
in interfaceAccessibleComponent
- Returns:
- the foreground color, if supported, of the object; otherwise,
null
- See Also:
-
setForeground
Description copied from interface:AccessibleComponent
Sets the foreground color of this object.- Specified by:
setForeground
in interfaceAccessibleComponent
- Parameters:
c
- the new color for the foreground- See Also:
-
getCursor
Description copied from interface:AccessibleComponent
Gets the cursor of this object.- Specified by:
getCursor
in interfaceAccessibleComponent
- Returns:
- the cursor, if supported, of the object; otherwise,
null
- See Also:
-
setCursor
Description copied from interface:AccessibleComponent
Sets the cursor of this object.- Specified by:
setCursor
in interfaceAccessibleComponent
- Parameters:
c
- the new cursor for the object- See Also:
-
getFont
Description copied from interface:AccessibleComponent
Gets the font of this object.- Specified by:
getFont
in interfaceAccessibleComponent
- Returns:
- the font, if supported, for the object; otherwise,
null
- See Also:
-
setFont
Description copied from interface:AccessibleComponent
Sets the font of this object.- Specified by:
setFont
in interfaceAccessibleComponent
- Parameters:
f
- the new font for the object- See Also:
-
getFontMetrics
Description copied from interface:AccessibleComponent
Gets theFontMetrics
of this object.- Specified by:
getFontMetrics
in interfaceAccessibleComponent
- Parameters:
f
- the font for which font metrics is to be obtained- Returns:
- the
FontMetrics
, if supported, the object; otherwise,null
- See Also:
-
isEnabled
public boolean isEnabled()Description copied from interface:AccessibleComponent
Determines if the object is enabled. Objects that are enabled will also have theAccessibleState.ENABLED
state set in theirAccessibleStateSets
.- Specified by:
isEnabled
in interfaceAccessibleComponent
- Returns:
true
if object is enabled; otherwise,false
- See Also:
-
setEnabled
public void setEnabled(boolean b) Description copied from interface:AccessibleComponent
Sets the enabled state of the object.- Specified by:
setEnabled
in interfaceAccessibleComponent
- Parameters:
b
- iftrue
, enables this object; otherwise, disables it- See Also:
-
isVisible
public boolean isVisible()Description copied from interface:AccessibleComponent
Determines if the object is visible. Note: this means that the object intends to be visible; however, it may not be showing on the screen because one of the objects that this object is contained by is currently not visible. To determine if an object is showing on the screen, useAccessibleComponent.isShowing()
Objects that are visible will also have the
AccessibleState.VISIBLE
state set in theirAccessibleStateSets
.- Specified by:
isVisible
in interfaceAccessibleComponent
- Returns:
true
if object is visible; otherwise,false
- See Also:
-
setVisible
public void setVisible(boolean b) Description copied from interface:AccessibleComponent
Sets the visible state of the object.- Specified by:
setVisible
in interfaceAccessibleComponent
- Parameters:
b
- iftrue
, shows this object; otherwise, hides it- See Also:
-
isShowing
public boolean isShowing()Description copied from interface:AccessibleComponent
Determines if the object is showing. This is determined by checking the visibility of the object and its ancestors. Note: this will returntrue
even if the object is obscured by another (for example, it is underneath a menu that was pulled down).- Specified by:
isShowing
in interfaceAccessibleComponent
- Returns:
true
if object is showing; otherwise,false
-
contains
Description copied from interface:AccessibleComponent
Checks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object.- Specified by:
contains
in interfaceAccessibleComponent
- Parameters:
p
- the point relative to the coordinate system of the object- Returns:
true
if object contains point; otherwisefalse
- See Also:
-
getLocationOnScreen
Description copied from interface:AccessibleComponent
Returns the location of the object on the screen.- Specified by:
getLocationOnScreen
in interfaceAccessibleComponent
- Returns:
- the location of the object on screen;
null
if this object is not on the screen - See Also:
-
getLocation
Description copied from interface:AccessibleComponent
Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.- Specified by:
getLocation
in interfaceAccessibleComponent
- Returns:
- An instance of
Point
representing the top-left corner of the object's bounds in the coordinate space of the screen;null
if this object or its parent are not on the screen - See Also:
-
setLocation
Description copied from interface:AccessibleComponent
Sets the location of the object relative to the parent.- Specified by:
setLocation
in interfaceAccessibleComponent
- Parameters:
p
- the new position for the top-left corner- See Also:
-
getBounds
Description copied from interface:AccessibleComponent
Gets the bounds of this object in the form of aRectangle
object. The bounds specify this object's width, height, and location relative to its parent.- Specified by:
getBounds
in interfaceAccessibleComponent
- Returns:
- A rectangle indicating this component's bounds;
null
if this object is not on the screen. - See Also:
-
setBounds
Description copied from interface:AccessibleComponent
Sets the bounds of this object in the form of aRectangle
object. The bounds specify this object's width, height, and location relative to its parent.- Specified by:
setBounds
in interfaceAccessibleComponent
- Parameters:
r
- rectangle indicating this component's bounds- See Also:
-
getSize
Description copied from interface:AccessibleComponent
Returns the size of this object in the form of aDimension
object. Theheight
field of theDimension
object contains this object's height, and thewidth
field of theDimension
object contains this object's width.- Specified by:
getSize
in interfaceAccessibleComponent
- Returns:
- A
Dimension
object that indicates the size of this component;null
if this object is not on the screen - See Also:
-
setSize
Description copied from interface:AccessibleComponent
Resizes this object so that it has width and height.- Specified by:
setSize
in interfaceAccessibleComponent
- Parameters:
d
- The dimension specifying the new size of the object- See Also:
-
getAccessibleAt
Description copied from interface:AccessibleComponent
Returns theAccessible
child, if one exists, contained at the local coordinatePoint
.- Specified by:
getAccessibleAt
in interfaceAccessibleComponent
- Parameters:
p
- The point relative to the coordinate system of this object- Returns:
- the
Accessible
, if it exists, at the specified location; otherwisenull
-
isFocusTraversable
public boolean isFocusTraversable()Description copied from interface:AccessibleComponent
Returns whether this object can accept focus or not. Objects that can accept focus will also have theAccessibleState.FOCUSABLE
state set in theirAccessibleStateSets
.- Specified by:
isFocusTraversable
in interfaceAccessibleComponent
- Returns:
true
if object can accept focus; otherwisefalse
- See Also:
-
requestFocus
public void requestFocus()Description copied from interface:AccessibleComponent
Requests focus for this object. If this object cannot accept focus, nothing will happen. Otherwise, the object will attempt to take focus.- Specified by:
requestFocus
in interfaceAccessibleComponent
- See Also:
-
addFocusListener
Description copied from interface:AccessibleComponent
Adds the specified focus listener to receive focus events from this component.- Specified by:
addFocusListener
in interfaceAccessibleComponent
- Parameters:
l
- the focus listener- See Also:
-
removeFocusListener
Description copied from interface:AccessibleComponent
Removes the specified focus listener so it no longer receives focus events from this component.- Specified by:
removeFocusListener
in interfaceAccessibleComponent
- Parameters:
l
- the focus listener- See Also:
-
getAccessibleIcon
Returns the icon for the element renderer, as the only item of an array ofAccessibleIcon
s or anull
array if the renderer component contains no icons.- Overrides:
getAccessibleIcon
in classAccessibleContext
- Returns:
- an array containing the accessible icon
or a
null
array if none - Since:
- 1.3
- See Also:
-
getAccessibleAction
Gets theAccessibleAction
associated with this object that supports one or more actions.- Overrides:
getAccessibleAction
in classAccessibleContext
- Implementation Requirements:
- Returns the AccessibleAction for this AccessibleJListChild as follows: First getListCellRendererComponent of the ListCellRenderer for the component at the "index in parent" of this child is called. Then its AccessibleContext is fetched and that AccessibleContext's AccessibleAction is returned. Note that if an AccessibleAction is not found using this process then this object with its implementation of the AccessibleAction interface is returned.
- Returns:
AccessibleAction
if supported by object; else returnnull
- Since:
- 9
- See Also:
-
doAccessibleAction
public boolean doAccessibleAction(int i) Performs the specified action on the object.- Specified by:
doAccessibleAction
in interfaceAccessibleAction
- Implementation Requirements:
- If i == 0 selects this AccessibleJListChild by calling JList.this.setSelectedIndex(indexInParent) and then returns true; otherwise returns false.
- Parameters:
i
- zero-based index of actions- Returns:
true
if the action was performed; otherwisefalse
- Since:
- 9
- See Also:
-
getAccessibleActionDescription
Returns a description of the specified action of the object.- Specified by:
getAccessibleActionDescription
in interfaceAccessibleAction
- Implementation Requirements:
- If i == 0 returns the action description fetched from UIManager.getString("AbstractButton.clickText"); otherwise returns null.
- Parameters:
i
- zero-based index of the actions- Returns:
- a
String
description of the action - Since:
- 9
- See Also:
-
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.- Specified by:
getAccessibleActionCount
in interfaceAccessibleAction
- Implementation Requirements:
- Returns 1, i.e. there is only one action.
- Returns:
- the zero-based number of actions in this object
- Since:
- 9
-