com.ibm.excelaccessor
Class ExcelRange

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

All Implemented Interfaces:

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

public class ExcelRange

extends java.lang.Object

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

This bean represents an Excel range and is used to access that range from the ExcelWorkbook supplied to this range. This bean uses the facilities provided by the ExcelWorkbook bean to access the range. The sheet name and the range name identify 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.

The following major properties of the range can be accessed using the ExcelRange bean:

Value: This property is the raw value of the cell without any information as to how the value is formatted or whether the value is the result of a formula evaluation. The various types of values returned are Strings, Double, Dates, Boolean. Blank cells are returned as blank Strings. Even time and currency values are returned as Double values.

Formula: This property returns the formula String for each cell. If a particular cell does not contain a formula, the value of the formula property is the constant in the cell, represented as a String.

Format: This property is the format string for the range.

NoteText: This is the note text property of the range.

In the ExcelRange bean, it is possible to specify the range both by giving the range name or the row/column numbers of the range. This bean provides output that is same as the output which would have been available had the particular property of the range been accessed using Excel APIs directly. The value property can be read as the actual type of value (String, Date, Boolean or Double) and can be written both as the actual type of value and as Strings. It is not possible to write to cells that are parts of an array using this bean.

This bean also provides features to clear the contents (either some or all of the above properties) of a range, to check whether the specified cell is part of an Array, to check whether the specified cell contains a Formula, to find the dimensions of the range and insertion and removal of worksheets in a workbook. It is also possible to unprotect worksheets in a workbook using this bean.

A single instance of the range bean can be used to access different ranges. Calling the setter for the range name (or selecting a different range using row and column numbers) results in the range bean getting uninitialized. initRange has to be invoked again to initialize the range.

See Also:

Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

propertyChange

Constructor Summary

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

Method Summary

void	addExcelRangeErrorListener(ExcelRangeErrorListener l) Adds the specified ExcelRangeErrorListener to receive ExcelRangeError events from the ExcelRange bean.
void	addExcelRangeListener(ExcelRangeListener l) Adds the specified ExcelRangeListener to receive ExcelRange events from the ExcelRange 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	clear() Clears all the cell properties (value, formula, format, text and noteText) for this Range.
void	clearContents() Clears the cell contents (values and formulae, if any) for this Range.
void	clearFormats() Clears all cell formatting information for all the cells in the range, the values, noteText and formulae are retained.
void	clearNotes() Clears all the notes for all the cells in the range, the value, formula and format information are retained.
void	createNamedRange(java.lang.String name) Assigns a name to the current range.
void	fillExcelFormatModel() Fills the ExcelFormatModel bean from the range.
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.
boolean	getAutoGetUsedRange() Gets the autoGetUsedRange property (boolean) value.
java.util.Vector	getColumnHeaders() Returns a Vector of Strings, which represents the headers of the columns of the range (as integers).
java.lang.String	getDefaultText() Returns the text property of the range as returned by Excel.
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 range as a String.
java.util.Vector	getFormula() Returns the Formula property for the Range as a Vector of Vectors.
java.lang.Object	getFormulaAsArray() Returns the formula property as a 2-Dimensional array of objects.
int	getNCols() Returns the number of columns present in the range.
java.lang.String	getNoteText() Returns the noteText for the top-left cell of the range.
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.util.Vector	getText() Returns the Text property for the Range.
java.util.Vector	getValue() Returns the Value property for the Range.
java.lang.Object	getValueAsArray() Returns the value property as a 2-Dimensional array of objects.
java.lang.String	getWorksheetName() Returns the name of the worksheet.
java.lang.Boolean	hasArray() Method to check whether the range is part of an array.
java.lang.Boolean	hasFormula() Method to check whether the cells in the range contain formulae.
void	initRange() A call to this method initializes the range 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 range bean.
void	propertyChange(java.beans.PropertyChangeEvent evt) The listener method for property change events.
void	removeExcelRangeErrorListener(ExcelRangeErrorListener l) Removes the specified ExcelRangeErrorListener so that it no longer receives ExcelRangeErrorEvents from this bean.
void	removeExcelRangeListener(ExcelRangeListener l) Removes the specified ExcelRangeListener so that it no longer receives ExcelRangeEvents 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	removeWorksheet() Removes a worksheet from the workbook.
void	saveExcelFormatModel() Saves the content of the contained ExcelFormatModel bean to the range.
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	setAutoGetUsedRange(boolean autoGetUsedRange) Sets the autoGetUsedRange property (boolean) value.
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 Range.
void	setFormula(java.util.Vector objFormula) Sets the formula property of this Range.
void	setFormulaAsObject(java.lang.Object objFormula) Sets the formula for this range.
void	setNoteText(java.lang.String strText) Sets the noteText for the top-left cell of this range.
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.util.Vector objValue) Sets the value property of this Range.
void	setValueAsObject(java.lang.Object objValue) Sets the value for this range.
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 Range 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

ExcelRange

public ExcelRange()

Constructs an ExcelRange 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 range can be accessed.

Method Detail

addExcelRangeErrorListener

public void addExcelRangeErrorListener(ExcelRangeErrorListener l)

Adds the specified ExcelRangeErrorListener to receive ExcelRangeError events from the ExcelRange bean.

Parameters:

l - The ExcelRangeErrorEvent listener.

See Also:

ExcelRangeErrorEvent, ExcelRangeErrorListener

addExcelRangeListener

public void addExcelRangeListener(ExcelRangeListener l)

Adds the specified ExcelRangeListener to receive ExcelRange events from the ExcelRange bean.

Parameters:

l - the ExcelRangeEvent listener.

See Also:

ExcelRangeEvent, ExcelRangeListener

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

clear

public void clear()

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

clearContents

public void clearContents()

Clears the cell contents (values and formulae, if any) for this Range. The formats and noteTexts are retained. Fires ExcelRangeErrorEvent on failure.

clearFormats

public void clearFormats()

Clears all cell formatting information for all the cells in the range, the values, noteText and formulae are retained. Fires ExcelRangeErrorEvent on failure.

clearNotes

public void clearNotes()

Clears all the notes for all the cells in the range, the value, formula and format information are retained. Fires ExcelRangeErrorEvent on failure.

createNamedRange

public void createNamedRange(java.lang.String name)

Assigns a name to the current range. Fires ExcelRangeErrorEvent on failure.

Parameters:

name - The name to be assigned to this range.

fillExcelFormatModel

public void fillExcelFormatModel()
                          throws ExcelAccessorException

Fills the ExcelFormatModel bean from the range. 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 ExcelRange bean itself is not in initialized state, or when an error occurs while the bean accessing the workbook.

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.

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)

getAutoGetUsedRange

public boolean getAutoGetUsedRange()

Gets the autoGetUsedRange property (boolean) value.

Returns:

The autoGetUsedRange property value.

See Also:

setAutoGetUsedRange(boolean)

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.

getDefaultText

public java.lang.String getDefaultText()

Returns the text property of the range as returned by Excel. Excel returns null if the text for all cells in the specified range is not homogeneous. If the text is homogeneous, the text is returned as a String.

Returns:

The text property.

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 range as a String. If the format for all cells in the specified range is not homogeneous, null is returned. 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.util.Vector getFormula()

Returns the Formula property for the Range as a Vector of Vectors. The inner Vectors represent the data for the respective rows. For the cells that do not have a formula, the value in that cell is returned as a String.

Returns:

The Formula as a 2-D Vector.

getFormulaAsArray

public java.lang.Object getFormulaAsArray()

Returns the formula property as a 2-Dimensional array of objects. The inner arrays represent the data for the respective rows. If the range is a single cell, a String object representing the formula for that cell is returned.

Returns:

The formula property of the range, as a 2-D array or as a String if the range is a single cell.

See Also:

getFormula

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 top-left cell of the range.

Returns:

The noteText property of the range.

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.util.Vector getText()

Returns the Text property for the Range. It is a Vector of Vectors, containing the text strings for all cells in this range. (this is not the default behavior of Excel). The inner Vectors represent the data for the respective rows.

Returns:

The text property of the range as a 2-D Vector.

See Also:

getDefaultText

getValue

public java.util.Vector getValue()

Returns the Value property for the Range. Value is returned as a Vector of Vectors. The inner Vectors represent the data for the respective rows. Values can be of various types such as Strings, Double, Dates, Boolean. Blank cells are returned as blank Strings. Time and currency values are returned as double values.

Returns:

The value property as a 2-D Vector.

getValueAsArray

public java.lang.Object getValueAsArray()

Returns the value property as a 2-Dimensional array of objects. The inner arrays represent the data for the respective rows. If the range is a single cell, an object representing the value for that cell is returned.

Returns:

The value property of the range, as a 2-D array or as an object if the range is a single cell.

See Also:

getValue

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 range is part of an array.

Returns:

True if this range is part of an Array. null if the range is heterogeneous, i.e. contains some cells that are part of an array. False if no cells are part of an array.

hasFormula

public java.lang.Boolean hasFormula()

Method to check whether the cells in the range contain formulae.

Returns:

True if all cells in the range contain formulae, false if no cell in the range contains a formula or null otherwise.

initRange

public void initRange()

A call to this method initializes the range and essentially turns it on for further use. After the range has been initialized, the properties of the range are available as bound properties on this object. Calling this method fires FetchArgumentsEvent which can be used to identify the 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 range 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 range initialization continues. This method has to be called before this bean can be used in a valid manner to access the properties of the range. It fires rangeInitialized( ExcelRangeEvent ) on successful initialization. It fires ExcelRangeErrorEvent on failure.

See Also:

FetchArgumentsEvent, ExcelRangeErrorEvent, ExcelRangeEvent

insertWorksheet

public void insertWorksheet()

Inserts a new worksheet in the workbook and renames it to the worksheetName of this range. The range 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 ExcelRangeErrorEvent 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 range 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 Range.

Returns:

The autoUnprotectSheet property.

isInitialized

public boolean isInitialized()

Returns the status of the initialization of the range bean.

Returns:

True if the range 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 range gets uninitialized and rangeUninitialized( ExcelRangeEvent ) is fired.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

evt - The PropertyChangeEvent.

removeExcelRangeErrorListener

public void removeExcelRangeErrorListener(ExcelRangeErrorListener l)

Removes the specified ExcelRangeErrorListener so that it no longer receives ExcelRangeErrorEvents from this bean.

Parameters:

l - The ExcelRangeErrorListener.

See Also:

ExcelRangeErrorEvent, ExcelRangeErrorListener

removeExcelRangeListener

public void removeExcelRangeListener(ExcelRangeListener l)

Removes the specified ExcelRangeListener so that it no longer receives ExcelRangeEvents from this bean.

Parameters:

l - the ExcelRangeListener.

See Also:

ExcelRangeEvent, ExcelRangeListener

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

removeWorksheet

public void removeWorksheet()

Removes a worksheet from the workbook. The name of the sheet removed is the property worksheetName. The range 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 ExcelRangeErrorEvent if an error occurs.

See Also:

ExcelSheetEvent

saveExcelFormatModel

public void saveExcelFormatModel()
                          throws ExcelAccessorException

Saves the content of the contained ExcelFormatModel bean to the range. 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 ExcelRange 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 equals to the dimension of the range - that is this.getExcelFormatModel().getRowCount() == this.getNRows() and this.getExcelFormatModel().getColumnCount() == this.getNCols() - 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 range. If set to true, if the worksheet does not exist in the workbook, it is automatically created.

Parameters:

bValue - The value to set.

setAutoGetUsedRange

public void setAutoGetUsedRange(boolean autoGetUsedRange)

Sets the autoGetUsedRange property (boolean) value.

Parameters:

autoGetUsedRange - The new value for the property.

See Also:

getAutoGetUsedRange()

setAutoUnprotectSheet

public void setAutoUnprotectSheet(boolean bValue)

Sets the value of the autoUnprotectSheet property. This value is used only at the time of initializing the Range. If set to true, the worksheet is unprotected at range 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 Range. The format string for all the cells in this range will be set to the specified parameter. Do not use this method in the future, because it may be removed. Use the ExcelFormatModel property instead this. Fires ExcelRangeErrorEvent on failure.

Parameters:

strFormat - String specifying the format.

setFormula

public void setFormula(java.util.Vector objFormula)

Sets the formula property of this Range. The behavior in case of different dimensions of the range and the parameter supplied is the same as the default Excel behavior in that case. Fires ExcelRangeErrorEvent on failure.

Parameters:

objFormula - A Vector of formulae for the cells. In case the vector further contains vectors, all the inner vectors should be of the same size. The inner Vectors are taken to represent the rows of the range.

setFormulaAsObject

public void setFormulaAsObject(java.lang.Object objFormula)

Sets the formula for this range. The parameter supplied could be an array, a Vector or just a single object.

Parameters:

objFormula - The formula to be set.

See Also:

setFormula

setNoteText

public void setNoteText(java.lang.String strText)

Sets the noteText for the top-left cell of this range. Fires ExcelRangeErrorEvent 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 range is initialized, calling this setter would result in the range becoming uninitialized. (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

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.util.Vector objValue)

Sets the value property of this Range. The behavior in case of different dimensions of the range and the parameter supplied is the same as the default Excel behavior in that case. Values supplied can be of types Double, String, Boolean or Date. For objects not of these types the toString() implementation is written to the range. Fires ExcelRangeErrorEvent on failure.

Parameters:

objValue - A Vector of values for the cells. In case the vector further contains vectors, all the inner vectors should be of the same size. The inner Vectors are taken to represent the rows of the range.

setValueAsObject

public void setValueAsObject(java.lang.Object objValue)

Sets the value for this range. The parameter supplied could be an array, a Vector or just a single object.

Parameters:

objValue - The value to be set.

See Also:

setValue

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 Range 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 ExcelRangeErrorEvent if unprotection fails.