com.ibm.excelaccessor
Class ExcelCell

java.lang.Object
  |
  +--com.ibm.excelaccessor.ExcelCell

All Implemented Interfaces:

java.util.EventListener, java.beans.PropertyChangeListener, java.io.Serializable

public class ExcelCell

extends java.lang.Object

implements java.beans.PropertyChangeListener, java.io.Serializable

This bean represents a cell in an Excel Worksheet. This bean uses the facilities provided by the ExcelWorkbook bean to access the cell. The sheet name and the range name identify the cell. If the range consists of more than one cell then this bean operates on the top-left cell in the range. The user of this bean needs to initialize (turn on) this bean before it can be used for accessing the range properties. Once the bean has been initialized, setting the properties of the range writes to the file.

This bean is similar in functionality to the ExcelRange bean, except that it operates on a single cell.

See Also:

Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

propertyChange

Constructor Summary

ExcelCell()
Constructs an ExcelCell object with properties autoCreateSheet and autoUnprotectSheet set to false.

Method Summary

void	addExcelCellErrorListener(ExcelCellErrorListener l) Adds the specified ExcelCellErrorListener to receive ExcelCellError events from the ExcelCell bean.
void	addExcelCellListener(ExcelCellListener l) Adds the specified ExcelCellListener to receive ExcelCell events from the ExcelCell bean.
void	addExcelSheetListener(ExcelSheetListener l) Adds the specified ExcelSheetListener to receive ExcelSheet events from the ExcelRange bean.
void	addFetchArgumentsListener(FetchArgumentsListener l) Adds the specified FetchArgumentsListener to receive FetchArguments events from the ExcelRange bean.
void	addFetchPasswordListener(FetchPasswordListener l) Adds the specified FetchPasswordListener to receive FetchPassword events from the ExcelRange bean.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Adds the specified PropertyChangeListener to receive PropertyChange events from the ExcelRange bean.
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) The addPropertyChangeListener method was generated to support the propertyChange field.
void	clear() Clears all the cell properties (value, formula, format, text and noteText) for this Cell.
void	clearContents() Clears the cell contents (value and formula, if any) for this Cell.
void	clearFormats() Clears all cell formatting information for this cell, the value, noteText and formula are retained.
void	clearNotes() Clears notetext for this cell, the value, formula and format information are retained.
void	createNamedCell(java.lang.String name) Assigns a name to the current cell.
void	fillExcelFormatModel() Fills the ExcelFormatModel bean from the cell.
void	firePropertyChange(java.beans.PropertyChangeEvent evt) The firePropertyChange method was generated to support the propertyChange field.
void	firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue) The firePropertyChange method was generated to support the propertyChange field.
void	firePropertyChange(java.lang.String propertyName, int oldValue, int newValue) The firePropertyChange method was generated to support the propertyChange field.
void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) The firePropertyChange method was generated to support the propertyChange field.
java.lang.String	getAboutThisBean() Gets the aboutThisBean property (java.lang.String) value.
java.util.Vector	getColumnHeaders() Returns a Vector of Strings, which represents the headers of the columns of the range (as integers).
int	getEndCol() Returns the column number for the bottom right cell of the range.
int	getEndRow() Returns the row number for the bottom right cell of the range.
ExcelFormatModel	getExcelFormatModel() Gets the excelFormatModel property (com.ibm.excelaccessor.ExcelFormatModel) value.
java.lang.String	getFormat() Returns the Format property of the cell as a String.
java.lang.String	getFormula() Returns the Formula property for the Cell as a String.
int	getNCols() Returns the number of columns present in the range.
java.lang.String	getNoteText() Returns the noteText for the cell.
int	getNRows() Returns the number of rows present in the range.
protected java.beans.PropertyChangeSupport	getPropertyChange() Accessor for the propertyChange field.
java.lang.String	getRangeName() Returns the name of the range if the range has been selected using rangeName.
java.util.Vector	getRowHeaders() Returns a Vector of Strings, which represents the headers of the rows of the range (as integers).
int	getStartCol() Returns the column number for the top left cell of the range.
int	getStartRow() Returns the row number for the top left cell of the range.
java.lang.String	getText() Returns the Text property for the Range.
java.lang.Object	getValue() Returns the Value property for the Range.
java.lang.String	getWorksheetName() Returns the name of the worksheet.
java.lang.Boolean	hasArray() Method to check whether the cell is part of an array.
java.lang.Boolean	hasFormula() Method to check whether the cell contains a formula.
boolean	hasListeners(java.lang.String propertyName) The hasListeners method was generated to support the propertyChange field.
void	initCell() A call to this method initializes the cell bean and essentially turns it on for further use.
void	insertWorksheet() Inserts a new worksheet in the workbook and renames it to the worksheetName of this range.
boolean	isAutoCreateSheet() Returns the value of the autoCreateSheet property.
boolean	isAutoUnprotectSheet() Returns the value of the autoUnprotectSheet property.
boolean	isInitialized() Returns the status of the initialization of the cell bean.
void	propertyChange(java.beans.PropertyChangeEvent evt) The listener method for property change events.
void	removeExcelCellErrorListener(ExcelCellErrorListener l) Removes the specified ExcelCellErrorListener so that it no longer receives ExcelCellErrorEvents from this bean.
void	removeExcelCellListener(ExcelCellListener l) Removes the specified ExcelCellListener so that it no longer receives ExcelCellEvents from this bean.
void	removeExcelSheetListener(ExcelSheetListener l) Removes the specified ExcelSheetListener so that it no longer receives ExcelSheetEvents from this bean.
void	removeFetchArgumentsListener(FetchArgumentsListener l) Removes the specified FetchArgumentsListener so that it no longer receives FetchArgumentsEvents from this bean.
void	removeFetchPasswordListener(FetchPasswordListener l) Removes the specified FetchPasswordListener so that it no longer receives FetchPasswordEvents from this bean.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Removes the specified PropertyChangeListener so that it no longer receives PropertyChangeEvents from this bean.
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) The removePropertyChangeListener method was generated to support the propertyChange field.
void	removeWorksheet() Removes a worksheet from the workbook.
void	saveExcelFormatModel() Saves the content of the contained ExcelFormatModel bean to the cell.
void	setAboutThisBean(java.lang.String aboutThisBean) Sets the aboutThisBean property (java.lang.String) value.
void	setAutoCreateSheet(boolean bValue) Sets the value of the autoCreateSheet property.
void	setAutoUnprotectSheet(boolean bValue) Sets the value of the autoUnprotectSheet property.
void	setCellR1C1(int row, int col) This method can be used to identify a single cell as the range to be accessed using the cell row and column numbers.
void	setExcelFormatModel(ExcelFormatModel excelFormatModel) Sets the excelFormatModel property (com.ibm.excelaccessor.ExcelFormatModel) value.
void	setFormat(java.lang.String strFormat) Sets the format property of this cell.
void	setFormula(java.lang.String strFormula) Sets the formula property of the cell.
void	setNoteText(java.lang.String strText) Sets the noteText for the cell.
void	setRangeName(java.lang.String strName) Sets the name of the Range to be accessed.
void	setRangeR1C1(int topRow, int leftCol, int bottomRow, int rightCol) This method can be used to identify the range to be accessed using the positions of the top-left and bottom-right cells.
void	setValue(java.lang.Object objValue) Sets the value property of this cell.
void	setWorksheetName(java.lang.String strName) Sets the name of the worksheet to be accessed.
void	setWorksheetProtectionPassword(java.lang.String strPass) Sets the worksheet protection password to be used while unprotecting the worksheet.
void	setXlWorkbook(ExcelWorkbook workbookBean) Sets the reference to the ExcelWorkbook bean that this cell bean operates on.
void	unprotectWorksheet() Unprotects the worksheet.

Methods inherited from class java.lang.Object

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

Field Detail

propertyChange

protected transient java.beans.PropertyChangeSupport propertyChange

Constructor Detail

ExcelCell

public ExcelCell()

Constructs an ExcelCell object with properties autoCreateSheet and autoUnprotectSheet set to false. The range to be accessed needs to be identified (by worksheetName and rangeName) and then initialized before the properties of the cell can be accessed.

Method Detail

addExcelCellErrorListener

public void addExcelCellErrorListener(ExcelCellErrorListener l)

Adds the specified ExcelCellErrorListener to receive ExcelCellError events from the ExcelCell bean.

Parameters:

l - The ExcelCellErrorEvent listener.

See Also:

ExcelCellErrorEvent, ExcelCellErrorListener

addExcelCellListener

public void addExcelCellListener(ExcelCellListener l)

Adds the specified ExcelCellListener to receive ExcelCell events from the ExcelCell bean.

Parameters:

l - the ExcelCellEvent listener.

See Also:

ExcelCellEvent, ExcelCellListener

addExcelSheetListener

public void addExcelSheetListener(ExcelSheetListener l)

Adds the specified ExcelSheetListener to receive ExcelSheet events from the ExcelRange bean.

Parameters:

l - The ExcelSheetEvent listener.

See Also:

ExcelSheetEvent, ExcelSheetListener

addFetchArgumentsListener

public void addFetchArgumentsListener(FetchArgumentsListener l)

Adds the specified FetchArgumentsListener to receive FetchArguments events from the ExcelRange bean.

Parameters:

l - The FetchArgumentsEvent listener.

See Also:

FetchArgumentsEvent, FetchArgumentsListener

addFetchPasswordListener

public void addFetchPasswordListener(FetchPasswordListener l)

Adds the specified FetchPasswordListener to receive FetchPassword events from the ExcelRange bean.

Parameters:

l - The FetchPasswordEvent listener.

See Also:

FetchPasswordEvent, FetchPasswordListener

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Adds the specified PropertyChangeListener to receive PropertyChange events from the ExcelRange bean.

Parameters:

l - The PropertyChangeEvent listener.

See Also:

PropertyChangeEvent, PropertyChangeListener

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

The addPropertyChangeListener method was generated to support the propertyChange field.

clear

public void clear()

Clears all the cell properties (value, formula, format, text and noteText) for this Cell. Fires ExcelCellErrorEvent on failure.

clearContents

public void clearContents()

Clears the cell contents (value and formula, if any) for this Cell. The format and noteText are retained. Fires ExcelCellErrorEvent on failure.

clearFormats

public void clearFormats()

Clears all cell formatting information for this cell, the value, noteText and formula are retained. Fires ExcelCellErrorEvent on failure.

clearNotes

public void clearNotes()

Clears notetext for this cell, the value, formula and format information are retained. Fires ExcelCellErrorEvent on failure.

createNamedCell

public void createNamedCell(java.lang.String name)

Assigns a name to the current cell. Fires ExcelCellErrorEvent on failure.

Parameters:

name - The name to be assigned to this cell.

fillExcelFormatModel

public void fillExcelFormatModel()
                          throws ExcelAccessorException

Fills the ExcelFormatModel bean from the cell. The contained ExcelFormatModel bean need not be in initialized state before you call this method. If this call is successfull, the format related properties of the cell will be accessible through the excelFormatModel property and the filledModel event is fired.

Throws:

ExcelAccessorException - Exception is thrown if the ExcelCell bean itself is not in initialized state, or when an error occurs while the bean accessing the workbook.

firePropertyChange

public void firePropertyChange(java.beans.PropertyChangeEvent evt)

The firePropertyChange method was generated to support the propertyChange field.

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               int oldValue,
                               int newValue)

The firePropertyChange method was generated to support the propertyChange field.

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)

The firePropertyChange method was generated to support the propertyChange field.

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               boolean oldValue,
                               boolean newValue)

The firePropertyChange method was generated to support the propertyChange field.

getAboutThisBean

public java.lang.String getAboutThisBean()

Gets the aboutThisBean property (java.lang.String) value.

Returns:

The aboutThisBean property value.

See Also:

setAboutThisBean(java.lang.String)

getColumnHeaders

public java.util.Vector getColumnHeaders()

Returns a Vector of Strings, which represents the headers of the columns of the range (as integers).

Returns:

Vector of Strings containing the column headers.

getEndCol

public int getEndCol()

Returns the column number for the bottom right cell of the range.

Returns:

The column number for the bottom right cell of the range.

getEndRow

public int getEndRow()

Returns the row number for the bottom right cell of the range.

Returns:

The row number for the bottom right cell of the range.

getExcelFormatModel

public ExcelFormatModel getExcelFormatModel()

Gets the excelFormatModel property (com.ibm.excelaccessor.ExcelFormatModel) value.

Returns:

The excelFormatModel property value.

See Also:

setExcelFormatModel(com.ibm.excelaccessor.ExcelFormatModel)

getFormat

public java.lang.String getFormat()

Returns the Format property of the cell as a String. Do not use this method in the future, because it may be removed. Use the ExcelFormatModel property instead this.

Returns:

The format property as a String.

getFormula

public java.lang.String getFormula()

Returns the Formula property for the Cell as a String. If the cell does not contain a formula the value property is returned as a String.

Returns:

The Formula as a String.

getNCols

public int getNCols()

Returns the number of columns present in the range.

Returns:

The number of columns in the range.

getNoteText

public java.lang.String getNoteText()

Returns the noteText for the cell.

Returns:

The noteText property of the cell.

getNRows

public int getNRows()

Returns the number of rows present in the range.

Returns:

The number of rows in the range.

getPropertyChange

protected java.beans.PropertyChangeSupport getPropertyChange()

Accessor for the propertyChange field.

getRangeName

public java.lang.String getRangeName()

Returns the name of the range if the range has been selected using rangeName.

Returns:

The name of the range.

getRowHeaders

public java.util.Vector getRowHeaders()

Returns a Vector of Strings, which represents the headers of the rows of the range (as integers).

Returns:

Vector of Strings containing the row headers.

getStartCol

public int getStartCol()

Returns the column number for the top left cell of the range.

Returns:

The column number for the top left cell of the range.

getStartRow

public int getStartRow()

Returns the row number for the top left cell of the range.

Returns:

The row number for the top left cell of the range.

getText

public java.lang.String getText()

Returns the Text property for the Range.

Returns:

The text property of the range as a String.

getValue

public java.lang.Object getValue()

Returns the Value property for the Range. Value is returned as an Object. Value can be of various types such as String, Double, Date, Boolean. Blank cells are returned as blank Strings. Time and currency values are returned as double values.

Returns:

The value property as an Object.

getWorksheetName

public java.lang.String getWorksheetName()

Returns the name of the worksheet.

Returns:

The name of the worksheet.

hasArray

public java.lang.Boolean hasArray()

Method to check whether the cell is part of an array.

Returns:

True if this cell is part of an Array, False otherwise.

hasFormula

public java.lang.Boolean hasFormula()

Method to check whether the cell contains a formula.

Returns:

True if the cell contains a formula, False otherwise.

hasListeners

public boolean hasListeners(java.lang.String propertyName)

The hasListeners method was generated to support the propertyChange field.

initCell

public void initCell()

A call to this method initializes the cell bean and essentially turns it on for further use. After the cell has been initialized, the properties of the cell are available as bound properties on this object. Calling this method fires FetchArgumentsEvent which can be used to identify the cell/range to be initialized. If the autoCreate flag is set to true, and if the worksheet does not exist in the workbook, it is inserted in the workbook during cell initialization. During sheet insertion, if the workbook structure is protected, it is automatically unprotected. If the sheet is protected and autoUnprotect is true it tries to unprotect the sheet. If unprotection fails an error event is fired and cell initialization continues. This method has to be called before this bean can be used in a valid manner to access the properties of the cell. It fires cellInitialized( ExcelCellEvent ) on successful initialization. It fires ExcelCellErrorEvent on failure.

See Also:

FetchArgumentsEvent, ExcelCellErrorEvent, ExcelCellEvent

insertWorksheet

public void insertWorksheet()

Inserts a new worksheet in the workbook and renames it to the worksheetName of this range. The cell bean need not be initialized to perform this operation. Before inserting the sheet, the FetchArgumentsEvent is fired which can be used to set the worksheetName. During insertion, if the workbook structure is protected, it is automatically unprotected. It fires sheetInserted( ExcelSheetEvent ) on success. It fires ExcelCellErrorEvent if an error occurs.

See Also:

ExcelSheetEvent

isAutoCreateSheet

public boolean isAutoCreateSheet()

Returns the value of the autoCreateSheet property. This property is used at the time of cell initialization.

Returns:

The autoCreateSheet property.

isAutoUnprotectSheet

public boolean isAutoUnprotectSheet()

Returns the value of the autoUnprotectSheet property. This value is used only at the time of initializing the cell.

Returns:

The autoUnprotectSheet property.

isInitialized

public boolean isInitialized()

Returns the status of the initialization of the cell bean.

Returns:

True if the cell has been initialized, false otherwise.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

The listener method for property change events. This object is a listener on the workbook bean. When the workbook changes, the cell gets uninitialized and cellUninitialized( ExcelCellEvent ) is fired.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

evt - The PropertyChangeEvent.

removeExcelCellErrorListener

public void removeExcelCellErrorListener(ExcelCellErrorListener l)

Removes the specified ExcelCellErrorListener so that it no longer receives ExcelCellErrorEvents from this bean.

Parameters:

l - The ExcelCellErrorListener.

See Also:

ExcelCellErrorEvent, ExcelCellErrorListener

removeExcelCellListener

public void removeExcelCellListener(ExcelCellListener l)

Removes the specified ExcelCellListener so that it no longer receives ExcelCellEvents from this bean.

Parameters:

l - the ExcelCellListener.

See Also:

ExcelCellEvent, ExcelCellListener

removeExcelSheetListener

public void removeExcelSheetListener(ExcelSheetListener l)

Removes the specified ExcelSheetListener so that it no longer receives ExcelSheetEvents from this bean.

Parameters:

l - The ExcelSheetListener.

See Also:

ExcelSheetEvent, ExcelSheetListener

removeFetchArgumentsListener

public void removeFetchArgumentsListener(FetchArgumentsListener l)

Removes the specified FetchArgumentsListener so that it no longer receives FetchArgumentsEvents from this bean.

Parameters:

l - The FetchArgumentsListener.

See Also:

FetchArgumentsEvent, FetchArgumentsListener

removeFetchPasswordListener

public void removeFetchPasswordListener(FetchPasswordListener l)

Removes the specified FetchPasswordListener so that it no longer receives FetchPasswordEvents from this bean.

Parameters:

l - the FetchPasswordListener.

See Also:

FetchPasswordEvent, FetchPasswordListener

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Removes the specified PropertyChangeListener so that it no longer receives PropertyChangeEvents from this bean.

Parameters:

l - the PropertyChangeListener.

See Also:

PropertyChangeEvent, PropertyChangeListener

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

The removePropertyChangeListener method was generated to support the propertyChange field.

removeWorksheet

public void removeWorksheet()

Removes a worksheet from the workbook. The name of the sheet removed is the property worksheetName. The cell bean need not be initialized to perform this operation. Before removing the sheet, the FetchArgumentsEvent is fired which can be used to set the worksheetName. During removal, if the workbook structure is protected, it is automatically unprotected. It fires sheetRemoved (ExcelSheetEvent) on success. It fires ExcelCellErrorEvent if an error occurs.

See Also:

ExcelSheetEvent

saveExcelFormatModel

public void saveExcelFormatModel()
                          throws ExcelAccessorException

Saves the content of the contained ExcelFormatModel bean to the cell. The contained ExcelFormatModel must be in initialized state before you call this method. If this call is successfull, the savedModel event is fired.

Throws:

ExcelAccessorException - Exception is thrown if the ExcelCell bean itself is not in initialized state, if the contained ExcelFormatModel bean is not in initialized state, if the dimension of the ExcelFormatModel bean is not (1, 1) - that is this.getExcelFormatModel().getRowCount() == 1 and this.getExcelFormatModel().getColumnCount() == 1 - or when an error occurs while the bean accessing the workbook.

setAboutThisBean

public void setAboutThisBean(java.lang.String aboutThisBean)

Sets the aboutThisBean property (java.lang.String) value.

Parameters:

aboutThisBean - The new value for the property.

See Also:

getAboutThisBean()

setAutoCreateSheet

public void setAutoCreateSheet(boolean bValue)

Sets the value of the autoCreateSheet property. This property is used while initializing the cell. If set to true, if the worksheet does not exist in the workbook, it is automatically created.

Parameters:

bValue - The value to set.

setAutoUnprotectSheet

public void setAutoUnprotectSheet(boolean bValue)

Sets the value of the autoUnprotectSheet property. This value is used only at the time of initializing the cell. If set to true, the worksheet is unprotected at cell initialization.

Parameters:

bValue - The value to set.

setCellR1C1

public void setCellR1C1(int row,
                        int col)

This method can be used to identify a single cell as the range to be accessed using the cell row and column numbers.

Parameters:

row - The row number of the cell.

col - The column number of the cell.

setExcelFormatModel

public void setExcelFormatModel(ExcelFormatModel excelFormatModel)

Sets the excelFormatModel property (com.ibm.excelaccessor.ExcelFormatModel) value.

Parameters:

excelFormatModel - The new value for the property.

See Also:

getExcelFormatModel()

setFormat

public void setFormat(java.lang.String strFormat)

Sets the format property of this cell. Do not use this method in the future, because it may be removed. Use the ExcelFormatModel property instead this. Fires ExcelCellErrorEvent on failure.

Parameters:

strFormat - String specifying the format.

setFormula

public void setFormula(java.lang.String strFormula)

Sets the formula property of the cell. Fires ExcelCellErrorEvent on failure.

Parameters:

strFormula - A String specifying the formula.

setNoteText

public void setNoteText(java.lang.String strText)

Sets the noteText for the cell. Fires ExcelCellErrorEvent on failure.

Parameters:

strText - String containing the noteText.

setRangeName

public void setRangeName(java.lang.String strName)

Sets the name of the Range to be accessed. The name of the range can be a name that is previously assigned or an "A1" style reference. Eg. A cell, say 'B4' would be referenced as "B4". A range, say from cell 'B4' to cell 'F6', would be referenced as "B4:F6". If the cell bean is initialized, calling this setter would result in the cell bean becoming uninitialized.

If the range contains multiple contiguous cells (such as a range "B4:F6") then the ExcelCell bean operates on the top-left cell of the range.

(Note: The beans do not have support for ranges that are composed of multiple areas.)

Parameters:

strName - The name of the Range to be accessed.

setRangeR1C1

public void setRangeR1C1(int topRow,
                         int leftCol,
                         int bottomRow,
                         int rightCol)

This method can be used to identify the range to be accessed using the positions of the top-left and bottom-right cells.

If the range contains multiple contiguous cells then the ExcelCell bean operates on the top-left cell of the range.

Parameters:

topRow - The row number of the top-left corner of the range.

leftCol - The column number of the top-left corner of the range.

bottomRow - The row number of the bottom right corner of the range.

rightCol - The column number of the bottom right corner of the range.

setValue

public void setValue(java.lang.Object objValue)

Sets the value property of this cell. Values supplied can be of types Double, String, Boolean or Date. For objects not of these types the toString() implementation is written to the cell. Fires ExcelCellErrorEvent on failure.

Parameters:

objValue - the Object containing the value to be written.

setWorksheetName

public void setWorksheetName(java.lang.String strName)

Sets the name of the worksheet to be accessed.

Parameters:

strName - The name of the worksheet to be accessed.

setWorksheetProtectionPassword

public void setWorksheetProtectionPassword(java.lang.String strPass)

Sets the worksheet protection password to be used while unprotecting the worksheet. Note that this method does not change the worksheet protection password in the Excel workbook, it simply uses the supplied password, if required when unprotecting the worksheet.

Parameters:

strPass - The worksheet protection password.

setXlWorkbook

public void setXlWorkbook(ExcelWorkbook workbookBean)

Sets the reference to the ExcelWorkbook bean that this cell bean operates on.

Parameters:

workbookBean - The ExcelWorkbook on which all operations will be performed

unprotectWorksheet

public void unprotectWorksheet()

Unprotects the worksheet. Throws a FetchPasswordEvent in case the worksheet is password protected. Fires the ExcelCellErrorEvent if unprotection fails.