Package com.atlassian.adf.model.mark

Enum Breakout.Mode

java.lang.Object

java.lang.Enum<Breakout.Mode>

com.atlassian.adf.model.mark.Breakout.Mode

All Implemented Interfaces:

Serializable, Comparable<Breakout.Mode>

Enclosing class:

Breakout

public static enum Breakout.Mode
extends Enum<Breakout.Mode>

Specifies the desired width of content that breaks out of the usual content margins.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL_WIDTH	Breaks out of the normal margins to use the widest display of the content with the smallest margins permitted in Atlassian's design standards.
WIDE	Breaks out of the normal margins to permit a wider display of this content, but still leaving a moderate margin on either side.

Method Summary

Modifier and Type	Method	Description
String	mode()
static Breakout.Mode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Breakout.Mode[]	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

WIDE

public static final Breakout.Mode WIDE

Breaks out of the normal margins to permit a wider display of this content, but still leaving a moderate margin on either side.

FULL_WIDTH

public static final Breakout.Mode FULL_WIDTH

Breaks out of the normal margins to use the widest display of the content with the smallest margins permitted in Atlassian's design standards.

Method Detail

values

public static Breakout.Mode[] 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 (Breakout.Mode c : Breakout.Mode.values())
    System.out.println(c);

Returns:

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

valueOf

public static Breakout.Mode valueOf(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:

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

NullPointerException - if the argument is null

mode

public String mode()

Returns:

the string representation of this breakout mode