net.sf.mmm.client.ui.api.common

Enum LengthUnit

java.lang.Object

java.lang.Enum<LengthUnit>

net.sf.mmm.client.ui.api.common.LengthUnit

All Implemented Interfaces:

Serializable, Comparable<LengthUnit>, AttributeReadValue<String>, Datatype, SimpleDatatype<String>

public enum LengthUnit
extends Enum<LengthUnit>
implements SimpleDatatype<String>

This enum contains the available units for size measures.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Length

Enum Constant Summary

Enum Constants

Enum Constant and Description
EM Unit for em meaning a factor relative to the current font-size.
PERCENT Unit for percent, relative to the parent container.
PIXEL Unit for pixels.

Field Summary

Fields

Modifier and Type	Field and Description
private String	title
private String	value

Method Summary

Modifier and Type	Method and Description
String	getValue() This method returns the raw value of this datatype.
Length	newLength(double amount) Creates a new Length with this LengthUnit as unit.
String	toString() Returns the official String representation of this Datatype.
static LengthUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static LengthUnit[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PIXEL

public static final LengthUnit PIXEL

Unit for pixels.

PERCENT

public static final LengthUnit PERCENT

Unit for percent, relative to the parent container. At topmost the entire window.

EM

public static final LengthUnit EM

Unit for em meaning a factor relative to the current font-size.

Field Detail

value

private final String value

See Also:

getValue()

title

private final String title

See Also:

toString()

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public String getValue()

This method returns the raw value of this datatype. This will typically be a standard datatype (like String , Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).

Specified by:

getValue in interface AttributeReadValue<String>

Specified by:

getValue in interface SimpleDatatype<String>

Returns:

the value of this datatype.

newLength

public Length newLength(double amount)

Creates a new Length with this LengthUnit as unit.

Parameters:

amount - is the amount.

Returns:

the new Length.

toString

public String toString()

Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
ATTENTION:
This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.

Specified by:

toString in interface Datatype

Overrides:

toString in class Enum<LengthUnit>

Returns:

the official String representation to display the value of this Datatype.