org.sejda.model.parameter

Class SetPagesTransitionParameters

java.lang.Object

org.sejda.model.parameter.base.AbstractParameters

org.sejda.model.parameter.base.AbstractPdfOutputParameters

org.sejda.model.parameter.base.SinglePdfSourceSingleOutputParameters

org.sejda.model.parameter.SetPagesTransitionParameters

All Implemented Interfaces:

SingleOutputTaskParameters, SinglePdfSourceTaskParameters, TaskParameters

@SingleOutputAllowedExtensions
 @HasTransitions
public class SetPagesTransitionParameters
extends SinglePdfSourceSingleOutputParameters

Parameter class for the set pages transition manipulation.

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor and Description
SetPagesTransitionParameters()
SetPagesTransitionParameters(PdfPageTransition defaultTransition)

Method Summary

Modifier and Type	Method and Description
void	clearTransitions() Clears the collection of transitions stored in this parameter instance.
boolean	equals(Object other)
PdfPageTransition	getDefaultTransition()
PdfPageTransition	getOrDefault(int page)
PdfSource<?>	getSource()
Map<Integer,PdfPageTransition>	getTransitions()
int	hashCode()
boolean	isFullScreen()
PdfPageTransition	putTransition(Integer page, PdfPageTransition transition) Associates the given transition to the given page number.
void	setFullScreen(boolean fullScreen)
void	setSource(PdfSource<?> source) Set the source for this parameter.

Methods inherited from class org.sejda.model.parameter.base.SinglePdfSourceSingleOutputParameters

getOutput, setOutput

Methods inherited from class org.sejda.model.parameter.base.AbstractPdfOutputParameters

getMinRequiredPdfVersion, getVersion, isCompress, setCompress, setVersion

Methods inherited from class org.sejda.model.parameter.base.AbstractParameters

getExistingOutputPolicy, isLenient, setExistingOutputPolicy, setLenient, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sejda.model.parameter.base.TaskParameters

getExistingOutputPolicy, isLenient, setExistingOutputPolicy, setLenient

Constructor Detail

SetPagesTransitionParameters

public SetPagesTransitionParameters()

SetPagesTransitionParameters

public SetPagesTransitionParameters(PdfPageTransition defaultTransition)

Parameters:

defaultTransition - the default transition

Method Detail

isFullScreen

public boolean isFullScreen()

setFullScreen

public void setFullScreen(boolean fullScreen)

putTransition

public PdfPageTransition putTransition(Integer page,
                                       PdfPageTransition transition)

Associates the given transition to the given page number. If a transition was already associated to the given page, it is replaced with the new one.

Parameters:

page -

transition -

Returns:

the previously associated transition or null.

clearTransitions

public void clearTransitions()

Clears the collection of transitions stored in this parameter instance.

getTransitions

public Map<Integer,PdfPageTransition> getTransitions()

Returns:

an unmodifiable view of the transitions in this parameter.

getDefaultTransition

public PdfPageTransition getDefaultTransition()

getOrDefault

public PdfPageTransition getOrDefault(int page)

Parameters:

page -

Returns:

the transition for the given page or the default one if no transition is set for that page

hashCode

public int hashCode()

Overrides:

hashCode in class SinglePdfSourceSingleOutputParameters

equals

public boolean equals(Object other)

Overrides:

equals in class SinglePdfSourceSingleOutputParameters

getSource

public PdfSource<?> getSource()

Specified by:

getSource in interface SinglePdfSourceTaskParameters

Returns:

the source for this parameter.

setSource

public void setSource(PdfSource<?> source)

Description copied from interface: SinglePdfSourceTaskParameters

Set the source for this parameter.

Specified by:

setSource in interface SinglePdfSourceTaskParameters