com.levigo.jadice.printer

Enum OutputReferenceBase

java.lang.Object

java.lang.Enum<OutputReferenceBase>

com.levigo.jadice.printer.OutputReferenceBase

All Implemented Interfaces:

Serializable, Comparable<OutputReferenceBase>

public enum OutputReferenceBase
extends Enum<OutputReferenceBase>

The reference base specifies what is used as the basic area of the printed output on the paper as well as how scaling/fitting/rotation- optimization is performed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PAGEFORMAT Reference base setting for the imageable area.
PAPER Reference base setting for the paper.

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() Simply returns the string value to get access to the preference in a PreferenceStore.
static OutputReferenceBase	valueOf(String name) Returns the enum constant of this type with the specified name.
static OutputReferenceBase[]	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

PAGEFORMAT

public static final OutputReferenceBase PAGEFORMAT

Reference base setting for the imageable area.
The upper-left corner of the content to be printed will be printed at the upper-left corner of the imageable area. This setting is appropriate if the material to be printed does not contain borders (like photos etc.)

PAPER

public static final OutputReferenceBase PAPER

Reference base setting for the paper.
The upper-left corner of the content to be printed will be printed at the upper-left corner of the paper. This setting is appropriate if the material to be printed does already contains borders like usually scanned pages, MO:DCA pages etc. do.

Method Detail

values

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

Returns:

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

valueOf

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

getIdentifier

public String getIdentifier()

Simply returns the string value to get access to the preference in a PreferenceStore.

Returns:

the identifier for the preference as String.