CoffeeTable.Grid
Class GridEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--java.awt.AWTEvent
              |
              +--CoffeeTable.Grid.GridEvent

public class GridEvent
extends java.awt.AWTEvent

The event class for Grid events generated by the GridPanel.

Version:
2.1.3 of October 1, 1999 Copyright © 1996-1999 3Magic
See Also:
Serialized Form

Field Summary
static int CANCEL_EDIT
          The cancel edit event type.
static int CELLS_CLICKED
          The cells clicked event type.
static int CELLS_RELEASED
          The cells released event type.
static int COMMIT_EDIT
          The commit edit event type.
static int DOUBLE_CLICKED
          The cells clicked event type.
static int GRID_EVENT_FIRST
          Marks the first integer id for the range of grid event ids.
static int GRID_EVENT_LAST
          Marks the last integer id for the range of grid event ids.
static int RESIZE_COL
          The resize column event type.
static int RESIZE_ROW
          The resize row event type.
static int SEL_CHANGED
          A selection changed event type.
static int SORT_COL
          The sort column event type.
static int START_EDIT
          The start edit event type.
 
Fields inherited from class java.awt.AWTEvent
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
GridEvent(java.lang.Object source, int id, int col, int row)
          Constructs a WindowEvent object with the specified source, id and the row and column index of the cell.
GridEvent(java.lang.Object source, int id, int modifiers, int col, int row)
          Constructs a WindowEvent object with the specified source, id, event modifiers and the row and column index of the cell.
 
Method Summary
 int getCol()
          Returns the column index for the cell.
 int getModifiers()
          Returns the modifiers held down during this action event.
 int getRow()
          Returns the row index for the cell.
 java.lang.String paramString()
           
 
Methods inherited from class java.awt.AWTEvent
consume, finalize, getID, isConsumed, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

GRID_EVENT_FIRST

public static final int GRID_EVENT_FIRST
Marks the first integer id for the range of grid event ids.

GRID_EVENT_LAST

public static final int GRID_EVENT_LAST
Marks the last integer id for the range of grid event ids.

CELLS_CLICKED

public static final int CELLS_CLICKED
The cells clicked event type. This event is delivered every time the user clicks a cell, row/column headers or range of cells.

DOUBLE_CLICKED

public static final int DOUBLE_CLICKED
The cells clicked event type. This event is delivered every time the user double clicks on a cell or row/column header.

CELLS_RELEASED

public static final int CELLS_RELEASED
The cells released event type. This event is delivered every time the user releases the mouse after clicking in a cell, row/column headers or range of cells.

START_EDIT

public static final int START_EDIT
The start edit event type. This event is delivered whenever editing is activated in a cell.

COMMIT_EDIT

public static final int COMMIT_EDIT
The commit edit event type. This event is delivered whenever editing ends in a cell and the changes are committed.

CANCEL_EDIT

public static final int CANCEL_EDIT
The cancel edit event type. This event is delivered whenever editing ends in a cell and the changes are canceled.

RESIZE_ROW

public static final int RESIZE_ROW
The resize row event type. This event is delivered whenever the user resizes a row.

RESIZE_COL

public static final int RESIZE_COL
The resize column event type. This event is delivered whenever the user resizes a column.

SORT_COL

public static final int SORT_COL
The sort column event type. This event is delivered whenever the user clicks on the column header to sort on a column.

SEL_CHANGED

public static final int SEL_CHANGED
A selection changed event type. This event is delivered whenever the GridPanel's selection changes.
Constructor Detail

GridEvent

public GridEvent(java.lang.Object source,
                 int id,
                 int col,
                 int row)
Constructs a WindowEvent object with the specified source, id and the row and column index of the cell.
Parameters:
source - the component where the event originated
id - the event type
col - the column index of the cell
row - the row index of the cell

GridEvent

public GridEvent(java.lang.Object source,
                 int id,
                 int modifiers,
                 int col,
                 int row)
Constructs a WindowEvent object with the specified source, id, event modifiers and the row and column index of the cell.
Parameters:
source - the component where the event originated
id - the event type
col - the column index of the cell
row - the row index of the cell
Method Detail

getModifiers

public int getModifiers()
Returns the modifiers held down during this action event. NOTE: This only applies to the CELLS_CLICKED, DOUBLE_CLICKED & CELLS_RELEASED events.

getRow

public int getRow()
Returns the row index for the cell. NOTE: This value is not available for the SEL_CHANGED event.

getCol

public int getCol()
Returns the column index for the cell. NOTE: This value is not available for the SEL_CHANGED event.

paramString

public java.lang.String paramString()
Overrides:
paramString in class java.awt.AWTEvent