org.foray.pdf.object
Enum PDFBorderStyle.Style

java.lang.Object
  java.lang.Enum<PDFBorderStyle.Style>
      org.foray.pdf.object.PDFBorderStyle.Style

All Implemented Interfaces:

Serializable, Comparable<PDFBorderStyle.Style>

Enclosing class:

PDFBorderStyle

public static enum PDFBorderStyle.Style
extends Enum<PDFBorderStyle.Style>

Enumeration of the possible BorderStyle style values.

Enum Constant Summary

BEVELED
A simulated embossed rectangle that appears to be raised above the surface of the page.

DASHED
A dashed rectangle.

INSET
A simulated engraved rectangle that appears to be recessed below the surface of the page.

SOLID
A solid rectangle.

UNDERLINE
A single line along the bottom of the rectangle.

Method Summary

String	getPdfName() Returns the value to write into the PDF file to designate this style.
static PDFBorderStyle.Style	valueOf(String name) Returns the enum constant of this type with the specified name.
static PDFBorderStyle.Style[]	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

SOLID

public static final PDFBorderStyle.Style SOLID

A solid rectangle.

DASHED

public static final PDFBorderStyle.Style DASHED

A dashed rectangle. The dash pattern is specified separately.

BEVELED

public static final PDFBorderStyle.Style BEVELED

A simulated embossed rectangle that appears to be raised above the surface of the page.

INSET

public static final PDFBorderStyle.Style INSET

A simulated engraved rectangle that appears to be recessed below the surface of the page.

UNDERLINE

public static final PDFBorderStyle.Style UNDERLINE

A single line along the bottom of the rectangle.

Method Detail

values

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

Returns:

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

valueOf

public static PDFBorderStyle.Style 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 String getPdfName()

Returns the value to write into the PDF file to designate this style.

Returns:

The PDF value for this style.