All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.excelaccessor.event.ExcelRangeEvent

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

public class ExcelRangeEvent
extends EventObject
This event is fired when a range has been successfully initialized, or uninitialized

See Also:
EventObject, ExcelRangeListener

Variable Index

 o RANGE_INITIALIZED
The id for the RANGE_INITIALIZED type of event.
 o RANGE_UNINITIALIZED
The id for the RANGE_UNINITIALIZED type of event.

Constructor Index

 o ExcelRangeEvent(Object, int, String, String, String, int, int, int, int)
Constructs an ExcelRangeEvent object with the specified source object, the name of the concerned workbook, sheet and range.

Method Index

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

Variables

 o RANGE_INITIALIZED
 public static final int RANGE_INITIALIZED
The id for the RANGE_INITIALIZED type of event.

 o RANGE_UNINITIALIZED
 public static final int RANGE_UNINITIALIZED
The id for the RANGE_UNINITIALIZED type of event.

Constructors

 o ExcelRangeEvent
 public ExcelRangeEvent(Object source,
                        int id,
                        String workbookName,
                        String sheetName,
                        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.

Methods

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

Returns:
The id indicating the type of event.
 o getEndCol
 public int getEndCol()
Returns the ending column number for the range.

Returns:
Returns the ending column number for the range.
 o getEndRow
 public int getEndRow()
Returns the ending row number for the range.

Returns:
Returns the ending row number for the range.
 o getRangeName
 public 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.
 o getWorksheetName
 public String getWorksheetName()
Returns the name of the worksheet in which the range was initialized.

Returns:
The name of the worksheet that contains the range.
 o getStartCol
 public int getStartCol()
Returns the starting column number for the range.

Returns:
Returns the starting column number for the range.
 o getStartRow
 public int getStartRow()
Returns the starting row number for the range.

Returns:
Returns the starting row number for the range.
 o getWorkbookName
 public String getWorkbookName()
Returns the name of the workbook containing the range.

Returns:
The name of the workbook containing the range.

All Packages  Class Hierarchy  This Package  Previous  Next  Index