org.pepstock.charba.client.dom.enums

Enum Unit

java.lang.Object

java.lang.Enum<Unit>

org.pepstock.charba.client.dom.enums.Unit

All Implemented Interfaces:

Serializable, Comparable<Unit>, Key

public enum Unit
extends Enum<Unit>
implements Key

Enumerates the unit of measure for sizes.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
PCT A percentage value.
PX One pixel.

Method Summary

Modifier and Type	Method and Description
String	format(double numValue) Creates a size adding the suffix of unit to the argument.
String	format(int numValue) Creates a size adding the suffix of unit to the argument.
String	value() Returns the name value of property
static Unit	valueOf(String name) Returns the enum constant of this type with the specified name.
static Unit[]	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

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkAndGetIfValid, checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

PCT

public static final Unit PCT

A percentage value. It is often used to define a size as relative to an element's parent object.

PX

public static final Unit PX

One pixel. For screen displays, it traditionally represents one device pixel (dot).

Method Detail

values

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

Returns:

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

valueOf

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

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property

format

public String format(double numValue)

Creates a size adding the suffix of unit to the argument.

Parameters:

numValue - number which represents the size.

Returns:

a size as string

format

public String format(int numValue)

Creates a size adding the suffix of unit to the argument.

Parameters:

numValue - number which represents the size.

Returns:

a size as string