EditableGrid (Advanced GWT Components 2.0.9 API)

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.google.gwt.user.client.ui.Panel
    - - com.google.gwt.user.client.ui.HTMLTable
      - com.google.gwt.user.client.ui.FlexTable
        
        org.gwt.advanced.client.ui.widget.AdvancedFlexTable
        
        org.gwt.advanced.client.ui.widget.SimpleGrid
        
        org.gwt.advanced.client.ui.widget.EditableGrid<T>

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesTableEvents, Iterable<com.google.gwt.user.client.ui.Widget>, AdvancedWidget, Resizable, SourcesTableDoubleClickEvents

Direct Known Subclasses:

HierarchicalGrid, TreeGrid
```
public class EditableGrid<T extends Editable>
extends SimpleGrid
implements AdvancedWidget
```
This is an editable grid widget.

Since:

1.0.0

Author:

Sergey Skladchikov

Nested Class Summary
- Nested classes/interfaces inherited from class org.gwt.advanced.client.ui.widget.SimpleGrid
  SimpleGrid.ResizeListener, SimpleGrid.ResizeTimer
- Nested classes/interfaces inherited from class org.gwt.advanced.client.ui.widget.AdvancedFlexTable
  AdvancedFlexTable.AdvancedWidgetIterator, AdvancedFlexTable.ClickTimer, AdvancedFlexTable.RowsScrollPanel
- Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.FlexTable
  com.google.gwt.user.client.ui.FlexTable.FlexCellFormatter
- Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.HTMLTable
  com.google.gwt.user.client.ui.HTMLTable.Cell, com.google.gwt.user.client.ui.HTMLTable.CellFormatter, com.google.gwt.user.client.ui.HTMLTable.ColumnFormatter, com.google.gwt.user.client.ui.HTMLTable.RowFormatter
- Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
  com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
- Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
  com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary
- Fields inherited from class com.google.gwt.user.client.ui.UIObject
  DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description
`EditableGrid(String[] headers, Class[] columnWidgetClasses)` Creates a new instance of this class.
`EditableGrid(String[] headers, Class[] columnWidgetClasses, boolean resizable)` Creates a new instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activateCell(int row, int column, boolean active)` This method activates / passivate the specified cell.
`void`	`addEditCellListener(EditCellListener listener)` Adds a new edit cell listener.
`void`	`addGridDecorator(GridDecorator decorator)` This method adds a new grid decorator to the grid.
`void`	`addGridListener(GridListener listener)` This method adds a new grid listener to be invoked on grid events.
`void`	`addInvisibleColumn(int column)` This method adds an invisible column in the internal list.
`protected void`	`addListeners()` This method adds grid specific listeners into the current widget.
`void`	`addRow()` This method adds a new empty row into the grid.
`protected void`	`addRow(int row, Object[] data)` This method adds the row into the grid.
`void`	`addSelectRowListener(SelectRowListener selectRowListener)` This method adds a selected row listener into the list.
`protected void`	`deleteRow(EditableModelEvent event)` Removes the grid row finding it by the model row number that was deleted.
`void`	`deselectCell(int row, int column)` This method deselects the specified cell.
`protected void`	`detectCurrentSortColumn()` This method looks for the sort column in the header list.
`void`	`display()` Deprecated. don't use this method anymore since it does nothing
`protected void`	`drawCell(EditableModelEvent event)` This method draws a concrete cell.
`protected void`	`drawColumn(int column)` This method draws a column getting data from the data model If the data model is not specified it does nothing.
`protected void`	`drawContent()` This method draws a content of the grid.
`protected void`	`drawHeaders()` This method draws header cells.
`protected void`	`drawRow(EditableModelEvent event)` This method adds a new row into the grid end of the current page if the model row has been added.
`protected void`	`dropSelection()` This method drops cell selection.
`protected boolean`	`fireAfterDrawEvent(int row, int pageSize, Object[] data)` This method fires row drawing event after the row is drawn.
`protected boolean`	`fireBeforeDrawEvent(int row, int pageSize, Object[] data)` This method fires row drawing event before the row is drawn.
`boolean`	`fireFinishEdit(GridCell cell, Object newValue)` This method fires the end edit event.
`void`	`fireSort(HeaderCell header)` This method fires the sort event
`boolean`	`fireStartEdit(GridCell cell)` This method fires the start edit event.
`protected GridCell`	`getActiveCell()` Gets a cell that is active, i.e. a cell that is chosen by a user to edit data.
`protected com.google.gwt.user.client.Element`	`getBodyElement()` Overrides this method to make it accessible for this package and server side renderers.
`protected Comparator<Object>`	`getCellComparator()` This method returns a cell comparator.
`int`	`getColumnByModelColumn(int modelColumn)` Gets a grid column number by a model column index.
`Class[]`	`getColumnWidgetClasses()` Getter for property 'columnWidgetClasses'.
`int`	`getCurrentColumn()` Getter for property 'currentColumn'.
`GridRow`	`getCurrentGridRow()` Gets a currently selected grid row.
`GridRow[]`	`getCurrentGridRows()` Gets a list of selected grid rows.
`int`	`getCurrentRow()` Gets a currently selected row number If there are several rows selected it returns only the first row number.
`int[]`	`getCurrentRows()` Gets a list of selected row numbers.
`HeaderCell`	`getCurrentSortColumn()` Getter for property 'currentSortColumn'.
`protected List<GridDecorator>`	`getDecorators()` Getter for property 'decorators'.
`int`	`getDefaultSelectedRow()` Getter for property 'defaultSelectedRow'.
`protected List<EditCellListener>`	`getEditCellListeners()` Getter for property 'editCellListeners'.
`GridCellFactory`	`getGridCellFactory()` Getter for property 'gridCellFactory'.
`GridColumn`	`getGridColumn(int index)` Gets a grid row column specified by the index.
`GridColumn`	`getGridColumn(String name)` This method gets a grid column by its name.
`GridColumn[]`	`getGridColumns()` gets a list of grid columns currently exisiting in the model (including invisible ones).
`GridPanel`	`getGridPanel()` Getter for property 'gridPanel'.
`GridRenderer`	`getGridRenderer()` Getter for property 'gridRenderer'.
`GridRow`	`getGridRow(int index)` Gets a grid row specified by the index.
`GridRow`	`getGridRowByRowNumber(int row)` Gets a grid row by a row number in the displayed page.
`GridRow[]`	`getGridRows()` Gets a list of grid rows currently loaded into the model.
`HeaderCell`	`getHeaderCell(int column)` This method returns a header cell widget.
`String[]`	`getHeaders()` Getter for property 'headers'.
`protected List<Integer>`	`getInvisibleColumns()` Getter for property 'invisibleColumns'.
`T`	`getModel()` Getter for property 'model'.
`int`	`getModelColumn(int column)` This method returns a column number taking into account invisible columns.
`int`	`getModelRow(int gridRow)` This metod calculates a row number in the model.
`protected com.google.gwt.user.client.ui.Widget`	`getOriginalWidget(int row, int column)` Invokes the `getWidget()` method of the `FlexTable`.
`protected Map<Integer,Boolean>`	`getReadOnlyColumns()` Getter for property 'readOnlyColumns'.
`int`	`getRowByModelRow(EditableModelEvent event)` Gets a grid row number on the displayed page by a model row number.
`GridRowDrawCallbackHandler`	`getRowDrawHandler()` This method returns a row draw handler instance.
`GridRowSelectDataModel`	`getSelectionModel()` Gets a selection model.
`protected List<SelectRowListener>`	`getSelectRowListeners()` This method retuns a list of select row listeners.
`protected Map<Integer,Boolean>`	`getSortableHeaders()` Getter for property 'sortableHeaders'.
`int`	`getSortColumn()` This method returns a sort column number.
`com.google.gwt.user.client.ui.Widget`	`getWidget(int row, int column)` Overrides the super method to emulate grid cell presence.
`protected boolean`	`hasActiveCell()` Checks whether the grid has an activated cell.
`protected void`	`increaseRowNumbers(int startRow, int step)` This method increases row numbers in the cells.
`boolean`	`isAscending(int column)` This method checks whether the specified column is sorted asceding.
`protected boolean`	`isClientSortEnabled()` This method checks whether client sorting is enabled.
`protected boolean`	`isLocked()` Getter for property 'locked'.
`boolean`	`isMultiRowModeEnabled()` Checks whether the multi-row selection mode enabled for this grid.
`boolean`	`isReadOnly(int column)` This method checks whether the specified column is read only.
`boolean`	`isSelected(int row)` This method checks whether the specified row is selected.
`boolean`	`isSortable(int column)` This method checks whether the specified column is sortable.
`boolean`	`isSorted(int column)` This method checks whether the specified column is sorted.
`boolean`	`isVisible(int column)` This method detects whether the specified column is visible.
`protected void`	`refreshAll()` This method refreshes all the content and headers.
`protected void`	`removeColumn(int column)` This method removes the specified column from the grid Note that it doesn't remove the column from the data model.
`protected void`	`removeContent()` This method removes all content from the grid.
`void`	`removeEditCellListener(EditCellListener listener)` This method removes the edit cell listener from the internal list.
`void`	`removeGridDecorator(GridDecorator decorator)` This method removes the grid decorator from the grid.
`void`	`removeGridListener(GridListener listener)` This method removes the specified grid listener.
`void`	`removeInvisibleColumn(int column)` This method removes the specified column form the list of invisible columns.
`protected void`	`removeRow()` This method removes the currently selected row or several rows if the multi row selection mode enabled.
`void`	`removeSelectRowListener(SelectRowListener selectRowListener)` This method removes a selected row listener from the list.
`protected void`	`runDecorators()` This method runs all attached decorators in the same order they have been added.
`void`	`selectRow(int row)` This method marks the specified row as selected.
`void`	`selectRows(int toRow)` This method selects the rows between the currently selected row and the specified one including both of them into the selection.
`void`	`setAscending(boolean ascending)` This method sets the order of sorting and redisplays the grid.
`void`	`setCellComparator(Comparator<Object> cellComparator)` This method sets custom cell comparator.
`void`	`setCurrentCell(int row, int column)` Sets a current column number and activates the cell that belong to this column and `the current row`.
`void`	`setCurrentRow(int currentRow)` Setter for property 'currentRow'.
`void`	`setDefaultSelectedRow(int defaultSelectedRow)` Setter for property 'defaultSelectedRow'.
`void`	`setFocus(boolean focus)` This method sets focus to the grid.
`void`	`setGridCellfactory(GridCellFactory gridCellFactory)` Setter for property 'gridCellFactory'.
`protected void`	`setGridPanel(GridPanel gridPanel)` Setter for property 'gridPanel'.
`void`	`setGridRenderer(GridRenderer gridRenderer)` Setter for property 'gridRenderer'.
`protected void`	`setLocked(boolean locked)` Setter for property 'locked'.
`void`	`setModel(T model)` Setter for property 'model'.
`void`	`setMultiRowModeEnabled(boolean multiRowModeEnabled)` Enables or disbales the multi-row selection mode.
`void`	`setReadOnly(int column, boolean readOnly)` This method makes a column to be read only.
`void`	`setRowDrawHandler(GridRowDrawCallbackHandler rowDrawHandler)` This method sets a row draw handler for this grid.
`void`	`setSelectionModel(GridRowSelectDataModel selectionModel)` Sets the selection model.
`void`	`setSortable(int column, boolean sortable)` This method makes a column to be sortable.
`void`	`setSortColumn(int column)` This method sets the sort column and redisplays the grid.
`protected void`	`sortOnClient()` This method performs client sorting.
`protected void`	`synchronizeDataModel()` This method invokes the data model handler to synchronize the model and persistence storage or redraws content if the model is not lazily loadable.
`protected void`	`synchronizeView(EditableModelEvent event)` This method draws a content on the specified model event.
`protected void`	`updateModel(GridCell cell, Object newValue)` This method updates the model with the new value of the cell on finish edit event.

Methods inherited from class org.gwt.advanced.client.ui.widget.SimpleGrid
addCell, addClickHandler, addDoubleClickListener, addHeaderCells, checkCellBounds, checkRowBounds, clear, clear, clearCell, createCell, enableVerticalScrolling, getBodyTable, getCellCount, getCellForEvent, getCellFormatter, getCellPadding, getCellSpacing, getColumnFormatter, getDOMCellCount, getDOMCellCount, getDOMRowCount, getDOMRowCount, getEventTargetCell, getFlexCellFormatter, getFooterTable, getFooterTdElement, getFooterWidgets, getHeaderTable, getHeaderWidgets, getHTML, getRowCount, getRowFormatter, getScrollPanel, getTableHeight, getTableWidth, getText, getTFootElement, getTHeadElement, getThElement, getThElementWidth, insertCell, insertCells, insertHeaderCell, insertRow, internalClearCell, isCellPresent, isColumnResizingAllowed, isResizable, makeResizable, onBrowserEvent, prepareCell, prepareColumn, prepareFooterCell, prepareHeaderCell, prepareRow, prepareScrolling, remove, removeAllRows, removeCell, removeCells, removeDoubleClickListener, removeFooterWidget, removeHeaderWidget, removeRow, resize, setBodyHeight, setBodyWidth, setBorderWidth, setCellPadding, setCellSpacing, setColumnResizingAllowed, setColumnWidth, setFooterWidget, setHeaderHeight, setHeaderWidget, setHeaderWidth, setHTML, setResizable, setText, setWidget, wrapContent

Methods inherited from class org.gwt.advanced.client.ui.widget.AdvancedFlexTable
addFooterCells, fireClickEvent, fireDoubleClickEvent, getCellClicked, getCellElement, getClickCount, getClickTimer, getDoubleClickListeners, getHandlerManager, isScrollable, iterator, setCellClicked, setCellFormatter, setClickCount, setClickTimer, setColumnFormatter, setDoubleClikcListeners, setHandlerManager, setRowFormatter, setScrollable

Methods inherited from class com.google.gwt.user.client.ui.HTMLTable
addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addTableListener, onEnsureDebugId, removeTableListener, setHTML, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Panel
add, add, adopt, adopt, disown, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent

- Constructor Detail
  - EditableGrid
```
public EditableGrid(String[] headers,
            Class[] columnWidgetClasses)
```
    Creates a new instance of this class.
    
    Parameters:
    headers - is a list of header labels (including invisible).
    columnWidgetClasses - is a list of column widget classes.
  - EditableGrid
```
public EditableGrid(String[] headers,
            Class[] columnWidgetClasses,
            boolean resizable)
```
    Creates a new instance of this class.
    
    Parameters:
    headers - is a list of header labels (including invisible).
    columnWidgetClasses - is a list of column widget classes.
    resizable - is a flag that means columns resizability (by default is true).
- Method Detail
  - getGridCellFactory
```
public GridCellFactory getGridCellFactory()
```
    Getter for property 'gridCellFactory'.
    
    Returns:
    Value for property 'gridCellFactory'.
  - getColumnWidgetClasses
```
public Class[] getColumnWidgetClasses()
```
    Getter for property 'columnWidgetClasses'.
    
    Returns:
    Value for property 'columnWidgetClasses'.
  - getHeaders
```
public String[] getHeaders()
```
    Getter for property 'headers'.
    
    Returns:
    Value for property 'headers'.
  - setGridCellfactory
```
public void setGridCellfactory(GridCellFactory gridCellFactory)
```
    Setter for property 'gridCellFactory'.
    
    Parameters:
    gridCellFactory - Value to set for property 'gridCellFactory'.
  - setModel
```
public void setModel(T model)
```
    Setter for property 'model'.
    
    Parameters:
    model - Value to set for property 'model'.
  - setCellComparator
```
public void setCellComparator(Comparator<Object> cellComparator)
```
    This method sets custom cell comparator.
    
    Parameters:
    cellComparator - is a cell comparator.
  - addEditCellListener
```
public void addEditCellListener(EditCellListener listener)
```
    Adds a new edit cell listener.
    Use this method to add validators.
    
    Parameters:
    listener - is a listener instance.
  - removeEditCellListener
```
public void removeEditCellListener(EditCellListener listener)
```
    This method removes the edit cell listener from the internal list.
    
    Parameters:
    listener - is a listener to be removed.
  - addInvisibleColumn
```
public void addInvisibleColumn(int column)
```
    This method adds an invisible column in the internal list.
    
    Parameters:
    column - is a data model column number.
  - removeColumn
```
protected void removeColumn(int column)
```
    This method removes the specified column from the grid
    Note that it doesn't remove the column from the data model.
    
    Parameters:
    column - is a column number to remove.
  - removeInvisibleColumn
```
public void removeInvisibleColumn(int column)
```
    This method removes the specified column form the list of invisible columns.
    
    Parameters:
    column - is an invisible column number.
  - drawColumn
```
protected void drawColumn(int column)
```
    This method draws a column getting data from the data model
    If the data model is not specified it does nothing.
    
    Parameters:
    column - is a column number.
  - addGridDecorator
```
public void addGridDecorator(GridDecorator decorator)
```
    This method adds a new grid decorator to the grid.
    
    Parameters:
    decorator - is a grid decorator instance.
  - removeGridDecorator
```
public void removeGridDecorator(GridDecorator decorator)
```
    This method removes the grid decorator from the grid.
    
    Parameters:
    decorator - is a grid decorator instance.
  - isReadOnly
```
public boolean isReadOnly(int column)
```
    This method checks whether the specified column is read only.
    
    Parameters:
    column - is a column to check.
    
    Returns:
    true if the column is read only.
  - isSortable
```
public boolean isSortable(int column)
```
    This method checks whether the specified column is sortable.
    
    Parameters:
    column - is a column to check.
    
    Returns:
    true if the column is sortable.
  - isAscending
```
public boolean isAscending(int column)
```
    This method checks whether the specified column is sorted asceding.
    
    Parameters:
    column - is a column to check.
    
    Returns:
    true if the column is sorted ascending.
  - isSorted
```
public boolean isSorted(int column)
```
    This method checks whether the specified column is sorted.
    
    Parameters:
    column - is a column to check.
    
    Returns:
    true if the column is sorted.
  - setReadOnly
```
public void setReadOnly(int column,
               boolean readOnly)
```
    This method makes a column to be read only.
    
    Parameters:
    column - is a column to be read only.
    readOnly - is a read only flag value.
  - setSortable
```
public void setSortable(int column,
               boolean sortable)
```
    This method makes a column to be sortable.
    
    Parameters:
    column - is a column to be sortable.
    sortable - is a sortable flag value.
  - isVisible
```
public boolean isVisible(int column)
```
    This method detects whether the specified column is visible.
    
    Parameters:
    column - is a column number.
    
    Returns:
    true if the column is visible.
  - getCurrentRow
```
public int getCurrentRow()
```
    Gets a currently selected row number
    If there are several rows selected it returns only the first row number.
    
    Returns:
    a selected row number.
  - getCurrentGridRow
```
public GridRow getCurrentGridRow()
```
    Gets a currently selected grid row.
    If there are several rows selected it returns only the first row.
    
    Returns:
    a current grid row.
  - getCurrentRows
```
public int[] getCurrentRows()
```
    Gets a list of selected row numbers.
    
    Returns:
    a list of selected row numbers.
  - getCurrentGridRows
```
public GridRow[] getCurrentGridRows()
```
    Gets a list of selected grid rows.
    
    Returns:
    a list of selected grid rows.
  - setCurrentRow
```
public void setCurrentRow(int currentRow)
```
    Setter for property 'currentRow'.
    
    Parameters:
    currentRow - Value to set for property 'currentRow'.
  - selectRow
```
public void selectRow(int row)
```
    This method marks the specified row as selected.
    It works similarly to the setCurrentRow(int) method but doesn't clear a previous selection. If the multiple rows selection is disabled it checks whether there is at least one selected row and if no it makes selection. Otherwise it does nothing.
    If multiple mode is enabled it always selects a row.
    
    Parameters:
    row - is a row number to make selected.
  - deselectCell
```
public void deselectCell(int row,
                int column)
```
    This method deselects the specified cell.
    
    Parameters:
    row - is a row number in the grid.
    column - is a column number in the grid.
  - isSelected
```
public boolean isSelected(int row)
```
    This method checks whether the specified row is selected.
    
    Parameters:
    row - is a row number in the grid.
    
    Returns:
    true if the row is selected.
  - getGridRowByRowNumber
```
public GridRow getGridRowByRowNumber(int row)
```
    Gets a grid row by a row number in the displayed page.
    
    Parameters:
    row - is a row number.
    
    Returns:
    a grid row of the data model.
  - selectRows
```
public void selectRows(int toRow)
```
    This method selects the rows between the currently selected row and the specified one including both of them into the selection.
    The method works only if the multiple rows selection mode is enabled.
    
    Parameters:
    toRow - is a right border (a row number that will the end of selection).
  - getGridPanel
```
public GridPanel getGridPanel()
```
    Getter for property 'gridPanel'.
    
    Returns:
    Value for property 'gridPanel'.
  - addSelectRowListener
```
public void addSelectRowListener(SelectRowListener selectRowListener)
```
    This method adds a selected row listener into the list.
    
    Parameters:
    selectRowListener - is a select row listener to be added.
  - removeSelectRowListener
```
public void removeSelectRowListener(SelectRowListener selectRowListener)
```
    This method removes a selected row listener from the list.
    
    Parameters:
    selectRowListener - a select row listener to be removed.
  - getRowDrawHandler
```
public GridRowDrawCallbackHandler getRowDrawHandler()
```
    This method returns a row draw handler instance.
    
    Returns:
    a link to the handler.
  - setRowDrawHandler
```
public void setRowDrawHandler(GridRowDrawCallbackHandler rowDrawHandler)
```
    This method sets a row draw handler for this grid.
    
    Parameters:
    rowDrawHandler - a row draw handler instance.
  - getSelectionModel
```
public GridRowSelectDataModel getSelectionModel()
```
    Gets a selection model.
    
    Returns:
    a selection model.
  - setSelectionModel
```
public void setSelectionModel(GridRowSelectDataModel selectionModel)
```
    Sets the selection model.
    
    Parameters:
    selectionModel - is a row selection model.
  - isMultiRowModeEnabled
```
public boolean isMultiRowModeEnabled()
```
    Checks whether the multi-row selection mode enabled for this grid.
    
    Returns:
    true if this mode has been enabled.
  - setMultiRowModeEnabled
```
public void setMultiRowModeEnabled(boolean multiRowModeEnabled)
```
    Enables or disbales the multi-row selection mode.
    
    Parameters:
    multiRowModeEnabled - true means that this grid will allow multiple row selection.
  - display
```
public void display()
```
    Deprecated. don't use this method anymore since it does nothing
    
    Use this method to displayActive the grid.
    
    Specified by:
    
    display in interface AdvancedWidget
  - addGridListener
```
public void addGridListener(GridListener listener)
```
    This method adds a new grid listener to be invoked on grid events.
    
    Parameters:
    listener - is a listener to add.
  - removeGridListener
```
public void removeGridListener(GridListener listener)
```
    This method removes the specified grid listener.
    
    Parameters:
    listener - is a listener to remove.
  - fireStartEdit
```
public boolean fireStartEdit(GridCell cell)
```
    This method fires the start edit event.
    
    Parameters:
    cell - is a cell to be edited.
    
    Returns:
    true if all listeners allow the edit operation.
  - fireFinishEdit
```
public boolean fireFinishEdit(GridCell cell,
                     Object newValue)
```
    This method fires the end edit event.
    
    Parameters:
    cell - is a cell to be edited.
    newValue - is a new value to be applied.
    
    Returns:
    true if all listeners allow finishing edit.
  - getSortColumn
```
public int getSortColumn()
```
    This method returns a sort column number.
    
    Returns:
    is a sort column number.
  - setSortColumn
```
public void setSortColumn(int column)
```
    This method sets the sort column and redisplays the grid.
    Don't use this method if you are going to do other actions before grid redisplaying. Use model methods instead.
    
    Parameters:
    column - is a column to be sorted.
  - setAscending
```
public void setAscending(boolean ascending)
```
    This method sets the order of sorting and redisplays the grid.
    Don't use this method if you are going to do other actions before grid redisplaying. Use model methods instead.
    
    Parameters:
    ascending - is the order of sorting. true means ascending.
  - fireSort
```
public void fireSort(HeaderCell header)
```
    This method fires the sort event
    
    Parameters:
    header - is a header cell of the sortable column.
  - getModel
```
public T getModel()
```
    Getter for property 'model'.
    
    Returns:
    Value for property 'model'.
  - getGridRenderer
```
public GridRenderer getGridRenderer()
```
    Getter for property 'gridRenderer'.
    
    Returns:
    Value for property 'gridRenderer'.
  - setGridRenderer
```
public void setGridRenderer(GridRenderer gridRenderer)
```
    Setter for property 'gridRenderer'.
    
    Parameters:
    gridRenderer - Value to set for property 'gridRenderer'.
  - getWidget
```
public com.google.gwt.user.client.ui.Widget getWidget(int row,
                                             int column)
```
    Overrides the super method to emulate grid cell presence.
    
    Overrides:
    
    getWidget in class SimpleGrid
    
    Parameters:
    row - is a row number.
    column - is a column number.
    
    Returns:
    a grid cell widget.
  - getDefaultSelectedRow
```
public int getDefaultSelectedRow()
```
    Getter for property 'defaultSelectedRow'.
    
    Returns:
    Value for property 'defaultSelectedRow'.
  - setDefaultSelectedRow
```
public void setDefaultSelectedRow(int defaultSelectedRow)
```
    Setter for property 'defaultSelectedRow'.
    
    Parameters:
    defaultSelectedRow - Value to set for property 'defaultSelectedRow'.
  - getGridRow
```
public GridRow getGridRow(int index)
```
    Gets a grid row specified by the index.
    
    Parameters:
    index - is a number of the row in the data model.
    
    Returns:
    a grid row instance.
  - getGridRows
```
public GridRow[] getGridRows()
```
    Gets a list of grid rows currently loaded into the model.
    
    Returns:
    a list of grid rows.
  - getGridColumn
```
public GridColumn getGridColumn(int index)
```
    Gets a grid row column specified by the index.
    
    Parameters:
    index - is a column number.
    
    Returns:
    a grid column instance.
  - getGridColumn
```
public GridColumn getGridColumn(String name)
```
    This method gets a grid column by its name.
    
    Parameters:
    name - is a name of the column.
    
    Returns:
    a link to grid column model.
  - getGridColumns
```
public GridColumn[] getGridColumns()
```
    gets a list of grid columns currently exisiting in the model (including invisible ones).
    
    Returns:
    a list of grid columns.
  - getModelColumn
```
public int getModelColumn(int column)
```
    This method returns a column number taking into account invisible columns.
    
    Parameters:
    column - is a column number of the grid.
    
    Returns:
    a column number in the data model.
  - getColumnByModelColumn
```
public int getColumnByModelColumn(int modelColumn)
```
    Gets a grid column number by a model column index.
    
    Parameters:
    modelColumn - is a model column index.
    
    Returns:
    a grid column number.
  - getOriginalWidget
```
protected com.google.gwt.user.client.ui.Widget getOriginalWidget(int row,
                                                     int column)
```
    Invokes the getWidget() method of the FlexTable.
    
    Parameters:
    row - is a row number.
    column - is a column number.
    
    Returns:
    an original widget.
  - runDecorators
```
protected void runDecorators()
```
    This method runs all attached decorators in the same order they have been added.
  - addRow
```
protected void addRow(int row,
          Object[] data)
```
    This method adds the row into the grid.
    
    Parameters:
    row - is a row number.
    data - is a row data set.
  - refreshAll
```
protected void refreshAll()
```
    This method refreshes all the content and headers.
    If the data model is not set it does nothing.
  - isLocked
```
protected boolean isLocked()
```
    Getter for property 'locked'.
    
    Returns:
    Value for property 'locked'.
  - setLocked
```
protected void setLocked(boolean locked)
```
    Setter for property 'locked'.
    
    Parameters:
    locked - Value to set for property 'locked'.
  - getCurrentColumn
```
public int getCurrentColumn()
```
    Getter for property 'currentColumn'.
    
    Returns:
    Value for property 'currentColumn'.
  - setFocus
```
public void setFocus(boolean focus)
```
    This method sets focus to the grid.
    
    Parameters:
    focus - is a focus value.
  - setCurrentCell
```
public void setCurrentCell(int row,
                  int column)
```
    Sets a current column number and activates the cell that belong to this column and the current row.
    
    Parameters:
    row - Value to set for property 'currentRow'.
    column - Value to set for property 'currentColumn'.
  - updateModel
```
protected void updateModel(GridCell cell,
               Object newValue)
```
    This method updates the model with the new value of the cell on finish edit event.
    
    Parameters:
    cell - is a cell that produced the event.
    newValue - is a new value of the cell.
  - dropSelection
```
protected void dropSelection()
```
    This method drops cell selection.
  - getEditCellListeners
```
protected List<EditCellListener> getEditCellListeners()
```
    Getter for property 'editCellListeners'.
    
    Returns:
    Value for property 'editCellListeners'.
  - getReadOnlyColumns
```
protected Map<Integer,Boolean> getReadOnlyColumns()
```
    Getter for property 'readOnlyColumns'.
    
    Returns:
    Value for property 'readOnlyColumns'.
  - getSortableHeaders
```
protected Map<Integer,Boolean> getSortableHeaders()
```
    Getter for property 'sortableHeaders'.
    
    Returns:
    Value for property 'sortableHeaders'.
  - isClientSortEnabled
```
protected boolean isClientSortEnabled()
```
    This method checks whether client sorting is enabled.
    
    Returns:
    true if sorting is enabled.
  - getCurrentSortColumn
```
public HeaderCell getCurrentSortColumn()
```
    Getter for property 'currentSortColumn'.
    
    Returns:
    Value for property 'currentSortColumn'.
  - getHeaderCell
```
public HeaderCell getHeaderCell(int column)
```
    This method returns a header cell widget.
    
    Parameters:
    column - is a column number.
    
    Returns:
    a header cell widget associated with this column.
  - addRow
```
public void addRow()
```
    This method adds a new empty row into the grid.
    Grid cells must provide correct results to allow the grid to support this feature.
  - drawRow
```
protected void drawRow(EditableModelEvent event)
```
    This method adds a new row into the grid end of the current page if the model row has been added.
    
    Parameters:
    event - is a model event containing a row number value.
  - drawCell
```
protected void drawCell(EditableModelEvent event)
```
    This method draws a concrete cell.
    If the cell has already been drawn the method renders it again.
    
    Parameters:
    event - is an event on which cell must be drawn.
  - removeRow
```
protected void removeRow()
```
    This method removes the currently selected row or several rows if the multi row selection mode enabled.
  - deleteRow
```
protected void deleteRow(EditableModelEvent event)
```
    Removes the grid row finding it by the model row number that was deleted.
    
    Parameters:
    event - is a model event containing a row number value.
  - synchronizeView
```
protected void synchronizeView(EditableModelEvent event)
```
    This method draws a content on the specified model event.
    
    Parameters:
    event - is a model event.
  - synchronizeDataModel
```
protected void synchronizeDataModel()
```
    This method invokes the data model handler to synchronize the model and persistence storage or redraws content if the model is not lazily loadable.
  - removeContent
```
protected void removeContent()
```
    This method removes all content from the grid.
  - getModelRow
```
public int getModelRow(int gridRow)
```
    This metod calculates a row number in the model.
    
    Parameters:
    gridRow - is a grid row.
    
    Returns:
    a model row.
  - getRowByModelRow
```
public int getRowByModelRow(EditableModelEvent event)
```
    Gets a grid row number on the displayed page by a model row number.
    
    Parameters:
    event - is a model event containing a row number value.
    
    Returns:
    a grid row number.
  - getCellComparator
```
protected Comparator<Object> getCellComparator()
```
    This method returns a cell comparator.
    
    Returns:
    a cell comparator.
  - drawContent
```
protected void drawContent()
```
    This method draws a content of the grid.
  - fireBeforeDrawEvent
```
protected boolean fireBeforeDrawEvent(int row,
                          int pageSize,
                          Object[] data)
```
    This method fires row drawing event before the row is drawn.
    
    Parameters:
    row - is a row number.
    pageSize - is a page size.
    data - is row data.
    
    Returns:
    true if the row must be drawn.
  - fireAfterDrawEvent
```
protected boolean fireAfterDrawEvent(int row,
                         int pageSize,
                         Object[] data)
```
    This method fires row drawing event after the row is drawn.
    
    Parameters:
    row - is a row number.
    pageSize - is a page size.
    data - is row data.
    
    Returns:
    true if drawing must be continued.
  - drawHeaders
```
protected void drawHeaders()
```
    This method draws header cells.
  - sortOnClient
```
protected void sortOnClient()
```
    This method performs client sorting.
  - detectCurrentSortColumn
```
protected void detectCurrentSortColumn()
```
    This method looks for the sort column in the header list.
    The method is invoked by the drawHeaders().
  - hasActiveCell
```
protected boolean hasActiveCell()
```
    Checks whether the grid has an activated cell.
    
    Returns:
    a result of check.
  - getActiveCell
```
protected GridCell getActiveCell()
```
    Gets a cell that is active, i.e. a cell that is chosen by a user to edit data.
    
    Returns:
    a grid cell that is currently active.
  - activateCell
```
public void activateCell(int row,
                int column,
                boolean active)
```
    This method activates / passivate the specified cell.
    
    Parameters:
    row - is a row of the cell.
    column - is a column of the cell.
    active - is an activation flag.
  - addListeners
```
protected void addListeners()
```
    This method adds grid specific listeners into the current widget.
    You can override the method in your extensions.
  - increaseRowNumbers
```
protected void increaseRowNumbers(int startRow,
                      int step)
```
    This method increases row numbers in the cells.
    
    Parameters:
    startRow - is a start row number.
    step - is an increase step.
  - getInvisibleColumns
```
protected List<Integer> getInvisibleColumns()
```
    Getter for property 'invisibleColumns'.
    
    Returns:
    Value for property 'invisibleColumns'.
  - getDecorators
```
protected List<GridDecorator> getDecorators()
```
    Getter for property 'decorators'.
    
    Returns:
    Value for property 'decorators'.
  - setGridPanel
```
protected void setGridPanel(GridPanel gridPanel)
```
    Setter for property 'gridPanel'.
    
    Parameters:
    gridPanel - Value to set for property 'gridPanel'.
  - getSelectRowListeners
```
protected List<SelectRowListener> getSelectRowListeners()
```
    This method retuns a list of select row listeners.
    
    Returns:
    a list of the listeners.
  - getBodyElement
```
protected com.google.gwt.user.client.Element getBodyElement()
```
    Overrides this method to make it accessible for this package and server side renderers.
    
    Overrides:
    
    getBodyElement in class AdvancedFlexTable
    
    Returns:
    a body element.

Class EditableGrid<T extends Editable>

Nested Class Summary

Nested classes/interfaces inherited from class org.gwt.advanced.client.ui.widget.SimpleGrid

Nested classes/interfaces inherited from class org.gwt.advanced.client.ui.widget.AdvancedFlexTable

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.FlexTable

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.HTMLTable

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

Constructor Summary

Method Summary

Methods inherited from class org.gwt.advanced.client.ui.widget.SimpleGrid

Methods inherited from class org.gwt.advanced.client.ui.widget.AdvancedFlexTable

Methods inherited from class com.google.gwt.user.client.ui.HTMLTable

Methods inherited from class com.google.gwt.user.client.ui.Panel

Methods inherited from class com.google.gwt.user.client.ui.Widget

Methods inherited from class com.google.gwt.user.client.ui.UIObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

Constructor Detail

EditableGrid

EditableGrid

Method Detail

getGridCellFactory

getColumnWidgetClasses

getHeaders

setGridCellfactory

setModel

setCellComparator

addEditCellListener

removeEditCellListener

addInvisibleColumn

removeColumn

removeInvisibleColumn

drawColumn

addGridDecorator

removeGridDecorator

isReadOnly

isSortable

isAscending

isSorted

setReadOnly

setSortable

isVisible

getCurrentRow

getCurrentGridRow

getCurrentRows

getCurrentGridRows

setCurrentRow

selectRow

deselectCell

isSelected

getGridRowByRowNumber

selectRows

getGridPanel

addSelectRowListener

removeSelectRowListener

getRowDrawHandler

setRowDrawHandler

getSelectionModel

setSelectionModel

isMultiRowModeEnabled

setMultiRowModeEnabled

display

addGridListener

removeGridListener

fireStartEdit

fireFinishEdit

getSortColumn

setSortColumn

setAscending

fireSort

getModel

getGridRenderer

setGridRenderer

getWidget

getDefaultSelectedRow

setDefaultSelectedRow

getGridRow