|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object jxl.SheetSettings
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.
Field Summary | |
static int |
DEFAULT_DEFAULT_ROW_HEIGHT
The default value for the default row height |
Constructor Summary | |
SheetSettings()
Default constructor |
|
SheetSettings(SheetSettings copy)
Copy constructor. |
Method Summary | |
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 |
PageOrientation |
getOrientation()
Accessor for the orientation |
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 |
boolean |
getPrintGridLines()
Accessor for the printGridLines property |
boolean |
getPrintHeaders()
Accessor for the printHeaders property |
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 |
isProtected()
Queries whether this sheet is protected (ie. |
boolean |
isSelected()
Accessor for the selected nature of the sheet |
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 |
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 |
setOrientation(PageOrientation po)
Sets the paper orientation 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 |
setPrintGridLines(boolean b)
Sets the printGridLines property |
void |
setPrintHeaders(boolean b)
Sets the printHeaders property |
void |
setProtected(boolean p)
Sets the protected (ie. |
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()
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 |
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. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int DEFAULT_DEFAULT_ROW_HEIGHT
Constructor Detail |
public SheetSettings()
public SheetSettings(SheetSettings copy)
copy
- the settings to copyMethod Detail |
public double getBottomMargin()
public int getCopies()
public int getDefaultColumnWidth()
public double getDefaultHeightMargin()
public int getDefaultRowHeight()
public double getDefaultWidthMargin()
public boolean getDisplayZeroValues()
public int getFitHeight()
public boolean getFitToPages()
public int getFitWidth()
public HeaderFooter getFooter()
public double getFooterMargin()
public HeaderFooter getHeader()
public double getHeaderMargin()
public int getHorizontalFreeze()
public int getHorizontalPrintResolution()
public double getLeftMargin()
public PageOrientation getOrientation()
public int getPageStart()
public PaperSize getPaperSize()
public java.lang.String getPassword()
public int getPasswordHash()
public boolean getPrintGridLines()
public boolean getPrintHeaders()
public double getRightMargin()
public int getScaleFactor()
public boolean getShowGridLines()
public double getTopMargin()
public int getVerticalFreeze()
public int getVerticalPrintResolution()
public int getZoomFactor()
public boolean isHidden()
public boolean isProtected()
public boolean isSelected()
public void setBottomMargin(double m)
m
- the bottom margin in inchespublic void setCopies(int c)
c
- the number of copiespublic void setDefaultColumnWidth(int w)
w
- the new default column widthpublic void setDefaultRowHeight(int h)
h
- the default row height, in 1/20ths of a pointpublic void setDisplayZeroValues(boolean b)
b
- TRUE to show zero values, FALSE not to botherpublic void setFitHeight(int fh)
fh
- the number of pages this sheet will be printed into heightwisepublic void setFitToPages(boolean b)
b
- TRUE to fit to pages, FALSE to use a scale factorpublic void setFitWidth(int fw)
fw
- the number of pagespublic void setFooter(HeaderFooter f)
f
- the footerpublic void setFooterMargin(double d)
d
- the footer margin in inchespublic void setHeader(HeaderFooter h)
h
- the headerpublic void setHeaderMargin(double d)
d
- the margin in inchespublic void setHidden(boolean h)
h
- the hidden flagpublic void setHorizontalFreeze(int row)
row
- the row number to freeze atpublic void setHorizontalPrintResolution(int hpw)
hpw
- the print resolutionpublic void setLeftMargin(double m)
m
- the left margin in inchespublic void setOrientation(PageOrientation po)
po
- the orientationpublic void setPageStart(int ps)
ps
- the page start numberpublic void setPaperSize(PaperSize ps)
ps
- the paper sizepublic void setPassword(java.lang.String s)
s
- the passwordpublic void setPasswordHash(int ph)
ph
- the password hashpublic void setPrintGridLines(boolean b)
b
- TRUE to print grid lines on this sheet, FALSE otherwisepublic void setPrintHeaders(boolean b)
b
- TRUE to print headers on this sheet, FALSE otherwisepublic void setProtected(boolean p)
p
- the protected statuspublic void setRightMargin(double m)
m
- the right margin in inchespublic void setScaleFactor(int sf)
sf
- the scale factor as a percentagepublic void setSelected()
public void setShowGridLines(boolean b)
b
- TRUE to show grid lines on this sheet, FALSE otherwisepublic void setTopMargin(double m)
m
- the top margin in inchespublic void setVerticalFreeze(int col)
col
- the column number to freeze atpublic void setVerticalPrintResolution(int vpw)
vpw
- the vertical print resolutionpublic void setZoomFactor(int zf)
zf
- the zoom factor as a percentage
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |