org.sejda.model.parameter

Class SetHeaderFooterParameters

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.SetHeaderFooterParameters

All Implemented Interfaces:

SingleOutputTaskParameters, SinglePdfSourceTaskParameters, TaskParameters

@SingleOutputAllowedExtensions
@HasHeaderFooterDefinition
public class SetHeaderFooterParameters
extends SinglePdfSourceSingleOutputParameters

Parameters configuring how to label the header/footer of a set of pages in a given pdf document.

Author:

Eduard Weissmann

Constructor Summary

Constructors

Constructor and Description
SetHeaderFooterParameters()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
StandardType1Font	getFont()
BigDecimal	getFontSize()
HorizontalAlign	getHorizontalAlign()
String	getLabelPrefix()
Numbering	getNumbering()
PageRange	getPageRange()
PdfSource<?>	getSource()
VerticalAlign	getVerticalAlign()
int	hashCode()
void	setFont(StandardType1Font font)
void	setFontSize(BigDecimal fontSize) Set the font size in pts
void	setHorizontalAlign(HorizontalAlign align)
void	setLabelPrefix(String labelPrefix)
void	setNumbering(Numbering numbering)
void	setPageRange(PageRange pageRange) Set the page range where the header/footer will be applied
void	setSource(PdfSource<?> source) Set the source for this parameter.
void	setVerticalAlign(VerticalAlign verticalAlign)
String	styledLabelFor(int pageNumber)

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

getOutput, getOutputName, setOutput, setOutputName

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

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

isOverwrite

Constructor Detail

SetHeaderFooterParameters

public SetHeaderFooterParameters()

Method Detail

getPageRange

public PageRange getPageRange()

setPageRange

public void setPageRange(PageRange pageRange)

Set the page range where the header/footer will be applied

Parameters:

pageRange -

styledLabelFor

public String styledLabelFor(int pageNumber)

Parameters:

pageNumber -

Returns:

the styled label for the given page number

getFont

public StandardType1Font getFont()

setFont

public void setFont(StandardType1Font font)

getHorizontalAlign

public HorizontalAlign getHorizontalAlign()

setHorizontalAlign

public void setHorizontalAlign(HorizontalAlign align)

getVerticalAlign

public VerticalAlign getVerticalAlign()

setVerticalAlign

public void setVerticalAlign(VerticalAlign verticalAlign)

getFontSize

public BigDecimal getFontSize()

getNumbering

public Numbering getNumbering()

setNumbering

public void setNumbering(Numbering numbering)

getLabelPrefix

public String getLabelPrefix()

setLabelPrefix

public void setLabelPrefix(String labelPrefix)

setFontSize

public void setFontSize(BigDecimal fontSize)

Set the font size in pts

Parameters:

fontSize -

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