Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
javax.accessibility

Interface AccessibleSelection

java.lang.Object
|
+--javax.accessibility.AccessibleSelection


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:Author:See Also:

Method Summary

voidaddAccessibleSelection(int i)

Select the specified child if it is not already selected, placing it in the object's current selection.
voidclearAccessibleSelection()

Unselect all children of this Accessible object.
javax.accessibility.AccessiblegetAccessibleSelection(int i)

Returns the i-th selected child (not necessarily the overall i-th child) of this Accessible object.
intgetAccessibleSelectionCount()

Returns the number of currently selected Accessible children, which may be 0 if nothing is selected.
booleanisAccessibleChildSelected(int i)

Determine if i-th overall child of this accessible object is selected.
voidremoveAccessibleSelection(int i)

Unselect the specified child of this Accessible object.
voidselectAllAccessibleSelection()

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

Method Details

addAccessibleSelection

public 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:


clearAccessibleSelection

public void clearAccessibleSelection()

Unselect all children of this Accessible object.


getAccessibleSelection

public 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:

Returns:

See Also:


getAccessibleSelectionCount

public int getAccessibleSelectionCount()

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

Returns:


isAccessibleChildSelected

public 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:

Returns:


removeAccessibleSelection

public 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:


selectAllAccessibleSelection

public void selectAllAccessibleSelection()

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