Package com.helger.pdflayout.spec

Enum EValueUOMType

java.lang.Object

java.lang.Enum<EValueUOMType>

com.helger.pdflayout.spec.EValueUOMType

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, Serializable, Comparable<EValueUOMType>

public enum EValueUOMType
extends Enum<EValueUOMType>
implements com.helger.commons.id.IHasID<String>

Defines the type of width unit of measure used.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABSOLUTE	Absolute value provided
AUTO	Automatic scaling
PERCENTAGE	Percentage value provided
STAR	'*' value provided

Method Summary

Modifier and Type	Method	Description
static EValueUOMType	getFromIDOrNull(String sID)
String	getID()
boolean	isOuterElementDependent()
boolean	isValueRequired()
static EValueUOMType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EValueUOMType[]	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

ABSOLUTE

public static final EValueUOMType ABSOLUTE

Absolute value provided

PERCENTAGE

public static final EValueUOMType PERCENTAGE

Percentage value provided

STAR

public static final EValueUOMType STAR

'*' value provided

AUTO

public static final EValueUOMType AUTO

Automatic scaling

Method Detail

values

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

Returns:

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

valueOf

public static EValueUOMType 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

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

isValueRequired

public boolean isValueRequired()

Returns:

true if this unit of measure requires a value, false if not.

isOuterElementDependent

public boolean isOuterElementDependent()

Returns:

true if this unit of measure depends on the width of the surrounding element, false if this unit of measure defines the width based on the content of this element.

getFromIDOrNull

@Nullable
public static EValueUOMType getFromIDOrNull(@Nullable
                                            String sID)