Class AccessibleRelationSet
- java.lang.Object
-
- javax.accessibility.AccessibleRelationSet
public class AccessibleRelationSet extends Object
Class AccessibleRelationSet
determines a component's relation set. The relation set of a component is a set of AccessibleRelation
objects that describe the component's relationships with other components.
- Since:
- 1.3
- See Also:
AccessibleRelation
Field Summary
Modifier and Type | Field | Description |
---|---|---|
protected Vector<AccessibleRelation> | relations | Each entry in the |
Constructor Summary
Constructor | Description |
---|---|
AccessibleRelationSet() | Creates a new empty relation set. |
AccessibleRelationSet(AccessibleRelation[] relations) | Creates a new relation with the initial set of relations contained in the array of relations passed in. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | add(AccessibleRelation relation) | Adds a new relation to the current relation set. |
void | addAll(AccessibleRelation[] relations) | Adds all of the relations to the existing relation set. |
void | clear() | Removes all the relations from the current relation set. |
boolean | contains(String key) | Returns whether the relation set contains a relation that matches the specified key. |
AccessibleRelation | get(String key) | Returns the relation that matches the specified key. |
boolean | remove(AccessibleRelation relation) | Removes a relation from the current relation set. |
int | size() | Returns the number of relations in the relation set. |
AccessibleRelation[] | toArray() | Returns the current relation set as an array of |
String | toString() | Creates a localized string representing all the relations in the set using the default locale. |
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Field Detail
relations
protected Vector<AccessibleRelation> relations
Each entry in the Vector
represents an AccessibleRelation
.
Constructor Detail
AccessibleRelationSet
public AccessibleRelationSet()
Creates a new empty relation set.
AccessibleRelationSet
public AccessibleRelationSet(AccessibleRelation[] relations)
Creates a new relation with the initial set of relations contained in the array of relations passed in. Duplicate entries are ignored.
- Parameters:
-
relations
- an array ofAccessibleRelation
describing the relation set
Method Detail
add
public boolean add(AccessibleRelation relation)
Adds a new relation to the current relation set. If the relation is already in the relation set, the target(s) of the specified relation is merged with the target(s) of the existing relation. Otherwise, the new relation is added to the relation set.
- Parameters:
-
relation
- the relation to add to the relation set - Returns:
-
true
if relation is added to the relation set;false
if the relation set is unchanged
addAll
public void addAll(AccessibleRelation[] relations)
Adds all of the relations to the existing relation set. Duplicate entries are ignored.
- Parameters:
-
relations
-AccessibleRelation
array describing the relation set
remove
public boolean remove(AccessibleRelation relation)
Removes a relation from the current relation set. If the relation is not in the set, the relation set will be unchanged and the return value will be false
. If the relation is in the relation set, it will be removed from the set and the return value will be true
.
- Parameters:
-
relation
- the relation to remove from the relation set - Returns:
-
true
if the relation is in the relation set;false
if the relation set is unchanged
clear
public void clear()
Removes all the relations from the current relation set.
size
public int size()
Returns the number of relations in the relation set.
- Returns:
- the number of relations in the relation set
contains
public boolean contains(String key)
Returns whether the relation set contains a relation that matches the specified key.
- Parameters:
-
key
- theAccessibleRelation
key - Returns:
-
true
if the relation is in the relation set; otherwisefalse
get
public AccessibleRelation get(String key)
Returns the relation that matches the specified key.
- Parameters:
-
key
- theAccessibleRelation
key - Returns:
- the relation, if one exists, that matches the specified key. Otherwise,
null
is returned.
toArray
public AccessibleRelation[] toArray()
Returns the current relation set as an array of AccessibleRelation
.
- Returns:
-
AccessibleRelation
array contacting the current relation
toString
public String toString()
Creates a localized string representing all the relations in the set using the default locale.
- Overrides:
-
toString
in classObject
- Returns:
- comma separated localized string
- See Also:
AccessibleBundle.toDisplayString(java.lang.String, java.util.Locale)