public class PageSettings
extends java.lang.Object
| Constructor and Description |
|---|
PageSettings() |
| Modifier and Type | Method and Description |
|---|---|
PageSettings |
clone() |
boolean |
getAlignMarginsHeaderFooter()
Returns whether to align the header and the footer with the margins set in the page setup options.
|
Rect |
getAvailbleContentRect() |
boolean |
getBlackAndWhite()
Returns whether the elements of the document will be printed in black and white.
|
double |
getBottomMargin()
Returns the size of the bottom margin, in points.
|
java.lang.String |
getCenterFooter()
Returns the alignment of text on the center footer of the page.
|
IGraphic |
getCenterFooterPicture()
Returns a IGraphic object that represents the picture for the center section of the footer.
|
java.lang.String |
getCenterHeader()
Returns the alignment of text on the center header of the page.
|
IGraphic |
getCenterHeaderPicture()
Returns a IGraphic object that represents the picture for the center section of the header.
|
boolean |
getCenterHorizontally()
Returns whether the sheet is centered horizontally on the page when it's printed.
|
boolean |
getCenterVertically()
Returns whether the sheet is centered vertically on the page when it's printed.
|
boolean |
getDraft()
Returns whether the sheet will be printed without graphics.
|
double |
getFooterMargin()
Returns the size of the footer margin, in points.
|
double |
getHeaderMargin()
Returns the size of the header margin, in points.
|
java.lang.String |
getLeftFooter()
Returns the alignment of text on the left footer of the page.
|
IGraphic |
getLeftFooterPicture()
Returns a IGraphic object that represents the picture for the left section of the footer.
|
java.lang.String |
getLeftHeader()
Returns the alignment of text on the left header of the page.
|
IGraphic |
getLeftHeaderPicture()
Returns a IGraphic object that represents the picture for the left section of the header.
|
double |
getLeftMargin()
Returns the size of the left margin, in points.
|
double |
getPaperHeight()
Returns the height in points of the paper, considered page orientation.
|
double |
getPaperWidth()
Returns the width in points of the paper, considered page orientation.
|
PrintErrors |
getPrintErrors()
Returns an PrintErrors contstant specifying the type of print error displayed.
|
boolean |
getPrintGridlines()
Returns whether cell gridlines are printed on the page.
|
java.lang.String |
getRightFooter()
Returns the alignment of text on the right footer of the page.
|
IGraphic |
getRightFooterPicture()
Returns a IGraphic object that represents the picture for the right section of the footer.
|
java.lang.String |
getRightHeader()
Returns the alignment of text on the right header of the page.
|
IGraphic |
getRightHeaderPicture()
Returns a IGraphic object that represents the picture for the right section of the header.
|
double |
getRightMargin()
Returns the size of the right margin, in points.
|
boolean |
getScaleWithDocHeaderFooter()
Returns if the header and footer should be scaled with the document when the size of the document changes.
|
double |
getTopMargin()
Returns the size of the top margin, in points.
|
void |
setAlignMarginsHeaderFooter(boolean value)
Sets whether to align the header and the footer with the margins set in the page setup options.
|
void |
setBlackAndWhite(boolean value)
Sets whether the elements of the document will be printed in black and white.
|
void |
setBottomMargin(double value)
Sets the size of the bottom margin, in points.
|
void |
setCenterFooter(java.lang.String value)
Sets the alignment of text on the center footer of the page.
|
void |
setCenterFooterPicture(IGraphic value)
Sets a IGraphic object that represents the picture for the center section of the footer.
|
void |
setCenterHeader(java.lang.String value)
Sets the alignment of text on the center header of the page.
|
void |
setCenterHeaderPicture(IGraphic value)
Sets a IGraphic object that represents the picture for the center section of the header.
|
void |
setCenterHorizontally(boolean value)
Sets whether the sheet is centered horizontally on the page when it's printed.
|
void |
setCenterVertically(boolean value)
Sets whether the sheet is centered vertically on the page when it's printed.
|
void |
setDraft(boolean value)
Sets whether the sheet will be printed without graphics.
|
void |
setFooterMargin(double value)
Sets the size of the footer margin, in points.
|
void |
setHeaderMargin(double value)
Sets the size of the header margin, in points.
|
void |
setLeftFooter(java.lang.String value)
Sets the alignment of text on the left footer of the page.
|
void |
setLeftFooterPicture(IGraphic value)
Sets a IGraphic object that represents the picture for the left section of the footer.
|
void |
setLeftHeader(java.lang.String value)
Sets the alignment of text on the left header of the page.
|
void |
setLeftHeaderPicture(IGraphic value)
Sets a IGraphic object that represents the picture for the left section of the header.
|
void |
setLeftMargin(double value)
Sets the size of the left margin, in points.
|
void |
setPaperHeight(double value)
Sets the height in points of the paper, considered page orientation.
|
void |
setPaperWidth(double value)
Sets the width in points of the paper, considered page orientation.
|
void |
setPrintErrors(PrintErrors value)
Sets an PrintErrors contstant specifying the type of print error displayed.
|
void |
setPrintGridlines(boolean value)
Sets whether cell gridlines are printed on the page.
|
void |
setRightFooter(java.lang.String value)
Sets the alignment of text on the right footer of the page.
|
void |
setRightFooterPicture(IGraphic value)
Sets a IGraphic object that represents the picture for the right section of the footer.
|
void |
setRightHeader(java.lang.String value)
Sets the alignment of text on the right header of the page.
|
void |
setRightHeaderPicture(IGraphic value)
Sets a IGraphic object that represents the picture for the right section of the header.
|
void |
setRightMargin(double value)
Sets the size of the right margin, in points.
|
void |
setScaleWithDocHeaderFooter(boolean value)
Sets if the header and footer should be scaled with the document when the size of the document changes.
|
void |
setTopMargin(double value)
Sets the size of the top margin, in points.
|
public final boolean getScaleWithDocHeaderFooter()
public final void setScaleWithDocHeaderFooter(boolean value)
public final java.lang.String getCenterFooter()
public final void setCenterFooter(java.lang.String value)
public final java.lang.String getLeftFooter()
public final void setLeftFooter(java.lang.String value)
public final java.lang.String getRightFooter()
public final void setRightFooter(java.lang.String value)
public final java.lang.String getLeftHeader()
public final void setLeftHeader(java.lang.String value)
public final java.lang.String getCenterHeader()
public final void setCenterHeader(java.lang.String value)
public final java.lang.String getRightHeader()
public final void setRightHeader(java.lang.String value)
public final IGraphic getCenterFooterPicture()
public final void setCenterFooterPicture(IGraphic value)
public final IGraphic getLeftFooterPicture()
public final void setLeftFooterPicture(IGraphic value)
public final IGraphic getRightFooterPicture()
public final void setRightFooterPicture(IGraphic value)
public final IGraphic getLeftHeaderPicture()
public final void setLeftHeaderPicture(IGraphic value)
public final IGraphic getCenterHeaderPicture()
public final void setCenterHeaderPicture(IGraphic value)
public final IGraphic getRightHeaderPicture()
public final void setRightHeaderPicture(IGraphic value)
public final boolean getBlackAndWhite()
public final void setBlackAndWhite(boolean value)
public final boolean getDraft()
public final void setDraft(boolean value)
public final boolean getPrintGridlines()
public final void setPrintGridlines(boolean value)
public final PrintErrors getPrintErrors()
public final void setPrintErrors(PrintErrors value)
public final boolean getAlignMarginsHeaderFooter()
public final void setAlignMarginsHeaderFooter(boolean value)
public final boolean getCenterHorizontally()
public final void setCenterHorizontally(boolean value)
public final boolean getCenterVertically()
public final void setCenterVertically(boolean value)
public final double getLeftMargin()
public final void setLeftMargin(double value)
public final double getTopMargin()
public final void setTopMargin(double value)
public final double getRightMargin()
public final void setRightMargin(double value)
public final double getBottomMargin()
public final void setBottomMargin(double value)
public final double getHeaderMargin()
public final void setHeaderMargin(double value)
public final double getFooterMargin()
public final void setFooterMargin(double value)
public final double getPaperWidth()
public final void setPaperWidth(double value)
public final double getPaperHeight()
public final void setPaperHeight(double value)
public final Rect getAvailbleContentRect()
public final PageSettings clone()
clone in class java.lang.Object