|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.PageSetup
public class PageSetup
Encapsulates info for page setup.
Typical usages are the following:
Constructor Summary | |
---|---|
PageSetup()
Initializes a new instance of the PageSetup class. |
|
PageSetup(Section section)
Initializes a new instance of the PageSetup class. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clones a new PageSetup object. |
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 BorderInfo object that indicates the page border. |
MarginInfo |
getPageBorderMargin()
Gets a MarginInfo object that indicates the margin between the page border
and the page edge. |
PageGutter |
getPageGutter()
Gets a PageGutter object that indicates the page gutter. |
float |
getPageHeight()
Gets a float value that indicates the page height. |
float |
getPageWidth()
Gets a float value that indicates the page width. |
RectData |
getTrimBox()
Gets a RectData object that indicates the trim box of the page. |
void |
setArtBox(RectData value)
Sets a RectData object that indicates the art box of the page. |
void |
setBleedBox(RectData value)
Sets a RectData object that indicates the bleed box of the page. |
void |
setCropBox(RectData value)
Sets a float value that indicates the page height. |
void |
setMargin(MarginInfo value)
Sets a MarginInfo object that indicates the page margin info. |
void |
setPageBorder(BorderInfo value)
Sets a BorderInfo object that indicates the page border. |
void |
setPageBorderMargin(MarginInfo value)
Sets a MarginInfo object that indicates the margin between the page border
and the page edge. |
void |
setPageGutter(PageGutter value)
Sets a PageGutter object that indicates the page gutter. |
void |
setPageHeight(float value)
Sets a float value that indicates the page height. |
void |
setPageWidth(float value)
Sets a float value that indicates the page width. |
void |
setTrimBox(RectData value)
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 |
---|
public PageSetup()
PageSetup
class.
public PageSetup(Section section)
PageSetup
class.
section
- The section in which this PageSetup is used for.Method Detail |
---|
public MarginInfo getMargin()
MarginInfo
object that indicates the page margin info.
public void setMargin(MarginInfo value)
MarginInfo
object that indicates the page margin info.
value
- public float getPageWidth()
public void setPageWidth(float value)
value
- public float getPageHeight()
public void setPageHeight(float value)
value
- public RectData getCropBox()
RectData
object that indicates the crop box
of the page.
public void setCropBox(RectData value)
value
- public RectData getBleedBox()
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.
public void setBleedBox(RectData value)
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.
value
- public RectData getArtBox()
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.
public void setArtBox(RectData value)
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.
value
- public RectData getTrimBox()
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.
public void setTrimBox(RectData value)
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.
value
- public BorderInfo getPageBorder()
BorderInfo
object that indicates the page border.
public void setPageBorder(BorderInfo value)
BorderInfo
object that indicates the page border.
value
- public MarginInfo getPageBorderMargin()
MarginInfo
object that indicates the margin between the page border
and the page edge. The default value is half of the page margin.
public void setPageBorderMargin(MarginInfo value)
MarginInfo
object that indicates the margin between the page border
and the page edge. The default value is half of the page margin.
value
- public PageGutter getPageGutter()
PageGutter
object that indicates the page gutter.
public void setPageGutter(PageGutter value)
PageGutter
object that indicates the page gutter.
value
- public java.lang.Object clone()
PageSetup
object.
clone
in class java.lang.Object
PageSetup
object.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |