javax.accessibility
Class AccessibleRelationSet

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.accessibility.AccessibleRelationSet

public class AccessibleRelationSet
extends Object sample code for java.lang.Object definition code for java.lang.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.

See Also:
AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation

Field Summary
protected  Vector sample code for java.util.Vector definition code for java.util.Vector <AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation > relations sample code for javax.accessibility.AccessibleRelationSet.relations definition code for javax.accessibility.AccessibleRelationSet.relations
          Each entry in the Vector represents an AccessibleRelation.
 
Constructor Summary
AccessibleRelationSet sample code for javax.accessibility.AccessibleRelationSet.AccessibleRelationSet() definition code for javax.accessibility.AccessibleRelationSet.AccessibleRelationSet() ()
          Creates a new empty relation set.
AccessibleRelationSet sample code for javax.accessibility.AccessibleRelationSet.AccessibleRelationSet(javax.accessibility.AccessibleRelation[]) definition code for javax.accessibility.AccessibleRelationSet.AccessibleRelationSet(javax.accessibility.AccessibleRelation[]) (AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation [] relations)
          Creates a new relation with the initial set of relations contained in the array of relations passed in.
 
Method Summary
 boolean add sample code for javax.accessibility.AccessibleRelationSet.add(javax.accessibility.AccessibleRelation) definition code for javax.accessibility.AccessibleRelationSet.add(javax.accessibility.AccessibleRelation) (AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation  relation)
          Adds a new relation to the current relation set.
 void addAll sample code for javax.accessibility.AccessibleRelationSet.addAll(javax.accessibility.AccessibleRelation[]) definition code for javax.accessibility.AccessibleRelationSet.addAll(javax.accessibility.AccessibleRelation[]) (AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation [] relations)
          Adds all of the relations to the existing relation set.
 void clear sample code for javax.accessibility.AccessibleRelationSet.clear() definition code for javax.accessibility.AccessibleRelationSet.clear() ()
          Removes all the relations from the current relation set.
 boolean contains sample code for javax.accessibility.AccessibleRelationSet.contains(java.lang.String) definition code for javax.accessibility.AccessibleRelationSet.contains(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  key)
          Returns whether the relation set contains a relation that matches the specified key.
 AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation get sample code for javax.accessibility.AccessibleRelationSet.get(java.lang.String) definition code for javax.accessibility.AccessibleRelationSet.get(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  key)
          Returns the relation that matches the specified key.
 boolean remove sample code for javax.accessibility.AccessibleRelationSet.remove(javax.accessibility.AccessibleRelation) definition code for javax.accessibility.AccessibleRelationSet.remove(javax.accessibility.AccessibleRelation) (AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation  relation)
          Removes a relation from the current relation set.
 int size sample code for javax.accessibility.AccessibleRelationSet.size() definition code for javax.accessibility.AccessibleRelationSet.size() ()
          Returns the number of relations in the relation set.
 AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation [] toArray sample code for javax.accessibility.AccessibleRelationSet.toArray() definition code for javax.accessibility.AccessibleRelationSet.toArray() ()
          Returns the current relation set as an array of AccessibleRelation
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.accessibility.AccessibleRelationSet.toString() definition code for javax.accessibility.AccessibleRelationSet.toString() ()
          Creates a localized String representing all the relations in the set using the default locale.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

relations sample code for javax.accessibility.AccessibleRelationSet.relations

protected Vector sample code for java.util.Vector definition code for java.util.Vector <AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation > relations
Each entry in the Vector represents an AccessibleRelation.

See Also:
add(javax.accessibility.AccessibleRelation) sample code for javax.accessibility.AccessibleRelationSet.add(javax.accessibility.AccessibleRelation) definition code for javax.accessibility.AccessibleRelationSet.add(javax.accessibility.AccessibleRelation) , addAll(javax.accessibility.AccessibleRelation[]) sample code for javax.accessibility.AccessibleRelationSet.addAll(javax.accessibility.AccessibleRelation[]) definition code for javax.accessibility.AccessibleRelationSet.addAll(javax.accessibility.AccessibleRelation[]) , remove(javax.accessibility.AccessibleRelation) sample code for javax.accessibility.AccessibleRelationSet.remove(javax.accessibility.AccessibleRelation) definition code for javax.accessibility.AccessibleRelationSet.remove(javax.accessibility.AccessibleRelation) , contains(java.lang.String) sample code for javax.accessibility.AccessibleRelationSet.contains(java.lang.String) definition code for javax.accessibility.AccessibleRelationSet.contains(java.lang.String) , get(java.lang.String) sample code for javax.accessibility.AccessibleRelationSet.get(java.lang.String) definition code for javax.accessibility.AccessibleRelationSet.get(java.lang.String) , size() sample code for javax.accessibility.AccessibleRelationSet.size() definition code for javax.accessibility.AccessibleRelationSet.size() , toArray() sample code for javax.accessibility.AccessibleRelationSet.toArray() definition code for javax.accessibility.AccessibleRelationSet.toArray() , clear() sample code for javax.accessibility.AccessibleRelationSet.clear() definition code for javax.accessibility.AccessibleRelationSet.clear()
Constructor Detail

AccessibleRelationSet sample code for javax.accessibility.AccessibleRelationSet() definition code for javax.accessibility.AccessibleRelationSet()

public AccessibleRelationSet()
Creates a new empty relation set.


AccessibleRelationSet sample code for javax.accessibility.AccessibleRelationSet(javax.accessibility.AccessibleRelation[]) definition code for javax.accessibility.AccessibleRelationSet(javax.accessibility.AccessibleRelation[])

public AccessibleRelationSet(AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.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 of AccessibleRelation describing the relation set.
Method Detail

add sample code for javax.accessibility.AccessibleRelationSet.add(javax.accessibility.AccessibleRelation) definition code for javax.accessibility.AccessibleRelationSet.add(javax.accessibility.AccessibleRelation)

public boolean add(AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.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 sample code for javax.accessibility.AccessibleRelationSet.addAll(javax.accessibility.AccessibleRelation[]) definition code for javax.accessibility.AccessibleRelationSet.addAll(javax.accessibility.AccessibleRelation[])

public void addAll(AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.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 sample code for javax.accessibility.AccessibleRelationSet.remove(javax.accessibility.AccessibleRelation) definition code for javax.accessibility.AccessibleRelationSet.remove(javax.accessibility.AccessibleRelation)

public boolean remove(AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.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 sample code for javax.accessibility.AccessibleRelationSet.clear() definition code for javax.accessibility.AccessibleRelationSet.clear()

public void clear()
Removes all the relations from the current relation set.


size sample code for javax.accessibility.AccessibleRelationSet.size() definition code for javax.accessibility.AccessibleRelationSet.size()

public int size()
Returns the number of relations in the relation set.


contains sample code for javax.accessibility.AccessibleRelationSet.contains(java.lang.String) definition code for javax.accessibility.AccessibleRelationSet.contains(java.lang.String)

public boolean contains(String sample code for java.lang.String definition code for java.lang.String  key)
Returns whether the relation set contains a relation that matches the specified key.

Parameters:
key - the AccessibleRelation key
Returns:
true if the relation is in the relation set; otherwise false

get sample code for javax.accessibility.AccessibleRelationSet.get(java.lang.String) definition code for javax.accessibility.AccessibleRelationSet.get(java.lang.String)

public AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation  get(String sample code for java.lang.String definition code for java.lang.String  key)
Returns the relation that matches the specified key.

Parameters:
key - the AccessibleRelation key
Returns:
the relation, if one exists, that matches the specified key. Otherwise, null is returned.

toArray sample code for javax.accessibility.AccessibleRelationSet.toArray() definition code for javax.accessibility.AccessibleRelationSet.toArray()

public AccessibleRelation sample code for javax.accessibility.AccessibleRelation definition code for javax.accessibility.AccessibleRelation [] toArray()
Returns the current relation set as an array of AccessibleRelation

Returns:
AccessibleRelation array contacting the current relation.

toString sample code for javax.accessibility.AccessibleRelationSet.toString() definition code for javax.accessibility.AccessibleRelationSet.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Creates a localized String representing all the relations in the set using the default locale.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
comma separated localized String
See Also:
AccessibleBundle.toDisplayString(java.lang.String, java.util.Locale) sample code for javax.accessibility.AccessibleBundle.toDisplayString(java.lang.String, java.util.Locale) definition code for javax.accessibility.AccessibleBundle.toDisplayString(java.lang.String, java.util.Locale)