com.itextpdf.dito.sdk.output.properties

Class PageProperties

java.lang.Object

com.itextpdf.dito.sdk.output.properties.PageProperties

public class PageProperties
extends Object

Constructor Summary

Constructors

Constructor and Description
PageProperties()

Method Summary

Modifier and Type	Method and Description
Float	getMarginBottom() Gets the value of bottom page margin in points or null if the value is unset (in that case template page margin will be used)
Float	getMarginLeft() Gets the value of left page margin in points or null if the value is unset (in that case template page margin will be used)
Float	getMarginRight() Gets the value of right page margin in points or null if the value is unset (in that case template page margin will be used)
Float	getMarginTop() Gets the value of top page margin in points or null if the value is unset (in that case template page margin will be used)
PageSize	getPageSize() Gets the PageSize instance that describes the page size that will be used for production of output PDF document, or null if the page size specified in the template (possibly the default one) will be used
PageProperties	setMargin(Float margin)
PageProperties	setMargin(Float topAndBottom, Float leftAndRight)
PageProperties	setMargin(Float top, Float leftAndRight, Float bottom)
PageProperties	setMargin(Float top, Float right, Float bottom, Float left)
PageProperties	setMarginBottom(Float marginBottom) Sets bottom page margin in points
PageProperties	setMarginLeft(Float marginLeft) Sets left page margin in points
PageProperties	setMarginRight(Float marginRight) Sets right page margin in points
PageProperties	setMarginTop(Float marginTop) Sets top page margin in points
PageProperties	setPageSize(PageSize pageSize) Sets page size for the output PDF document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageProperties

public PageProperties()

Method Detail

setMarginLeft

public PageProperties setMarginLeft(Float marginLeft)

Sets left page margin in points

Parameters:

marginLeft - value of left margin in points, or null to use template value instead

Returns:

this instance for chaining

setMarginRight

public PageProperties setMarginRight(Float marginRight)

Sets right page margin in points

Parameters:

marginRight - value of right margin in points, or null to use template value instead

Returns:

this instance for chaining

setMarginTop

public PageProperties setMarginTop(Float marginTop)

Sets top page margin in points

Parameters:

marginTop - value of top margin in points, or null to use template value instead

Returns:

this instance for chaining

setMarginBottom

public PageProperties setMarginBottom(Float marginBottom)

Sets bottom page margin in points

Parameters:

marginBottom - value of bottom margin in points, or null to use template value instead

Returns:

this instance for chaining

setMargin

public PageProperties setMargin(Float margin)

setMargin

public PageProperties setMargin(Float topAndBottom,
                                Float leftAndRight)

setMargin

public PageProperties setMargin(Float top,
                                Float leftAndRight,
                                Float bottom)

setMargin

public PageProperties setMargin(Float top,
                                Float right,
                                Float bottom,
                                Float left)

setPageSize

public PageProperties setPageSize(PageSize pageSize)

Sets page size for the output PDF document. If set, this page size will be used for all the pages

Parameters:

pageSize - page size to be used in the document

Returns:

this instance for chaining

getMarginLeft

public Float getMarginLeft()

Gets the value of left page margin in points or null if the value is unset (in that case template page margin will be used)

Returns:

value of left page margin

getMarginRight

public Float getMarginRight()

Gets the value of right page margin in points or null if the value is unset (in that case template page margin will be used)

Returns:

value of right page margin

getMarginTop

public Float getMarginTop()

Gets the value of top page margin in points or null if the value is unset (in that case template page margin will be used)

Returns:

value of top page margin

getMarginBottom

public Float getMarginBottom()

Gets the value of bottom page margin in points or null if the value is unset (in that case template page margin will be used)

Returns:

value of bottom page margin

getPageSize

public PageSize getPageSize()

Gets the PageSize instance that describes the page size that will be used for production of output PDF document, or null if the page size specified in the template (possibly the default one) will be used

Returns:

PageSize instance describing the page size