APIdia Launch Partner
Top Description Fields Constructors Methods
javax.accessibility

public Class AccessibleRelation

extends AccessibleBundle
Class Inheritance
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.

Author
Lynn Monsanto
Since
1.3

Field Summary

Modifier and TypeField and Description
public static final String
CHILD_NODE_OF

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

public static final String
CHILD_NODE_OF_PROPERTY

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

public static final String
CONTROLLED_BY

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

public static final String
CONTROLLED_BY_PROPERTY

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

public static final String
CONTROLLER_FOR

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

public static final String
CONTROLLER_FOR_PROPERTY

Identifies that the controller for the target object has changed.

public static final String
EMBEDDED_BY

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

public static final String
EMBEDDED_BY_PROPERTY

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

public static final String
EMBEDS

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

public static final String
EMBEDS_PROPERTY

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

public static final String
FLOWS_FROM

Indicates an object is logically contiguous with a second object where the second object occurs before the object.

public static final String
FLOWS_FROM_PROPERTY

Indicates the FLOWS_FROM relation between two objects has changed.

public static final String
FLOWS_TO

Indicates an object is logically contiguous with a second object where the second object occurs after the object.

public static final String
FLOWS_TO_PROPERTY

Indicates the FLOWS_TO relation between two objects has changed.

public static final String
LABEL_FOR

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

public static final String
LABEL_FOR_PROPERTY

Identifies that the target group for a label has changed.

public static final String
LABELED_BY

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

public static final String
LABELED_BY_PROPERTY

Identifies that the objects that are doing the labeling have changed.

public static final String
MEMBER_OF

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

public static final String
MEMBER_OF_PROPERTY

Identifies that group membership has changed.

public static final String
PARENT_WINDOW_OF

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

public static final String
PARENT_WINDOW_OF_PROPERTY

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

public static final String
SUBWINDOW_OF

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

public static final String
SUBWINDOW_OF_PROPERTY

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

private Object[]
target

The group of objects that participate in the relation.

Inherited from javax.accessibility.AccessibleBundle:
key

Constructor Summary

AccessConstructor and Description
public
AccessibleRelation(String
the locale independent name of the relation
key)

Create a new AccessibleRelation using the given locale independent key.

public
AccessibleRelation(String
the locale independent name of the relation
key, Object
the target object for this relation
target)

Creates a new AccessibleRelation using the given locale independent key.

public
AccessibleRelation(String
the locale independent name of the relation
key, Object[]
the target object(s) for this relation
target)

Creates a new AccessibleRelation using the given locale independent key.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the key for this relation
getKey()

Returns the key for this relation.

public Object[]

Returns:

an array containing the target objects for this relation
getTarget()

Returns the target objects for this relation.

public void
setTarget(Object
the target object for this relation
target)

Sets the target object for this relation.

public void
setTarget(Object[]
an array containing the target objects for this relation
target)

Sets the target objects for this relation.

Inherited from javax.accessibility.AccessibleBundle:
toDisplayStringtoDisplayStringtoDisplayStringtoString

Field Detail

CHILD_NODE_OFback to summary
public static final String CHILD_NODE_OF

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

Since
1.5
CHILD_NODE_OF_PROPERTYback to summary
public static final String CHILD_NODE_OF_PROPERTY

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

Since
1.5
CONTROLLED_BYback to summary
public static final String CONTROLLED_BY

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

See Also
getTarget, CONTROLLER_FOR, LABEL_FOR, LABELED_BY, MEMBER_OF
CONTROLLED_BY_PROPERTYback to summary
public static final String CONTROLLED_BY_PROPERTY

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

CONTROLLER_FORback to summary
public static final String CONTROLLER_FOR

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

See Also
getTarget, CONTROLLED_BY, LABEL_FOR, LABELED_BY, MEMBER_OF
CONTROLLER_FOR_PROPERTYback to summary
public static final String CONTROLLER_FOR_PROPERTY

Identifies that the controller for the target object has changed.

EMBEDDED_BYback to summary
public static final String EMBEDDED_BY

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

Since
1.5
EMBEDDED_BY_PROPERTYback to summary
public static final String EMBEDDED_BY_PROPERTY

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

Since
1.5
EMBEDSback to summary
public static final String EMBEDS

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

Since
1.5
EMBEDS_PROPERTYback to summary
public static final String EMBEDS_PROPERTY

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

Since
1.5
FLOWS_FROMback to summary
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.

Since
1.5
FLOWS_FROM_PROPERTYback to summary
public static final String FLOWS_FROM_PROPERTY

Indicates the FLOWS_FROM relation between two objects has changed.

Since
1.5
FLOWS_TOback to summary
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.

Since
1.5
FLOWS_TO_PROPERTYback to summary
public static final String FLOWS_TO_PROPERTY

Indicates the FLOWS_TO relation between two objects has changed.

Since
1.5
LABEL_FORback to summary
public static final String LABEL_FOR

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

See Also
getTarget, CONTROLLER_FOR, CONTROLLED_BY, LABELED_BY, MEMBER_OF
LABEL_FOR_PROPERTYback to summary
public static final String LABEL_FOR_PROPERTY

Identifies that the target group for a label has changed.

LABELED_BYback to summary
public static final String LABELED_BY

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

See Also
getTarget, CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, MEMBER_OF
LABELED_BY_PROPERTYback to summary
public static final String LABELED_BY_PROPERTY

Identifies that the objects that are doing the labeling have changed.

MEMBER_OFback to summary
public static final String MEMBER_OF

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

See Also
getTarget, CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, LABELED_BY
MEMBER_OF_PROPERTYback to summary
public static final String MEMBER_OF_PROPERTY

Identifies that group membership has changed.

PARENT_WINDOW_OFback to summary
public static final String PARENT_WINDOW_OF

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

Since
1.5
PARENT_WINDOW_OF_PROPERTYback to summary
public static final String PARENT_WINDOW_OF_PROPERTY

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

Since
1.5
SUBWINDOW_OFback to summary
public static final String SUBWINDOW_OF

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

Since
1.5
SUBWINDOW_OF_PROPERTYback to summary
public static final String SUBWINDOW_OF_PROPERTY

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

Since
1.5
targetback to summary
private Object[] target

The group of objects that participate in the relation. The relation may be one-to-one or one-to-many. For example, in the case of a LABEL_FOR relation, the target vector would contain a list of objects labeled by the object that implements this AccessibleRelation. In the case of a MEMBER_OF relation, the target vector would contain all of the components that are members of the same group as the object that implements this AccessibleRelation.

Constructor Detail

AccessibleRelationback to summary
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:String

the locale independent name of the relation

See Also
AccessibleBundle#toDisplayString
AccessibleRelationback to summary
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:String

the locale independent name of the relation

target:Object

the target object for this relation

See Also
AccessibleBundle#toDisplayString
AccessibleRelationback to summary
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:String

the locale independent name of the relation

target:Object[]

the target object(s) for this relation

See Also
AccessibleBundle#toDisplayString

Method Detail

getKeyback to summary
public String getKey()

Returns the key for this relation.

Returns:String

the key for this relation

See Also
CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, LABELED_BY, MEMBER_OF
getTargetback to summary
public Object[] getTarget()

Returns the target objects for this relation.

Returns:Object[]

an array containing the target objects for this relation

setTargetback to summary
public void setTarget(Object target)

Sets the target object for this relation.

Parameters
target:Object

the target object for this relation

setTargetback to summary
public void setTarget(Object[] target)

Sets the target objects for this relation.

Parameters
target:Object[]

an array containing the target objects for this relation