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, accessibleParentFields declared in interface javax.accessibility.AccessibleAction
CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUP -
Constructor Summary
ConstructorsConstructorDescriptionAccessibleJListChild(JList<E> parent, int indexInParent) Constructs anAccessibleJListChild. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds the specified focus listener to receive focus events from this component.booleanChecks 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.booleandoAccessibleAction(int i) Performs the specified action on the object.Gets theAccessibleActionassociated with this object that supports one or more actions.intReturns 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 theAccessiblechild, if one exists, contained at the local coordinatePoint.getAccessibleChild(int i) Returns the specifiedAccessiblechild of the object.intReturns 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 ofAccessibleIcons or anullarray if the renderer component contains no icons.intGets 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 aRectangleobject.Gets the cursor of this object.getFont()Gets the font of this object.Gets theFontMetricsof 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 aDimensionobject.booleanDetermines if the object is enabled.booleanReturns whether this object can accept focus or not.booleanDetermines if the object is showing.booleanDetermines if the object is visible.voidRemoves the specified focus listener so it no longer receives focus events from this component.voidRequests focus for this object.voidSets the accessible description of this object.voidSets the localized accessible name of this object.voidSets the background color of this object.voidSets the bounds of this object in the form of aRectangleobject.voidSets the cursor of this object.voidsetEnabled(boolean b) Sets the enabled state of the object.voidSets the font of this object.voidSets the foreground color of this object.voidsetLocation(Point p) Sets the location of the object relative to the parent.voidResizes this object so that it has width and height.voidsetVisible(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:
getAccessibleContextin interfaceAccessible- Returns:
- this object
-
setAccessibleName
Description copied from class:AccessibleContextSets the localized accessible name of this object. Changing the name will cause aPropertyChangeEventto be fired for theACCESSIBLE_NAME_PROPERTYproperty.- Overrides:
setAccessibleNamein classAccessibleContext- Parameters:
s- the new localized name of the object- See Also:
-
setAccessibleDescription
Description copied from class:AccessibleContextSets the accessible description of this object. Changing the name will cause aPropertyChangeEventto be fired for theACCESSIBLE_DESCRIPTION_PROPERTYproperty.- Overrides:
setAccessibleDescriptionin classAccessibleContext- Parameters:
s- the new localized description of the object- See Also:
-
getAccessibleRole
Description copied from class:AccessibleContextGets 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 inAccessibleRoleare 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_BUTTONfor all components that act like a push button) as well as distinguish between subclasses that behave differently (e.g.,AccessibleRole.CHECK_BOXfor check boxes andAccessibleRole.RADIO_BUTTONfor radio buttons).Note that the
AccessibleRoleclass is also extensible, so custom component developers can define their ownAccessibleRole's if the set of predefined roles is inadequate.- Specified by:
getAccessibleRolein classAccessibleContext- Returns:
- an instance of
AccessibleRoledescribing the role of the object - See Also:
-
getAccessibleStateSet
Description copied from class:AccessibleContextGets the state set of this object. TheAccessibleStateSetof an object is composed of a set of uniqueAccessibleStates. A change in theAccessibleStateSetof an object will cause aPropertyChangeEventto be fired for theACCESSIBLE_STATE_PROPERTYproperty.- Specified by:
getAccessibleStateSetin classAccessibleContext- Returns:
- an instance of
AccessibleStateSetcontaining the current state set of the object - See Also:
-
getAccessibleIndexInParent
public int getAccessibleIndexInParent()Description copied from class:AccessibleContextGets the 0-based index of this object in its accessible parent.- Specified by:
getAccessibleIndexInParentin 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:AccessibleContextReturns the number of accessible children of the object.- Specified by:
getAccessibleChildrenCountin classAccessibleContext- Returns:
- the number of accessible children of the object.
-
getAccessibleChild
Description copied from class:AccessibleContextReturns the specifiedAccessiblechild of the object. TheAccessiblechildren of anAccessibleobject are zero-based, so the first child of anAccessiblechild is at index 0, the second child is at index 1, and so on.- Specified by:
getAccessibleChildin classAccessibleContext- Parameters:
i- zero-based index of child- Returns:
- the
Accessiblechild of the object - See Also:
-
getLocale
Description copied from class:AccessibleContextGets the locale of the component. If the component does not have a locale, then the locale of its parent is returned.- Specified by:
getLocalein 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:
getAccessibleComponentin classAccessibleContext- Returns:
- this object
- See Also:
-
getBackground
Description copied from interface:AccessibleComponentGets the background color of this object.- Specified by:
getBackgroundin interfaceAccessibleComponent- Returns:
- the background color, if supported, of the object; otherwise,
null - See Also:
-
setBackground
Description copied from interface:AccessibleComponentSets the background color of this object.- Specified by:
setBackgroundin interfaceAccessibleComponent- Parameters:
c- the new color for the background- See Also:
-
getForeground
Description copied from interface:AccessibleComponentGets the foreground color of this object.- Specified by:
getForegroundin interfaceAccessibleComponent- Returns:
- the foreground color, if supported, of the object; otherwise,
null - See Also:
-
setForeground
Description copied from interface:AccessibleComponentSets the foreground color of this object.- Specified by:
setForegroundin interfaceAccessibleComponent- Parameters:
c- the new color for the foreground- See Also:
-
getCursor
Description copied from interface:AccessibleComponentGets the cursor of this object.- Specified by:
getCursorin interfaceAccessibleComponent- Returns:
- the cursor, if supported, of the object; otherwise,
null - See Also:
-
setCursor
Description copied from interface:AccessibleComponentSets the cursor of this object.- Specified by:
setCursorin interfaceAccessibleComponent- Parameters:
c- the new cursor for the object- See Also:
-
getFont
Description copied from interface:AccessibleComponentGets the font of this object.- Specified by:
getFontin interfaceAccessibleComponent- Returns:
- the font, if supported, for the object; otherwise,
null - See Also:
-
setFont
Description copied from interface:AccessibleComponentSets the font of this object.- Specified by:
setFontin interfaceAccessibleComponent- Parameters:
f- the new font for the object- See Also:
-
getFontMetrics
Description copied from interface:AccessibleComponentGets theFontMetricsof this object.- Specified by:
getFontMetricsin 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:AccessibleComponentDetermines if the object is enabled. Objects that are enabled will also have theAccessibleState.ENABLEDstate set in theirAccessibleStateSets.- Specified by:
isEnabledin interfaceAccessibleComponent- Returns:
trueif object is enabled; otherwise,false- See Also:
-
setEnabled
public void setEnabled(boolean b) Description copied from interface:AccessibleComponentSets the enabled state of the object.- Specified by:
setEnabledin interfaceAccessibleComponent- Parameters:
b- iftrue, enables this object; otherwise, disables it- See Also:
-
isVisible
public boolean isVisible()Description copied from interface:AccessibleComponentDetermines 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.VISIBLEstate set in theirAccessibleStateSets.- Specified by:
isVisiblein interfaceAccessibleComponent- Returns:
trueif object is visible; otherwise,false- See Also:
-
setVisible
public void setVisible(boolean b) Description copied from interface:AccessibleComponentSets the visible state of the object.- Specified by:
setVisiblein interfaceAccessibleComponent- Parameters:
b- iftrue, shows this object; otherwise, hides it- See Also:
-
isShowing
public boolean isShowing()Description copied from interface:AccessibleComponentDetermines if the object is showing. This is determined by checking the visibility of the object and its ancestors. Note: this will returntrueeven if the object is obscured by another (for example, it is underneath a menu that was pulled down).- Specified by:
isShowingin interfaceAccessibleComponent- Returns:
trueif object is showing; otherwise,false
-
contains
Description copied from interface:AccessibleComponentChecks 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:
containsin interfaceAccessibleComponent- Parameters:
p- the point relative to the coordinate system of the object- Returns:
trueif object contains point; otherwisefalse- See Also:
-
getLocationOnScreen
Description copied from interface:AccessibleComponentReturns the location of the object on the screen.- Specified by:
getLocationOnScreenin interfaceAccessibleComponent- Returns:
- the location of the object on screen;
nullif this object is not on the screen - See Also:
-
getLocation
Description copied from interface:AccessibleComponentGets 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:
getLocationin interfaceAccessibleComponent- Returns:
- An instance of
Pointrepresenting the top-left corner of the object's bounds in the coordinate space of the screen;nullif this object or its parent are not on the screen - See Also:
-
setLocation
Description copied from interface:AccessibleComponentSets the location of the object relative to the parent.- Specified by:
setLocationin interfaceAccessibleComponent- Parameters:
p- the new position for the top-left corner- See Also:
-
getBounds
Description copied from interface:AccessibleComponentGets the bounds of this object in the form of aRectangleobject. The bounds specify this object's width, height, and location relative to its parent.- Specified by:
getBoundsin interfaceAccessibleComponent- Returns:
- A rectangle indicating this component's bounds;
nullif this object is not on the screen. - See Also:
-
setBounds
Description copied from interface:AccessibleComponentSets the bounds of this object in the form of aRectangleobject. The bounds specify this object's width, height, and location relative to its parent.- Specified by:
setBoundsin interfaceAccessibleComponent- Parameters:
r- rectangle indicating this component's bounds- See Also:
-
getSize
Description copied from interface:AccessibleComponentReturns the size of this object in the form of aDimensionobject. Theheightfield of theDimensionobject contains this object's height, and thewidthfield of theDimensionobject contains this object's width.- Specified by:
getSizein interfaceAccessibleComponent- Returns:
- A
Dimensionobject that indicates the size of this component;nullif this object is not on the screen - See Also:
-
setSize
Description copied from interface:AccessibleComponentResizes this object so that it has width and height.- Specified by:
setSizein interfaceAccessibleComponent- Parameters:
d- The dimension specifying the new size of the object- See Also:
-
getAccessibleAt
Description copied from interface:AccessibleComponentReturns theAccessiblechild, if one exists, contained at the local coordinatePoint.- Specified by:
getAccessibleAtin 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:AccessibleComponentReturns whether this object can accept focus or not. Objects that can accept focus will also have theAccessibleState.FOCUSABLEstate set in theirAccessibleStateSets.- Specified by:
isFocusTraversablein interfaceAccessibleComponent- Returns:
trueif object can accept focus; otherwisefalse- See Also:
-
requestFocus
public void requestFocus()Description copied from interface:AccessibleComponentRequests focus for this object. If this object cannot accept focus, nothing will happen. Otherwise, the object will attempt to take focus.- Specified by:
requestFocusin interfaceAccessibleComponent- See Also:
-
addFocusListener
Description copied from interface:AccessibleComponentAdds the specified focus listener to receive focus events from this component.- Specified by:
addFocusListenerin interfaceAccessibleComponent- Parameters:
l- the focus listener- See Also:
-
removeFocusListener
Description copied from interface:AccessibleComponentRemoves the specified focus listener so it no longer receives focus events from this component.- Specified by:
removeFocusListenerin interfaceAccessibleComponent- Parameters:
l- the focus listener- See Also:
-
getAccessibleIcon
Returns the icon for the element renderer, as the only item of an array ofAccessibleIcons or anullarray if the renderer component contains no icons.- Overrides:
getAccessibleIconin classAccessibleContext- Returns:
- an array containing the accessible icon
or a
nullarray if none - Since:
- 1.3
- See Also:
-
getAccessibleAction
Gets theAccessibleActionassociated with this object that supports one or more actions.- Overrides:
getAccessibleActionin 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:
AccessibleActionif supported by object; else returnnull- Since:
- 9
- See Also:
-
doAccessibleAction
public boolean doAccessibleAction(int i) Performs the specified action on the object.- Specified by:
doAccessibleActionin 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:
trueif the action was performed; otherwisefalse- Since:
- 9
- See Also:
-
getAccessibleActionDescription
Returns a description of the specified action of the object.- Specified by:
getAccessibleActionDescriptionin 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
Stringdescription 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:
getAccessibleActionCountin interfaceAccessibleAction- Implementation Requirements:
- Returns 1, i.e. there is only one action.
- Returns:
- the zero-based number of actions in this object
- Since:
- 9
-