javax.accessibility
Class AccessibleStateSet

java.lang.Object
  extended by javax.accessibility.AccessibleStateSet

public class AccessibleStateSet
extends Object

Describes all elements of an accessible object's state. For example, an object may be enabled and have focus.

Since:
1.2
See Also:
AccessibleState

Field Summary
protected  Vector<AccessibleState> states
          The list of states, should be instances of AccessibleState.
 
Constructor Summary
AccessibleStateSet()
          Create an empty state set.
AccessibleStateSet(AccessibleState[] states)
          Create a state set initialized with the given states, duplicates are ignored.
 
Method Summary
 boolean add(AccessibleState state)
          Add a new state to the current set.
 void addAll(AccessibleState[] array)
          Add all of the states to the current set.
 void clear()
          Clear all states in the set.
 boolean contains(AccessibleState state)
          Check if the current state is in the set.
 boolean remove(AccessibleState state)
          Remove a state from the set.
 AccessibleState[] toArray()
          Return the state set as an array.
 String toString()
          Return a localized, comma-separated string representing all states in the set.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

states

protected Vector<AccessibleState> states
The list of states, should be instances of AccessibleState. Don't set this to null.

See Also:
add(AccessibleState), addAll(AccessibleState[]), remove(AccessibleState), contains(AccessibleState), toArray(), clear()
Constructor Detail

AccessibleStateSet

public AccessibleStateSet()
Create an empty state set.


AccessibleStateSet

public AccessibleStateSet(AccessibleState[] states)
Create a state set initialized with the given states, duplicates are ignored.

Parameters:
states - the states to insert
Throws:
NullPointerException - if states is null
Method Detail

add

public boolean add(AccessibleState state)
Add a new state to the current set. Return true if the state was added, as duplicates are ignored. Entering a null state will cause problems later, so don't do it.

Parameters:
state - the state to add
Returns:
true if the state was added

addAll

public void addAll(AccessibleState[] array)
Add all of the states to the current set. Duplicates are ignored. Entering a null state will cause problems later, so don't do it.

Parameters:
array - the array of states to add
Throws:
NullPointerException - if array is null

remove

public boolean remove(AccessibleState state)
Remove a state from the set. If a state was removed, return true.

Parameters:
state - the state to remove
Returns:
true if the set changed

clear

public void clear()
Clear all states in the set.


contains

public boolean contains(AccessibleState state)
Check if the current state is in the set.

Parameters:
state - the state to locate
Returns:
true if it is in the set

toArray

public AccessibleState[] toArray()
Return the state set as an array.

Returns:
an array of the current states

toString

public String toString()
Return a localized, comma-separated string representing all states in the set. This is in arbitrary order.

Overrides:
toString in class Object
Returns:
the string representation
See Also:
AccessibleBundle.toDisplayString(String, Locale)