com.ibm.excelaccessor.event
Class ExcelSheetEvent

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

All Implemented Interfaces:

java.io.Serializable

public class ExcelSheetEvent

extends java.util.EventObject

This event is fired to signal the insertion or removal of a worksheet from an Excel file.

See Also:

EventObject, ExcelSheetListener, Serialized Form

Field Summary

protected int	id The event-id indicating the type of event.
static int	SHEET_INSERTED The id for the SHEET_INSERTED type of event.
static int	SHEET_REMOVED The id for the SHEET_REMOVED type of event.
protected java.lang.String	sheetName The name of the worksheet added or removed.
protected java.lang.String	workbookName The name of the workbook affected by the operation.

Fields inherited from class java.util.EventObject

source

Constructor Summary

ExcelSheetEvent(java.lang.Object source, int id, java.lang.String sheetName, java.lang.String workbookName)
Constructs an ExcelSheetEvent object with the specified source object, the name of the concerned sheet and the name of the affected workbook.

Method Summary

int	getId() Returns an id indicating the type of event.
java.lang.String	getSheetName() Returns the name of the sheet concerned with this event.
java.lang.String	getWorkbookName() Returns the name of the affected workbook.

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

SHEET_INSERTED

public static final int SHEET_INSERTED

The id for the SHEET_INSERTED type of event.

SHEET_REMOVED

public static final int SHEET_REMOVED

The id for the SHEET_REMOVED type of event.

sheetName

protected java.lang.String sheetName

The name of the worksheet added or removed.

workbookName

protected java.lang.String workbookName

The name of the workbook affected by the operation.

id

protected int id

The event-id indicating the type of event.

Constructor Detail

ExcelSheetEvent

public ExcelSheetEvent(java.lang.Object source,
                       int id,
                       java.lang.String sheetName,
                       java.lang.String workbookName)

Constructs an ExcelSheetEvent object with the specified source object, the name of the concerned sheet and the name of the affected workbook.

Parameters:

source - The object where the event originated.

id - The id indicating the type of event.

sheetName - The name of the sheet concerned.

workbookName - The name of the workbook affected.

Method Detail

getId

public int getId()

Returns an id indicating the type of event.

Returns:

The id indicating the type of event.

getSheetName

public java.lang.String getSheetName()

Returns the name of the sheet concerned with this event.

Returns:

The name of the sheet concerned with this event.

getWorkbookName

public java.lang.String getWorkbookName()

Returns the name of the affected workbook.

Returns:

The name of the affected workbook.