Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.accessibility

Class AccessibleRelation

public class AccessibleRelation
extends AccessibleBundle
The relation between one accessible object and one or more other objects. For example, a button may control an action. An AccessibleRelationSet summarizes all relations of the object. This strongly typed "enumeration" supports localized strings. If the constants of this class are not adequate, new ones may be added in a similar matter.
Since:
1.2

Field Summary

static String
CHILD_NODE_OF
Indicates that an object is a child of another object.
static String
CHILD_NODE_OF_PROPERTY
Indicates that the ancestry relationship has changed.
static String
CONTROLLED_BY
Indicates an object is controlled by other objects.
static String
CONTROLLED_BY_PROPERTY
Indicates that the controlling objects have changed.
static String
CONTROLLER_FOR
Indicates an object is a controller for other objects.
static String
CONTROLLER_FOR_PROPERTY
Indicates that the controller target group has changed.
static String
EMBEDDED_BY
Indicates that an object is embedded by another object.
static String
EMBEDDED_BY_PROPERTY
Indicates that the EMBEDDED_BY property changed.
static String
EMBEDS
Indicates that an object embeds another object.
static String
EMBEDS_PROPERTY
Indicates that the EMBEDS property changed.
static String
FLOWS_FROM
Indicates that one object directly follows another object, as in a paragraph flow.
static String
FLOWS_FROM_PROPERTY
Indicates that the FLOWS_FROM property changed.
static String
FLOWS_TO
Indicates that one object comes directly before another object, as in a paragraph flow.
static String
FLOWS_TO_PROPERTY
Indicates that the FLOWS_TO property changed.
static String
LABELED_BY
Indicates the object is labeled by other objects.
static String
LABELED_BY_PROPERTY
Indicates that the labelling objects have changed.
static String
LABEL_FOR
Indicates the object labels other objects.
static String
LABEL_FOR_PROPERTY
Indicates that the label target group has changed.
static String
MEMBER_OF
Indicates an object is a member of a group of target objects.
static String
MEMBER_OF_PROPERTY
Indicates that group membership has changed.
static String
PARENT_WINDOW_OF
Indicates that one object is a parent window of another object.
static String
PARENT_WINDOW_OF_PROPERTY
Indicates that the PARENT_WINDOW_OF property changed.
static String
SUBWINDOW_OF
Indicates that one object is a subwindow of another object.
static String
SUBWINDOW_OF_PROPERTY
Indicates that the SUBWINDOW_OF property changed.

Fields inherited from class javax.accessibility.AccessibleBundle

key

Constructor Summary

AccessibleRelation(String key)
Create a new relation with a locale independent key, and no related objects.
AccessibleRelation(String key, Object target)
Create a new relation with a locale independent key, and a single related object.
AccessibleRelation(String key, Object[] targets)
Create a new relation with a locale independent key, and the given related objects.

Method Summary

String
getKey()
Return the key for this relation.
Object[]
getTarget()
Return the targets of this relation.
void
setTarget(Object target)
Set the target to a single object.
void
setTarget(Object[] targets)
Set the target to an array of objects.

Methods inherited from class javax.accessibility.AccessibleBundle

toDisplayString, toDisplayString, toDisplayString, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CHILD_NODE_OF

public static final String CHILD_NODE_OF
Indicates that an object is a child of another object.
Field Value:
"childNodeOf"
Since:
1.5

CHILD_NODE_OF_PROPERTY

public static final String CHILD_NODE_OF_PROPERTY
Indicates that the ancestry relationship has changed.
Field Value:
"childNodeOfProperty"
Since:
1.5

CONTROLLED_BY

public static final String CONTROLLED_BY
Indicates an object is controlled by other objects.
See Also:
getTarget(), CONTROLLER_FOR, LABEL_FOR, LABELED_BY, MEMBER_OF

CONTROLLED_BY_PROPERTY

public static final String CONTROLLED_BY_PROPERTY
Indicates that the controlling objects have changed.
Field Value:
"controlledByProperty"

CONTROLLER_FOR

public static final String CONTROLLER_FOR
Indicates an object is a controller for other objects.
See Also:
getTarget(), CONTROLLED_BY, LABEL_FOR, LABELED_BY, MEMBER_OF

CONTROLLER_FOR_PROPERTY

public static final String CONTROLLER_FOR_PROPERTY
Indicates that the controller target group has changed.
Field Value:
"controllerForProperty"

EMBEDDED_BY

public static final String EMBEDDED_BY
Indicates that an object is embedded by another object.
Field Value:
"embeddedBy"
Since:
1.5

EMBEDDED_BY_PROPERTY

public static final String EMBEDDED_BY_PROPERTY
Indicates that the EMBEDDED_BY property changed.
Field Value:
"embeddedByProperty"
Since:
1.5

EMBEDS

public static final String EMBEDS
Indicates that an object embeds another object.
Field Value:
"embeds"
Since:
1.5

EMBEDS_PROPERTY

public static final String EMBEDS_PROPERTY
Indicates that the EMBEDS property changed.
Field Value:
"embedsProperty"
Since:
1.5

FLOWS_FROM

public static final String FLOWS_FROM
Indicates that one object directly follows another object, as in a paragraph flow.
Field Value:
"flowsFrom"
Since:
1.5

FLOWS_FROM_PROPERTY

public static final String FLOWS_FROM_PROPERTY
Indicates that the FLOWS_FROM property changed.
Field Value:
"flowsFromProperty"
Since:
1.5

FLOWS_TO

public static final String FLOWS_TO
Indicates that one object comes directly before another object, as in a paragraph flow.
Field Value:
"flowsTo"
Since:
1.5

FLOWS_TO_PROPERTY

public static final String FLOWS_TO_PROPERTY
Indicates that the FLOWS_TO property changed.
Field Value:
"flowsToProperty"
Since:
1.5

LABELED_BY

public static final String LABELED_BY
Indicates the object is labeled by other objects.
See Also:
getTarget(), CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, MEMBER_OF

LABELED_BY_PROPERTY

public static final String LABELED_BY_PROPERTY
Indicates that the labelling objects have changed.
Field Value:
"labeledByProperty"

LABEL_FOR

public static final String LABEL_FOR
Indicates the object labels other objects.
See Also:
getTarget(), CONTROLLER_FOR, CONTROLLED_BY, LABELED_BY, MEMBER_OF

LABEL_FOR_PROPERTY

public static final String LABEL_FOR_PROPERTY
Indicates that the label target group has changed.
Field Value:
"labelForProperty"

MEMBER_OF

public static final String MEMBER_OF
Indicates an object is a member of a group of target objects.
See Also:
getTarget(), CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, LABELED_BY

MEMBER_OF_PROPERTY

public static final String MEMBER_OF_PROPERTY
Indicates that group membership has changed.
Field Value:
"memberOfProperty"

PARENT_WINDOW_OF

public static final String PARENT_WINDOW_OF
Indicates that one object is a parent window of another object.
Field Value:
"parentWindowOf"
Since:
1.5

PARENT_WINDOW_OF_PROPERTY

public static final String PARENT_WINDOW_OF_PROPERTY
Indicates that the PARENT_WINDOW_OF property changed.
Field Value:
"parentWindowOfProperty"
Since:
1.5

SUBWINDOW_OF

public static final String SUBWINDOW_OF
Indicates that one object is a subwindow of another object.
Field Value:
"subwindowOf"
Since:
1.5

SUBWINDOW_OF_PROPERTY

public static final String SUBWINDOW_OF_PROPERTY
Indicates that the SUBWINDOW_OF property changed.
Field Value:
"subwindowOfProperty"
Since:
1.5

Constructor Details

AccessibleRelation

public AccessibleRelation(String key)
Create a new relation with a locale independent key, and no related objects.
Parameters:
key - the name of the role
See Also:
toDisplayString(String,Locale)

AccessibleRelation

public AccessibleRelation(String key,
                          Object target)
Create a new relation with a locale independent key, and a single related object.
Parameters:
key - the name of the role
target - the related object
See Also:
toDisplayString(String,Locale)

AccessibleRelation

public AccessibleRelation(String key,
                          Object[] targets)
Create a new relation with a locale independent key, and the given related objects.
Parameters:
key - the name of the role
targets - the related objects
See Also:
toDisplayString(String,Locale)

Method Details

getKey

public String getKey()
Return the key for this relation.
Returns:
the key
See Also:
CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, LABELED_BY, MEMBER_OF

getTarget

public Object[] getTarget()
Return the targets of this relation.
Returns:
the targets, may be empty, but never null

setTarget

public void setTarget(Object target)
Set the target to a single object.
Parameters:
target - the new target

setTarget

public void setTarget(Object[] targets)
Set the target to an array of objects.
Parameters:
targets - the new targets
AccessibleRelation.java -- the relation between accessible objects Copyright (C) 2002, 2005 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About