public final class SheetSettings
extends java.lang.Object
Modifier and Type | Field | Description |
---|---|---|
static int |
DEFAULT_DEFAULT_ROW_HEIGHT |
The default value for the default row height
|
Constructor | Description |
---|---|
SheetSettings(Sheet s) |
Default constructor
|
SheetSettings(SheetSettings copy,
Sheet s) |
Copy constructor.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
getAutomaticFormulaCalculation() |
Retrieves the automatic formula calculation flag
|
double |
getBottomMargin() |
Accessor for the bottom margin
|
int |
getCopies() |
Accessor for the number of copies to print
|
int |
getDefaultColumnWidth() |
Accessor for the default column width
|
double |
getDefaultHeightMargin() |
Gets the default margin height
|
int |
getDefaultRowHeight() |
Accessor for the default row height
|
double |
getDefaultWidthMargin() |
Gets the default margin width
|
boolean |
getDisplayZeroValues() |
Accessor for the displayZeroValues property
|
int |
getFitHeight() |
Accessor for the fit height
|
boolean |
getFitToPages() |
Accessor for the fit width print flag
|
int |
getFitWidth() |
Accessor for the fit width
|
HeaderFooter |
getFooter() |
Accessor for the footer
|
double |
getFooterMargin() |
Accessor for the footer margin
|
HeaderFooter |
getHeader() |
Accessor for the header
|
double |
getHeaderMargin() |
Accessor for the header margin
|
int |
getHorizontalFreeze() |
Gets the row at which the pane is frozen horizontally
|
int |
getHorizontalPrintResolution() |
Accessor for the horizontal print resolution
|
double |
getLeftMargin() |
Accessor for the left margin
|
int |
getNormalMagnification() |
Accessor for the nomral view magnificaton factor.
|
PageOrientation |
getOrientation() |
Accessor for the orientation
|
int |
getPageBreakPreviewMagnification() |
Accessor for the page break preview mangificaton factor.
|
boolean |
getPageBreakPreviewMode() |
Accessor for the pageBreakPreview mode
|
PageOrder |
getPageOrder() |
Accessor for the order
|
int |
getPageStart() |
Accessor for the page start
|
PaperSize |
getPaperSize() |
Accessor for the paper size
|
java.lang.String |
getPassword() |
Accessor for the password
|
int |
getPasswordHash() |
Accessor for the password hash - used only when copying sheets
|
Range |
getPrintArea() |
Accessor for the print area
|
boolean |
getPrintGridLines() |
Accessor for the printGridLines property
|
boolean |
getPrintHeaders() |
Accessor for the printHeaders property
|
Range |
getPrintTitlesCol() |
Accessor for the print column titles
|
Range |
getPrintTitlesRow() |
Accessor for the print row titles
|
boolean |
getRecalculateFormulasBeforeSave() |
Retrieves the recalculate formulas before save flag
|
double |
getRightMargin() |
Accessor for the right margin
|
int |
getScaleFactor() |
Accessor for the scale factor
|
boolean |
getShowGridLines() |
Accessor for the showGridLines property
|
double |
getTopMargin() |
Accessor for the top margin
|
int |
getVerticalFreeze() |
Gets the column at which the pane is frozen vertically
|
int |
getVerticalPrintResolution() |
Accessor for the vertical print resolution
|
int |
getZoomFactor() |
Accessor for the zoom factor.
|
boolean |
isHidden() |
Accessor for the hidden nature of this sheet
|
boolean |
isHorizontalCentre() |
Accessor for the horizontal centre
|
boolean |
isProtected() |
Queries whether this sheet is protected (ie.
|
boolean |
isSelected() |
Accessor for the selected nature of the sheet
|
boolean |
isVerticalCentre() |
Accessor for the vertical centre
|
void |
setAutomaticFormulaCalculation(boolean auto) |
Sets the automatic formula calculation flag
|
void |
setBottomMargin(double m) |
Sets the bottom margin
|
void |
setCopies(int c) |
Sets the number of copies
|
void |
setDefaultColumnWidth(int w) |
Sets the default column width
|
void |
setDefaultRowHeight(int h) |
Sets the default row height
|
void |
setDisplayZeroValues(boolean b) |
Sets the displayZeroValues property
|
void |
setFitHeight(int fh) |
Sets the number of pages vertically that this sheet will be printed into
|
void |
setFitToPages(boolean b) |
Accessor for the fit to pages flag
|
void |
setFitWidth(int fw) |
Sets the number of pages widthwise which this sheet should be
printed into
|
void |
setFooter(HeaderFooter f) |
Sets the footer
|
void |
setFooterMargin(double d) |
Sets the margin for any page footer
|
void |
setHeader(HeaderFooter h) |
Sets the header
|
void |
setHeaderMargin(double d) |
Sets the margin for any page headers
|
void |
setHidden(boolean h) |
Sets the hidden status of this worksheet
|
void |
setHorizontalCentre(boolean horizCentre) |
Sets the horizontal centre
|
void |
setHorizontalFreeze(int row) |
Sets the row at which the pane is frozen horizontally
|
void |
setHorizontalPrintResolution(int hpw) |
Sets the horizontal print resolution
|
void |
setLeftMargin(double m) |
Sets the left margin
|
void |
setNormalMagnification(int f) |
Accessor for the normal magnificaton factor.
|
void |
setOrientation(PageOrientation po) |
Sets the paper orientation for printing this sheet
|
void |
setPageBreakPreviewMagnification(int f) |
Accessor for the page break preview magnificaton factor.
|
void |
setPageBreakPreviewMode(boolean b) |
Sets the pageBreakPreviewMode property
|
void |
setPageOrder(PageOrder order) |
Sets the page order for printing this sheet
|
void |
setPageStart(int ps) |
Sets the page number at which to commence printing
|
void |
setPaperSize(PaperSize ps) |
Sets the paper size to be used when printing this sheet
|
void |
setPassword(java.lang.String s) |
Sets the password for this sheet
|
void |
setPasswordHash(int ph) |
Accessor for the password hash - used only when copying sheets
|
void |
setPrintArea(int firstCol,
int firstRow,
int lastCol,
int lastRow) |
Sets the print area for this sheet
|
void |
setPrintGridLines(boolean b) |
Sets the printGridLines property
|
void |
setPrintHeaders(boolean b) |
Sets the printHeaders property
|
void |
setPrintTitles(int firstRow,
int lastRow,
int firstCol,
int lastCol) |
Sets both of the print titles for this sheet
|
void |
setPrintTitlesCol(int firstCol,
int lastCol) |
Sets the print column titles for this sheet
|
void |
setPrintTitlesRow(int firstRow,
int lastRow) |
Sets the print row titles for this sheet
|
void |
setProtected(boolean p) |
Sets the protected (ie.
|
void |
setRecalculateFormulasBeforeSave(boolean recalc) |
Sets the recalculate formulas when the sheet is saved flag
|
void |
setRightMargin(double m) |
Sets the right margin
|
void |
setScaleFactor(int sf) |
Sets the scale factor for this sheet to be used when printing.
|
void |
setSelected() |
Deprecated.
use overloaded version which takes a boolean
|
void |
setSelected(boolean s) |
Sets this sheet to be when it is opened in excel
|
void |
setShowGridLines(boolean b) |
Sets the showGridLines property
|
void |
setTopMargin(double m) |
Sets the top margin
|
void |
setVerticalCentre(boolean vertCentre) |
Sets the vertical centre
|
void |
setVerticalFreeze(int col) |
Sets the row at which the pane is frozen vertically
|
void |
setVerticalPrintResolution(int vpw) |
Sets the vertical print reslution
|
void |
setZoomFactor(int zf) |
Sets the zoom factor.
|
public static final int DEFAULT_DEFAULT_ROW_HEIGHT
public SheetSettings(Sheet s)
public SheetSettings(SheetSettings copy, Sheet s)
copy
- the settings to copypublic void setOrientation(PageOrientation po)
po
- the orientationpublic PageOrientation getOrientation()
public PageOrder getPageOrder()
public void setPageOrder(PageOrder order)
order
- public void setPaperSize(PaperSize ps)
ps
- the paper sizepublic PaperSize getPaperSize()
public boolean isProtected()
public void setProtected(boolean p)
p
- the protected statuspublic void setHeaderMargin(double d)
d
- the margin in inchespublic double getHeaderMargin()
public void setFooterMargin(double d)
d
- the footer margin in inchespublic double getFooterMargin()
public void setHidden(boolean h)
h
- the hidden flagpublic boolean isHidden()
public void setSelected()
public void setSelected(boolean s)
s
- sets whether this sheet is selected or notpublic boolean isSelected()
public void setScaleFactor(int sf)
sf
- the scale factor as a percentagepublic int getScaleFactor()
public void setPageStart(int ps)
ps
- the page start numberpublic int getPageStart()
public void setFitWidth(int fw)
fw
- the number of pagespublic int getFitWidth()
public void setFitHeight(int fh)
fh
- the number of pages this sheet will be printed into heightwisepublic int getFitHeight()
public void setHorizontalPrintResolution(int hpw)
hpw
- the print resolutionpublic int getHorizontalPrintResolution()
public void setVerticalPrintResolution(int vpw)
vpw
- the vertical print resolutionpublic int getVerticalPrintResolution()
public void setRightMargin(double m)
m
- the right margin in inchespublic double getRightMargin()
public void setLeftMargin(double m)
m
- the left margin in inchespublic double getLeftMargin()
public void setTopMargin(double m)
m
- the top margin in inchespublic double getTopMargin()
public void setBottomMargin(double m)
m
- the bottom margin in inchespublic double getBottomMargin()
public double getDefaultWidthMargin()
public double getDefaultHeightMargin()
public boolean getFitToPages()
public void setFitToPages(boolean b)
b
- TRUE to fit to pages, FALSE to use a scale factorpublic java.lang.String getPassword()
public void setPassword(java.lang.String s)
s
- the passwordpublic int getPasswordHash()
public void setPasswordHash(int ph)
ph
- the password hashpublic int getDefaultColumnWidth()
public void setDefaultColumnWidth(int w)
w
- the new default column widthpublic int getDefaultRowHeight()
public void setDefaultRowHeight(int h)
h
- the default row height, in 1/20ths of a pointpublic int getZoomFactor()
public void setZoomFactor(int zf)
zf
- the zoom factor as a percentagepublic int getPageBreakPreviewMagnification()
public void setPageBreakPreviewMagnification(int f)
f
- the page break preview magnification as a percentagepublic int getNormalMagnification()
public void setNormalMagnification(int f)
f
- the page break preview magnification as a percentagepublic boolean getDisplayZeroValues()
public void setDisplayZeroValues(boolean b)
b
- TRUE to show zero values, FALSE not to botherpublic boolean getShowGridLines()
public void setShowGridLines(boolean b)
b
- TRUE to show grid lines on this sheet, FALSE otherwisepublic boolean getPageBreakPreviewMode()
public void setPageBreakPreviewMode(boolean b)
b
- TRUE to launch in page break preview mode, FALSE otherwisepublic boolean getPrintGridLines()
public void setPrintGridLines(boolean b)
b
- TRUE to print grid lines on this sheet, FALSE otherwisepublic boolean getPrintHeaders()
public void setPrintHeaders(boolean b)
b
- TRUE to print headers on this sheet, FALSE otherwisepublic int getHorizontalFreeze()
public void setHorizontalFreeze(int row)
row
- the row number to freeze atpublic int getVerticalFreeze()
public void setVerticalFreeze(int col)
col
- the column number to freeze atpublic void setCopies(int c)
c
- the number of copiespublic int getCopies()
public HeaderFooter getHeader()
public void setHeader(HeaderFooter h)
h
- the headerpublic void setFooter(HeaderFooter f)
f
- the footerpublic HeaderFooter getFooter()
public boolean isHorizontalCentre()
public void setHorizontalCentre(boolean horizCentre)
horizCentre
- The horizontalCentre to set.public boolean isVerticalCentre()
public void setVerticalCentre(boolean vertCentre)
vertCentre
- The verticalCentre to set.public void setAutomaticFormulaCalculation(boolean auto)
auto
- - TRUE to automatically calculate the formulas,
FALSE otherwisepublic boolean getAutomaticFormulaCalculation()
public void setRecalculateFormulasBeforeSave(boolean recalc)
recalc
- - TRUE to automatically calculate the formulas when the,
spreadsheet is saved, FALSE otherwisepublic boolean getRecalculateFormulasBeforeSave()
public void setPrintArea(int firstCol, int firstRow, int lastCol, int lastRow)
firstCol
- the first column of the print areafirstRow
- the first row of the print arealastCol
- the last column of the print arealastRow
- the last row of the print areapublic Range getPrintArea()
public void setPrintTitles(int firstRow, int lastRow, int firstCol, int lastCol)
firstRow
- the first row of the print row titleslastRow
- the last row of the print row titlesfirstCol
- the first column of the print column titleslastCol
- the last column of the print column titlespublic void setPrintTitlesRow(int firstRow, int lastRow)
firstRow
- the first row of the print titleslastRow
- the last row of the print titlespublic void setPrintTitlesCol(int firstCol, int lastCol)
firstRow
- the first row of the print titleslastRow
- the last row of the print titlespublic Range getPrintTitlesRow()
public Range getPrintTitlesCol()