com.eteks.sweethome3d.swing

Enum HomePrintableComponent.Variable

java.lang.Object

java.lang.Enum<HomePrintableComponent.Variable>

com.eteks.sweethome3d.swing.HomePrintableComponent.Variable

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HomePrintableComponent.Variable>

Enclosing class:

HomePrintableComponent

public static enum HomePrintableComponent.Variable
extends java.lang.Enum<HomePrintableComponent.Variable>

List of the variables that the user may insert in header and footer.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATE
HOME_NAME
HOME_PRESENTATION_NAME
LEVEL_NAME
PAGE_COUNT
PAGE_NUMBER
PLAN_SCALE
TIME

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormatCode() Returns a format usable code matching this field.
static java.text.MessageFormat	getMessageFormat(java.lang.String format) Returns the message format built from a format that uses variables.
java.lang.String	getUserCode() Returns a user readable code matching this field.
static HomePrintableComponent.Variable	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HomePrintableComponent.Variable[]	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

PAGE_NUMBER

public static final HomePrintableComponent.Variable PAGE_NUMBER

PAGE_COUNT

public static final HomePrintableComponent.Variable PAGE_COUNT

PLAN_SCALE

public static final HomePrintableComponent.Variable PLAN_SCALE

DATE

public static final HomePrintableComponent.Variable DATE

TIME

public static final HomePrintableComponent.Variable TIME

HOME_PRESENTATION_NAME

public static final HomePrintableComponent.Variable HOME_PRESENTATION_NAME

HOME_NAME

public static final HomePrintableComponent.Variable HOME_NAME

LEVEL_NAME

public static final HomePrintableComponent.Variable LEVEL_NAME

Method Detail

values

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

Returns:

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

valueOf

public static HomePrintableComponent.Variable valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getUserCode

public java.lang.String getUserCode()

Returns a user readable code matching this field.

getFormatCode

public java.lang.String getFormatCode()

Returns a format usable code matching this field.

getMessageFormat

public static java.text.MessageFormat getMessageFormat(java.lang.String format)

Returns the message format built from a format that uses variables.