javax.accessibility

Interface AccessibleSelection

All Known Implementing Classes:

CheckboxMenuItem.AccessibleAWTCheckboxMenuItem, JComboBox.AccessibleJComboBox, JList.AccessibleJList, JMenu.AccessibleJMenu, JMenuBar.AccessibleJMenuBar, JTabbedPane.AccessibleJTabbedPane, JTable.AccessibleJTable, JTree.AccessibleJTree, JTree.AccessibleJTree.AccessibleJTreeNode, List.AccessibleAWTList, Menu.AccessibleAWTMenu, MenuBar.AccessibleAWTMenuBar, MenuComponent.AccessibleAWTMenuComponent, MenuItem.AccessibleAWTMenuItem, PopupMenu.AccessibleAWTPopupMenu

public interface AccessibleSelection

If an object implements this interface then it must be able to control the selection of its children. Accessibility software can use the implementations of this interface to change the selection set of children.

The AccessibleContext.getAccessibleSelection() method should return null if an object does not implement this interface.

Since:

1.2

See Also:

Accessible, AccessibleContext, AccessibleContext.getAccessibleSelection()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAccessibleSelection(int i) Select the specified child if it is not already selected, placing it in the object's current selection.
void	clearAccessibleSelection() Unselect all children of this Accessible object.
Accessible	getAccessibleSelection(int i) Returns the i-th selected child (not necessarily the overall i-th child) of this Accessible object.
int	getAccessibleSelectionCount() Returns the number of currently selected Accessible children, which may be 0 if nothing is selected.
boolean	isAccessibleChildSelected(int i) Determine if i-th overall child of this accessible object is selected.
void	removeAccessibleSelection(int i) Unselect the specified child of this Accessible object.
void	selectAllAccessibleSelection() Select all children of this Accessible object if the object supports multiple selections or has a single child.

Method Detail

getAccessibleSelectionCount

int getAccessibleSelectionCount()

Returns the number of currently selected Accessible children, which may be 0 if nothing is selected.

Returns:

the number of selected children

getAccessibleSelection

Accessible getAccessibleSelection(int i)

Returns the i-th selected child (not necessarily the overall i-th child) of this Accessible object. If i is out of bounds, null is returned.

Parameters:

i - zero-based index of selected child objects

Returns:

the Accessible child, or null

See Also:

getAccessibleSelectionCount()

isAccessibleChildSelected

boolean isAccessibleChildSelected(int i)

Determine if i-th overall child of this accessible object is selected. If i is out of bounds, false is returned.

Parameters:

i - zero-based index of child objects

Returns:

true if specified child exists and is selected

addAccessibleSelection

void addAccessibleSelection(int i)

Select the specified child if it is not already selected, placing it in the object's current selection. If the object does not support multiple selections then the new selection replaces the old. If the specified child is already selected, or is out of bounds, this method does nothing.

Parameters:

i - zero-based index of child objects

removeAccessibleSelection

void removeAccessibleSelection(int i)

Unselect the specified child of this Accessible object. If the specified child is not selected, or is out of bounds, this method does nothing.

Parameters:

i - the zero-based index of the child objects

clearAccessibleSelection

void clearAccessibleSelection()

Unselect all children of this Accessible object.

selectAllAccessibleSelection

void selectAllAccessibleSelection()

Select all children of this Accessible object if the object supports multiple selections or has a single child. Otherwise this does nothing.