org.sejda.model.parameter.image

Class AbstractPdfToImageParameters

java.lang.Object

org.sejda.model.parameter.base.AbstractParameters

org.sejda.model.parameter.image.AbstractPdfToImageParameters

All Implemented Interfaces:

SinglePdfSourceTaskParameters, TaskParameters

Direct Known Subclasses:

AbstractPdfToMultipleImageParameters, AbstractPdfToSingleImageParameters

public abstract class AbstractPdfToImageParameters
extends AbstractParameters
implements SinglePdfSourceTaskParameters

Base class for a parameter meant to convert an existing pdf source to an image of a specified type.

Author:

Andrea Vacondio

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DPI

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
ImageColorType	getOutputImageColorType()
abstract ImageType	getOutputImageType()
int	getResolutionInDpi()
PdfSource<?>	getSource()
float	getUserZoom()
int	hashCode()
void	setResolutionInDpi(int resolutionInDpi)
void	setSource(PdfSource<?> source) Set the source for this parameter.
void	setUserZoom(float userZoom) Controls the resolution of the resulting images.

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

isOverwrite, setOverwrite, 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

getOutput, isOverwrite

Field Detail

DEFAULT_DPI

public static final int DEFAULT_DPI

See Also:

Constant Field Values

Method Detail

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

getOutputImageColorType

public ImageColorType getOutputImageColorType()

getUserZoom

public float getUserZoom()

setUserZoom

public void setUserZoom(float userZoom)

Controls the resolution of the resulting images. Works well with vector pdf files, not with the ones that already have images embedded.

Parameters:

userZoom - how much should the pdf page be zoomed in before it gets rendered as an image.

getOutputImageType

@NotNull
public abstract ImageType getOutputImageType()

Returns:

the type of image the task executing this parameter will convert the pdf source to.

getResolutionInDpi

public int getResolutionInDpi()

setResolutionInDpi

public void setResolutionInDpi(int resolutionInDpi)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractParameters

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractParameters