The
GridDecorator
interface is implemented by classes that wish to augment the functionality
provided by the core grid implementation. Grid decorators are not only able to modify the HTML rendered by
the grid, including adding any event listeners they may wish to add, but are also able to register
themselves as listeners on the module:caplin/grid/GridRowModel
, the
module:caplin/grid/GridRowSelectionModel
, the
module:caplin/grid/GridColumnModel
and/or the module:caplin/grid/GridView
itself —
the module:caplin/component/ComponentLifecycleEvents
events are forwarded on by the
module:caplin/grid/GridView
to any interested decorators.- Implementations:
- module:caplin/grid/decorator/ColumnHeaderMenuDecorator
- module:caplin/grid/decorator/ColumnMenuDecorator
- module:caplin/grid/decorator/ColumnReorderingDecorator
- module:caplin/grid/decorator/ColumnResizingDecorator
- module:caplin/grid/decorator/ColumnSortDecorator
- module:caplin/grid/decorator/ContainerExportDecorator
- module:caplin/grid/decorator/DragDecorator
- module:caplin/grid/decorator/DropDecorator
- module:caplin/grid/decorator/GroupHeaderDecorator
- module:caplin/grid/decorator/HoverDecorator
- module:caplin/grid/decorator/LoadingDataDecorator
- module:caplin/grid/decorator/NoDataFoundBubbleMessageDecorator
- module:caplin/grid/decorator/RemoveRowDecorator
- module:caplin/grid/decorator/ResetColumnsDecorator
- module:caplin/grid/decorator/RowLoadingDecorator
- module:caplin/grid/decorator/ScrollTipDecorator
- module:caplin/grid/decorator/SelectionDecorator
- module:caplin/grid/decorator/StatusDecorator
- module:caplin/grid/decorator/SubjectDecorator
- module:caplin/grid/refine/RefinerSummaryDecorator
Methods
-
setGridView(oGridView)
-
The opportunity for the decorator to add itself as a listener to the
module:caplin/grid/GridRowModel
, themodule:caplin/grid/GridRowSelectionModel
, themodule:caplin/grid/GridColumnModel
and/or themodule:caplin/grid/GridView
itself.At the point at which this method is called, the HTML for the grid will not yet be rendered. Decorators that need to augment the HTML as soon as it is first rendered must register themselves as a listener on the
module:caplin/grid/GridView
, and wait for themodule:caplin/grid/GridViewListener#onContainerHtmlRendered
event to be fired.Parameters:
Name Type Description oGridView
module:caplin/grid/GridView The grid view to which this decorator is being attached. - Implementations:
- module:caplin/grid/decorator/ColumnHeaderMenuDecorator#setGridView
- module:caplin/grid/decorator/ColumnReorderingDecorator#setGridView
- module:caplin/grid/decorator/ColumnResizingDecorator#setGridView
- module:caplin/grid/decorator/ColumnSortDecorator#setGridView
- module:caplin/grid/decorator/ContainerExportDecorator#setGridView
- module:caplin/grid/decorator/DragDecorator#setGridView
- module:caplin/grid/decorator/DropDecorator#setGridView
- module:caplin/grid/decorator/GroupHeaderDecorator#setGridView
- module:caplin/grid/decorator/HoverDecorator#setGridView
- module:caplin/grid/decorator/LoadingDataDecorator#setGridView
- module:caplin/grid/decorator/NoDataFoundBubbleMessageDecorator#setGridView
- module:caplin/grid/decorator/RemoveRowDecorator#setGridView
- module:caplin/grid/decorator/ResetColumnsDecorator#setGridView
- module:caplin/grid/decorator/RowLoadingDecorator#setGridView
- module:caplin/grid/decorator/ScrollTipDecorator#setGridView
- module:caplin/grid/decorator/SelectionDecorator#setGridView
- module:caplin/grid/decorator/StatusDecorator#setGridView
- module:caplin/grid/decorator/SubjectDecorator#setGridView
- module:caplin/grid/refine/RefinerSummaryDecorator#setGridView