This is a bean which client applications may use to get/set various
properties which are associated with a particular worksheet, such
as headers and footers, page orientation etc.
getAutomaticFormulaCalculation
public boolean getAutomaticFormulaCalculation()
Retrieves the automatic formula calculation flag
- TRUE if formulas are calculated automatically, FALSE if they
are calculated manually
getBottomMargin
public double getBottomMargin()
Accessor for the bottom margin
- the bottom margin in inches
getCopies
public int getCopies()
Accessor for the number of copies to print
getDefaultColumnWidth
public int getDefaultColumnWidth()
Accessor for the default column width
- the default column width, in characters
getDefaultHeightMargin
public double getDefaultHeightMargin()
Gets the default margin height
- the default margin height
getDefaultRowHeight
public int getDefaultRowHeight()
Accessor for the default row height
- the default row height, in 1/20ths of a point
getDefaultWidthMargin
public double getDefaultWidthMargin()
Gets the default margin width
getDisplayZeroValues
public boolean getDisplayZeroValues()
Accessor for the displayZeroValues property
- TRUE to display zero values, FALSE not to bother
getFitHeight
public int getFitHeight()
Accessor for the fit height
- the number of pages this sheet will be printed into heightwise
getFitToPages
public boolean getFitToPages()
Accessor for the fit width print flag
- TRUE if the print is to fit to pages, false otherwise
getFitWidth
public int getFitWidth()
Accessor for the fit width
- the number of pages this sheet will be printed into widthwise
getFooter
public HeaderFooter getFooter()
Accessor for the footer
getFooterMargin
public double getFooterMargin()
Accessor for the footer margin
getHeader
public HeaderFooter getHeader()
Accessor for the header
getHeaderMargin
public double getHeaderMargin()
Accessor for the header margin
getHorizontalFreeze
public int getHorizontalFreeze()
Gets the row at which the pane is frozen horizontally
- the row at which the pane is horizontally frozen, or 0 if there
is no freeze
getHorizontalPrintResolution
public int getHorizontalPrintResolution()
Accessor for the horizontal print resolution
- the horizontal print resolution
getLeftMargin
public double getLeftMargin()
Accessor for the left margin
- the left margin in inches
getNormalMagnification
public int getNormalMagnification()
Accessor for the nomral view magnificaton factor.
Do not confuse zoom factor or scale factor
- the page break preview magnification a percentage
getOrientation
public PageOrientation getOrientation()
Accessor for the orientation
getPageBreakPreviewMagnification
public int getPageBreakPreviewMagnification()
Accessor for the page break preview mangificaton factor.
Do not confuse zoom factor or scale factor
- the page break preview magnification a percentage
getPageBreakPreviewMode
public boolean getPageBreakPreviewMode()
Accessor for the pageBreakPreview mode
- TRUE if page break preview is enabled, FALSE otherwise
getPageStart
public int getPageStart()
Accessor for the page start
getPaperSize
public PaperSize getPaperSize()
Accessor for the paper size
getPassword
public String getPassword()
Accessor for the password
- the password to unlock this sheet, or NULL if not protected
getPasswordHash
public int getPasswordHash()
Accessor for the password hash - used only when copying sheets
getPrintArea
public Range getPrintArea()
Accessor for the print area
- the print area, or NULL if one is not defined for this sheet
getPrintGridLines
public boolean getPrintGridLines()
Accessor for the printGridLines property
- TRUE if grid lines will be printed, FALSE otherwise
getPrintHeaders
public boolean getPrintHeaders()
Accessor for the printHeaders property
- TRUE if headers will be printed, FALSE otherwise
getRecalculateFormulasBeforeSave
public boolean getRecalculateFormulasBeforeSave()
Retrieves the recalculate formulas before save flag
- TRUE if formulas are calculated before the sheet is saved,
FALSE otherwise
getRightMargin
public double getRightMargin()
Accessor for the right margin
- the right margin in inches
getScaleFactor
public int getScaleFactor()
Accessor for the scale factor
getShowGridLines
public boolean getShowGridLines()
Accessor for the showGridLines property
- TRUE if grid lines will be shown, FALSE otherwise
getTopMargin
public double getTopMargin()
Accessor for the top margin
getVerticalFreeze
public int getVerticalFreeze()
Gets the column at which the pane is frozen vertically
- the column at which the pane is vertically frozen, or 0 if there
is no freeze
getVerticalPrintResolution
public int getVerticalPrintResolution()
Accessor for the vertical print resolution
- the vertical print resolution
getZoomFactor
public int getZoomFactor()
Accessor for the zoom factor. Do not confuse zoom factor (which relates
to the on screen view) with scale factor (which refers to the scale factor
when printing)
- the zoom factor as a percentage
isHidden
public boolean isHidden()
Accessor for the hidden nature of this sheet
- TRUE if this sheet is hidden, FALSE otherwise
isHorizontalCentre
public boolean isHorizontalCentre()
Accessor for the horizontal centre
- Returns the horizontalCentre.
isProtected
public boolean isProtected()
Queries whether this sheet is protected (ie. read only)
- TRUE if this sheet is read only, FALSE otherwise
isSelected
public boolean isSelected()
Accessor for the selected nature of the sheet
- TRUE if this sheet is selected, FALSE otherwise
isVerticalCentre
public boolean isVerticalCentre()
Accessor for the vertical centre
- Returns the verticalCentre.
setAutomaticFormulaCalculation
public void setAutomaticFormulaCalculation(boolean auto)
Sets the automatic formula calculation flag
auto
- - TRUE to automatically calculate the formulas,
FALSE otherwise
setBottomMargin
public void setBottomMargin(double m)
Sets the bottom margin
m
- the bottom margin in inches
setCopies
public void setCopies(int c)
Sets the number of copies
setDefaultColumnWidth
public void setDefaultColumnWidth(int w)
Sets the default column width
w
- the new default column width
setDefaultRowHeight
public void setDefaultRowHeight(int h)
Sets the default row height
h
- the default row height, in 1/20ths of a point
setDisplayZeroValues
public void setDisplayZeroValues(boolean b)
Sets the displayZeroValues property
b
- TRUE to show zero values, FALSE not to bother
setFitHeight
public void setFitHeight(int fh)
Sets the number of pages vertically that this sheet will be printed into
fh
- the number of pages this sheet will be printed into heightwise
setFitToPages
public void setFitToPages(boolean b)
Accessor for the fit to pages flag
b
- TRUE to fit to pages, FALSE to use a scale factor
setFitWidth
public void setFitWidth(int fw)
Sets the number of pages widthwise which this sheet should be
printed into
setFooter
public void setFooter(HeaderFooter f)
Sets the footer
setFooterMargin
public void setFooterMargin(double d)
Sets the margin for any page footer
d
- the footer margin in inches
setHeader
public void setHeader(HeaderFooter h)
Sets the header
setHeaderMargin
public void setHeaderMargin(double d)
Sets the margin for any page headers
setHidden
public void setHidden(boolean h)
Sets the hidden status of this worksheet
setHorizontalCentre
public void setHorizontalCentre(boolean horizCentre)
Sets the horizontal centre
horizCentre
- The horizontalCentre to set.
setHorizontalFreeze
public void setHorizontalFreeze(int row)
Sets the row at which the pane is frozen horizontally
row
- the row number to freeze at
setHorizontalPrintResolution
public void setHorizontalPrintResolution(int hpw)
Sets the horizontal print resolution
hpw
- the print resolution
setLeftMargin
public void setLeftMargin(double m)
Sets the left margin
m
- the left margin in inches
setNormalMagnification
public void setNormalMagnification(int f)
Accessor for the normal magnificaton factor.
Do not confuse zoom factor or scale factor
f
- the page break preview magnification as a percentage
setOrientation
public void setOrientation(PageOrientation po)
Sets the paper orientation for printing this sheet
setPageBreakPreviewMagnification
public void setPageBreakPreviewMagnification(int f)
Accessor for the page break preview magnificaton factor.
Do not confuse zoom factor or scale factor
f
- the page break preview magnification as a percentage
setPageBreakPreviewMode
public void setPageBreakPreviewMode(boolean b)
Sets the pageBreakPreviewMode property
b
- TRUE to launch in page break preview mode, FALSE otherwise
setPageStart
public void setPageStart(int ps)
Sets the page number at which to commence printing
ps
- the page start number
setPaperSize
public void setPaperSize(PaperSize ps)
Sets the paper size to be used when printing this sheet
setPassword
public void setPassword(String s)
Sets the password for this sheet
setPasswordHash
public void setPasswordHash(int ph)
Accessor for the password hash - used only when copying sheets
setPrintArea
public void setPrintArea(int firstCol,
int firstRow,
int lastCol,
int lastRow)
Sets the print area for this sheet
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 area
setPrintGridLines
public void setPrintGridLines(boolean b)
Sets the printGridLines property
b
- TRUE to print grid lines on this sheet, FALSE otherwise
setPrintHeaders
public void setPrintHeaders(boolean b)
Sets the printHeaders property
b
- TRUE to print headers on this sheet, FALSE otherwise
setProtected
public void setProtected(boolean p)
Sets the protected (ie. read only) status of this sheet
setRecalculateFormulasBeforeSave
public void setRecalculateFormulasBeforeSave(boolean recalc)
Sets the recalculate formulas when the sheet is saved flag
recalc
- - TRUE to automatically calculate the formulas when the,
spreadsheet is saved, FALSE otherwise
setRightMargin
public void setRightMargin(double m)
Sets the right margin
m
- the right margin in inches
setScaleFactor
public void setScaleFactor(int sf)
Sets the scale factor for this sheet to be used when printing. The
parameter is a percentage, therefore setting a scale factor of 100 will
print at normal size, 50 half size, 200 double size etc
sf
- the scale factor as a percentage
setSelected
public void setSelected()
use overloaded version which takes a boolean
Sets this sheet to be when it is opened in excel
setSelected
public void setSelected(boolean s)
Sets this sheet to be when it is opened in excel
s
- sets whether this sheet is selected or not
setShowGridLines
public void setShowGridLines(boolean b)
Sets the showGridLines property
b
- TRUE to show grid lines on this sheet, FALSE otherwise
setTopMargin
public void setTopMargin(double m)
Sets the top margin
m
- the top margin in inches
setVerticalCentre
public void setVerticalCentre(boolean vertCentre)
Sets the vertical centre
vertCentre
- The verticalCentre to set.
setVerticalFreeze
public void setVerticalFreeze(int col)
Sets the row at which the pane is frozen vertically
col
- the column number to freeze at
setVerticalPrintResolution
public void setVerticalPrintResolution(int vpw)
Sets the vertical print reslution
vpw
- the vertical print resolution
setZoomFactor
public void setZoomFactor(int zf)
Sets the zoom factor. Do not confuse zoom factor (which relates
to the on screen view) with scale factor (which refers to the scale factor
when printing)
zf
- the zoom factor as a percentage