Class AccessibleStateSet

java.lang.Object
javax.accessibility.AccessibleStateSet

public class AccessibleStateSet extends Object
Class AccessibleStateSet determines a component's state set. The state set of a component is a set of AccessibleState objects and descriptions. E.G., The current overall state of the object, such as whether it is enabled, has focus, etc.
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    Each entry in the Vector represents an AccessibleState.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates a new empty state set.
    Creates a new state with the initial set of states contained in the array of states passed in.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Adds a new state to the current state set if it is not already present.
    void
    Adds all of the states to the existing state set.
    void
    Removes all the states from the current state set.
    boolean
    Checks if the current state is in the state set.
    boolean
    Removes a state from the current state set.
    Returns the current state set as an array of AccessibleState.
    Creates a localized string representing all the states in the set using the default locale.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    Creates and returns a copy of this object.
    boolean
    Indicates whether some other object is "equal to" this one.
    protected void
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    Returns the runtime class of this Object.
    int
    Returns a hash code value for this object.
    final void
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    Wakes up all threads that are waiting on this object's monitor.
    final void
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
  • Field Details

  • Constructor Details

    • AccessibleStateSet

      public AccessibleStateSet()
      Creates a new empty state set.
    • AccessibleStateSet

      public AccessibleStateSet(AccessibleState[] states)
      Creates a new state with the initial set of states contained in the array of states passed in. Duplicate entries are ignored.
      Parameters:
      states - an array of AccessibleState describing the state set
  • Method Details

    • add

      public boolean add(AccessibleState state)
      Adds 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 if the state set is unchanged
    • addAll

      public void addAll(AccessibleState[] states)
      Adds all of the states to the existing state set. Duplicate entries are ignored.
      Parameters:
      states - AccessibleState array describing the state set
    • remove

      public boolean remove(AccessibleState state)
      Removes 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 if the state is in the state set; false if the state set will be unchanged
    • clear

      public void clear()
      Removes all the states from the current state set.
    • contains

      public boolean contains(AccessibleState state)
      Checks 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
    • toArray

      public AccessibleState[] toArray()
      Returns the current state set as an array of AccessibleState.
      Returns:
      AccessibleState array containing the current state
    • toString

      public String toString()
      Creates a localized string representing all the states in the set using the default locale.
      Overrides:
      toString in class Object
      Returns:
      comma separated localized string
      See Also: