AccessibleStateSet (Java SE 15 & JDK 15) (original) (raw)

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:

AccessibleState

• Field Summary

Fields

• Constructor Summary

Constructors

• Method Summary

• Field Details

  • states

  Each entry in the Vector represents an AccessibleState.
  See Also:
  add(javax.accessibility.AccessibleState), addAll(javax.accessibility.AccessibleState[]), remove(javax.accessibility.AccessibleState), contains(javax.accessibility.AccessibleState), toArray(), clear()

• Constructor Details

  • AccessibleStateSet

  public AccessibleStateSet()
  Creates a new empty state set.

  • AccessibleStateSet

  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

  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

  Adds all of the states to the existing state set. Duplicate entries are ignored.
  Parameters:
  states - AccessibleState array describing the state set

  • remove

  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 befalse. 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

  Checks if the current state is in the state set.
  Parameters:
  state - the state
  Returns:
  true if the state is in the state set; otherwisefalse

  • toArray

  Returns the current state set as an array of AccessibleState.
  Returns:
  AccessibleState array containing the current state

  • toString

  Creates a localized string representing all the states in the set using the default locale.
  Overrides:
  [toString](../../../java.base/java/lang/Object.html#toString%28%29) in class [Object](../../../java.base/java/lang/Object.html "class in java.lang")
  Returns:
  comma separated localized string
  See Also:
  AccessibleBundle.toDisplayString(java.lang.String, java.util.Locale)