Package com.esri.arcgisruntime.mapping.labeling

Enum LabelStackBreakPosition

java.lang.Object

java.lang.Enum<LabelStackBreakPosition>

com.esri.arcgisruntime.mapping.labeling.LabelStackBreakPosition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LabelStackBreakPosition>

public enum LabelStackBreakPosition
extends java.lang.Enum<LabelStackBreakPosition>

The strategy for whether a row of text should be broken before or after it exceeds the ideal length.

If stacking is turned on, label placement can insert a line break before or after the word that overruns the maximum number of characters per row.

Since:

100.11.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
AFTER	Insert the line break after a word that has broken the stackRowLength limit.
AUTOMATIC	Use the default break position (AFTER).
BEFORE	Insert the line break before a word that will break the stackRowLength limit.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTOMATIC

public static final LabelStackBreakPosition AUTOMATIC

Use the default break position (AFTER).

Since:

100.11.0

AFTER

public static final LabelStackBreakPosition AFTER

Insert the line break after a word that has broken the stackRowLength limit.

This means rows will generally be longer than the LabelDefinition.getStackRowLength().

Since:

100.11.0

BEFORE

public static final LabelStackBreakPosition BEFORE

Insert the line break before a word that will break the stackRowLength limit.

This means rows will generally be shorter than the LabelDefinition.getStackRowLength() (although they will overrun for individual words larger than this count).

Since:

100.11.0

Method Detail

values

public static LabelStackBreakPosition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LabelStackBreakPosition c : LabelStackBreakPosition.values())
    System.out.println(c);

Returns:

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

valueOf

public static LabelStackBreakPosition valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null