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

Enum LengthProperty

java.lang.Object

java.lang.Enum<LengthProperty>

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

All Implemented Interfaces:

Serializable, Comparable<LengthProperty>, CssProperty, AttributeReadValue<String>, Datatype, SimpleDatatype<String>

public enum LengthProperty
extends Enum<LengthProperty>
implements SimpleDatatype<String>, CssProperty

This enum contains the available properties that are configured with Length values. Both value and string representation are the CSS property name.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Length

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEIGHT The actual height (vertical length).
MAX_HEIGHT The maximum height (vertical length).
MAX_WIDTH The maximum width (horizontal length).
MIN_HEIGHT The minimum height (vertical length).
MIN_WIDTH The minimum width (horizontal length).
WIDTH The actual width (horizontal length).

Field Summary

Fields

Modifier and Type	Field and Description
private String	memberName
private String	styleName

Method Summary

Modifier and Type	Method and Description
Length	getDefaultValue()
double	getLengthInPixel(AttributeReadLengthProperty lengthSource, AttributeReadSizeInPixel basePixelSize)
double	getLengthInPixel(AttributeReadLengthProperty lengthSource, double basePixelLength)
String	getMemberName()
String	getStyleName()
String	getValue() This method returns the raw value of this datatype.
boolean	isWidth()
String	toString() Returns the official String representation of this Datatype.
static LengthProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static LengthProperty[]	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

WIDTH

public static final LengthProperty WIDTH

The actual width (horizontal length).

MIN_WIDTH

public static final LengthProperty MIN_WIDTH

The minimum width (horizontal length).

MAX_WIDTH

public static final LengthProperty MAX_WIDTH

The maximum width (horizontal length).

HEIGHT

public static final LengthProperty HEIGHT

The actual height (vertical length).

MIN_HEIGHT

public static final LengthProperty MIN_HEIGHT

The minimum height (vertical length).

MAX_HEIGHT

public static final LengthProperty MAX_HEIGHT

The maximum height (vertical length).

Field Detail

styleName

private final String styleName

See Also:

getStyleName()

memberName

private final String memberName

See Also:

getMemberName()

Method Detail

values

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

Returns:

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

valueOf

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

getStyleName

public String getStyleName()

Specified by:

getStyleName in interface CssProperty

Returns:

the name of this property when used in CSS.

getMemberName

public String getMemberName()

Specified by:

getMemberName in interface CssProperty

Returns:

the name of this property when used in JavaScript to define the member variable of an element style object.

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.

isWidth

public boolean isWidth()

Returns:

true if WIDTH, MIN_WIDTH, or MAX_WIDTH - false otherwise.

getLengthInPixel

public double getLengthInPixel(AttributeReadLengthProperty lengthSource,
                               double basePixelLength)

Parameters:

lengthSource - is the object to get the Length from.

basePixelLength - - see Length#convertToPixel(double, LengthProperty)

Returns:

the requested Length in LengthUnit.PIXEL.

See Also:

Length.convertToPixel(double, LengthProperty)

getLengthInPixel

public double getLengthInPixel(AttributeReadLengthProperty lengthSource,
                               AttributeReadSizeInPixel basePixelSize)

Parameters:

lengthSource - is the object to get the Length from.

basePixelSize - gives access to read the size of the base container (e.g. screen, parent panel, etc.).

Returns:

the requested Length in LengthUnit.PIXEL.

See Also:

Length.convertToPixel(double, LengthProperty)

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<LengthProperty>

Returns:

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

getDefaultValue

public Length getDefaultValue()

Returns:

the default value for this LengthProperty. Will be Length.MAX for max properties and Length.ZERO otherwise.