Enum PDTransitionDirection
- java.lang.Object
-
- java.lang.Enum<PDTransitionDirection>
-
- org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransitionDirection
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<PDTransitionDirection>
public enum PDTransitionDirection extends java.lang.Enum<PDTransitionDirection>
The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. Only forPDTransitionStyle.Wipe
,PDTransitionStyle.Glitter
,PDTransitionStyle.Fly
,PDTransitionStyle.Cover
,PDTransitionStyle.Uncover
andPDTransitionStyle.Push
.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BOTTOM_TO_TOP
Relevant only for the Wipe transitionLEFT_TO_RIGHT
NONE
Relevant only for the Fly transition when the value of SS is not 1.0RIGHT_TO_LEFT
Relevant only for the Wipe transitionTOP_LEFT_TO_BOTTOM_RIGHT
Relevant only for the Glitter transitionTOP_TO_BOTTOM
-
Field Summary
Fields Modifier and Type Field Description private int
degrees
-
Constructor Summary
Constructors Modifier Constructor Description private
PDTransitionDirection(int degrees)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description COSBase
getCOSBase()
static PDTransitionDirection
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static PDTransitionDirection[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LEFT_TO_RIGHT
public static final PDTransitionDirection LEFT_TO_RIGHT
-
BOTTOM_TO_TOP
public static final PDTransitionDirection BOTTOM_TO_TOP
Relevant only for the Wipe transition
-
RIGHT_TO_LEFT
public static final PDTransitionDirection RIGHT_TO_LEFT
Relevant only for the Wipe transition
-
TOP_TO_BOTTOM
public static final PDTransitionDirection TOP_TO_BOTTOM
-
TOP_LEFT_TO_BOTTOM_RIGHT
public static final PDTransitionDirection TOP_LEFT_TO_BOTTOM_RIGHT
Relevant only for the Glitter transition
-
NONE
public static final PDTransitionDirection NONE
Relevant only for the Fly transition when the value of SS is not 1.0
-
-
Method Detail
-
values
public static PDTransitionDirection[] 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 (PDTransitionDirection c : PDTransitionDirection.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PDTransitionDirection 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 namejava.lang.NullPointerException
- if the argument is null
-
getCOSBase
public COSBase getCOSBase()
- Returns:
- the value for this direction
-
-