javax.accessibility
Class AccessibleRelation

java.lang.Object
  extended by javax.accessibility.AccessibleBundle
      extended by javax.accessibility.AccessibleRelation

public class AccessibleRelation
extends AccessibleBundle

The relation between one accessible object and one or more other objects. For example, a button may control an action. An AccessibleRelationSet summarizes all relations of the object. This strongly typed "enumeration" supports localized strings. If the constants of this class are not adequate, new ones may be added in a similar matter.

Since:
1.2

Field Summary
static String CHILD_NODE_OF
          Indicates that an object is a child of another object.
static String CHILD_NODE_OF_PROPERTY
          Indicates that the ancestry relationship has changed.
static String CONTROLLED_BY
          Indicates an object is controlled by other objects.
static String CONTROLLED_BY_PROPERTY
          Indicates that the controlling objects have changed.
static String CONTROLLER_FOR
          Indicates an object is a controller for other objects.
static String CONTROLLER_FOR_PROPERTY
          Indicates that the controller target group has changed.
static String EMBEDDED_BY
          Indicates that an object is embedded by another object.
static String EMBEDDED_BY_PROPERTY
          Indicates that the EMBEDDED_BY property changed.
static String EMBEDS
          Indicates that an object embeds another object.
static String EMBEDS_PROPERTY
          Indicates that the EMBEDS property changed.
static String FLOWS_FROM
          Indicates that one object directly follows another object, as in a paragraph flow.
static String FLOWS_FROM_PROPERTY
          Indicates that the FLOWS_FROM property changed.
static String FLOWS_TO
          Indicates that one object comes directly before another object, as in a paragraph flow.
static String FLOWS_TO_PROPERTY
          Indicates that the FLOWS_TO property changed.
static String LABEL_FOR
          Indicates the object labels other objects.
static String LABEL_FOR_PROPERTY
          Indicates that the label target group has changed.
static String LABELED_BY
          Indicates the object is labeled by other objects.
static String LABELED_BY_PROPERTY
          Indicates that the labelling objects have changed.
static String MEMBER_OF
          Indicates an object is a member of a group of target objects.
static String MEMBER_OF_PROPERTY
          Indicates that group membership has changed.
static String PARENT_WINDOW_OF
          Indicates that one object is a parent window of another object.
static String PARENT_WINDOW_OF_PROPERTY
          Indicates that the PARENT_WINDOW_OF property changed.
static String SUBWINDOW_OF
          Indicates that one object is a subwindow of another object.
static String SUBWINDOW_OF_PROPERTY
          Indicates that the SUBWINDOW_OF property changed.
 
Fields inherited from class javax.accessibility.AccessibleBundle
key
 
Constructor Summary
AccessibleRelation(String key)
          Create a new relation with a locale independent key, and no related objects.
AccessibleRelation(String key, Object target)
          Create a new relation with a locale independent key, and a single related object.
AccessibleRelation(String key, Object[] targets)
          Create a new relation with a locale independent key, and the given related objects.
 
Method Summary
 String getKey()
          Return the key for this relation.
 Object[] getTarget()
          Return the targets of this relation.
 void setTarget(Object target)
          Set the target to a single object.
 void setTarget(Object[] targets)
          Set the target to an array of objects.
 
Methods inherited from class javax.accessibility.AccessibleBundle
toDisplayString, toDisplayString, toDisplayString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LABEL_FOR

public static final String LABEL_FOR
Indicates the object labels other objects.

See Also:
getTarget(), CONTROLLER_FOR, CONTROLLED_BY, LABELED_BY, MEMBER_OF

LABELED_BY

public static final String LABELED_BY
Indicates the object is labeled by other objects.

See Also:
getTarget(), CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, MEMBER_OF

MEMBER_OF

public static final String MEMBER_OF
Indicates an object is a member of a group of target objects.

See Also:
getTarget(), CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, LABELED_BY

CONTROLLER_FOR

public static final String CONTROLLER_FOR
Indicates an object is a controller for other objects.

See Also:
getTarget(), CONTROLLED_BY, LABEL_FOR, LABELED_BY, MEMBER_OF

CONTROLLED_BY

public static final String CONTROLLED_BY
Indicates an object is controlled by other objects.

See Also:
getTarget(), CONTROLLER_FOR, LABEL_FOR, LABELED_BY, MEMBER_OF

LABEL_FOR_PROPERTY

public static final String LABEL_FOR_PROPERTY
Indicates that the label target group has changed.

See Also:
Constant Field Values

LABELED_BY_PROPERTY

public static final String LABELED_BY_PROPERTY
Indicates that the labelling objects have changed.

See Also:
Constant Field Values

MEMBER_OF_PROPERTY

public static final String MEMBER_OF_PROPERTY
Indicates that group membership has changed.

See Also:
Constant Field Values

CONTROLLER_FOR_PROPERTY

public static final String CONTROLLER_FOR_PROPERTY
Indicates that the controller target group has changed.

See Also:
Constant Field Values

CONTROLLED_BY_PROPERTY

public static final String CONTROLLED_BY_PROPERTY
Indicates that the controlling objects have changed.

See Also:
Constant Field Values

CHILD_NODE_OF

public static final String CHILD_NODE_OF
Indicates that an object is a child of another object.

Since:
1.5
See Also:
Constant Field Values

CHILD_NODE_OF_PROPERTY

public static final String CHILD_NODE_OF_PROPERTY
Indicates that the ancestry relationship has changed.

Since:
1.5
See Also:
Constant Field Values

EMBEDDED_BY

public static final String EMBEDDED_BY
Indicates that an object is embedded by another object.

Since:
1.5
See Also:
Constant Field Values

EMBEDDED_BY_PROPERTY

public static final String EMBEDDED_BY_PROPERTY
Indicates that the EMBEDDED_BY property changed.

Since:
1.5
See Also:
Constant Field Values

EMBEDS

public static final String EMBEDS
Indicates that an object embeds another object.

Since:
1.5
See Also:
Constant Field Values

EMBEDS_PROPERTY

public static final String EMBEDS_PROPERTY
Indicates that the EMBEDS property changed.

Since:
1.5
See Also:
Constant Field Values

FLOWS_FROM

public static final String FLOWS_FROM
Indicates that one object directly follows another object, as in a paragraph flow.

Since:
1.5
See Also:
Constant Field Values

FLOWS_FROM_PROPERTY

public static final String FLOWS_FROM_PROPERTY
Indicates that the FLOWS_FROM property changed.

Since:
1.5
See Also:
Constant Field Values

FLOWS_TO

public static final String FLOWS_TO
Indicates that one object comes directly before another object, as in a paragraph flow.

Since:
1.5
See Also:
Constant Field Values

FLOWS_TO_PROPERTY

public static final String FLOWS_TO_PROPERTY
Indicates that the FLOWS_TO property changed.

Since:
1.5
See Also:
Constant Field Values

PARENT_WINDOW_OF

public static final String PARENT_WINDOW_OF
Indicates that one object is a parent window of another object.

Since:
1.5
See Also:
Constant Field Values

PARENT_WINDOW_OF_PROPERTY

public static final String PARENT_WINDOW_OF_PROPERTY
Indicates that the PARENT_WINDOW_OF property changed.

Since:
1.5
See Also:
Constant Field Values

SUBWINDOW_OF

public static final String SUBWINDOW_OF
Indicates that one object is a subwindow of another object.

Since:
1.5
See Also:
Constant Field Values

SUBWINDOW_OF_PROPERTY

public static final String SUBWINDOW_OF_PROPERTY
Indicates that the SUBWINDOW_OF property changed.

Since:
1.5
See Also:
Constant Field Values
Constructor Detail

AccessibleRelation

public AccessibleRelation(String key)
Create a new relation with a locale independent key, and no related objects.

Parameters:
key - the name of the role
See Also:
AccessibleBundle.toDisplayString(String, Locale)

AccessibleRelation

public AccessibleRelation(String key,
                          Object target)
Create a new relation with a locale independent key, and a single related object.

Parameters:
key - the name of the role
target - the related object
See Also:
AccessibleBundle.toDisplayString(String, Locale)

AccessibleRelation

public AccessibleRelation(String key,
                          Object[] targets)
Create a new relation with a locale independent key, and the given related objects.

Parameters:
key - the name of the role
targets - the related objects
See Also:
AccessibleBundle.toDisplayString(String, Locale)
Method Detail

getKey

public String getKey()
Return the key for this relation.

Returns:
the key
See Also:
CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, LABELED_BY, MEMBER_OF

getTarget

public Object[] getTarget()
Return the targets of this relation.

Returns:
the targets, may be empty, but never null

setTarget

public void setTarget(Object target)
Set the target to a single object.

Parameters:
target - the new target

setTarget

public void setTarget(Object[] targets)
Set the target to an array of objects.

Parameters:
targets - the new targets