All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.excelaccessor.event.FetchPasswordEvent 

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----com.ibm.excelaccessor.event.FetchPasswordEvent
public class FetchPasswordEvent
extends 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

Variable Index

o WKBK_PROTECTION_PASSWD_REQD
The type of event when the workbook protection password is required.
o WKBK_STRUCTURE_PROTECTION_PASSWD_REQD
The type of event when the workbook structure protection password is required.
o WKBK_WRITE_RESERVATION_PASSWD_REQD
The type of event when the workbook write reservation password is required.
o WORKSHEET_PROTECTION_PASSWD_REQD
The type of event when the worksheet protection password is required.

Constructor Index

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

Method Index

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

Variables

o WKBK_PROTECTION_PASSWD_REQD 
 public static final int WKBK_PROTECTION_PASSWD_REQD
The type of event when the workbook protection password is required.

o 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.

o 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.

o WORKSHEET_PROTECTION_PASSWD_REQD 
 public static final int WORKSHEET_PROTECTION_PASSWD_REQD
The type of event when the worksheet protection password is required.

Constructors

o FetchPasswordEvent 
 public FetchPasswordEvent(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.

Methods

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

Returns:
The id that indicates the type of this event. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index