Class AccessibleRelation
java.lang.Object
javax.accessibility.AccessibleBundle
javax.accessibility.AccessibleRelation
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 AccessibleBundle.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.
- Since:
- 1.3
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Indicates that an object is a child node of one or more objects.static final String
Indicates theCHILD_NODE_OF
relation between two or more objects has changed.static final String
Indicates an object is controlled by one or more target objects.static final String
Identifies that the target object that is doing the controlling has changed.static final String
Indicates an object is a controller for one or more target objects.static final String
Identifies that the controller for the target object has changed.static final String
Indicates that an object is embedded in one or more objects.static final String
Indicates theEMBEDDED_BY
relation between two or more objects has changed.static final String
Indicates that an object has one or more objects embedded in it.static final String
Indicates theEMBEDS
relation between two or more objects has changed.static final String
Indicates an object is logically contiguous with a second object where the second object occurs before the object.static final String
Indicates theFLOWS_FROM
relation between two objects has changed.static final String
Indicates an object is logically contiguous with a second object where the second object occurs after the object.static final String
Indicates theFLOWS_TO
relation between two objects has changed.static final String
Indicates an object is a label for one or more target objects.static final String
Identifies that the target group for a label has changed.static final String
Indicates an object is labeled by one or more target objects.static final String
Identifies that the objects that are doing the labeling have changed.static final String
Indicates an object is a member of a group of one or more target objects.static final String
Identifies that group membership has changed.static final String
Indicates that an object is a parent window of one or more objects.static final String
Indicates thePARENT_WINDOW_OF
relation between two or more objects has changed.static final String
Indicates that an object is a subwindow of one or more objects.static final String
Indicates theSUBWINDOW_OF
relation between two or more objects has changed.Fields inherited from class javax.accessibility.AccessibleBundle
key
-
Constructor Summary
ConstructorDescriptionAccessibleRelation
(String key) Create a newAccessibleRelation
using the given locale independent key.AccessibleRelation
(String key, Object target) Creates a newAccessibleRelation
using the given locale independent key.AccessibleRelation
(String key, Object[] target) Creates a newAccessibleRelation
using the given locale independent key. -
Method Summary
Methods inherited from class javax.accessibility.AccessibleBundle
toDisplayString, toDisplayString, toDisplayString, toString
-
Field Details
-
LABEL_FOR
Indicates an object is a label for one or more target objects.- See Also:
-
LABELED_BY
Indicates an object is labeled by one or more target objects.- See Also:
-
MEMBER_OF
Indicates an object is a member of a group of one or more target objects.- See Also:
-
CONTROLLER_FOR
Indicates an object is a controller for one or more target objects.- See Also:
-
CONTROLLED_BY
Indicates an object is controlled by one or more target objects.- See Also:
-
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.- Since:
- 1.5
- See Also:
-
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.- Since:
- 1.5
- See Also:
-
SUBWINDOW_OF
Indicates that an object is a subwindow of one or more objects.- Since:
- 1.5
- See Also:
-
PARENT_WINDOW_OF
Indicates that an object is a parent window of one or more objects.- Since:
- 1.5
- See Also:
-
EMBEDS
Indicates that an object has one or more objects embedded in it.- Since:
- 1.5
- See Also:
-
EMBEDDED_BY
Indicates that an object is embedded in one or more objects.- Since:
- 1.5
- See Also:
-
CHILD_NODE_OF
Indicates that an object is a child node of one or more objects.- Since:
- 1.5
- See Also:
-
LABEL_FOR_PROPERTY
Identifies that the target group for a label has changed.- See Also:
-
LABELED_BY_PROPERTY
Identifies that the objects that are doing the labeling have changed.- See Also:
-
MEMBER_OF_PROPERTY
Identifies that group membership has changed.- See Also:
-
CONTROLLER_FOR_PROPERTY
Identifies that the controller for the target object has changed.- See Also:
-
CONTROLLED_BY_PROPERTY
Identifies that the target object that is doing the controlling has changed.- See Also:
-
FLOWS_TO_PROPERTY
Indicates theFLOWS_TO
relation between two objects has changed.- Since:
- 1.5
- See Also:
-
FLOWS_FROM_PROPERTY
Indicates theFLOWS_FROM
relation between two objects has changed.- Since:
- 1.5
- See Also:
-
SUBWINDOW_OF_PROPERTY
Indicates theSUBWINDOW_OF
relation between two or more objects has changed.- Since:
- 1.5
- See Also:
-
PARENT_WINDOW_OF_PROPERTY
Indicates thePARENT_WINDOW_OF
relation between two or more objects has changed.- Since:
- 1.5
- See Also:
-
EMBEDS_PROPERTY
Indicates theEMBEDS
relation between two or more objects has changed.- Since:
- 1.5
- See Also:
-
EMBEDDED_BY_PROPERTY
Indicates theEMBEDDED_BY
relation between two or more objects has changed.- Since:
- 1.5
- See Also:
-
CHILD_NODE_OF_PROPERTY
Indicates theCHILD_NODE_OF
relation between two or more objects has changed.- Since:
- 1.5
- See Also:
-
-
Constructor Details
-
AccessibleRelation
Create a newAccessibleRelation
using the given locale independent key. The keyString
should be a locale independent key for the relation. It is not intended to be used as the actualString
to display to the user. To get the localized string, useAccessibleBundle.toDisplayString()
.- Parameters:
key
- the locale independent name of the relation- See Also:
-
AccessibleRelation
Creates a newAccessibleRelation
using the given locale independent key. The keyString
should be a locale independent key for the relation. It is not intended to be used as the actualString
to display to the user. To get the localized string, useAccessibleBundle.toDisplayString()
.- Parameters:
key
- the locale independent name of the relationtarget
- the target object for this relation- See Also:
-
AccessibleRelation
Creates a newAccessibleRelation
using the given locale independent key. The keyString
should be a locale independent key for the relation. It is not intended to be used as the actualString
to display to the user. To get the localized string, useAccessibleBundle.toDisplayString()
.- Parameters:
key
- the locale independent name of the relationtarget
- the target object(s) for this relation- See Also:
-
-
Method Details
-
getKey
Returns the key for this relation.- Returns:
- the key for this relation
- See Also:
-
getTarget
Returns the target objects for this relation.- Returns:
- an array containing the target objects for this relation
-
setTarget
Sets the target object for this relation.- Parameters:
target
- the target object for this relation
-
setTarget
Sets the target objects for this relation.- Parameters:
target
- an array containing the target objects for this relation
-