org.tentackle.ui
Class FormTableTraversalEvent

java.lang.Object
  java.util.EventObject
      org.tentackle.ui.FormTableTraversalEvent

All Implemented Interfaces:

Serializable

public class FormTableTraversalEvent
extends EventObject

A cell traversal event.
Whenever a cell traversal occurs on a FormTable (see setCellTraversal()) an event will be sent to all FormTableTraversalListeners. The event will also be triggered if a cell traversal does not take place due to wrapping restrictions.
Furthermore, the event is vetoable, i.e. if one of the listeners does not ack the event, the cell traversal will be cancelled.

Author:

harald

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

FormTableTraversalEvent(FormTable table, boolean inhibited, int fromRow, int fromColumn, int toRow, int toColumn, boolean editing, boolean next)
Creates a new traversal event.

Method Summary

int	getFromColumn() Gets the column in which the event was fired.
int	getFromRow() Gets the row in which the event was fired.
FormTable	getTable() Gets the table.
int	getToColumn() Gets the column the event is related to.
int	getToRow() Gets the row the event is related to.
boolean	isEditing() Returns whether traversal will start editing of the cell in toRow/toColumn.
boolean	isInhibited() Returns whether traversal was inhibited due to wrapping restrictions.
boolean	isNext() Returns whether traversal was "to next", false if "to previous" cell.
String	toString() Returns a String representation of this EventObject.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FormTableTraversalEvent

public FormTableTraversalEvent(FormTable table,
                               boolean inhibited,
                               int fromRow,
                               int fromColumn,
                               int toRow,
                               int toColumn,
                               boolean editing,
                               boolean next)

Creates a new traversal event.

Parameters:

table - the FormTable

inhibited - true if traversal inhibited due to wrapping restrictions

fromRow - the row in which the event was fired

fromColumn - the column in which the event was fired

toRow - the row the event is related to

toColumn - the column the event is related to

editing - true if traversal will start editing of the cell in toRow/toColumn

next - true if traversal was "to next", false if "to previous" cell

Method Detail

getTable

public FormTable getTable()

Gets the table.

Returns:

the FormTable

getFromRow

public int getFromRow()

Gets the row in which the event was fired.

Returns:

the row

getFromColumn

public int getFromColumn()

Gets the column in which the event was fired.

Returns:

the column

getToRow

public int getToRow()

Gets the row the event is related to.

Returns:

the row

getToColumn

public int getToColumn()

Gets the column the event is related to.

Returns:

the column

isEditing

public boolean isEditing()

Returns whether traversal will start editing of the cell in toRow/toColumn.

Returns:

true if start editing

isNext

public boolean isNext()

Returns whether traversal was "to next", false if "to previous" cell.

Returns:

true if next

isInhibited

public boolean isInhibited()

Returns whether traversal was inhibited due to wrapping restrictions.

Returns:

true if inhibited

toString

public String toString()

Description copied from class: java.util.EventObject

Returns a String representation of this EventObject.

Overrides:

toString in class EventObject

Returns:

A a String representation of this EventObject.