org.axsl.pdf

Enum PdfTextRenderingMode

java.lang.Object

java.lang.Enum<PdfTextRenderingMode>

org.axsl.pdf.PdfTextRenderingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PdfTextRenderingMode>

public enum PdfTextRenderingMode
extends java.lang.Enum<PdfTextRenderingMode>

An enumeration of the valid text rendering modes. See PDF Reference, 3rd Edition, Section 5.2.5.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIP Add text to path for clipping.
FILL Fill text.
FILL_CLIP Fill text and add to path for clipping.
FILL_STROKE Fill, then stroke text.
FILL_STROKE_CLIP Fill, then stroke text and add to path for clipping.
INVISIBLE Neither fill nor stroke text (invisible).
STROKE Stroke text.
STROKE_CLIP Stroke text and add to path for clipping.

Method Summary

Modifier and Type	Method and Description
byte	getModeValue() Returns the PDF value for this mode.
static PdfTextRenderingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PdfTextRenderingMode[]	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

FILL

public static final PdfTextRenderingMode FILL

Fill text.

STROKE

public static final PdfTextRenderingMode STROKE

Stroke text.

FILL_STROKE

public static final PdfTextRenderingMode FILL_STROKE

Fill, then stroke text.

INVISIBLE

public static final PdfTextRenderingMode INVISIBLE

Neither fill nor stroke text (invisible).

FILL_CLIP

public static final PdfTextRenderingMode FILL_CLIP

Fill text and add to path for clipping.

STROKE_CLIP

public static final PdfTextRenderingMode STROKE_CLIP

Stroke text and add to path for clipping.

FILL_STROKE_CLIP

public static final PdfTextRenderingMode FILL_STROKE_CLIP

Fill, then stroke text and add to path for clipping.

CLIP

public static final PdfTextRenderingMode CLIP

Add text to path for clipping.

Method Detail

values

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

Returns:

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

valueOf

public static PdfTextRenderingMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getModeValue

public byte getModeValue()

Returns the PDF value for this mode.

Returns:

The PDF value for this mode.