jxl
Class WorkbookSettings

java.lang.Object
  jxl.WorkbookSettings

public final class WorkbookSettings

extends java.lang.Object

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

Constructor Summary

WorkbookSettings()
Default constructor

Method Summary

int	getArrayGrowSize() Accessor for the array grow size property
boolean	getDrawingsDisabled() Gets the drawings disabled flag
java.lang.String	getEncoding() Accessor for the character encoding
boolean	getFormulaAdjust() Accessor for the formula adjust disabled
jxl.biff.formula.FunctionNames	getFunctionNames() Gets the function names.
boolean	getGCDisabled() Accessor for the disabling of garbage collection
int	getInitialFileSize() Accessor for the initial file size property
java.util.Locale	getLocale() Returns the locale used for the spreadsheet
boolean	getNamesDisabled() Accessor for the disabling of interpretation of named ranges
boolean	getRationalizationDisabled() Accessor to retrieve the rationalization flag
void	setArrayGrowSize(int sz) Sets the amount of memory by which to increase the amount of memory allocated to storing the workbook data.
void	setEncoding(java.lang.String enc) Sets the encoding for this workbook
void	setFormulaAdjust(boolean b) Setter for the formula adjust disabled property
void	setInitialFileSize(int sz) Sets the initial amount of memory allocated to store the workbook data when reading a worksheet.
void	setLocale(java.util.Locale l) Sets the locale for this spreadsheet
void	setNamesDisabled(boolean b) Disables the handling of names
void	setRationalization(boolean r) Sets whether or not to rationalize the cell formats before writing out the sheet.
void	setSuppressWarnings(boolean w) Accessor to set the suppress warnings flag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkbookSettings

public WorkbookSettings()

Default constructor

Method Detail

getArrayGrowSize

public int getArrayGrowSize()

Accessor for the array grow size property

Returns:

the array grow size

getDrawingsDisabled

public boolean getDrawingsDisabled()

Gets the drawings disabled flag

Returns:

TRUE if drawings are disabled, FALSE otherwise

getEncoding

public java.lang.String getEncoding()

Accessor for the character encoding

Returns:

the character encoding for this workbook

getFormulaAdjust

public boolean getFormulaAdjust()

Accessor for the formula adjust disabled

Returns:

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

Returns:

the list of function names

getGCDisabled

public boolean getGCDisabled()

Accessor for the disabling of garbage collection

Returns:

FALSE if JExcelApi hints for garbage collection, TRUE otherwise

getInitialFileSize

public int getInitialFileSize()

Accessor for the initial file size property

Returns:

the initial file size

getLocale

public java.util.Locale getLocale()

Returns the locale used for the spreadsheet

Returns:

the locale

getNamesDisabled

public boolean getNamesDisabled()

Accessor for the disabling of interpretation of named ranges

Returns:

FALSE if named cells are interpreted, TRUE otherwise

getRationalizationDisabled

public boolean getRationalizationDisabled()

Accessor to retrieve the rationalization flag

Returns:

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

Parameters:

sz - the file size in bytes

setEncoding

public void setEncoding(java.lang.String enc)

Sets the encoding for this workbook

Parameters:

enc - the encoding

setFormulaAdjust

public void setFormulaAdjust(boolean b)

Setter for the formula adjust disabled property

Parameters:

b - TRUE to adjust formulas, FALSE otherwise

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

Parameters:

sz - the file size in bytes

setLocale

public void setLocale(java.util.Locale l)

Sets the locale for this spreadsheet

Parameters:

l - the locale

setNamesDisabled

public void setNamesDisabled(boolean b)

Disables the handling of names

Parameters:

b - TRUE to disable the names feature, FALSE otherwise

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

Parameters:

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)

Parameters:

w - the flag