FileDocCategorySizeDatePackage
AccessibleRelation.javaAPI DocJava SE 6 API10714Tue Jun 10 00:26:02 BST 2008javax.accessibility

AccessibleRelation

public class AccessibleRelation extends AccessibleBundle

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.

version
1.16 04/07/06
author
Lynn Monsanto
since
1.3

Fields Summary
private Object[]
target
public static final String
LABEL_FOR
Indicates an object is a label 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
MEMBER_OF
Indicates an object is a member of a group of 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
CONTROLLED_BY
Indicates an object is controlled by one or more target objects.
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.
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.
public static final String
SUBWINDOW_OF
Indicates that an object is a subwindow of one or more objects.
public static final String
PARENT_WINDOW_OF
Indicates that an object is a parent window of one or more objects.
public static final String
EMBEDS
Indicates that an object has one or more objects embedded in it.
public static final String
EMBEDDED_BY
Indicates that an object is embedded in one or more objects.
public static final String
CHILD_NODE_OF
Indicates that an object is a child node of one or more objects.
public static final String
LABEL_FOR_PROPERTY
Identifies that the target group for a label has changed
public static final String
LABELED_BY_PROPERTY
Identifies that the objects that are doing the labeling have changed
public static final String
MEMBER_OF_PROPERTY
Identifies that group membership has changed.
public static final String
CONTROLLER_FOR_PROPERTY
Identifies that the controller for the target object has changed
public static final String
CONTROLLED_BY_PROPERTY
Identifies that the target object that is doing the controlling has changed
public static final String
FLOWS_TO_PROPERTY
Indicates the FLOWS_TO relation between two objects has changed.
public static final String
FLOWS_FROM_PROPERTY
Indicates the FLOWS_FROM relation between two objects has changed.
public static final String
SUBWINDOW_OF_PROPERTY
Indicates the SUBWINDOW_OF relation between two or more objects has changed.
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
EMBEDS_PROPERTY
Indicates the EMBEDS relation between two or more objects has changed.
public static final String
EMBEDDED_BY_PROPERTY
Indicates the EMBEDDED_BY relation between two or more objects has changed.
public static final String
CHILD_NODE_OF_PROPERTY
Indicates the CHILD_NODE_OF relation between two or more objects has changed.
Constructors 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.

param
key the locale independent name of the relation.
see
AccessibleBundle#toDisplayString


                                                                   
       
        this.key = key;
	this.target = null;
    
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.

param
key the locale independent name of the relation.
param
target the target object for this relation
see
AccessibleBundle#toDisplayString

        this.key = key;
	this.target = new Object[1];
	this.target[0] = target;
    
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.

param
key the locale independent name of the relation.
param
target the target object(s) for this relation
see
AccessibleBundle#toDisplayString

        this.key = key;
	this.target = target;
    
Methods Summary
public java.lang.StringgetKey()
Returns the key for this relation

return
the key for this relation
see
#CONTROLLER_FOR
see
#CONTROLLED_BY
see
#LABEL_FOR
see
#LABELED_BY
see
#MEMBER_OF

	return this.key;
    
public java.lang.Object[]getTarget()
Returns the target objects for this relation

return
an array containing the target objects for this relation

        if (target == null) {
	    target = new Object[0];
	}
	Object [] retval = new Object[target.length];
	for (int i = 0; i < target.length; i++) {
	    retval[i] = target[i];
	}
	return retval;
    
public voidsetTarget(java.lang.Object target)
Sets the target object for this relation

param
target the target object for this relation

	this.target = new Object[1];
	this.target[0] = target;
    
public voidsetTarget(java.lang.Object[] target)
Sets the target objects for this relation

param
target an array containing the target objects for this relation

	this.target = target;