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

Class Length

java.lang.Object

net.sf.mmm.util.lang.api.AbstractDatatype

net.sf.mmm.util.lang.api.AbstractSimpleDatatypeBase<String>

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

All Implemented Interfaces:

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

public class Length
extends AbstractSimpleDatatypeBase<String>

This is the Datatype for a Length. It typically represents a width or height of a UI-object. Therefore it consists of two parts:

• an amount
• a unit

Examples:

getValue()	getAmount()	getUnit()
12px	12.0	LengthUnit.PIXEL
100%	100.0	LengthUnit.PERCENT
0.8em	0.8	LengthUnit.EM

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

LengthUnit.newLength(double), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private double	amount
static Length	FULL The full Length as "100%".
static Length	MAX The maximum Length.
private static long	serialVersionUID UID for serialization.
private LengthUnit	unit
static Length	ZERO The empty Length.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Length() The constructor.
	Length(double value, LengthUnit unit) The constructor.
	Length(String size) The constructor.

Method Summary

Modifier and Type	Method and Description
double	convertToPixel(double basePixelLength, LengthProperty property) This method gets the amount in pixels.
double	getAmount() This method gets the value (amount) of this size.
LengthUnit	getUnit() This method gets the unit of the value.
String	getValue() This method returns the raw value of this datatype.
static Length	valueOfPercent(double amount) Creates a new Length with unit LengthUnit.PERCENT.
static Length	valueOfPixel(double amount) Creates a new Length with unit LengthUnit.PERCENT.

Methods inherited from class net.sf.mmm.util.lang.api.AbstractSimpleDatatypeBase

equals, getValue, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

ZERO

public static final Length ZERO

The empty Length.

MAX

public static final Length MAX

The maximum Length.

FULL

public static final Length FULL

The full Length as "100%".

amount

private double amount

See Also:

getAmount()

unit

private LengthUnit unit

See Also:

getUnit()

Constructor Detail

Length

protected Length()

The constructor.

Length

public Length(double value,
              LengthUnit unit)

The constructor.

Parameters:

value - is the value.

unit - is the unit.

Length

public Length(String size)

The constructor.

Parameters:

size - is the value representing the size as string.

Method Detail

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.).

Returns:

the value of this datatype.

getAmount

public double getAmount()

This method gets the value (amount) of this size. Is to be interpreted in the according unit.

Returns:

the actual value of this Length.

getUnit

public LengthUnit getUnit()

This method gets the unit of the value.

Returns:

the LengthUnit.

convertToPixel

public double convertToPixel(double basePixelLength,
                             LengthProperty property)

This method gets the amount in pixels.
ATTENTION:
This implementation is NOT precise and should only used when you know what you are doing.

Parameters:

basePixelLength - is the base length in pixel used to convert from percent. Use 0 if unknown (what will result in 0 in case of percent length values).

property - is the LengthProperty or null if not available.

Returns:

the length in pixels.

valueOfPercent

public static Length valueOfPercent(double amount)

Creates a new Length with unit LengthUnit.PERCENT.

Parameters:

amount - is the amount.

Returns:

the new Length.

valueOfPixel

public static Length valueOfPixel(double amount)

Creates a new Length with unit LengthUnit.PERCENT.

Parameters:

amount - is the amount.

Returns:

the new Length.