This is a bean which client applications may use to set various advanced
workbook properties. Use of this bean is not mandatory, and its absence
will merely result in workbooks being read/written using the default
settings
getArrayGrowSize
public int getArrayGrowSize()
Accessor for the array grow size property
getAutoFilterDisabled
public boolean getAutoFilterDisabled()
Accessor for the autofilter disabled feature
- TRUE if autofilter is disabled, FALSE otherwise
getCellValidationDisabled
public boolean getCellValidationDisabled()
Accessor for the ignore cell validation
- TRUE if cell validation is disabled
getCharacterSet
public int getCharacterSet()
Accessor for the character set. This value is only used for reading
and has no effect when writing out the spreadsheet
- the character set used by this spreadsheet
getDrawingsDisabled
public boolean getDrawingsDisabled()
Gets the drawings disabled flag
- TRUE if drawings are disabled, FALSE otherwise
getEncoding
public String getEncoding()
Accessor for the character encoding
- the character encoding for this workbook
getExcelDisplayLanguage
public String getExcelDisplayLanguage()
Returns the two character ISO 3166 mnemonic used by excel for user
language displayto display
getExcelRegionalSettings
public String getExcelRegionalSettings()
Returns the two character ISO 3166 mnemonic used by excel for
its regional settings
getFormulaAdjust
public boolean getFormulaAdjust()
Accessor for the formula adjust disabled
- TRUE if formulas are adjusted following row/column inserts/deletes
FALSE otherwise
getFunctionNames
public jxl.biff.formula.FunctionNames getFunctionNames()
Gets the function names. This is used by the formula parsing package
in order to get the locale specific function names for this particular
workbook
- the list of function names
getGCDisabled
public boolean getGCDisabled()
Accessor for the disabling of garbage collection
- FALSE if JExcelApi hints for garbage collection, TRUE otherwise
getIgnoreBlanks
public boolean getIgnoreBlanks()
Accessor for the ignore blanks flag
- TRUE if blank cells are being ignored, FALSE otherwise
getInitialFileSize
public int getInitialFileSize()
Accessor for the initial file size property
getLocale
public Locale getLocale()
Returns the locale used by JExcelAPI to read the spreadsheet
getMergedCellCheckingDisabled
public boolean getMergedCellCheckingDisabled()
Accessor to retrieve the merged cell checking flag
- TRUE if merged cell checking is off, FALSE if it is on
getNamesDisabled
public boolean getNamesDisabled()
Accessor for the disabling of interpretation of named ranges
- FALSE if named cells are interpreted, TRUE otherwise
getPropertySetsDisabled
public boolean getPropertySetsDisabled()
Accessor to retrieve the property sets disabled flag
- TRUE if property sets are disabled, FALSE otherwise
getRationalizationDisabled
public boolean getRationalizationDisabled()
Accessor to retrieve the rationalization flag
- TRUE if rationalization is off, FALSE if rationalization is on
setArrayGrowSize
public void setArrayGrowSize(int sz)
Sets the amount of memory by which to increase the amount of
memory allocated to storing the workbook data.
For processeses reading many small workbooks
inside a WAS it might be necessary to reduce the default size
Default value is 1 megabyte
sz
- the file size in bytes
setAutoFilterDisabled
public void setAutoFilterDisabled(boolean disabled)
Sets the autofilter disabled
setCellValidationDisabled
public void setCellValidationDisabled(boolean cv)
Sets the ignore cell validation flag
cv
- TRUE to disable cell validation, FALSE to enable it
setCharacterSet
public void setCharacterSet(int cs)
Sets the character set. This is only used when the spreadsheet is
read, and has no effect when the spreadsheet is written
cs
- the character set encoding value
setDrawingsDisabled
public void setDrawingsDisabled(boolean b)
Disables the handling of drawings
b
- TRUE to disable the names feature, FALSE otherwise
setEncoding
public void setEncoding(String enc)
Sets the encoding for this workbook
setExcelDisplayLanguage
public void setExcelDisplayLanguage(String code)
Sets the language in which the generated file will display
code
- the two character ISO 3166 country code
setExcelRegionalSettings
public void setExcelRegionalSettings(String code)
Sets the regional settings for the generated excel file
code
- the two character ISO 3166 country code
setFormulaAdjust
public void setFormulaAdjust(boolean b)
Setter for the formula adjust disabled property
b
- TRUE to adjust formulas, FALSE otherwise
setGCDisabled
public void setGCDisabled(boolean disabled)
Sets the garbage collection disabled
disabled
- TRUE to disable garbage collection, FALSE to enable it
setIgnoreBlanks
public void setIgnoreBlanks(boolean ignoreBlanks)
Sets the ignore blanks flag
ignoreBlanks
- TRUE to ignore blanks, FALSE to take them into account
setInitialFileSize
public void setInitialFileSize(int sz)
Sets the initial amount of memory allocated to store the workbook data
when reading a worksheet. For processeses reading many small workbooks
inside a WAS it might be necessary to reduce the default size
Default value is 5 megabytes
sz
- the file size in bytes
setLocale
public void setLocale(Locale l)
Sets the locale used by JExcelApi to generate the spreadsheet.
Setting this value has no effect on the language or region of
the generated excel file
setMergedCellChecking
public void setMergedCellChecking(boolean b)
Accessor to set the merged cell checking
b
- - TRUE to enable merged cell checking, FALSE otherwise
setNamesDisabled
public void setNamesDisabled(boolean b)
Disables the handling of names
b
- TRUE to disable the names feature, FALSE otherwise
setPropertySets
public void setPropertySets(boolean r)
Sets whether or not to enable any property sets (such as macros)
to be copied along with the workbook
Leaving this feature enabled will result in the JXL process using
more memory
r
- the property sets flag
setRationalization
public void setRationalization(boolean r)
Sets whether or not to rationalize the cell formats before
writing out the sheet. The default value is true
r
- the rationalization flag
setSuppressWarnings
public void setSuppressWarnings(boolean w)
Accessor to set the suppress warnings flag. Due to the change
in logging in version 2.4, this will now set the warning
behaviour across the JVM (depending on the type of logger used)