Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class PDFOutlineFlags

java.lang.Object

java.lang.Enum<PDFOutlineFlags>

org.freedesktop.cairo.PDFOutlineFlags

All Implemented Interfaces:

Flag, Serializable, Comparable<PDFOutlineFlags>, Constable

public enum PDFOutlineFlags
extends Enum<PDFOutlineFlags>
implements Flag

PDFOutlineFlags is used by the cairo_pdf_surface_add_outline() function specify the attributes of an outline item. These flags may be bitwise-or'd to produce any combination of flags.

Since:

1.16

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOLD	The outline item is displayed by the viewer in bold text
ITALIC	The outline item is displayed by the viewer in italic text
OPEN	The outline item defaults to open in the PDF viewer

Method Summary

Modifier and Type	Method	Description
int	getValue()	Return the value of this enum
static PDFOutlineFlags	of(int ordinal)	Returns the enum constant for the given ordinal (its position in the enum declaration).
static PDFOutlineFlags	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PDFOutlineFlags[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPEN

public static final PDFOutlineFlags OPEN

The outline item defaults to open in the PDF viewer

Since:

1.16

BOLD

public static final PDFOutlineFlags BOLD

The outline item is displayed by the viewer in bold text

Since:

1.16

ITALIC

public static final PDFOutlineFlags ITALIC

The outline item is displayed by the viewer in italic text

Since:

1.16

Method Details

values

public static PDFOutlineFlags[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PDFOutlineFlags valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Return the value of this enum

Specified by:

getValue in interface Flag

Returns:

the value

of

public static PDFOutlineFlags of(int ordinal)

Returns the enum constant for the given ordinal (its position in the enum declaration).

Parameters:

ordinal - the position in the enum declaration, starting from zero

Returns:

the enum constant for the given ordinal