public class

AccessibleRelation

extends AccessibleBundle
java.lang.Object
   ↳ javax.accessibility.AccessibleBundle
     ↳ javax.accessibility.AccessibleRelation

Class Overview

Class AccessibleRelation describes a relation between the object that implements the AccessibleRelation and one or more other objects. The actual relations that an object has with other objects are defined as an AccessibleRelationSet, which is a composed set of AccessibleRelations.

The toDisplayString method allows you to obtain the localized string for a locale independent key from a predefined ResourceBundle for the keys defined in this class.

The constants in this class present a strongly typed enumeration of common object roles. If the constants in this class are not sufficient to describe the role of an object, a subclass should be generated from this class and it should provide constants in a similar manner.

Summary

Constants
String CHILD_NODE_OF Indicates that an object is a child node of one or more objects.
String CHILD_NODE_OF_PROPERTY Indicates the CHILD_NODE_OF relation between two or more objects has changed.
String CONTROLLED_BY_PROPERTY Identifies that the target object that is doing the controlling has changed
String CONTROLLER_FOR_PROPERTY Identifies that the controller for the target object has changed
String EMBEDDED_BY Indicates that an object is embedded in one or more objects.
String EMBEDDED_BY_PROPERTY Indicates the EMBEDDED_BY relation between two or more objects has changed.
String EMBEDS Indicates that an object has one or more objects embedded in it.
String EMBEDS_PROPERTY Indicates the EMBEDS relation between two or more objects has changed.
String FLOWS_FROM Indicates an object is logically contiguous with a second object where the second object occurs before the object.
String FLOWS_FROM_PROPERTY Indicates the FLOWS_FROM relation between two objects has changed.
String FLOWS_TO Indicates an object is logically contiguous with a second object where the second object occurs after the object.
String FLOWS_TO_PROPERTY Indicates the FLOWS_TO relation between two objects has changed.
String LABELED_BY_PROPERTY Identifies that the objects that are doing the labeling have changed
String LABEL_FOR_PROPERTY Identifies that the target group for a label has changed
String MEMBER_OF_PROPERTY Identifies that group membership has changed.
String PARENT_WINDOW_OF Indicates that an object is a parent window of one or more objects.
String PARENT_WINDOW_OF_PROPERTY Indicates the PARENT_WINDOW_OF relation between two or more objects has changed.
String SUBWINDOW_OF Indicates that an object is a subwindow of one or more objects.
String SUBWINDOW_OF_PROPERTY Indicates the SUBWINDOW_OF relation between two or more objects has changed.
Fields
public static final String CONTROLLED_BY Indicates an object is controlled by one or more target objects.
public static final String CONTROLLER_FOR Indicates an object is a controller for one or more target objects.
public static final String LABELED_BY Indicates an object is labeled by one or more target objects.
public static final String LABEL_FOR Indicates an object is a label for one or more target objects.
public static final String MEMBER_OF Indicates an object is a member of a group of one or more target objects.
[Expand]
Inherited Fields
From class javax.accessibility.AccessibleBundle
Public Constructors
AccessibleRelation(String key)
Create a new AccessibleRelation using the given locale independent key.
AccessibleRelation(String key, Object target)
Creates a new AccessibleRelation using the given locale independent key.
AccessibleRelation(String key, Object[] target)
Creates a new AccessibleRelation using the given locale independent key.
Public Methods
String getKey()
Returns the key for this relation
Object[] getTarget()
Returns the target objects for this relation
void setTarget(Object[] target)
Sets the target objects for this relation
void setTarget(Object target)
Sets the target object for this relation
[Expand]
Inherited Methods
From class javax.accessibility.AccessibleBundle
From class java.lang.Object

Constants

public static final String CHILD_NODE_OF

Indicates that an object is a child node of one or more objects.

Constant Value: "childNodeOf"

public static final String CHILD_NODE_OF_PROPERTY

Indicates the CHILD_NODE_OF relation between two or more objects has changed.

Constant Value: "childNodeOfProperty"

public static final String CONTROLLED_BY_PROPERTY

Identifies that the target object that is doing the controlling has changed

Constant Value: "controlledByProperty"

public static final String CONTROLLER_FOR_PROPERTY

Identifies that the controller for the target object has changed

Constant Value: "controllerForProperty"

public static final String EMBEDDED_BY

Indicates that an object is embedded in one or more objects.

Constant Value: "embeddedBy"

public static final String EMBEDDED_BY_PROPERTY

Indicates the EMBEDDED_BY relation between two or more objects has changed.

Constant Value: "embeddedByProperty"

public static final String EMBEDS

Indicates that an object has one or more objects embedded in it.

Constant Value: "embeds"

public static final String EMBEDS_PROPERTY

Indicates the EMBEDS relation between two or more objects has changed.

Constant Value: "embedsProperty"

public static final String FLOWS_FROM

Indicates an object is logically contiguous with a second object where the second object occurs before the object. An example is a paragraph of text that runs to the end of a page and continues on the next page with an intervening text footer and/or text header. The two parts of the paragraph are separate text elements but are related in that the second element is a continuation of the first element. In other words, the second element "flows from" the second element.

Constant Value: "flowsFrom"

public static final String FLOWS_FROM_PROPERTY

Indicates the FLOWS_FROM relation between two objects has changed.

Constant Value: "flowsFromProperty"

public static final String FLOWS_TO

Indicates an object is logically contiguous with a second object where the second object occurs after the object. An example is a paragraph of text that runs to the end of a page and continues on the next page with an intervening text footer and/or text header. The two parts of the paragraph are separate text elements but are related in that the second element is a continuation of the first element. In other words, the first element "flows to" the second element.

Constant Value: "flowsTo"

public static final String FLOWS_TO_PROPERTY

Indicates the FLOWS_TO relation between two objects has changed.

Constant Value: "flowsToProperty"

public static final String LABELED_BY_PROPERTY

Identifies that the objects that are doing the labeling have changed

Constant Value: "labeledByProperty"

public static final String LABEL_FOR_PROPERTY

Identifies that the target group for a label has changed

Constant Value: "labelForProperty"

public static final String MEMBER_OF_PROPERTY

Identifies that group membership has changed.

Constant Value: "memberOfProperty"

public static final String PARENT_WINDOW_OF

Indicates that an object is a parent window of one or more objects.

Constant Value: "parentWindowOf"

public static final String PARENT_WINDOW_OF_PROPERTY

Indicates the PARENT_WINDOW_OF relation between two or more objects has changed.

Constant Value: "parentWindowOfProperty"

public static final String SUBWINDOW_OF

Indicates that an object is a subwindow of one or more objects.

Constant Value: "subwindowOf"

public static final String SUBWINDOW_OF_PROPERTY

Indicates the SUBWINDOW_OF relation between two or more objects has changed.

Constant Value: "subwindowOfProperty"

Fields

public static final String CONTROLLED_BY

Indicates an object is controlled by one or more target objects.

See Also

public static final String CONTROLLER_FOR

Indicates an object is a controller for one or more target objects.

See Also

public static final String LABELED_BY

Indicates an object is labeled by one or more target objects.

See Also

public static final String LABEL_FOR

Indicates an object is a label for one or more target objects.

See Also

public static final String MEMBER_OF

Indicates an object is a member of a group of one or more target objects.

See Also

Public Constructors

public AccessibleRelation (String key)

Create a new AccessibleRelation using the given locale independent key. The key String should be a locale independent key for the relation. It is not intended to be used as the actual String to display to the user. To get the localized string, use toDisplayString.

Parameters
key the locale independent name of the relation.
See Also

public AccessibleRelation (String key, Object target)

Creates a new AccessibleRelation using the given locale independent key. The key String should be a locale independent key for the relation. It is not intended to be used as the actual String to display to the user. To get the localized string, use toDisplayString.

Parameters
key the locale independent name of the relation.
target the target object for this relation
See Also

public AccessibleRelation (String key, Object[] target)

Creates a new AccessibleRelation using the given locale independent key. The key String should be a locale independent key for the relation. It is not intended to be used as the actual String to display to the user. To get the localized string, use toDisplayString.

Parameters
key the locale independent name of the relation.
target the target object(s) for this relation
See Also

Public Methods

public String getKey ()

Returns the key for this relation

Returns
  • the key for this relation
See Also

public Object[] getTarget ()

Returns the target objects for this relation

Returns
  • an array containing the target objects for this relation

public void setTarget (Object[] target)

Sets the target objects for this relation

Parameters
target an array containing the target objects for this relation

public void setTarget (Object target)

Sets the target object for this relation

Parameters
target the target object for this relation