Enum Class Placement

java.lang.Object

java.lang.Enum<Placement>

org.patternfly.style.Placement

All Implemented Interfaces:

Serializable, Comparable<Placement>, Constable, TypedModifier

public enum Placement
extends Enum<Placement>
implements TypedModifier

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
bottom
bottomEnd
bottomStart
left
leftEnd
leftStart
right
rightEnd
rightStart
top
topEnd
topStart

Method Summary

Modifier and Type	Method	Description
Placement	base()	Returns the base direction (top, bottom, left, or right) for this placement.
String	modifier()
String	value()
static Placement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Placement[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
Placement	withBase(Placement newBase)	Returns a placement that combines the base direction of newBase with the alignment (none, start, end) of this placement.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

top

public static final Placement top

topStart

public static final Placement topStart

topEnd

public static final Placement topEnd

bottom

public static final Placement bottom

bottomStart

public static final Placement bottomStart

bottomEnd

public static final Placement bottomEnd

left

public static final Placement left

leftStart

public static final Placement leftStart

leftEnd

public static final Placement leftEnd

right

public static final Placement right

rightStart

public static final Placement rightStart

rightEnd

public static final Placement rightEnd

Method Details

values

public static Placement[] 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 Placement 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

value

public String value()

Specified by:

value in interface TypedModifier

modifier

public String modifier()

Specified by:

modifier in interface TypedModifier

base

public Placement base()

Returns the base direction (top, bottom, left, or right) for this placement.

withBase

public Placement withBase(Placement newBase)

Returns a placement that combines the base direction of newBase with the alignment (none, start, end) of this placement. For example, topStart.withBase(bottom) returns bottomStart.