This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.accessibility
class AccessibleRelation

java.lang.Object extended by javax.accessibility.AccessibleBundle extended by javax.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.

Field Summary
static String CHILD_NODE_OF
          Indicates that an object is a child node of one or more objects.
static String CHILD_NODE_OF_PROPERTY
          Indicates the CHILD_NODE_OF relation between two or more objects has changed.
static String CONTROLLED_BY
          Indicates an object is controlled by one or more target objects.
static String CONTROLLED_BY_PROPERTY
          Identifies that the target object that is doing the controlling has changed
static String CONTROLLER_FOR
          Indicates an object is a controller for one or more target objects.
static String CONTROLLER_FOR_PROPERTY
          Identifies that the controller for the target object has changed
static String EMBEDDED_BY
          Indicates that an object is embedded in one or more objects.
static String EMBEDDED_BY_PROPERTY
          Indicates the EMBEDDED_BY relation between two or more objects has changed.
static String EMBEDS
          Indicates that an object has one or more objects embedded in it.
static String EMBEDS_PROPERTY
          Indicates the EMBEDS relation between two or more objects has changed.
static String FLOWS_FROM
          Indicates an object is logically contiguous with a second object where the second object occurs before the object.
static String FLOWS_FROM_PROPERTY
          Indicates the FLOWS_FROM relation between two objects has changed.
static String FLOWS_TO
          Indicates an object is logically contiguous with a second object where the second object occurs after the object.
static String FLOWS_TO_PROPERTY
          Indicates the FLOWS_TO relation between two objects has changed.
static String LABELED_BY
          Indicates an object is labeled by one or more target objects.
static String LABELED_BY_PROPERTY
          Identifies that the objects that are doing the labeling have changed
static String LABEL_FOR
          Indicates an object is a label for one or more target objects.
static String LABEL_FOR_PROPERTY
          Identifies that the target group for a label has changed
static String MEMBER_OF
          Indicates an object is a member of a group of one or more target objects.
static String MEMBER_OF_PROPERTY
          Identifies that group membership has changed.
static String PARENT_WINDOW_OF
          Indicates that an object is a parent window of one or more objects.
static String PARENT_WINDOW_OF_PROPERTY
          Indicates the PARENT_WINDOW_OF relation between two or more objects has changed.
static String SUBWINDOW_OF
          Indicates that an object is a subwindow of one or more objects.
static String SUBWINDOW_OF_PROPERTY
          Indicates the SUBWINDOW_OF relation between two or more objects has changed.
 
Fields inherited from class javax.accessibility.AccessibleBundle
key
 
Constructor Summary
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.
 
Method Summary
 String
getKey()

          Returns the key for this relation
 Object[]
getTarget()

          Returns the target objects for this relation
 void
setTarget(Object target)

          Sets the target object for this relation
 void
setTarget(Object[] target)

          Sets the target objects for this relation
 
Methods inherited from class javax.accessibility.AccessibleBundle
toDisplayString, toDisplayString, toDisplayString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CHILD_NODE_OF

public static final String CHILD_NODE_OF
Indicates that an object is a child node of one or more objects.

CHILD_NODE_OF_PROPERTY

public static final String CHILD_NODE_OF_PROPERTY
Indicates the CHILD_NODE_OF relation between two or more objects has changed.

CONTROLLED_BY

public static final String CONTROLLED_BY
Indicates an object is controlled by one or more target objects.

CONTROLLED_BY_PROPERTY

public static final String CONTROLLED_BY_PROPERTY
Identifies that the target object that is doing the controlling has changed

CONTROLLER_FOR

public static final String CONTROLLER_FOR
Indicates an object is a controller for one or more target objects.

CONTROLLER_FOR_PROPERTY

public static final String CONTROLLER_FOR_PROPERTY
Identifies that the controller for the target object has changed

EMBEDDED_BY

public static final String EMBEDDED_BY
Indicates that an object is embedded in one or more objects.

EMBEDDED_BY_PROPERTY

public static final String EMBEDDED_BY_PROPERTY
Indicates the EMBEDDED_BY relation between two or more objects has changed.

EMBEDS

public static final String EMBEDS
Indicates that an object has one or more objects embedded in it.

EMBEDS_PROPERTY

public static final String EMBEDS_PROPERTY
Indicates the EMBEDS relation between two or more objects has changed.

FLOWS_FROM

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.

FLOWS_FROM_PROPERTY

public static final String FLOWS_FROM_PROPERTY
Indicates the FLOWS_FROM relation between two objects has changed.

FLOWS_TO

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.

FLOWS_TO_PROPERTY

public static final String FLOWS_TO_PROPERTY
Indicates the FLOWS_TO relation between two objects has changed.

LABELED_BY

public static final String LABELED_BY
Indicates an object is labeled by one or more target objects.

LABELED_BY_PROPERTY

public static final String LABELED_BY_PROPERTY
Identifies that the objects that are doing the labeling have changed

LABEL_FOR

public static final String LABEL_FOR
Indicates an object is a label for one or more target objects.

LABEL_FOR_PROPERTY

public static final String LABEL_FOR_PROPERTY
Identifies that the target group for a label has changed

MEMBER_OF

public static final String MEMBER_OF
Indicates an object is a member of a group of one or more target objects.

MEMBER_OF_PROPERTY

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

PARENT_WINDOW_OF

public static final String PARENT_WINDOW_OF
Indicates that an object is a parent window of one or more objects.

PARENT_WINDOW_OF_PROPERTY

public static final String PARENT_WINDOW_OF_PROPERTY
Indicates the PARENT_WINDOW_OF relation between two or more objects has changed.

SUBWINDOW_OF

public static final String SUBWINDOW_OF
Indicates that an object is a subwindow of one or more objects.

SUBWINDOW_OF_PROPERTY

public static final String SUBWINDOW_OF_PROPERTY
Indicates the SUBWINDOW_OF relation between two or more objects has changed.
Constructor Detail

AccessibleRelation

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.

AccessibleRelation

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

AccessibleRelation

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
Method Detail

getKey

public String getKey()
Returns the key for this relation

Returns:
the key for this relation

getTarget

public Object[] getTarget()
Returns the target objects for this relation

Returns:
an array containing the target objects for this relation

setTarget

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

Parameters:
target - the target object for this relation

setTarget

public void setTarget(Object[] target)
Sets the target objects for this relation

Parameters:
target - an array containing the target objects for this relation
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.