javax.accessibility

Class 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
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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

states

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

Constructor Details

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 Details

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

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

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

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 interface Object
Returns:
the string representation

AccessibleStateSet.java -- the combined state of an accessible object Copyright (C) 2002, 2005 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.