com.tutego.jrtf

Enum RtfUnit

java.lang.Object

java.lang.Enum<RtfUnit>

com.tutego.jrtf.RtfUnit

All Implemented Interfaces:

Serializable, Comparable<RtfUnit>

public enum RtfUnit
extends Enum<RtfUnit>

Represents a RTF measurement.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CM Measurement in cm.
INCH Measurement in inch.
POINT Measurement in point.
TWIPS Measurement in twips.

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	toTwips(double v) Converts to twips.
static RtfUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static RtfUnit[]	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

TWIPS

public static final RtfUnit TWIPS

Measurement in twips. A twip is a 1/20 of a point and the internal representation in RTF.

POINT

public static final RtfUnit POINT

Measurement in point. One point is 20 twips.

INCH

public static final RtfUnit INCH

Measurement in inch. One inch is 1440 twips.

CM

public static final RtfUnit CM

Measurement in cm. One cm is around 566.9 twips.

Method Detail

values

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

Returns:

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

valueOf

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

toTwips

public abstract int toTwips(double v)

Converts to twips.

Parameters:

v - Value to convert to twips.

Returns:

Twips.