javax.accessibility
Class AccessibleRelationSet
java.lang.Object
|
+--javax.accessibility.AccessibleRelationSet
public class
AccessibleRelationSetextends
Object Describes all relations of an accessible object. For example, an object
by labeled by one object and control another.
Since:Author:- Eric Blake <ebb9@email.byu.edu>
See Also:
relations
protected Vector relations
The list of relations, should be instances of AccessibleRelation. Don't
set this to null.
See Also:
AccessibleRelationSet
public AccessibleRelationSet()
Create an empty relation set.
AccessibleRelationSet
public AccessibleRelationSet(javax.accessibility.AccessibleRelation[] relations)
Create a relation set initialized with the given relations, duplicates are
ignored.
Parameters:
Throws:
add
public boolean add(javax.accessibility.AccessibleRelation relation)
Add a new relation to the current set. If the relation is already in
the set, the targets are merged with the existing relation, possibly
resulting in an object being in the target list more than once. Do not
add a relation with a null key, as it will cause problems later.
Parameters:
Returns:
- true if the set was modified, which is always the case
Throws:
addAll
public void addAll(javax.accessibility.AccessibleRelation[] array)
Add all of the relations to the current set. Duplicates are ignored.
Parameters:
Throws:
clear
public void clear()
Clear all relations in the set.
contains
public boolean contains(java.lang.String key)
Check if the relation key is in the set.
Parameters:
Returns:
get
public AccessibleRelation get(java.lang.String key)
Get the relation that matches the key.
Parameters:
Returns:
- the relation in the set, or null
remove
public boolean remove(javax.accessibility.AccessibleRelation relation)
Remove a relation from the set. If a relation was removed, return true.
Note that this uses AccessibleRelation.equals, which defaults to ==, so a
relation with the same key may still exist in the set afterwords.
Parameters:
Returns:
size
public int size()
Return the number of relations in the set.
Returns:
toArray
public AccessibleRelation[] toArray()
Return the relation set as an array.
Returns:
- an array of the current relations
toString
public String toString()
Return a localized, comma-separated string representing all relations
in the set. This is in arbitrary order.
Returns:
- the string representation
See Also: