javax.accessibility

Class 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

UNKNOWN: updated to 1.4

Field Summary
static StringCHILD_NODE_OF
Indicates that an object is a child of another object.
static StringCHILD_NODE_OF_PROPERTY
Indicates that the ancestry relationship has changed.
static StringCONTROLLED_BY
Indicates an object is controlled by other objects.
static StringCONTROLLED_BY_PROPERTY
Indicates that the controlling objects have changed.
static StringCONTROLLER_FOR
Indicates an object is a controller for other objects.
static StringCONTROLLER_FOR_PROPERTY
Indicates that the controller target group has changed.
static StringEMBEDDED_BY
Indicates that an object is embedded by another object.
static StringEMBEDDED_BY_PROPERTY
Indicates that the {@link #EMBEDDED_BY} property changed.
static StringEMBEDS
Indicates that an object embeds another object.
static StringEMBEDS_PROPERTY
Indicates that the {@link #EMBEDS} property changed.
static StringFLOWS_FROM
Indicates that one object directly follows another object, as in a paragraph flow.
static StringFLOWS_FROM_PROPERTY
Indicates that the {@link #FLOWS_FROM} property changed.
static StringFLOWS_TO
Indicates that one object comes directly before another object, as in a paragraph flow.
static StringFLOWS_TO_PROPERTY
Indicates that the {@link #FLOWS_TO} property changed.
static StringLABELED_BY
Indicates the object is labeled by other objects.
static StringLABELED_BY_PROPERTY
Indicates that the labelling objects have changed.
static StringLABEL_FOR
Indicates the object labels other objects.
static StringLABEL_FOR_PROPERTY
Indicates that the label target group has changed.
static StringMEMBER_OF
Indicates an object is a member of a group of target objects.
static StringMEMBER_OF_PROPERTY
Indicates that group membership has changed.
static StringPARENT_WINDOW_OF
Indicates that one object is a parent window of another object.
static StringPARENT_WINDOW_OF_PROPERTY
Indicates that the {@link #PARENT_WINDOW_OF} property changed.
static StringSUBWINDOW_OF
Indicates that one object is a subwindow of another object.
static StringSUBWINDOW_OF_PROPERTY
Indicates that the {@link #SUBWINDOW_OF} property changed.
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
StringgetKey()
Return the key for this relation.
Object[]getTarget()
Return the targets of this relation.
voidsetTarget(Object target)
Set the target to a single object.
voidsetTarget(Object[] targets)
Set the target to an array of objects.

Field Detail

CHILD_NODE_OF

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

Since: 1.5

CHILD_NODE_OF_PROPERTY

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

Since: 1.5

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

CONTROLLED_BY_PROPERTY

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

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

CONTROLLER_FOR_PROPERTY

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

EMBEDDED_BY

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

Since: 1.5

EMBEDDED_BY_PROPERTY

public static final String EMBEDDED_BY_PROPERTY
Indicates that the {@link #EMBEDDED_BY} property changed.

Since: 1.5

EMBEDS

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

Since: 1.5

EMBEDS_PROPERTY

public static final String EMBEDS_PROPERTY
Indicates that the {@link #EMBEDS} property changed.

Since: 1.5

FLOWS_FROM

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

Since: 1.5

FLOWS_FROM_PROPERTY

public static final String FLOWS_FROM_PROPERTY
Indicates that the {@link #FLOWS_FROM} property changed.

Since: 1.5

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

FLOWS_TO_PROPERTY

public static final String FLOWS_TO_PROPERTY
Indicates that the {@link #FLOWS_TO} property changed.

Since: 1.5

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

LABELED_BY_PROPERTY

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

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

LABEL_FOR_PROPERTY

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

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

MEMBER_OF_PROPERTY

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

PARENT_WINDOW_OF

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

Since: 1.5

PARENT_WINDOW_OF_PROPERTY

public static final String PARENT_WINDOW_OF_PROPERTY
Indicates that the {@link #PARENT_WINDOW_OF} property changed.

Since: 1.5

SUBWINDOW_OF

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

Since: 1.5

SUBWINDOW_OF_PROPERTY

public static final String SUBWINDOW_OF_PROPERTY
Indicates that the {@link #SUBWINDOW_OF} property changed.

Since: 1.5

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: AccessibleRelation

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: AccessibleRelation

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: AccessibleRelation

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