com.ibm.excelaccessor.event
Class ExcelRangeEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.excelaccessor.event.ExcelRangeEvent

All Implemented Interfaces:

java.io.Serializable

public class ExcelRangeEvent

extends java.util.EventObject

This event is fired when a range has been successfully initialized, or uninitialized

See Also:

EventObject, ExcelRangeListener, Serialized Form

Field Summary

protected int	id The event-id indicating the type of event.
static int	RANGE_INITIALIZED The id for the RANGE_INITIALIZED type of event.
static int	RANGE_UNINITIALIZED The id for the RANGE_UNINITIALIZED type of event.
protected java.lang.String	rangeName The name of the range which has been initialised or uninitialised.
protected java.lang.String	sheetName The name of the worksheet for the range.
protected java.lang.String	workbookName The name of the workbook containing the range.

Fields inherited from class java.util.EventObject

source

Constructor Summary

ExcelRangeEvent(java.lang.Object source, int id, java.lang.String workbookName, java.lang.String sheetName, java.lang.String rangeName, int startRow, int startCol, int endRow, int endCol)
Constructs an ExcelRangeEvent object with the specified source object, the name of the concerned workbook, sheet and range.

Method Summary

int	getEndCol() Returns the ending column number for the range.
int	getEndRow() Returns the ending row number for the range.
int	getId() Returns an id indicating the type of event.
java.lang.String	getRangeName() Returns the name of the range that has been initialized.
int	getStartCol() Returns the starting column number for the range.
int	getStartRow() Returns the starting row number for the range.
java.lang.String	getWorkbookName() Returns the name of the workbook containing the range.
java.lang.String	getWorksheetName() Returns the name of the worksheet in which the range was initialized.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

RANGE_INITIALIZED

public static final int RANGE_INITIALIZED

The id for the RANGE_INITIALIZED type of event.

RANGE_UNINITIALIZED

public static final int RANGE_UNINITIALIZED

The id for the RANGE_UNINITIALIZED type of event.

sheetName

protected java.lang.String sheetName

The name of the worksheet for the range.

workbookName

protected java.lang.String workbookName

The name of the workbook containing the range.

rangeName

protected java.lang.String rangeName

The name of the range which has been initialised or uninitialised.

id

protected int id

The event-id indicating the type of event.

Constructor Detail

ExcelRangeEvent

public ExcelRangeEvent(java.lang.Object source,
                       int id,
                       java.lang.String workbookName,
                       java.lang.String sheetName,
                       java.lang.String rangeName,
                       int startRow,
                       int startCol,
                       int endRow,
                       int endCol)

Constructs an ExcelRangeEvent object with the specified source object, the name of the concerned workbook, sheet and range.

Parameters:

source - The object where the event originated.

id - The id specifying the type of event.

workbookName - The name of the workbook of the range.

sheetName - The name of the sheet of the range.

rangeName - The name of the range which has been initialized.

startRow - The starting row number for the range.

startCol - The starting column number for the range.

endRow - The ending row number for the range.

endCol - The ending column number for the range.

Method Detail

getEndCol

public int getEndCol()

Returns the ending column number for the range.

Returns:

Returns the ending column number for the range.

getEndRow

public int getEndRow()

Returns the ending row number for the range.

Returns:

Returns the ending row number for the range.

getId

public int getId()

Returns an id indicating the type of event.

Returns:

The id indicating the type of event.

getRangeName

public java.lang.String getRangeName()

Returns the name of the range that has been initialized. If the range is not named it returns null.

Returns:

The name of the initialized range.

getStartCol

public int getStartCol()

Returns the starting column number for the range.

Returns:

Returns the starting column number for the range.

getStartRow

public int getStartRow()

Returns the starting row number for the range.

Returns:

Returns the starting row number for the range.

getWorkbookName

public java.lang.String getWorkbookName()

Returns the name of the workbook containing the range.

Returns:

The name of the workbook containing the range.

getWorksheetName

public java.lang.String getWorksheetName()

Returns the name of the worksheet in which the range was initialized.

Returns:

The name of the worksheet that contains the range.