org.sejda.model.pdf.transition

Class PdfPageTransition

java.lang.Object

org.sejda.model.pdf.transition.PdfPageTransition

public final class PdfPageTransition
extends Object

Model for a page transition.
Pdf reference 1.7, Chap. 8.3.3

Author:

Andrea Vacondio

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
int	getDisplayDuration()
PdfPageTransitionStyle	getStyle()
int	getTransitionDuration()
int	hashCode()
static PdfPageTransition	newInstance(PdfPageTransitionStyle style, int transitionDuration, int displayDuration) Creates a new PdfPageTransition instance.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getStyle

public PdfPageTransitionStyle getStyle()

getTransitionDuration

public int getTransitionDuration()

Returns:

The duration of the transition effect in seconds.

getDisplayDuration

public int getDisplayDuration()

Returns:

the number of seconds a page is displayed before the transition to the next page is triggered.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

newInstance

public static PdfPageTransition newInstance(PdfPageTransitionStyle style,
                                            int transitionDuration,
                                            int displayDuration)

Creates a new PdfPageTransition instance.

Parameters:

style -

transitionDuration -

displayDuration -

Returns:

the newly created instance.

Throws:

InvalidParameterException - if the input transition or display duration is not positive. if the input style is null.