org.sejda.model.pdf.transition

Enum PdfPageTransitionStyle

java.lang.Object

java.lang.Enum<PdfPageTransitionStyle>

org.sejda.model.pdf.transition.PdfPageTransitionStyle

All Implemented Interfaces:

Serializable, Comparable<PdfPageTransitionStyle>, FriendlyNamed, MinRequiredVersion

public enum PdfPageTransitionStyle
extends Enum<PdfPageTransitionStyle>
implements MinRequiredVersion, FriendlyNamed

Possible entries in the transition dictionary defining a visual transition when moving from a page to another in presentation mode.
Pdf reference 1.7, section 8.3.3, TABLE 8.13 Entries in a transition dictionary

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLINDS_HORIZONTAL
BLINDS_VERTICAL
BOX_INWARD
BOX_OUTWARD
COVER_LEFT_TO_RIGHT
COVER_TOP_TO_BOTTOM
DISSOLVE
FADE
FLY_LEFT_TO_RIGHT
FLY_TOP_TO_BOTTOM
GLITTER_DIAGONAL
GLITTER_LEFT_TO_RIGHT
GLITTER_TOP_TO_BOTTOM
PUSH_LEFT_TO_RIGHT
PUSH_TOP_TO_BOTTOM
REPLACE
SPLIT_HORIZONTAL_INWARD
SPLIT_HORIZONTAL_OUTWARD
SPLIT_VERTICAL_INWARD
SPLIT_VERTICAL_OUTWARD
UNCOVER_LEFT_TO_RIGHT
UNCOVER_TOP_TO_BOTTOM
WIPE_BOTTOM_TO_TOP
WIPE_LEFT_TO_RIGHT
WIPE_RIGHT_TO_LEFT
WIPE_TOP_TO_BOTTOM

Method Summary

Methods

Modifier and Type	Method and Description
String	getFriendlyName()
PdfVersion	getMinVersion()
static PdfPageTransitionStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static PdfPageTransitionStyle[]	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

SPLIT_HORIZONTAL_INWARD

public static final PdfPageTransitionStyle SPLIT_HORIZONTAL_INWARD

SPLIT_HORIZONTAL_OUTWARD

public static final PdfPageTransitionStyle SPLIT_HORIZONTAL_OUTWARD

SPLIT_VERTICAL_INWARD

public static final PdfPageTransitionStyle SPLIT_VERTICAL_INWARD

SPLIT_VERTICAL_OUTWARD

public static final PdfPageTransitionStyle SPLIT_VERTICAL_OUTWARD

BLINDS_HORIZONTAL

public static final PdfPageTransitionStyle BLINDS_HORIZONTAL

BLINDS_VERTICAL

public static final PdfPageTransitionStyle BLINDS_VERTICAL

BOX_INWARD

public static final PdfPageTransitionStyle BOX_INWARD

BOX_OUTWARD

public static final PdfPageTransitionStyle BOX_OUTWARD

DISSOLVE

public static final PdfPageTransitionStyle DISSOLVE

WIPE_LEFT_TO_RIGHT

public static final PdfPageTransitionStyle WIPE_LEFT_TO_RIGHT

WIPE_RIGHT_TO_LEFT

public static final PdfPageTransitionStyle WIPE_RIGHT_TO_LEFT

WIPE_TOP_TO_BOTTOM

public static final PdfPageTransitionStyle WIPE_TOP_TO_BOTTOM

WIPE_BOTTOM_TO_TOP

public static final PdfPageTransitionStyle WIPE_BOTTOM_TO_TOP

GLITTER_LEFT_TO_RIGHT

public static final PdfPageTransitionStyle GLITTER_LEFT_TO_RIGHT

GLITTER_TOP_TO_BOTTOM

public static final PdfPageTransitionStyle GLITTER_TOP_TO_BOTTOM

GLITTER_DIAGONAL

public static final PdfPageTransitionStyle GLITTER_DIAGONAL

REPLACE

public static final PdfPageTransitionStyle REPLACE

PUSH_LEFT_TO_RIGHT

public static final PdfPageTransitionStyle PUSH_LEFT_TO_RIGHT

PUSH_TOP_TO_BOTTOM

public static final PdfPageTransitionStyle PUSH_TOP_TO_BOTTOM

COVER_LEFT_TO_RIGHT

public static final PdfPageTransitionStyle COVER_LEFT_TO_RIGHT

COVER_TOP_TO_BOTTOM

public static final PdfPageTransitionStyle COVER_TOP_TO_BOTTOM

UNCOVER_LEFT_TO_RIGHT

public static final PdfPageTransitionStyle UNCOVER_LEFT_TO_RIGHT

UNCOVER_TOP_TO_BOTTOM

public static final PdfPageTransitionStyle UNCOVER_TOP_TO_BOTTOM

FADE

public static final PdfPageTransitionStyle FADE

FLY_LEFT_TO_RIGHT

public static final PdfPageTransitionStyle FLY_LEFT_TO_RIGHT

FLY_TOP_TO_BOTTOM

public static final PdfPageTransitionStyle FLY_TOP_TO_BOTTOM

Method Detail

values

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

Returns:

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

valueOf

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

getFriendlyName

public String getFriendlyName()

Specified by:

getFriendlyName in interface FriendlyNamed

Returns:

the friendly name of the entity, to be usually used as a representation for an user.

getMinVersion

public PdfVersion getMinVersion()

Specified by:

getMinVersion in interface MinRequiredVersion

Returns:

the minimum required version