Grid (GXT 4.0.4)

java.lang.Object
- Widget
- - com.sencha.gxt.widget.core.client.Component
  - - com.sencha.gxt.widget.core.client.grid.Grid<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, BodyScrollEvent.HasBodyScrollHandlers, CellClickEvent.HasCellClickHandlers, CellDoubleClickEvent.HasCellDoubleClickHandlers, CellMouseDownEvent.HasCellMouseDownHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HeaderClickEvent.HasHeaderClickHandlers, HeaderContextMenuEvent.HasHeaderContextMenuHandlers, HeaderDoubleClickEvent.HasHeaderDoubleClickHandlers, HeaderMouseDownEvent.HasHeaderMouseDownHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ReconfigureEvent.HasReconfigureHandlers, RefreshEvent.HasRefreshHandlers, RowClickEvent.HasRowClickHandlers, RowDoubleClickEvent.HasRowDoubleClickHandlers, RowMouseDownEvent.HasRowMouseDownHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, SortChangeEvent.HasSortChangeHandlers, ViewReadyEvent.HasViewReadyHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

TreeGrid
```
public class Grid<M>
extends Component
implements ViewReadyEvent.HasViewReadyHandlers, SortChangeEvent.HasSortChangeHandlers, RowClickEvent.HasRowClickHandlers, RowDoubleClickEvent.HasRowDoubleClickHandlers, RowMouseDownEvent.HasRowMouseDownHandlers, CellClickEvent.HasCellClickHandlers, CellDoubleClickEvent.HasCellDoubleClickHandlers, CellMouseDownEvent.HasCellMouseDownHandlers, HeaderClickEvent.HasHeaderClickHandlers, HeaderDoubleClickEvent.HasHeaderDoubleClickHandlers, HeaderContextMenuEvent.HasHeaderContextMenuHandlers, HeaderMouseDownEvent.HasHeaderMouseDownHandlers, RefreshEvent.HasRefreshHandlers, ReconfigureEvent.HasReconfigureHandlers, BodyScrollEvent.HasBodyScrollHandlers
```
A Grid provides support for displaying and editing two-dimensional tables of cells. The grid gets its data from a ListStore and its column definitions from a ColumnModel. Each model in the store is rendered as a row in the grid. The fields in the model provide the data for each column in the row. Any updates to the store are automatically pushed to the grid. This includes inserting, removing, sorting and filtering.

In GXT version 3, ModelKeyProviders and ValueProviders provide the interface between your data model and the list store and ColumnConfig classes. This enables a grid to work with data of any object type.

You can provide your own implementation of these interfaces, or you can use a Sencha supplied generator to create them for you automatically. A generator runs at compile time to create a Java class that is compiled to JavaScript. The Sencha supplied generator can create classes for interfaces that extend the PropertyAccess interface. The generator transparently creates the class at compile time and the GWT#create(Class) method returns an instance of that class at run time. The generated class is managed by GWT and GXT and you generally do not need to worry about what the class is called, where it is located, or other similar details.

Each grid has a GridView. The grid view provides many options for customizing the grid's appearance (e.g. striping, mouse-over tracking, empty text). To set these options, get the current grid view using getView() and then set the desired option on the grid view.

To customize the appearance of a column in a grid, provide a cell implementation using ColumnConfig#setCell(Cell).

Grids support several ways to manage column widths:
1. The most basic approach is to simply give pixel widths to each column. Columns widths will match the specified values.
2. A column can be identified as an auto-expand column. As the width of the grid changes, or columns are resized, the specified column's width is adjusted so that the column fills the available width with no horizontal scrolling. See GridView.setAutoExpandColumn(ColumnConfig).
3. The grid can resize columns based on relative weights, determined by the pixel width assigned to each column. As the width of the grid or columns change, the weight is used to allocate the available space. Use GridView.setAutoFill(boolean) or GridView.setForceFit(boolean) to enable this feature:
  - With auto fill, the calculations are run when the grid is created (or reconfigured). After the grid is rendered, the column widths will not be adjusted when the available width changes.
  - With force fit the width calculations are run every time there are changes to the available width or column sizes.
4. To prevent a column from participating in auto fill or force fit, use ColumnConfig.setFixed(boolean).
The following code snippet illustrates the creation of a simple grid with local data for test purposes. For more practical examples that show how to load data from remote sources, see the Json Grid, Live Grid, Paging Grid, RequestFactory Grid and Xml Grid examples in the online Explorer demo.
```
 // Create an instance of the generated key and value providers for the Data class 
 DataProperties dp = GWT.create(DataProperties.class);

 // Create the configurations for each column in the grid
 List<ColumnConfig<Data, ?>> ccs = new LinkedList<ColumnConfig<Data, ?>>();
 ccs.add(new ColumnConfig<Data, String>(dp.name(), 200, "Name"));
 ccs.add(new ColumnConfig<Data, String>(dp.value(), 200, "Value"));
 ColumnModel<Data> cm = new ColumnModel<Test.Data>(ccs);

 // Create the store that the contains the data to display in the grid 
 ListStore<Data> s = new ListStore<Test.Data>(dp.key());
 s.add(new Data("name1", "value1"));
 s.add(new Data("name2", "value2"));
 s.add(new Data("name3", "value3"));
 s.add(new Data("name4", "value4"));

 // Create the grid using the store and column configurations 
 Grid<Data> g = new Grid<Data>(s, cm);

 // Add the grid to a container 
 RootPanel.get().add(g);
 
```
To use the Sencha supplied generator to create model key providers and value providers, extend the PropertyAccess interface, parameterized with the type of data you want to access (as shown below) and invoke the GWT.create method on its class member (as shown in the code snippet above). This creates an instance of the class that can be used to initialize the column configuration and list store. In the following code snippet we define a new interface called DataProperties that extends the PropertyAccess interface and is parameterized with Data, a Plain Old Java Object (POJO).
```
 public interface DataProperties extends PropertyAccess<Data> {
   @Path("name")
   ModelKeyProvider<Data> key();
   ValueProvider<Data, String> name();
   ValueProvider<Data, String> value();
 }

 public class Data {
   protected String name;
   protected String value;

   public Data(String name, String value) {
     super();
     this.name = name;
     this.value = value;
   }
   public String getName() {
     return name;
   }
   public String getValue() {
     return value;
   }
   public void setName(String name) {
     this.name = name;
   }
   public void setValue(String value) {
     this.value = value;
   }
 }
 
```
To enable drag and drop for a grid, add the following:
```
 new GridDragSource<Data>(g);
 GridDropTarget<Data> dt = new GridDropTarget<Data>(g);
 dt.setFeedback(Feedback.BOTH);
 
```
To add reordering support to the drag and drop, include:
```
 dt.setAllowSelfAsSource(true);
 
```
See Also:

ListStore, ColumnModel, ColumnConfig, GridView, GridDragSource, GridDropTarget, GridInlineEditing, CellSelectionModel

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Grid.Callback` Provides a mechanism by which other components can report whether a cell is selectable.
`static class`	`Grid.GridCell` A reference to a cell in the grid that can be used for a variety of purposes, including, for example, whether it is active or selected.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ColumnModel<M>`	`cm` The current column model for this grid.
`protected boolean`	`enableColumnReorder`
`protected boolean`	`enableColumnResize`
`protected boolean`	`hideHeaders`
`protected int`	`lazyRowRender`
`protected ListLoader<?,?>`	`loader`
`protected HandlerRegistration`	`loaderRegistration`
`protected LoaderHandler<ListLoadConfig,ListLoadResult<?>>`	`loadHandler`
`protected boolean`	`loadMask`
`protected GridSelectionModel<M>`	`sm` The current selection model for this grid.
`protected ListStore<M>`	`store` The current store for this grid.
`protected GridView<M>`	`view` The current view for this grid.
`protected boolean`	`viewReady` The current view for this grid.

Fields inherited from class com.sencha.gxt.widget.core.client.Component
adjustSize, allowTextSelection, cacheSizes, contextMenu, contextMenuGestureRecognizer, dataMap, deferHeight, disableContextMenu, disabled, disabledStyle, disableEvents, ensureVisibilityOnSizing, focusManagerSupport, gestureRecognizers, height, hidden, hideMode, itemId, lastSize, layer, left, mask, maskMessage, monitorWindowResize, overElements, pageX, pageY, resizeHandler, shadow, shadowPosition, shim, stateful, stateId, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Grid()` Creates a grid to be initialized by derived classes.
	`Grid(ListStore<M> store, ColumnModel<M> cm)` Creates a new grid with the given data store and column model.
	`Grid(ListStore<M> store, ColumnModel<M> cm, GridView<M> view)` Creates a new grid with the given data store and column model.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addBodyScrollHandler(BodyScrollEvent.BodyScrollHandler handler)`
`HandlerRegistration`	`addCellClickHandler(CellClickEvent.CellClickHandler handler)`
`HandlerRegistration`	`addCellDoubleClickHandler(CellDoubleClickEvent.CellDoubleClickHandler handler)`
`HandlerRegistration`	`addCellMouseDownHandler(CellMouseDownEvent.CellMouseDownHandler handler)`
`HandlerRegistration`	`addCellMouseUpHandler(CellMouseUpEvent.CellMouseUpHandler handler)` Add cell mouse up handler.
`HandlerRegistration`	`addCellTapHandler(CellTapEvent.CellTapHandler handler)` Add a cell tap handler.
`HandlerRegistration`	`addHeaderClickHandler(HeaderClickEvent.HeaderClickHandler handler)`
`HandlerRegistration`	`addHeaderContextMenuHandler(HeaderContextMenuEvent.HeaderContextMenuHandler handler)`
`HandlerRegistration`	`addHeaderDoubleClickHandler(HeaderDoubleClickEvent.HeaderDoubleClickHandler handler)`
`HandlerRegistration`	`addHeaderMouseDownHandler(HeaderMouseDownEvent.HeaderMouseDownHandler handler)`
`HandlerRegistration`	`addReconfigureHandler(ReconfigureEvent.ReconfigureHandler handler)`
`HandlerRegistration`	`addRefreshHandler(RefreshEvent.RefreshHandler handler)` Adds a `RefreshEvent.RefreshHandler` handler for `RefreshEvent` events.
`HandlerRegistration`	`addRowClickHandler(RowClickEvent.RowClickHandler handler)`
`HandlerRegistration`	`addRowDoubleClickHandler(RowDoubleClickEvent.RowDoubleClickHandler handler)`
`HandlerRegistration`	`addRowMouseDownHandler(RowMouseDownEvent.RowMouseDownHandler handler)`
`HandlerRegistration`	`addRowMouseUpHandler(RowMouseUpEvent.RowMouseUpHandler handler)` Add row mouse up handler.
`HandlerRegistration`	`addRowTapHandler(RowTapEvent.RowTapHandler handler)` Add a row tap handler.
`HandlerRegistration`	`addSortChangeHandler(SortChangeEvent.SortChangeHandler handler)`
`HandlerRegistration`	`addViewReadyHandler(ViewReadyEvent.ViewReadyHandler handler)`
`protected void`	`afterRenderView()` Invoked after the view element is first attached, performs the final steps before the grid is completely initialized.
`protected boolean`	`cellConsumesEventType(<any> cell, String eventType)` Returns true if the given cell consumes the given event.
`protected void`	`doAttachChildren()`
`protected void`	`doDetachChildren()`
`protected <N> <any>`	`fireEventToCell(Event event, String eventType, Element cellParent, M m, Context context, ColumnConfig<M,N> column)` Fires an event to the cell specified by the given record data model and column.
`void`	`focus()` Try to focus this widget.
`ColumnModel<M>`	`getColumnModel()` Returns the column model.
`int`	`getLazyRowRender()` Returns the time in ms after the rows get rendered.
`ListLoader<?,?>`	`getLoader()` Returns the loader.
`GridSelectionModel<M>`	`getSelectionModel()` Returns the grid's selection model.
`ListStore<M>`	`getStore()` Returns the grid's store.
`GridView<M>`	`getView()` Returns the grid's view.
`protected <any>`	`handleEventForCell(Event event)` Inspects the given event and fires it to a cell if possible.
`boolean`	`isColumnReordering()` Returns true if column reordering is enabled.
`boolean`	`isColumnResize()` Returns true if column resizing is enabled.
`boolean`	`isHideHeaders()` Returns true if the header is hidden.
`boolean`	`isLoadMask()` Returns true if the load mask in enabled.
`boolean`	`isViewReady()` Returns true if the view is ready.
`protected void`	`notifyHide()`
`protected void`	`notifyShow()`
`protected void`	`onAfterFirstAttach()` Called immediately after the first time the widget becomes attached to the browser's document only the first time.
`protected void`	`onAfterRenderView()` Invoked after the view has been rendered, may be overridden to perform any activities that require a rendered view.
`protected void`	`onAttach()`
`void`	`onBrowserEvent(Event event)`
`protected void`	`onClick(Event e)` Handles the browser click event.
`protected void`	`onDisable()`
`protected void`	`onDoubleClick(Event e)` Handles the browser double click event.
`protected void`	`onEnable()`
`protected void`	`onFocus(Event event)`
`protected void`	`onGestureCancel(List<TouchData> touches)`
`protected void`	`onGestureEnd(List<TouchData> touches)`
`protected void`	`onGestureLongPress(TouchData touchData)`
`protected void`	`onGestureStart(TouchData startedTouch)`
`protected void`	`onGestureTap(TouchData touchData)`
`protected void`	`onLoaderBeforeLoad()` Invoked before the loader loads new data, displays the Loading...
`protected void`	`onLoaderLoadException()` Invoked if the loader encounters an exception, cancels the Loading...
`protected void`	`onLoadLoader()` Invoked after the loader loads new data, cancels the Loading...
`protected void`	`onMouseDown(Event event)` Handles the browser mouse down event.
`protected void`	`onMouseUp(Event event)` Handles the browser mouse up event.
`protected void`	`onResize(int width, int height)` Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
`void`	`reconfigure(ListStore<M> store, ColumnModel<M> cm)` Reconfigures the grid to use a different Store and Column Model.
`void`	`setAllowTextSelection(boolean enable)` Enables and disables text selection for the widget.
`void`	`setColumnReordering(boolean enableColumnReorder)` True to enable column reordering via drag and drop (defaults to false).
`void`	`setColumnResize(boolean enableColumnResize)` Sets whether columns may be resized (defaults to true).
`void`	`setHideHeaders(boolean hideHeaders)` Sets whether the header should be hidden (defaults to false).
`void`	`setLazyRowRender(int lazyRowRender)` Sets the time in ms after the row gets rendered (defaults to 10).
`void`	`setLoader(ListLoader<?,?> loader)` Sets the loader.
`void`	`setLoadMask(boolean loadMask)` Sets whether a load mask should be displayed during load operations (defaults to false).
`void`	`setSelectionModel(GridSelectionModel<M> sm)` Sets the grid selection model.
`void`	`setView(GridView<M> view)` Sets the grid's view.
`protected void`	`sinkCellEvents()` Sinks all the events consumed by the cells in the column configs.
`Grid.GridCell`	`walkCells(int row, int col, int step, Grid.Callback callback)` Navigate in the requested direction to the next selectable cell, given the row, column and step.

Methods inherited from class com.sencha.gxt.widget.core.client.Component
addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAdjustSize, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, makeVisible, mask, mask, onBlur, onDetach, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeGestureRecognizer, removeStyleDependentName, removeStyleOnOver, removeToolTip, restoreVisible, setAdjustSize, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

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

- Field Detail
  - cm
```
protected ColumnModel<M> cm
```
    The current column model for this grid. Should be considered read-only in derived classes unless the class is tightly integrated with the grid's construction and reconfiguration process.
  - sm
```
protected GridSelectionModel<M> sm
```
    The current selection model for this grid. Should be considered read-only in derived classes unless the class is tightly integrated with the grid's construction and reconfiguration process.
  - store
```
protected ListStore<M> store
```
    The current store for this grid. Should be considered read-only in derived classes unless the class is tightly integrated with the grid's construction and reconfiguration process.
  - view
```
protected GridView<M> view
```
    The current view for this grid. Should be considered read-only in derived classes unless the class is tightly integrated with the grid's construction and reconfiguration process.
  - viewReady
```
protected boolean viewReady
```
    The current view for this grid. Should be considered read-only in derived classes.
  - loader
```
protected ListLoader<?,?> loader
```
  - enableColumnReorder
```
protected boolean enableColumnReorder
```
  - enableColumnResize
```
protected boolean enableColumnResize
```
  - hideHeaders
```
protected boolean hideHeaders
```
  - lazyRowRender
```
protected int lazyRowRender
```
  - loaderRegistration
```
protected HandlerRegistration loaderRegistration
```
  - loadHandler
```
protected LoaderHandler<ListLoadConfig,ListLoadResult<?>> loadHandler
```
  - loadMask
```
protected boolean loadMask
```
- Constructor Detail
  - Grid
```
public Grid(ListStore<M> store,
            ColumnModel<M> cm)
```
    Creates a new grid with the given data store and column model.
    
    Parameters:
    
    store - the data store
    
    cm - the column model
  - Grid
```
public Grid(ListStore<M> store,
            ColumnModel<M> cm,
            GridView<M> view)
```
    Creates a new grid with the given data store and column model.
    
    Parameters:
    
    store - the data store
    
    cm - the column model
    
    view - the grid view
  - Grid
```
protected Grid()
```
    Creates a grid to be initialized by derived classes.
- Method Detail
  - addBodyScrollHandler
```
public HandlerRegistration addBodyScrollHandler(BodyScrollEvent.BodyScrollHandler handler)
```
    Specified by:
    
    addBodyScrollHandler in interface BodyScrollEvent.HasBodyScrollHandlers
  - addCellClickHandler
```
public HandlerRegistration addCellClickHandler(CellClickEvent.CellClickHandler handler)
```
    Specified by:
    
    addCellClickHandler in interface CellClickEvent.HasCellClickHandlers
  - addCellDoubleClickHandler
```
public HandlerRegistration addCellDoubleClickHandler(CellDoubleClickEvent.CellDoubleClickHandler handler)
```
    Specified by:
    
    addCellDoubleClickHandler in interface CellDoubleClickEvent.HasCellDoubleClickHandlers
  - addCellMouseDownHandler
```
public HandlerRegistration addCellMouseDownHandler(CellMouseDownEvent.CellMouseDownHandler handler)
```
    Specified by:
    
    addCellMouseDownHandler in interface CellMouseDownEvent.HasCellMouseDownHandlers
  - addHeaderClickHandler
```
public HandlerRegistration addHeaderClickHandler(HeaderClickEvent.HeaderClickHandler handler)
```
    Specified by:
    
    addHeaderClickHandler in interface HeaderClickEvent.HasHeaderClickHandlers
  - addHeaderContextMenuHandler
```
public HandlerRegistration addHeaderContextMenuHandler(HeaderContextMenuEvent.HeaderContextMenuHandler handler)
```
    Specified by:
    
    addHeaderContextMenuHandler in interface HeaderContextMenuEvent.HasHeaderContextMenuHandlers
  - addHeaderDoubleClickHandler
```
public HandlerRegistration addHeaderDoubleClickHandler(HeaderDoubleClickEvent.HeaderDoubleClickHandler handler)
```
    Specified by:
    
    addHeaderDoubleClickHandler in interface HeaderDoubleClickEvent.HasHeaderDoubleClickHandlers
  - addHeaderMouseDownHandler
```
public HandlerRegistration addHeaderMouseDownHandler(HeaderMouseDownEvent.HeaderMouseDownHandler handler)
```
    Specified by:
    
    addHeaderMouseDownHandler in interface HeaderMouseDownEvent.HasHeaderMouseDownHandlers
  - addReconfigureHandler
```
public HandlerRegistration addReconfigureHandler(ReconfigureEvent.ReconfigureHandler handler)
```
    Specified by:
    
    addReconfigureHandler in interface ReconfigureEvent.HasReconfigureHandlers
  - addRefreshHandler
```
public HandlerRegistration addRefreshHandler(RefreshEvent.RefreshHandler handler)
```
    Description copied from interface: RefreshEvent.HasRefreshHandlers
    
    Adds a RefreshEvent.RefreshHandler handler for RefreshEvent events.
    
    Specified by:
    
    addRefreshHandler in interface RefreshEvent.HasRefreshHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addRowClickHandler
```
public HandlerRegistration addRowClickHandler(RowClickEvent.RowClickHandler handler)
```
    Specified by:
    
    addRowClickHandler in interface RowClickEvent.HasRowClickHandlers
  - addRowDoubleClickHandler
```
public HandlerRegistration addRowDoubleClickHandler(RowDoubleClickEvent.RowDoubleClickHandler handler)
```
    Specified by:
    
    addRowDoubleClickHandler in interface RowDoubleClickEvent.HasRowDoubleClickHandlers
  - addRowMouseDownHandler
```
public HandlerRegistration addRowMouseDownHandler(RowMouseDownEvent.RowMouseDownHandler handler)
```
    Specified by:
    
    addRowMouseDownHandler in interface RowMouseDownEvent.HasRowMouseDownHandlers
  - addRowMouseUpHandler
```
public HandlerRegistration addRowMouseUpHandler(RowMouseUpEvent.RowMouseUpHandler handler)
```
    Add row mouse up handler.
    
    Parameters:
    
    handler - row mouse up handler
    
    Returns:
    
    handler registration
    
    Since:
    
    4.0.3
  - addCellMouseUpHandler
```
public HandlerRegistration addCellMouseUpHandler(CellMouseUpEvent.CellMouseUpHandler handler)
```
    Add cell mouse up handler.
    
    Parameters:
    
    handler - row mouse up handler
    
    Returns:
    
    handler registration
    
    Since:
    
    4.0.3
  - addRowTapHandler
```
public HandlerRegistration addRowTapHandler(RowTapEvent.RowTapHandler handler)
```
    Add a row tap handler.
    
    Parameters:
    
    handler - row mouse up handler
    
    Returns:
    
    handler registration
    
    Since:
    
    4.0.3
  - addCellTapHandler
```
public HandlerRegistration addCellTapHandler(CellTapEvent.CellTapHandler handler)
```
    Add a cell tap handler.
    
    Parameters:
    
    handler - row mouse up handler
    
    Returns:
    
    handler registration
    
    Since:
    
    4.0.3
  - addSortChangeHandler
```
public HandlerRegistration addSortChangeHandler(SortChangeEvent.SortChangeHandler handler)
```
    Specified by:
    
    addSortChangeHandler in interface SortChangeEvent.HasSortChangeHandlers
  - addViewReadyHandler
```
public HandlerRegistration addViewReadyHandler(ViewReadyEvent.ViewReadyHandler handler)
```
    Specified by:
    
    addViewReadyHandler in interface ViewReadyEvent.HasViewReadyHandlers
  - focus
```
public void focus()
```
    Description copied from class: Component
    
    Try to focus this widget.
    
    Overrides:
    
    focus in class Component
  - getColumnModel
```
public ColumnModel<M> getColumnModel()
```
    Returns the column model.
    
    Returns:
    
    the column model
  - getLazyRowRender
```
public int getLazyRowRender()
```
    Returns the time in ms after the rows get rendered.
    
    Returns:
    
    the lazy row rendering time
  - getLoader
```
public ListLoader<?,?> getLoader()
```
    Returns the loader.
    
    Returns:
    
    the loader
  - getSelectionModel
```
public GridSelectionModel<M> getSelectionModel()
```
    Returns the grid's selection model.
    
    Returns:
    
    the selection model
  - getStore
```
public ListStore<M> getStore()
```
    Returns the grid's store.
    
    Returns:
    
    the store
  - getView
```
public GridView<M> getView()
```
    Returns the grid's view.
    
    Returns:
    
    the grid view
  - isColumnReordering
```
public boolean isColumnReordering()
```
    Returns true if column reordering is enabled.
    
    Returns:
    
    true if enabled
  - isColumnResize
```
public boolean isColumnResize()
```
    Returns true if column resizing is enabled.
    
    Returns:
    
    true if resizing is enabled
  - isHideHeaders
```
public boolean isHideHeaders()
```
    Returns true if the header is hidden.
    
    Returns:
    
    true for hidden
  - isLoadMask
```
public boolean isLoadMask()
```
    Returns true if the load mask in enabled.
    
    Returns:
    
    the load mask state
  - isViewReady
```
public boolean isViewReady()
```
    Returns true if the view is ready.
    
    Returns:
    
    the view ready state
  - onBrowserEvent
```
public void onBrowserEvent(Event event)
```
    Overrides:
    
    onBrowserEvent in class Component
  - onFocus
```
protected void onFocus(Event event)
```
    Overrides:
    
    onFocus in class Component
  - reconfigure
```
public void reconfigure(ListStore<M> store,
                        ColumnModel<M> cm)
```
    Reconfigures the grid to use a different Store and Column Model. The View will be bound to the new objects and refreshed.
    
    Parameters:
    
    store - the new store
    
    cm - the new column model
  - setAllowTextSelection
```
public void setAllowTextSelection(boolean enable)
```
    Description copied from class: Component
    
    Enables and disables text selection for the widget.
    
    Overrides:
    
    setAllowTextSelection in class Component
    
    Parameters:
    
    enable - true to enable, false to disable
  - setColumnReordering
```
public void setColumnReordering(boolean enableColumnReorder)
```
    True to enable column reordering via drag and drop (defaults to false).
    
    Parameters:
    
    enableColumnReorder - true to enable
  - setColumnResize
```
public void setColumnResize(boolean enableColumnResize)
```
    Sets whether columns may be resized (defaults to true).
    
    Parameters:
    
    enableColumnResize - true to allow column resizing
  - setHideHeaders
```
public void setHideHeaders(boolean hideHeaders)
```
    Sets whether the header should be hidden (defaults to false).
    
    Parameters:
    
    hideHeaders - true to hide the header
  - setLazyRowRender
```
public void setLazyRowRender(int lazyRowRender)
```
    Sets the time in ms after the row gets rendered (defaults to 10). 0 means that the rows get rendered as soon as the grid gets rendered.
    
    Parameters:
    
    lazyRowRender - the time in ms after the rows get rendered.
  - setLoader
```
public void setLoader(ListLoader<?,?> loader)
```
    Sets the loader.
    
    Parameters:
    
    loader - the loader
  - setLoadMask
```
public void setLoadMask(boolean loadMask)
```
    Sets whether a load mask should be displayed during load operations (defaults to false).
    
    Parameters:
    
    loadMask - true to show a mask
  - setSelectionModel
```
public void setSelectionModel(GridSelectionModel<M> sm)
```
    Sets the grid selection model.
    
    Parameters:
    
    sm - the selection model
  - setView
```
public void setView(GridView<M> view)
```
    Sets the grid's view. May only be called before the Grid is first attached.
    
    Parameters:
    
    view - the view to use for this grid
  - walkCells
```
public Grid.GridCell walkCells(int row,
                               int col,
                               int step,
                               Grid.Callback callback)
```
    Navigate in the requested direction to the next selectable cell, given the row, column and step.
    
    Parameters:
    
    row - the starting row index
    
    col - the starting column index
    
    step - the step size and direction
    
    callback - a callback that determines whether the given cell is selectable
    
    Returns:
    
    the next cell or null if no cell matches the criteria
  - afterRenderView
```
protected void afterRenderView()
```
    Invoked after the view element is first attached, performs the final steps before the grid is completely initialized.
  - cellConsumesEventType
```
protected boolean cellConsumesEventType(<any> cell,
                                        String eventType)
```
    Returns true if the given cell consumes the given event.
    
    Parameters:
    
    cell - the cell to inspect
    
    eventType - the event
    
    Returns:
    
    true if the cell consumes the given event
  - doAttachChildren
```
protected void doAttachChildren()
```
  - doDetachChildren
```
protected void doDetachChildren()
```
  - fireEventToCell
```
protected <N> <any> fireEventToCell(Event event,
                                    String eventType,
                                    Element cellParent,
                                    M m,
                                    Context context,
                                    ColumnConfig<M,N> column)
```
    Fires an event to the cell specified by the given record data model and column.
    
    Parameters:
    
    event - the event to fire
    
    eventType - the type of event
    
    cellParent - the containing parent element
    
    m - the record data model containing the cell
    
    context - the context of the cell (row, column and key)
    
    column - the column containing the cell
  - handleEventForCell
```
protected <any> handleEventForCell(Event event)
```
    Inspects the given event and fires it to a cell if possible.
    
    Parameters:
    
    event - the event to handle
  - notifyHide
```
protected void notifyHide()
```
    Overrides:
    
    notifyHide in class Component
  - notifyShow
```
protected void notifyShow()
```
    Overrides:
    
    notifyShow in class Component
  - onAfterFirstAttach
```
protected void onAfterFirstAttach()
```
    Description copied from class: Component
    
    Called immediately after the first time the widget becomes attached to the browser's document only the first time.
    
    Overrides:
    
    onAfterFirstAttach in class Component
  - onAfterRenderView
```
protected void onAfterRenderView()
```
    Invoked after the view has been rendered, may be overridden to perform any activities that require a rendered view.
  - onAttach
```
protected void onAttach()
```
    Overrides:
    
    onAttach in class Component
  - onClick
```
protected void onClick(Event e)
```
    Handles the browser click event. Propagates the event to the cell and row if possible.
    
    Parameters:
    
    e - the click event
  - onDisable
```
protected void onDisable()
```
    Overrides:
    
    onDisable in class Component
  - onDoubleClick
```
protected void onDoubleClick(Event e)
```
    Handles the browser double click event. Propagates the event to the cell and row if possible.
    
    Parameters:
    
    e - the double click event
  - onEnable
```
protected void onEnable()
```
    Overrides:
    
    onEnable in class Component
  - onGestureStart
```
protected void onGestureStart(TouchData startedTouch)
```
    Since:
    
    4.0.3
  - onGestureEnd
```
protected void onGestureEnd(List<TouchData> touches)
```
    Since:
    
    4.0.3
  - onGestureTap
```
protected void onGestureTap(TouchData touchData)
```
    Since:
    
    4.0.3
  - onGestureCancel
```
protected void onGestureCancel(List<TouchData> touches)
```
    Since:
    
    4.0.3
  - onGestureLongPress
```
protected void onGestureLongPress(TouchData touchData)
```
    Since:
    
    4.0.3
  - onLoaderBeforeLoad
```
protected void onLoaderBeforeLoad()
```
    Invoked before the loader loads new data, displays the Loading... mask if it is enabled.
  - onLoaderLoadException
```
protected void onLoaderLoadException()
```
    Invoked if the loader encounters an exception, cancels the Loading... mask if it is enabled.
  - onLoadLoader
```
protected void onLoadLoader()
```
    Invoked after the loader loads new data, cancels the Loading... mask if it is enabled.
  - onMouseDown
```
protected void onMouseDown(Event event)
```
    Handles the browser mouse down event. Propagates the event to the cell and row if possible.
    
    Parameters:
    
    event - the mouse down event
  - onMouseUp
```
protected void onMouseUp(Event event)
```
    Handles the browser mouse up event.
    
    Parameters:
    
    event - the mouse up event
  - onResize
```
protected void onResize(int width,
                        int height)
```
    Description copied from class: Component
    
    Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
    
    Overrides:
    
    onResize in class Component
    
    Parameters:
    
    width - the width
    
    height - the height
  - sinkCellEvents
```
protected void sinkCellEvents()
```
    Sinks all the events consumed by the cells in the column configs.

Class Grid<M>

Nested Class Summary

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.Component

Constructor Summary

Method Summary

Methods inherited from class com.sencha.gxt.widget.core.client.Component

Methods inherited from class java.lang.Object

Field Detail

cm

sm

store

view

viewReady

loader

enableColumnReorder

enableColumnResize

hideHeaders

lazyRowRender

loaderRegistration

loadHandler

loadMask

Constructor Detail

Grid

Grid

Grid

Method Detail

addBodyScrollHandler

addCellClickHandler

addCellDoubleClickHandler

addCellMouseDownHandler

addHeaderClickHandler

addHeaderContextMenuHandler

addHeaderDoubleClickHandler

addHeaderMouseDownHandler

addReconfigureHandler

addRefreshHandler

addRowClickHandler

addRowDoubleClickHandler

addRowMouseDownHandler

addRowMouseUpHandler

addCellMouseUpHandler

addRowTapHandler

addCellTapHandler

addSortChangeHandler

addViewReadyHandler

focus

getColumnModel

getLazyRowRender

getLoader

getSelectionModel

getStore

getView

isColumnReordering

isColumnResize

isHideHeaders

isLoadMask

isViewReady

onBrowserEvent

onFocus

reconfigure

setAllowTextSelection

setColumnReordering

setColumnResize

setHideHeaders

setLazyRowRender

setLoader

setLoadMask

setSelectionModel

setView

walkCells

afterRenderView

cellConsumesEventType

doAttachChildren

doDetachChildren

fireEventToCell

handleEventForCell

notifyHide

notifyShow

onAfterFirstAttach