com.yworks.yfiles.layout

Class LabelPlacements

java.lang.Object

java.lang.Number

com.yworks.yfiles.utils.FlagsEnum<LabelPlacements>

com.yworks.yfiles.layout.LabelPlacements

All Implemented Interfaces:

Serializable

public final class LabelPlacements
extends FlagsEnum<LabelPlacements>

See Also:

PreferredPlacementDescriptor.newSharedInstance(LabelPlacements), PreferredPlacementDescriptor.getPlaceAlongEdge(), PreferredPlacementDescriptor.getSideOfEdge(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static LabelPlacements	ALONG_EDGE_MASK Placement specifier mask that masks all placement specifiers that describe the placement along the edge.
static LabelPlacements	ANYWHERE Preferred placement specifier for edge labels which expresses that the label can be placed anywhere along the edge or on any side of the edge.
static LabelPlacements	AT_CENTER Preferred placement specifier for edge labels which expresses that the label should be placed near the center of the edge path.
static LabelPlacements	AT_SOURCE Preferred placement specifier for edge labels which expresses that the label should be placed near the source node of an edge.
static LabelPlacements	AT_SOURCE_PORT Preferred placement specifier for edge labels which expresses that the label should be placed directly at the source port of the edge.
static LabelPlacements	AT_TARGET Preferred placement specifier for edge labels which expresses that the label should be placed near the target node of an edge.
static LabelPlacements	AT_TARGET_PORT Preferred placement specifier for edge labels which expresses that the label should be placed directly at the target port of the edge.
static LabelPlacements	LEFT_OF_EDGE Preferred placement specifier for edge labels which expresses that the label should be placed on the left hand side of the edge path.
static LabelPlacements	ON_EDGE Preferred placement specifier for edge labels which expresses that the label should be placed on the path of the edge.
static LabelPlacements	ON_SIDE_OF_EDGE_MASK Placement specifier mask that masks all placement specifiers that describe the side of the edge.
static LabelPlacements	RIGHT_OF_EDGE Preferred placement specifier for edge labels which expresses that the label should be placed on the right hand side of the edge path.

Method Summary

Modifier and Type	Method and Description
static LabelPlacements	fromName(String name)
static LabelPlacements	fromOrdinal(int value)
protected LabelPlacements	fromOrdinalImpl(int ordinal)
protected LabelPlacements[]	getItems() Returns all items defined in this FlagsEnum.
int	value()

Methods inherited from class com.yworks.yfiles.utils.FlagsEnum

and, and, contains, containsAll, doubleValue, equals, equals, floatValue, hashCode, intValue, inverse, inverse, longValue, notContains, notEquals, or, or, ordinal, toString, xor, xor

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALONG_EDGE_MASK

public static final LabelPlacements ALONG_EDGE_MASK

Placement specifier mask that masks all placement specifiers that describe the placement along the edge.

To determine the preferred placement along the edge, this mask can be used to hide the side specifiers that may also be encoded in the preferred placement.

ANYWHERE

public static final LabelPlacements ANYWHERE

Preferred placement specifier for edge labels which expresses that the label can be placed anywhere along the edge or on any side of the edge.

AT_CENTER

public static final LabelPlacements AT_CENTER

Preferred placement specifier for edge labels which expresses that the label should be placed near the center of the edge path.

AT_SOURCE

public static final LabelPlacements AT_SOURCE

Preferred placement specifier for edge labels which expresses that the label should be placed near the source node of an edge.

AT_SOURCE_PORT

public static final LabelPlacements AT_SOURCE_PORT

Preferred placement specifier for edge labels which expresses that the label should be placed directly at the source port of the edge.

Placement at the source port is currently only supported by HierarchicLayout when enabling integrated edge labeling.

AT_TARGET

public static final LabelPlacements AT_TARGET

Preferred placement specifier for edge labels which expresses that the label should be placed near the target node of an edge.

AT_TARGET_PORT

public static final LabelPlacements AT_TARGET_PORT

Preferred placement specifier for edge labels which expresses that the label should be placed directly at the target port of the edge.

Placement at the target port is currently only supported by HierarchicLayout when enabling integrated edge labeling.

LEFT_OF_EDGE

public static final LabelPlacements LEFT_OF_EDGE

Preferred placement specifier for edge labels which expresses that the label should be placed on the left hand side of the edge path.

The side is interpreted relative to the direction of the edge, if no different side reference is defined.

ON_EDGE

public static final LabelPlacements ON_EDGE

Preferred placement specifier for edge labels which expresses that the label should be placed on the path of the edge.

ON_SIDE_OF_EDGE_MASK

public static final LabelPlacements ON_SIDE_OF_EDGE_MASK

Placement specifier mask that masks all placement specifiers that describe the side of the edge.

To determine the preferred side of the edge, this mask can be used to hide the placement specifiers that may also be encoded in the preferred placement.

RIGHT_OF_EDGE

public static final LabelPlacements RIGHT_OF_EDGE

Preferred placement specifier for edge labels which expresses that the label should be placed on the right hand side of the edge path.

The side is interpreted relative to the direction of the edge, if no different side reference is defined.

Method Detail

fromName

public static final LabelPlacements fromName(String name)

fromOrdinal

public static final LabelPlacements fromOrdinal(int value)

fromOrdinalImpl

protected final LabelPlacements fromOrdinalImpl(int ordinal)

Specified by:

fromOrdinalImpl in class FlagsEnum<LabelPlacements>

getItems

protected final LabelPlacements[] getItems()

Description copied from class: FlagsEnum

Returns all items defined in this FlagsEnum.

Specified by:

getItems in class FlagsEnum<LabelPlacements>

value

public int value()