Class AccessibleRelation

public static final String CHILD_NODE_OF

Indicates that an object is a child of another object.

Field Value:

"childNodeOf"

Since:

1.5

public static final String CHILD_NODE_OF_PROPERTY

Indicates that the ancestry relationship has changed.

Field Value:

"childNodeOfProperty"

Since:

1.5

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

public static final String CONTROLLED_BY_PROPERTY

Indicates that the controlling objects have changed.

Field Value:

"controlledByProperty"

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

public static final String CONTROLLER_FOR_PROPERTY

Indicates that the controller target group has changed.

Field Value:

"controllerForProperty"

public static final String EMBEDDED_BY

Indicates that an object is embedded by another object.

Field Value:

"embeddedBy"

Since:

1.5

public static final String EMBEDDED_BY_PROPERTY

Indicates that the EMBEDDED_BY property changed.

Field Value:

"embeddedByProperty"

Since:

1.5

public static final String EMBEDS

Indicates that an object embeds another object.

Field Value:

"embeds"

Since:

1.5

public static final String EMBEDS_PROPERTY

Indicates that the EMBEDS property changed.

Field Value:

"embedsProperty"

Since:

1.5

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

public static final String FLOWS_FROM_PROPERTY

Indicates that the FLOWS_FROM property changed.

Field Value:

"flowsFromProperty"

Since:

1.5

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

public static final String FLOWS_TO_PROPERTY

Indicates that the FLOWS_TO property changed.

Field Value:

"flowsToProperty"

Since:

1.5

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

public static final String LABELED_BY_PROPERTY

Indicates that the labelling objects have changed.

Field Value:

"labeledByProperty"

public static final String LABEL_FOR

Indicates the object labels other objects.

See Also:

getTarget(), CONTROLLER_FOR, CONTROLLED_BY, LABELED_BY, MEMBER_OF

public static final String LABEL_FOR_PROPERTY

Indicates that the label target group has changed.

Field Value:

"labelForProperty"

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

public static final String MEMBER_OF_PROPERTY

Indicates that group membership has changed.

Field Value:

"memberOfProperty"

public static final String PARENT_WINDOW_OF

Indicates that one object is a parent window of another object.

Field Value:

"parentWindowOf"

Since:

1.5

public static final String PARENT_WINDOW_OF_PROPERTY

Indicates that the PARENT_WINDOW_OF property changed.

Field Value:

"parentWindowOfProperty"

Since:

1.5

public static final String SUBWINDOW_OF

Indicates that one object is a subwindow of another object.

Field Value:

"subwindowOf"

Since:

1.5

public static final String SUBWINDOW_OF_PROPERTY

Indicates that the SUBWINDOW_OF property changed.

Field Value:

"subwindowOfProperty"

Since:

1.5

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)

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)

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)

public String getKey()

Return the key for this relation.

Returns:

the key

See Also:

CONTROLLER_FOR, CONTROLLED_BY, LABEL_FOR, LABELED_BY, MEMBER_OF

public Object[] getTarget()

Return the targets of this relation.

Returns:

the targets, may be empty, but never null

public void setTarget(Object target)

Set the target to a single object.

Parameters:

target - the new target

public void setTarget(Object[] targets)

Set the target to an array of objects.

Parameters:

targets - the new targets