com.klg.jclass.higrid
Class HiGridEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.klg.jclass.higrid.HiGridEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HiGridColumnSelectionEvent, HiGridExpansionEvent, HiGridFormatNodeEvent, HiGridMoveCellEvent, HiGridRepaintEvent, HiGridResizeCellEvent, HiGridRowSelectionEvent, HiGridSortTableEvent, HiGridTraverseEvent, HiGridUpdateEvent, HiGridValidateEvent

public abstract class HiGridEvent

extends EventObject

HiGridEvent is the base class for most HiGrid events.

See Also:

Serialized Form

Field Summary

protected boolean	cancelled
protected String	column
protected int	eventType
protected com.klg.jclass.higrid.HiGrid	grid
protected com.klg.jclass.higrid.RowNode	rowNode

Fields inherited from class java.util.EventObject

source

Constructor Summary

HiGridEvent(com.klg.jclass.higrid.HiGrid grid, int eventType, com.klg.jclass.higrid.RowNode rowNode, String column)
Constructor

Method Summary

void	cancelProposedAction() Cancels the proposed action.
boolean	getCancelled() Indicates if proposed action was cancelled by a listener.
String	getColumn() Returns a string indicating which column is affected, or "" in the case where the column is not applicable.
int	getEventType() Retrieves the type of this event.
com.klg.jclass.higrid.RowNode	getRowNode() Retrieves the RowNode associated with this event.
boolean	isCancelable() Return true if this event can be cancelled.

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

grid

protected com.klg.jclass.higrid.HiGrid grid

eventType

protected int eventType

rowNode

protected com.klg.jclass.higrid.RowNode rowNode

column

protected String column

cancelled

protected boolean cancelled

Constructor Detail

HiGridEvent

public HiGridEvent(com.klg.jclass.higrid.HiGrid grid,
                   int eventType,
                   com.klg.jclass.higrid.RowNode rowNode,
                   String column)

Constructor

Method Detail

getColumn

public String getColumn()

Returns a string indicating which column is affected, or "" in the case where the column is not applicable.

Returns:

the column name of the column

getEventType

public int getEventType()

Retrieves the type of this event.

Returns:

The type of event.

getRowNode

public com.klg.jclass.higrid.RowNode getRowNode()

Retrieves the RowNode associated with this event.

Returns:

The RowNode associated with this event.

cancelProposedAction

public void cancelProposedAction()

Cancels the proposed action. Call this method to veto the pending action. The default is to accept the change (false). If isCancelable() returns false the cancel request is ignored.

See Also:

isCancelable(), getCancelled()

getCancelled

public boolean getCancelled()

Indicates if proposed action was cancelled by a listener.

Returns:

a boolean: true if cancelled.

See Also:

cancelProposedAction()

isCancelable

public boolean isCancelable()

Return true if this event can be cancelled. Cancelling an event cancels the operation which generated the event.

Returns:

true if this event can be cancelled.