com.ibm.excelaccessor.event
Class FetchPasswordEvent

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

All Implemented Interfaces:

java.io.Serializable

public class FetchPasswordEvent

extends java.util.EventObject

This event is fired when an operation in Excel requires a password for successful completion. These passwords could be the workbook protection password or the workbook write protection password needed at the time of opening a workbook, or the workbook structure unprotection password needed when a sheet is inserted into or removed from a workbook, or the worksheet protection password needed when a sheet has to be unprotected. This event could then be used for prompting for and setting the appropriate password.

See Also:

FetchPasswordListener, Serialized Form

Field Summary

protected int	id The event-id indicating the type of event.
static int	WKBK_PROTECTION_PASSWD_REQD The type of event when the workbook protection password is required.
static int	WKBK_STRUCTURE_PROTECTION_PASSWD_REQD The type of event when the workbook structure protection password is required.
static int	WKBK_WRITE_RESERVATION_PASSWD_REQD The type of event when the workbook write reservation password is required.
static int	WORKSHEET_PROTECTION_PASSWD_REQD The type of event when the worksheet protection password is required.

Fields inherited from class java.util.EventObject

source

Constructor Summary

FetchPasswordEvent(java.lang.Object source, int id)
Constructs a FetchPasswordEvent object with the specified source object and the type of FetchPasswordEvent.

Method Summary

int	getId() Returns an event-id indicating the type of event.

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

WKBK_PROTECTION_PASSWD_REQD

public static final int WKBK_PROTECTION_PASSWD_REQD

The type of event when the workbook protection password is required.

WKBK_WRITE_RESERVATION_PASSWD_REQD

public static final int WKBK_WRITE_RESERVATION_PASSWD_REQD

The type of event when the workbook write reservation password is required.

WKBK_STRUCTURE_PROTECTION_PASSWD_REQD

public static final int WKBK_STRUCTURE_PROTECTION_PASSWD_REQD

The type of event when the workbook structure protection password is required.

WORKSHEET_PROTECTION_PASSWD_REQD

public static final int WORKSHEET_PROTECTION_PASSWD_REQD

The type of event when the worksheet protection password is required.

id

protected int id

The event-id indicating the type of event.

Constructor Detail

FetchPasswordEvent

public FetchPasswordEvent(java.lang.Object source,
                          int id)

Constructs a FetchPasswordEvent object with the specified source object and the type of FetchPasswordEvent.

Parameters:

source - The object where the event originated.

id - The type of FetchPasswordEvent.

Method Detail

getId

public int getId()

Returns an event-id indicating the type of event.

Returns:

The id that indicates the type of this event.