com.ibm.excelaccessor.event
Class FileSavingEvent

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

All Implemented Interfaces:

java.io.Serializable

public class FileSavingEvent

extends java.util.EventObject

This event is fired to signal that a modified workbook file is being closed and the status of the saveOnClose flag of the ExcelWorkbook will be used to determine whether it will be saved or not. This event can be used to modify the saveOnClose flag and possibly discard changes made to a workbook file.

See Also:

EventObject, FileSavingListener, Serialized Form

Field Summary

protected java.lang.String

workbookName The name of the modified workbook file being closed.

Fields inherited from class java.util.EventObject

source

Constructor Summary

FileSavingEvent(java.lang.Object source, java.lang.String workbookName)
Constructs a FileSavingEvent object with the specified source object and the name of the modified workbook file that is being closed.

Method Summary

java.lang.String

getWorkbookName() Returns the name of the 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

workbookName

protected java.lang.String workbookName

The name of the modified workbook file being closed.

Constructor Detail

FileSavingEvent

public FileSavingEvent(java.lang.Object source,
                       java.lang.String workbookName)

Constructs a FileSavingEvent object with the specified source object and the name of the modified workbook file that is being closed.

Parameters:

source - The object where the event originated.

workbookName - The name of the workbook being closed.

Method Detail

getWorkbookName

public java.lang.String getWorkbookName()

Returns the name of the workbook.

Returns:

The name of the workbook.