com.itextpdf.text.pdf.spatial.units

Enum Square

java.lang.Object

java.lang.Enum<Square>

com.itextpdf.text.pdf.spatial.units.Square

All Implemented Interfaces:

Serializable, Comparable<Square>

public enum Square
extends Enum<Square>

Area display units for use in a Preferred Display Units (PDU) array.

Since:

5.1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACRE an acre
HECTARE a hectare (10,000 square meters)
SQUARE_FOOT a square foot
SQUARE_KILOMETER a square kilometer
SQUARE_METER a square meter
SQUARE_MILE a square mile

Method Summary

Modifier and Type	Method and Description
PdfName	getPdfName() Gets the PdfName.
static Square	valueOf(String name) Returns the enum constant of this type with the specified name.
static Square[]	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

SQUARE_METER

public static final Square SQUARE_METER

a square meter

HECTARE

public static final Square HECTARE

a hectare (10,000 square meters)

SQUARE_KILOMETER

public static final Square SQUARE_KILOMETER

a square kilometer

SQUARE_FOOT

public static final Square SQUARE_FOOT

a square foot

ACRE

public static final Square ACRE

an acre

SQUARE_MILE

public static final Square SQUARE_MILE

a square mile

Method Detail

values

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

Returns:

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

valueOf

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

getPdfName

public PdfName getPdfName()

Gets the PdfName.