com.aspose.pdf.elements
Class PageSetup

java.lang.Object
  com.aspose.pdf.elements.PageSetup

All Implemented Interfaces:

java.lang.Cloneable

public class PageSetup
extends java.lang.Object
implements java.lang.Cloneable

Encapsulates info for page setup.

Constructor Summary

PageSetup()
Initializes a new instance of the PageSetup class.

Method Summary

java.lang.Object	clone() Gets a clone of PageSetup.
RectData	getArtBox() Gets a RectData object that indicates the art box of the page.
RectData	getBleedBox() Gets a RectData object that indicates the bleed box of the page.
RectData	getCropBox() Gets a RectData object that indicates the crop box of the page.
MarginInfo	getMargin() Gets a MarginInfo object that indicates the page margin info.
BorderInfo	getPageBorder() Gets a PageBorder object that indicates the page border.
MarginInfo	getPageBorderMargin() Gets a MarginInfo object that indicates the margin between the page border and the page edge.
float	getPageHeight() Gets the height of page.
float	getPageWidth() Gets the width of page.
RectData	getTrimBox() Gets a RectData object that indicates the trim box of the page.
PageSetup	setArtBox(RectData artBox) Sets a RectData object that indicates the art box of the page.
PageSetup	setBleedBox(RectData bleedBox) Sets a RectData object that indicates the bleed box of the page.
PageSetup	setCropBox(RectData cropBox) Sets a RectData object that indicates the crop box of the page.
PageSetup	setMargin(MarginInfo margin) Sets a MarginInfo object that indicates the page margin info.
PageSetup	setPageBorder(BorderInfo border) Sets a PageBorder object that indicates the page border.
PageSetup	setPageBorderMargin(MarginInfo borderMargin) Sets a MarginInfo object that indicates the margin between the page border and the page edge.
PageSetup	setPageHeight(float pageHeight) Sets the height of page, unit is pt.
PageSetup	setPageWidth(float pageWidth) Sets the width of page, unit is pt.
PageSetup	setTrimBox(RectData trimBox) Sets a RectData object that indicates the trim box of the page.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageSetup

public PageSetup()

Initializes a new instance of the PageSetup class.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Gets a clone of PageSetup. You could get an object of PageSetup by Pdf.getPageSetup().clone()

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException - throw when Cloneable interface not implemented

AsposeBaseException

See Also:

Object.clone()

setPageHeight

public PageSetup setPageHeight(float pageHeight)

Sets the height of page, unit is pt.

Parameters:

pageHeight - float, page height in pt

getPageHeight

public float getPageHeight()

Gets the height of page.

Returns:

page height

setPageWidth

public PageSetup setPageWidth(float pageWidth)

Sets the width of page, unit is pt.

Parameters:

pageWidth - float, page width in pt

getPageWidth

public float getPageWidth()

Gets the width of page.

Returns:

page width

setMargin

public PageSetup setMargin(MarginInfo margin)

Sets a MarginInfo object that indicates the page margin info.

Parameters:

margin - MarginInfo

getMargin

public MarginInfo getMargin()

Gets a MarginInfo object that indicates the page margin info.

Returns:

MarginInfo object

getArtBox

public RectData getArtBox()

Gets a RectData object that indicates the art box of the page.
The art box (PDF 1.3) defines the extent of the page¡¯s meaningful content
(including potential white space) as intended by the page¡¯s creator.

Returns:

Returns the ArtBox.

setArtBox

public PageSetup setArtBox(RectData artBox)

Sets a RectData object that indicates the art box of the page.
The art box (PDF 1.3) defines the extent of the page¡¯s meaningful content
(including potential white space) as intended by the page¡¯s creator.

Parameters:

artBox - The ArtBox to set.

getBleedBox

public RectData getBleedBox()

Gets a RectData object that indicates the bleed box of the page.
The bleed box (PDF 1.3) defines the region to which the contents of the page
should be clipped when output in a production environment. This may include any
extra ¡°bleed area¡± needed to accommodate the physical limitations of cutting,
folding, and trimming equipment. The actual printed page may include printing
marks that fall outside the bleed box.

Returns:

Returns the BleedBox.

setBleedBox

public PageSetup setBleedBox(RectData bleedBox)

Sets a RectData object that indicates the bleed box of the page.
The bleed box (PDF 1.3) defines the region to which the contents of the page
should be clipped when output in a production environment. This may include any
extra ¡°bleed area¡± needed to accommodate the physical limitations of cutting,
folding, and trimming equipment. The actual printed page may include printing
marks that fall outside the bleed box.

Parameters:

bleedBox - The BleedBox to set.

getCropBox

public RectData getCropBox()

Gets a RectData object that indicates the crop box of the page.

Returns:

Returns the CropBox.

setCropBox

public PageSetup setCropBox(RectData cropBox)

Sets a RectData object that indicates the crop box of the page.

Parameters:

cropBox - The CropBox to set.

getPageBorder

public BorderInfo getPageBorder()

Gets a PageBorder object that indicates the page border.

Returns:

Returns the PageBorder.

setPageBorder

public PageSetup setPageBorder(BorderInfo border)

Sets a PageBorder object that indicates the page border.

Parameters:

border - The PageBorder to set.

getPageBorderMargin

public MarginInfo getPageBorderMargin()

Gets a MarginInfo object that indicates the margin between the page
border and the page edge. The default value is half of the page margin.

Returns:

Returns the PageBorderMargin.

setPageBorderMargin

public PageSetup setPageBorderMargin(MarginInfo borderMargin)

Sets a MarginInfo object that indicates the margin between the page
border and the page edge. The default value is half of the page margin.

Parameters:

borderMargin - The PageBorderMargin to set.

getTrimBox

public RectData getTrimBox()

Gets a RectData object that indicates the trim box of the page.
The trim box (PDF 1.3) defines the intended dimensions of the finished page
after trimming. It may be smaller than the media box, to allow for productionrelated
content such as printing instructions, cut marks, or color bars.

Returns:

Returns the TrimBox.

setTrimBox

public PageSetup setTrimBox(RectData trimBox)

Sets a RectData object that indicates the trim box of the page.
The trim box (PDF 1.3) defines the intended dimensions of the finished page
after trimming. It may be smaller than the media box, to allow for productionrelated
content such as printing instructions, cut marks, or color bars.

Parameters:

trimBox - The TrimBox to set.