com.mapinfo.midev.unit

Enum PaperUnit

java.lang.Object

java.lang.Enum<PaperUnit>

com.mapinfo.midev.unit.PaperUnit

All Implemented Interfaces:

Serializable, Comparable<PaperUnit>

public enum PaperUnit
extends Enum<PaperUnit>
implements Serializable

This class represents a unit of measure for length on paper (as opposed to spatial).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTIMETER Unit representing centimeter.
INCH Unit representing inch.
METER Unit representing meter.
MILLIMETER Unit representing millimeter.
PICA Unit representing pica.
PIXEL Unit representing pixel.
POINT Unit representing point.
TWIP Unit representing twip.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DPI The default DPI (Dots Per Inch).

Method Summary

Modifier and Type	Method and Description
static double	calculateConversionFactor(PaperUnit fromUnit, PaperUnit toUnit, Integer dotsPerInch) Returns the conversion factor used toUnit convert something in the specified fromUnit PaperUnit toUnit the specified toUnit PaperUnit.
static double	convert(double length, PaperUnit fromUnit, PaperUnit toUnit, Integer dotsPerInch) Returns the conversion of the specified length in the specified PaperUnit to the specified PaperUnit.
double	getPointsPerUnit() Returns the number of points per unit of this measurement.
static PaperUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static PaperUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INCH

public static final PaperUnit INCH

Unit representing inch.

POINT

public static final PaperUnit POINT

Unit representing point.

PICA

public static final PaperUnit PICA

Unit representing pica.

TWIP

public static final PaperUnit TWIP

Unit representing twip.

MILLIMETER

public static final PaperUnit MILLIMETER

Unit representing millimeter.

CENTIMETER

public static final PaperUnit CENTIMETER

Unit representing centimeter.

PIXEL

public static final PaperUnit PIXEL

Unit representing pixel.

METER

public static final PaperUnit METER

Unit representing meter.

Field Detail

DEFAULT_DPI

public static final int DEFAULT_DPI

The default DPI (Dots Per Inch).

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getPointsPerUnit

public double getPointsPerUnit()

Returns the number of points per unit of this measurement.

Returns:

the number of points per unit of this measurement.

convert

public static double convert(double length,
                             PaperUnit fromUnit,
                             PaperUnit toUnit,
                             Integer dotsPerInch)

Returns the conversion of the specified length in the specified PaperUnit to the specified PaperUnit.

Parameters:

length - The length to convert.

fromUnit - The units of the length to convert.

toUnit - The unit to convert the length to.

dotsPerInch - The dots per inch. It's required only when PaperUnit.PIXEL is involved.

Returns:

the conversion of the specified length in the specified PaperUnit to the specified PaperUnit.

calculateConversionFactor

public static double calculateConversionFactor(PaperUnit fromUnit,
                                               PaperUnit toUnit,
                                               Integer dotsPerInch)

Returns the conversion factor used toUnit convert something in the specified fromUnit PaperUnit toUnit the specified toUnit PaperUnit.

Parameters:

fromUnit - The PaperUnit toUnit convert fromUnit.

toUnit - The PaperUnit toUnit convert toUnit.

dotsPerInch - The dots per inch. It's required only when PaperUnit.PIXEL is involved.

Returns:

the conversion factor used toUnit convert something in the specified fromUnit PaperUnit toUnit the specified toUnit PaperUnit.