org.apache.pivot.wtk
Interface TableView.RowEditorListener

All Known Implementing Classes:
TableView.RowEditor.RowEditorListenerList, TableView.RowEditorListener.Adapter
Enclosing class:
TableView

public static interface TableView.RowEditorListener

The row editor listener interface. This provides callers with notifications about a row editor's activity.


Nested Class Summary
static class TableView.RowEditorListener.Adapter
          Row editor listener adapter.
 
Method Summary
 void changesSaved(TableView.RowEditor rowEditor, TableView tableView, int rowIndex, int columnIndex)
          Called when changes have been saved.
 void editCancelled(TableView.RowEditor rowEditor, TableView tableView, int rowIndex, int columnIndex)
          Called when an edit has been cancelled.
 void editRowVetoed(TableView.RowEditor rowEditor, Vote reason)
          Called when a row edit was vetoed by a listener in the preview event.
 Vote previewEditRow(TableView.RowEditor rowEditor, TableView tableView, int rowIndex, int columnIndex)
          Called to preview a row edit.
 Vote previewSaveChanges(TableView.RowEditor rowEditor, TableView tableView, int rowIndex, int columnIndex, Dictionary<String,Object> changes)
          Called to preview a save.
 void rowEditing(TableView.RowEditor rowEditor, TableView tableView, int rowIndex, int columnIndex)
          Called when editing has begun.
 void saveChangesVetoed(TableView.RowEditor rowEditor, Vote reason)
          Called when a save was vetoed by a listener in the preview event.
 

Method Detail

previewEditRow

Vote previewEditRow(TableView.RowEditor rowEditor,
                    TableView tableView,
                    int rowIndex,
                    int columnIndex)
Called to preview a row edit.

Parameters:
rowEditor - The row editor
tableView - The table view containing the row to be edited.
rowIndex - The index of the row to edit.
columnIndex - The index of the column to edit.
Returns:
A vote on whether editing should be allowed to begin.

editRowVetoed

void editRowVetoed(TableView.RowEditor rowEditor,
                   Vote reason)
Called when a row edit was vetoed by a listener in the preview event.

Parameters:
rowEditor - The row editor
reason - The reason for the veto

rowEditing

void rowEditing(TableView.RowEditor rowEditor,
                TableView tableView,
                int rowIndex,
                int columnIndex)
Called when editing has begun.

Parameters:
rowEditor - The row editor
tableView - The table view containing the row being edited.
rowIndex - The index of the row being edited.
columnIndex - The index of the column being edited.

previewSaveChanges

Vote previewSaveChanges(TableView.RowEditor rowEditor,
                        TableView tableView,
                        int rowIndex,
                        int columnIndex,
                        Dictionary<String,Object> changes)
Called to preview a save.

Parameters:
rowEditor - The row editor
tableView - The table view containing the row being edited.
rowIndex - The index of the row being edited.
columnIndex - The index of the column being edited.
changes - The proposed changes, indexed by table view column name. The type of each entry in this dictionary will depend on the editor implementation.
Returns:
A vote on whether the changes should be allowed to be saved.

saveChangesVetoed

void saveChangesVetoed(TableView.RowEditor rowEditor,
                       Vote reason)
Called when a save was vetoed by a listener in the preview event.

Parameters:
rowEditor - The row editor
reason - The reason for the veto

changesSaved

void changesSaved(TableView.RowEditor rowEditor,
                  TableView tableView,
                  int rowIndex,
                  int columnIndex)
Called when changes have been saved.

Parameters:
rowEditor - The row editor
tableView - The table view containing the row that was edited.
rowIndex - The index of the row that was edited.
columnIndex - The index of the column that was edited.

editCancelled

void editCancelled(TableView.RowEditor rowEditor,
                   TableView tableView,
                   int rowIndex,
                   int columnIndex)
Called when an edit has been cancelled.

Parameters:
rowEditor - The row editor
tableView - The table view containing the row that was being edited.
rowIndex - The index of the row that was being edited.
columnIndex - The index of the column that was being edited.