All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.accessibility.AccessibleStateSet

java.lang.Object
    |
    +----java.awt.accessibility.AccessibleStateSet

public class AccessibleStateSet

extends Object

Class used to determine the state set of a component. The state set of a component is a set of AccessibleState objects and describes the current overall state of the object, such as whether it is enabled, has focus, etc.

states

Each entry in the Vector represents an AccessibleState.

AccessibleStateSet()

Create a new empty state set.

AccessibleStateSet(AccessibleState[])

Create a new state with the initial set of states contained in the array of states passed in.

add(AccessibleState)

Add a new state to the current state set if it is not already present.

addAll(AccessibleState[])

Add all of the states to the existing state set.

clear()

Remove all the states from the current state set.

contains(AccessibleState)

See if the current state is in the state set.

remove(AccessibleState)

Remove a state from the current state set.

toArray()

Returns the current state set as an array of AccessibleState

toString()

Create a localized String representing all the modes set in the state using the default locale.

protected Vector states

Each entry in the Vector represents an AccessibleState.

See Also:

add, addAll, remove, contains, toArray, clear

public AccessibleStateSet()

Create a new empty state set.

public AccessibleStateSet(AccessibleState[] states)

Create a new state with the initial set of states contained in the array of states passed in. Duplicate entries are ignored.

Parameters:

state - an array of AccessibleState describing the state set.

public boolean add(AccessibleState state)

Add a new state to the current state set if it is not already present. If the state is already in the state set, the state set is unchanged and the return value is false. Otherwise, the state is added to the state set and the return value is true.

Parameters:

state - the state to add to the state set

Returns:

true if state is added to the state set; false id the state set is unchanged

public void addAll(AccessibleState[] states)

Add all of the states to the existing state set. Duplicate entries are ignored.

Parameters:

state - AccessibleState array describing the state set.

public boolean remove(AccessibleState state)

Remove a state from the current state set. If the state is not in the set, the state set will be unchanged and the return value will be false. If the state is in the state set, it will be removed from the set and the return value will be true.

Parameters:

state - the state to remove from the state set

Returns:

true is the state is in the state set; false if the state set will be unchanged

public void clear()

Remove all the states from the current state set.

public boolean contains(AccessibleState state)

See if the current state is in the state set.

Parameters:

state - the state

Returns:

true if the state is in the state set; otherwise false

public AccessibleState[] toArray()

Returns the current state set as an array of AccessibleState

Returns:

AccessibleState array conatining the current state.

public String toString()

Create a localized String representing all the modes set in the state using the default locale.

Returns:

comma separated localized String

Overrides:

toString in class Object

See Also:

toDisplayString

All Packages  Class Hierarchy  This Package  Previous  Next  Index