JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.table
Class JCTraverseCellEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.klg.jclass.table.JCTraverseCellEvent
All Implemented Interfaces:
Serializable

public class JCTraverseCellEvent
extends EventObject

This event is posted as a user traverses from one cell to another.

The event is posted after a user has committed a cell edit, and before moving to the next cell.

See Also:
JCTable.addTraverseCellListener(com.klg.jclass.table.JCTraverseCellListener), JCTraverseCellListener, Serialized Form

Field Summary
static int AFTER_TRAVERSE_CELL
           
protected  boolean cancelled
           
protected  int current_column
           
protected  int current_row
           
protected  int next_column
           
protected  int next_row
           
static int TRAVERSE_CELL
           
protected  int traverse_type
           
protected  int type
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
JCTraverseCellEvent(Object source, int type, int row, int column, int next_row, int next_column, int traverse_type)
           
 
Method Summary
 int getColumn()
          Gets the column of the current cell.
 int getNextColumn()
          Gets the proposed column of the cell to traverse to.
 int getNextRow()
          Gets the proposed row of the cell to traverse to.
 int getRow()
          Gets the row of the current cell.
 int getTraverseType()
          Returns the action that caused the traverse.
 String getTraverseTypeString()
          Returns a String value for a traverse type.
 int getType()
          Gets the event type.
 boolean isCancelled()
          Gets the Cancelled value.
 void setCancelled(boolean value)
          Sets the Cancelled value.
 void setNextColumn(int value)
          Sets the column of the cell to traverse to.
 void setNextRow(int value)
          Sets the row of the cell to traverse to.
 String toString()
          Returns a String representation of the event.
 
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
 

Field Detail

TRAVERSE_CELL

public static final int TRAVERSE_CELL
See Also:
Constant Field Values

AFTER_TRAVERSE_CELL

public static final int AFTER_TRAVERSE_CELL
See Also:
Constant Field Values

type

protected int type

current_row

protected int current_row

current_column

protected int current_column

next_row

protected int next_row

next_column

protected int next_column

traverse_type

protected int traverse_type

cancelled

protected boolean cancelled
Constructor Detail

JCTraverseCellEvent

public JCTraverseCellEvent(Object source,
                           int type,
                           int row,
                           int column,
                           int next_row,
                           int next_column,
                           int traverse_type)
Method Detail

getRow

public int getRow()
Gets the row of the current cell.

Returns:

getColumn

public int getColumn()
Gets the column of the current cell.

Returns:

getNextRow

public int getNextRow()
Gets the proposed row of the cell to traverse to.

Returns:

getNextColumn

public int getNextColumn()
Gets the proposed column of the cell to traverse to.

Returns:

setNextRow

public void setNextRow(int value)
Sets the row of the cell to traverse to.

Parameters:
value -

setNextColumn

public void setNextColumn(int value)
Sets the column of the cell to traverse to.

Parameters:
value -

getTraverseType

public int getTraverseType()
Returns the action that caused the traverse. Valid actions are:
JCTableEnum.TRAVERSE_POINTERmouse click
JCTableEnum.TRAVERSE_DOWNdown
JCTableEnum.TRAVERSE_UPup
JCTableEnum.TRAVERSE_LEFT left
JCTableEnum.TRAVERSE_RIGHTright
JCTableEnum.TRAVERSE_PAGEUPpage up
JCTableEnum.TRAVERSE_PAGEDOWNpage down
JCTableEnum.TRAVERSE_HOMEtop/left
JCTableEnum.TRAVERSE_ENDbottom/right
JCTableEnum.TRAVERSE_TOPtop of column
JCTableEnum.TRAVERSE_BOTTOMbottom of column
JCTableEnum.TRAVERSE_TO_CELLprogrammatic

Returns:
action that caused the traverse
See Also:
JCTable.traverse(int, int, boolean, boolean)

getTraverseTypeString

public String getTraverseTypeString()
Returns a String value for a traverse type.

Returns:
String value

isCancelled

public boolean isCancelled()
Gets the Cancelled value.

Returns:
See Also:
setCancelled(boolean)

setCancelled

public void setCancelled(boolean value)
Sets the Cancelled value.

Parameters:
value -
See Also:
isCancelled()

getType

public int getType()
Gets the event type.

Returns:

toString

public String toString()
Returns a String representation of the event.

Overrides:
toString in class EventObject
Returns:
String representation of the event

Copyright © 2004 Quest Software Inc..
All rights reserved.