Home » JCraft » jxl » [javadoc | source]
jxl
public final class: WorkbookSettings [javadoc | source]
java.lang.Object
   jxl.WorkbookSettings
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
Field Summary
public static final  int HIDEOBJ_HIDE_ALL    The HIDEOBJ record stores options selected in the Options dialog,View tab. 
public static final  int HIDEOBJ_SHOW_PLACEHOLDERS    The HIDEOBJ record stores options selected in the Options dialog,View tab. 
public static final  int HIDEOBJ_SHOW_ALL    The HIDEOBJ record stores options selected in the Options dialog,View tab. 
Constructor:
 public WorkbookSettings() 
Method from jxl.WorkbookSettings Summary:
getArrayGrowSize,   getAutoFilterDisabled,   getCellValidationDisabled,   getCharacterSet,   getDrawingsDisabled,   getEncoding,   getExcel9File,   getExcelDisplayLanguage,   getExcelRegionalSettings,   getFormulaAdjust,   getFunctionNames,   getGCDisabled,   getHideobj,   getIgnoreBlanks,   getInitialFileSize,   getLocale,   getMergedCellCheckingDisabled,   getNamesDisabled,   getPropertySetsDisabled,   getRationalizationDisabled,   getRefreshAll,   getTemplate,   getTemporaryFileDuringWriteDirectory,   getUseTemporaryFileDuringWrite,   getWindowProtected,   getWriteAccess,   setArrayGrowSize,   setAutoFilterDisabled,   setCellValidationDisabled,   setCharacterSet,   setDrawingsDisabled,   setEncoding,   setExcel9File,   setExcelDisplayLanguage,   setExcelRegionalSettings,   setFormulaAdjust,   setGCDisabled,   setHideobj,   setIgnoreBlanks,   setInitialFileSize,   setLocale,   setMergedCellChecking,   setNamesDisabled,   setPropertySets,   setRationalization,   setRefreshAll,   setSuppressWarnings,   setTemplate,   setTemporaryFileDuringWriteDirectory,   setUseTemporaryFileDuringWrite,   setWindowProtected,   setWriteAccess
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from jxl.WorkbookSettings Detail:
 public int getArrayGrowSize() 
    Accessor for the array grow size property
 public boolean getAutoFilterDisabled() 
    Accessor for the autofilter disabled feature
 public boolean getCellValidationDisabled() 
    Accessor for the ignore cell validation
 public int getCharacterSet() 
    Accessor for the character set. This value is only used for reading and has no effect when writing out the spreadsheet
 public boolean getDrawingsDisabled() 
    Gets the drawings disabled flag
 public String getEncoding() 
    Accessor for the character encoding
 public boolean getExcel9File() 
    Has this file been written by excel 2000?
 public String getExcelDisplayLanguage() 
    Returns the two character ISO 3166 mnemonic used by excel for user language displayto display
 public String getExcelRegionalSettings() 
    Returns the two character ISO 3166 mnemonic used by excel for its regional settings
 public boolean getFormulaAdjust() 
    Accessor for the formula adjust disabled
 public 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
 public boolean getGCDisabled() 
    Accessor for the disabling of garbage collection
 public int getHideobj() 
    The HIDEOBJ record stores options selected in the Options dialog,View tab Possible values are: HIDEOBJ_HIDE_ALL, HIDEOBJ_SHOW_ALL and HIDEOBJ_SHOW_PLACEHOLDERS
 public boolean getIgnoreBlanks() 
    Accessor for the ignore blanks flag
 public int getInitialFileSize() 
    Accessor for the initial file size property
 public Locale getLocale() 
    Returns the locale used by JExcelAPI to read the spreadsheet
 public boolean getMergedCellCheckingDisabled() 
    Accessor to retrieve the merged cell checking flag
 public boolean getNamesDisabled() 
    Accessor for the disabling of interpretation of named ranges
 public boolean getPropertySetsDisabled() 
    Accessor to retrieve the property sets disabled flag
 public boolean getRationalizationDisabled() 
    Accessor to retrieve the rationalization flag
 public boolean getRefreshAll() 
    When true then Refresh All should be done on all external data ranges and PivotTables when loading the workbook (the default is =0)
 public boolean getTemplate() 
    Workbook Is a Template
 public File getTemporaryFileDuringWriteDirectory() 
    Used in conjunction with the UseTemporaryFileDuringWrite setting to set the target directory for the temporary files. This value can be NULL, in which case the normal system default temporary directory is used instead
 public boolean getUseTemporaryFileDuringWrite() 
    Accessor for the temporary file during write. If this is set, then when the workbook is written a temporary file will be used to store the interim binary data, otherwise it will take place in memory. Setting this flag involves an assessment of the trade-offs between memory usage and performance
 public boolean getWindowProtected() 
 public String getWriteAccess() 
 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
 public  void setAutoFilterDisabled(boolean disabled) 
    Sets the autofilter disabled
 public  void setCellValidationDisabled(boolean cv) 
    Sets the ignore cell validation flag
 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
 public  void setDrawingsDisabled(boolean b) 
    Disables the handling of drawings
 public  void setEncoding(String enc) 
    Sets the encoding for this workbook
 public  void setExcel9File(boolean excel9file) 
 public  void setExcelDisplayLanguage(String code) 
    Sets the language in which the generated file will display
 public  void setExcelRegionalSettings(String code) 
    Sets the regional settings for the generated excel file
 public  void setFormulaAdjust(boolean b) 
    Setter for the formula adjust disabled property
 public  void setGCDisabled(boolean disabled) 
    Sets the garbage collection disabled
 public  void setHideobj(int hideobj) 
    The HIDEOBJ record stores options selected in the Options dialog,View tab Possible values are: HIDEOBJ_HIDE_ALL, HIDEOBJ_SHOW_ALL and HIDEOBJ_SHOW_PLACEHOLDERS
 public  void setIgnoreBlanks(boolean ignoreBlanks) 
    Sets the ignore blanks flag
 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
 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
 public  void setMergedCellChecking(boolean b) 
    Accessor to set the merged cell checking
 public  void setNamesDisabled(boolean b) 
    Disables the handling of names
 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
 public  void setRationalization(boolean r) 
    Sets whether or not to rationalize the cell formats before writing out the sheet. The default value is true
 public  void setRefreshAll(boolean refreshAll) 
    When true then Refresh All should be done on all external data ranges and PivotTables when loading the workbook (the default is =0)
 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)
 public  void setTemplate(boolean template) 
    Workbook Is a Template
 public  void setTemporaryFileDuringWriteDirectory(File dir) 
    Used in conjunction with the UseTemporaryFileDuringWrite setting to set the target directory for the temporary files. If this is not set, the system default temporary directory is used. This has no effect unless the useTemporaryFileDuringWrite setting is TRUE
 public  void setUseTemporaryFileDuringWrite(boolean temp) 
    Sets whether a temporary file is used during the generation of the workbook. If not set, the workbook will take place entirely in memory. Setting this flag involves an assessment of the trade-offs between memory usage and performance
 public  void setWindowProtected(boolean windowprotected) 
 public  void setWriteAccess(String writeAccess)