com.goldencode.p2j.ui

Interface SheetEventHandler

All Known Implementing Classes:

SpreadsheetWidget.EventHandler

public interface SheetEventHandler

Spreadsheet event handler interface.

Method Summary

Modifier and Type	Method and Description
void	onCellClick(int row, int column) Called when cell is clicked.
void	onCellDoubleClick(int row, int column) Called when cell is double clicked.
void	onCellFocus(java.lang.String sheetName, int sheetIdx, java.lang.String cellRef, int cellColumn, int cellRow) Called when a cell receives focus.
void	onCellRightClick(int row, int column) Called when cell is right clicked.
void	onCellSelection() Called when cell selection changes.
void	onKeyDown(int keyCode, int keyState, java.lang.Runnable completion) Triggered when a key changes to down.
void	onKeyPress(int keyAscii, java.lang.Runnable completion) Triggered when a key is pressed.
void	onKeyUp(int keyCode, int keyState, java.lang.Runnable completion) Triggered when a key changes to up.
void	onObjClick(java.lang.String name, int objId) Triggered when an object is clicked.
void	onObjValueChanged(java.lang.String objName, int objId) Called when an object's value is changed.
void	onStartEditing(java.lang.Object editingValue, java.lang.Runnable initiation) Called when cell enters editing mode.
void	onStopEditing(java.lang.Object editingValue, java.lang.Runnable completion) Called when cell exits editing mode.

Method Detail

onCellClick

void onCellClick(int row,
                 int column)

Called when cell is clicked.

Parameters:

row - Cell row.

column - Cell column.

onCellDoubleClick

void onCellDoubleClick(int row,
                       int column)

Called when cell is double clicked.

Parameters:

row - Cell row.

column - Cell column.

onCellRightClick

void onCellRightClick(int row,
                      int column)

Called when cell is right clicked.

Parameters:

row - Cell row.

column - Cell column.

onStartEditing

void onStartEditing(java.lang.Object editingValue,
                    java.lang.Runnable initiation)

Called when cell enters editing mode.

Parameters:

editingValue - The editing value.

initiation - A runnable called right before the legacy start editing event handler begins execution. The runnable is called on the legacy OS event queue.

onStopEditing

void onStopEditing(java.lang.Object editingValue,
                   java.lang.Runnable completion)

Called when cell exits editing mode.

Parameters:

editingValue - The editing value.

completion - A runnable called after the legacy stop editing event handler finishes execution. The runnable is called on the legacy OS event queue.

onCellFocus

void onCellFocus(java.lang.String sheetName,
                 int sheetIdx,
                 java.lang.String cellRef,
                 int cellColumn,
                 int cellRow)

Called when a cell receives focus.

Parameters:

sheetName - Sheet name.

sheetIdx - Sheet index.

cellRef - Cell reference string.

cellColumn - Cell column.

cellRow - Cell row.

onCellSelection

void onCellSelection()

Called when cell selection changes.

onObjClick

void onObjClick(java.lang.String name,
                int objId)

Triggered when an object is clicked.

Parameters:

name - Object name.

objId - Object id.

onObjValueChanged

void onObjValueChanged(java.lang.String objName,
                       int objId)

Called when an object's value is changed.

Parameters:

objName - the name of the object whose value is changed

objId - the id of the object whose value is changed

onKeyDown

void onKeyDown(int keyCode,
               int keyState,
               java.lang.Runnable completion)

Triggered when a key changes to down.

Parameters:

keyCode - The key code.

keyState - The extended keys state. Bit 0 for shift, bit 1 for ctrl and bit 2 for alt.

completion - Completion handler, invoked after the event is dispatched.

onKeyUp

void onKeyUp(int keyCode,
             int keyState,
             java.lang.Runnable completion)

Triggered when a key changes to up.

Parameters:

keyCode - The key code.

keyState - The extended keys state. Bit 0 for shift, bit 1 for ctrl and bit 2 for alt.

completion - Completion handler, invoked after the event is dispatched.

onKeyPress

void onKeyPress(int keyAscii,
                java.lang.Runnable completion)

Triggered when a key is pressed.

Parameters:

keyAscii - The key ascii code.

completion - Completion handler, invoked after the event is dispatched.