Package limn.accessibility

Enum Class Accessible.Relation

java.lang.Object

java.lang.Enum<Accessible.Relation>

limn.accessibility.Accessible.Relation

All Implemented Interfaces:

Serializable, Comparable<Accessible.Relation>, Constable

Enclosing class:

Accessible

public static enum Accessible.Relation
extends Enum<Accessible.Relation>

A link between two nodes that the tree's parent-and-child shape cannot carry.

A relation is resolved to the nearest published ancestor of its target and is dropped when there is none: a relation naming a node that was never published is worse than no relation at all, because every platform answers it with an element that does not resolve.

A 1.x minor release may add constants to this enum: a switch over it needs a default branch.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTROLLED_BY	This node is changed by the target; the mirror of CONTROLLER_FOR.
CONTROLLER_FOR	Operating this node changes the target.
DESCRIBED_BY	This node's description comes from the target.
LABEL_FOR	This node is the name of the target; the mirror of LABELLED_BY.
LABELLED_BY	This node's name comes from the target.
MEMBER_OF	This node is one member of the target group.
POPUP_FOR	This node is the popup the target opened.

Method Summary

Modifier and Type	Method	Description
static Accessible.Relation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Accessible.Relation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LABELLED_BY

public static final Accessible.Relation LABELLED_BY

This node's name comes from the target.

LABEL_FOR

public static final Accessible.Relation LABEL_FOR

This node is the name of the target; the mirror of LABELLED_BY.

DESCRIBED_BY

public static final Accessible.Relation DESCRIBED_BY

This node's description comes from the target.

CONTROLLER_FOR

public static final Accessible.Relation CONTROLLER_FOR

Operating this node changes the target.

CONTROLLED_BY

public static final Accessible.Relation CONTROLLED_BY

This node is changed by the target; the mirror of CONTROLLER_FOR.

MEMBER_OF

public static final Accessible.Relation MEMBER_OF

This node is one member of the target group.

POPUP_FOR

public static final Accessible.Relation POPUP_FOR

This node is the popup the target opened.

Method Details

values

public static Accessible.Relation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Accessible.Relation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null