- java.lang.Object
- 
- javax.accessibility.AccessibleBundle
- 
- javax.accessibility.AccessibleRelation
 
 
- 
 public class AccessibleRelation extends AccessibleBundle ClassAccessibleRelationdescribes a relation between the object that implements theAccessibleRelationand one or more other objects. The actual relations that an object has with other objects are defined as anAccessibleRelationSet, which is a composed set ofAccessibleRelations.The AccessibleBundle.toDisplayString()method allows you to obtain the localized string for a locale independent key from a predefinedResourceBundlefor 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 SummaryFields Modifier and Type Field Description static StringCHILD_NODE_OFIndicates that an object is a child node of one or more objects.static StringCHILD_NODE_OF_PROPERTYIndicates theCHILD_NODE_OFrelation between two or more objects has changed.static StringCONTROLLED_BYIndicates an object is controlled by one or more target objects.static StringCONTROLLED_BY_PROPERTYIdentifies that the target object that is doing the controlling has changed.static StringCONTROLLER_FORIndicates an object is a controller for one or more target objects.static StringCONTROLLER_FOR_PROPERTYIdentifies that the controller for the target object has changed.static StringEMBEDDED_BYIndicates that an object is embedded in one or more objects.static StringEMBEDDED_BY_PROPERTYIndicates theEMBEDDED_BYrelation between two or more objects has changed.static StringEMBEDSIndicates that an object has one or more objects embedded in it.static StringEMBEDS_PROPERTYIndicates theEMBEDSrelation between two or more objects has changed.static StringFLOWS_FROMIndicates an object is logically contiguous with a second object where the second object occurs before the object.static StringFLOWS_FROM_PROPERTYIndicates theFLOWS_FROMrelation between two objects has changed.static StringFLOWS_TOIndicates an object is logically contiguous with a second object where the second object occurs after the object.static StringFLOWS_TO_PROPERTYIndicates theFLOWS_TOrelation between two objects has changed.static StringLABEL_FORIndicates an object is a label for one or more target objects.static StringLABEL_FOR_PROPERTYIdentifies that the target group for a label has changed.static StringLABELED_BYIndicates an object is labeled by one or more target objects.static StringLABELED_BY_PROPERTYIdentifies that the objects that are doing the labeling have changed.static StringMEMBER_OFIndicates an object is a member of a group of one or more target objects.static StringMEMBER_OF_PROPERTYIdentifies that group membership has changed.static StringPARENT_WINDOW_OFIndicates that an object is a parent window of one or more objects.static StringPARENT_WINDOW_OF_PROPERTYIndicates thePARENT_WINDOW_OFrelation between two or more objects has changed.static StringSUBWINDOW_OFIndicates that an object is a subwindow of one or more objects.static StringSUBWINDOW_OF_PROPERTYIndicates theSUBWINDOW_OFrelation between two or more objects has changed.- 
Fields declared in class javax.accessibility.AccessibleBundlekey
 
- 
 - 
Constructor SummaryConstructors Constructor Description AccessibleRelation(String key)Create a newAccessibleRelationusing the given locale independent key.AccessibleRelation(String key, Object target)Creates a newAccessibleRelationusing the given locale independent key.AccessibleRelation(String key, Object[] target)Creates a newAccessibleRelationusing the given locale independent key.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetKey()Returns the key for this relation.Object[]getTarget()Returns the target objects for this relation.voidsetTarget(Object target)Sets the target object for this relation.voidsetTarget(Object[] target)Sets the target objects for this relation.- 
Methods declared in class javax.accessibility.AccessibleBundletoDisplayString, toDisplayString, toDisplayString, toString
 
- 
 
- 
- 
- 
Field Detail- 
LABEL_FORpublic 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
 
 - 
LABELED_BYpublic 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
 
 - 
MEMBER_OFpublic 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
 
 - 
CONTROLLER_FORpublic 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
 
 - 
CONTROLLED_BYpublic 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
 
 - 
FLOWS_TOpublic 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
- See Also:
- Constant Field Values
 
 - 
FLOWS_FROMpublic 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
- See Also:
- Constant Field Values
 
 - 
SUBWINDOW_OFpublic static final String SUBWINDOW_OF Indicates that an object is a subwindow of one or more objects.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
PARENT_WINDOW_OFpublic static final String PARENT_WINDOW_OF Indicates that an object is a parent window of one or more objects.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
EMBEDSpublic static final String EMBEDS Indicates that an object has one or more objects embedded in it.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
EMBEDDED_BYpublic static final String EMBEDDED_BY Indicates that an object is embedded in one or more objects.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
CHILD_NODE_OFpublic static final String CHILD_NODE_OF Indicates that an object is a child node of one or more objects.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
LABEL_FOR_PROPERTYpublic static final String LABEL_FOR_PROPERTY Identifies that the target group for a label has changed.- See Also:
- Constant Field Values
 
 - 
LABELED_BY_PROPERTYpublic static final String LABELED_BY_PROPERTY Identifies that the objects that are doing the labeling have changed.- See Also:
- Constant Field Values
 
 - 
MEMBER_OF_PROPERTYpublic static final String MEMBER_OF_PROPERTY Identifies that group membership has changed.- See Also:
- Constant Field Values
 
 - 
CONTROLLER_FOR_PROPERTYpublic static final String CONTROLLER_FOR_PROPERTY Identifies that the controller for the target object has changed.- See Also:
- Constant Field Values
 
 - 
CONTROLLED_BY_PROPERTYpublic static final String CONTROLLED_BY_PROPERTY Identifies that the target object that is doing the controlling has changed.- See Also:
- Constant Field Values
 
 - 
FLOWS_TO_PROPERTYpublic static final String FLOWS_TO_PROPERTY Indicates theFLOWS_TOrelation between two objects has changed.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
FLOWS_FROM_PROPERTYpublic static final String FLOWS_FROM_PROPERTY Indicates theFLOWS_FROMrelation between two objects has changed.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
SUBWINDOW_OF_PROPERTYpublic static final String SUBWINDOW_OF_PROPERTY Indicates theSUBWINDOW_OFrelation between two or more objects has changed.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
PARENT_WINDOW_OF_PROPERTYpublic static final String PARENT_WINDOW_OF_PROPERTY Indicates thePARENT_WINDOW_OFrelation between two or more objects has changed.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
EMBEDS_PROPERTYpublic static final String EMBEDS_PROPERTY Indicates theEMBEDSrelation between two or more objects has changed.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
EMBEDDED_BY_PROPERTYpublic static final String EMBEDDED_BY_PROPERTY Indicates theEMBEDDED_BYrelation between two or more objects has changed.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 - 
CHILD_NODE_OF_PROPERTYpublic static final String CHILD_NODE_OF_PROPERTY Indicates theCHILD_NODE_OFrelation between two or more objects has changed.- Since:
- 1.5
- See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
AccessibleRelationpublic AccessibleRelation(String key) Create a newAccessibleRelationusing the given locale independent key. The keyStringshould be a locale independent key for the relation. It is not intended to be used as the actualStringto display to the user. To get the localized string, useAccessibleBundle.toDisplayString().- Parameters:
- key- the locale independent name of the relation
- See Also:
- AccessibleBundle.toDisplayString(java.lang.String, java.util.Locale)
 
 - 
AccessibleRelationpublic AccessibleRelation(String key, Object target) Creates a newAccessibleRelationusing the given locale independent key. The keyStringshould be a locale independent key for the relation. It is not intended to be used as the actualStringto display to the user. To get the localized string, useAccessibleBundle.toDisplayString().- Parameters:
- key- the locale independent name of the relation
- target- the target object for this relation
- See Also:
- AccessibleBundle.toDisplayString(java.lang.String, java.util.Locale)
 
 - 
AccessibleRelationpublic AccessibleRelation(String key, Object[] target) Creates a newAccessibleRelationusing the given locale independent key. The keyStringshould be a locale independent key for the relation. It is not intended to be used as the actualStringto display to the user. To get the localized string, useAccessibleBundle.toDisplayString().- Parameters:
- key- the locale independent name of the relation
- target- the target object(s) for this relation
- See Also:
- AccessibleBundle.toDisplayString(java.lang.String, java.util.Locale)
 
 
- 
 - 
Method Detail- 
getKeypublic String getKey() Returns the key for this relation.- Returns:
- the key for this relation
- See Also:
- CONTROLLER_FOR,- CONTROLLED_BY,- LABEL_FOR,- LABELED_BY,- MEMBER_OF
 
 - 
getTargetpublic Object[] getTarget() Returns the target objects for this relation.- Returns:
- an array containing the target objects for this relation
 
 - 
setTargetpublic void setTarget(Object target) Sets the target object for this relation.- Parameters:
- target- the target object for this relation
 
 - 
setTargetpublic void setTarget(Object[] target) Sets the target objects for this relation.- Parameters:
- target- an array containing the target objects for this relation
 
 
- 
 
-