Home » openjdk-7 » javax » accessibility » [javadoc | source]
javax.accessibility
public class: AccessibleRelation [javadoc | source]
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 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
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.
    since: 1.5 -
 
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 -
 
public static final  String SUBWINDOW_OF    Indicates that an object is a subwindow of one or more objects.
    since: 1.5 -
 
public static final  String PARENT_WINDOW_OF    Indicates that an object is a parent window of one or more objects.
    since: 1.5 -
 
public static final  String EMBEDS    Indicates that an object has one or more objects embedded in it.
    since: 1.5 -
 
public static final  String EMBEDDED_BY    Indicates that an object is embedded in one or more objects.
    since: 1.5 -
 
public static final  String CHILD_NODE_OF    Indicates that an object is a child node of one or more objects.
    since: 1.5 -
 
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.
    since: 1.5 -
 
public static final  String FLOWS_FROM_PROPERTY    Indicates the FLOWS_FROM relation between two objects has changed.
    since: 1.5 -
 
public static final  String SUBWINDOW_OF_PROPERTY    Indicates the SUBWINDOW_OF relation between two or more objects has changed.
    since: 1.5 -
 
public static final  String PARENT_WINDOW_OF_PROPERTY    Indicates the PARENT_WINDOW_OF relation between two or more objects has changed.
    since: 1.5 -
 
public static final  String EMBEDS_PROPERTY    Indicates the EMBEDS relation between two or more objects has changed.
    since: 1.5 -
 
public static final  String EMBEDDED_BY_PROPERTY    Indicates the EMBEDDED_BY relation between two or more objects has changed.
    since: 1.5 -
 
public static final  String CHILD_NODE_OF_PROPERTY    Indicates the CHILD_NODE_OF relation between two or more objects has changed.
    since: 1.5 -
 
Fields inherited from javax.accessibility.AccessibleBundle:
key
Constructor:
 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.
    Also see:
    AccessibleBundle#toDisplayString
 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
    Also see:
    AccessibleBundle#toDisplayString
 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
    Also see:
    AccessibleBundle#toDisplayString
Method from javax.accessibility.AccessibleRelation Summary:
getKey,   getTarget,   setTarget,   setTarget
Methods from javax.accessibility.AccessibleBundle:
toDisplayString,   toDisplayString,   toDisplayString,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.accessibility.AccessibleRelation Detail:
 public String getKey() 
    Returns the key for this relation
 public Object[] getTarget() 
    Returns the target objects for this relation
 public  void setTarget(Object target) 
    Sets the target object for this relation
 public  void setTarget(Object[] target) 
    Sets the target objects for this relation