Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
javax.accessibility

Class AccessibleRelationSet

java.lang.Object
|
+--javax.accessibility.AccessibleRelationSet


public class AccessibleRelationSet

extends Object

Describes all relations of an accessible object. For example, an object by labeled by one object and control another.

Since:Author:See Also:

Field Summary

java.util.Vectorrelations

The list of relations, should be instances of AccessibleRelation.

Constructor Summary

AccessibleRelationSet()

Create an empty relation set.
AccessibleRelationSet(javax.accessibility.AccessibleRelation[] relations)

Create a relation set initialized with the given relations, duplicates are ignored.

Method Summary

booleanadd(javax.accessibility.AccessibleRelation relation)

Add a new relation to the current set.
voidaddAll(javax.accessibility.AccessibleRelation[] array)

Add all of the relations to the current set.
voidclear()

Clear all relations in the set.
booleancontains(java.lang.String key)

Check if the relation key is in the set.
javax.accessibility.AccessibleRelationget(java.lang.String key)

Get the relation that matches the key.
booleanremove(javax.accessibility.AccessibleRelation relation)

Remove a relation from the set.
intsize()

Return the number of relations in the set.
javax.accessibility.AccessibleRelation[]toArray()

Return the relation set as an array.
java.lang.StringtoString()

Return a localized, comma-separated string representing all relations in the set.

Field Details

relations

protected Vector relations

The list of relations, should be instances of AccessibleRelation. Don't set this to null.

See Also:


Constructor Details

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:


Method Details

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:

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:


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:


toString

public String toString()

Return a localized, comma-separated string representing all relations in the set. This is in arbitrary order.

Returns:

See Also: