Interface
caplin.grid.decorator

GridDecorator

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 caplin.grid.GridRowModel, the caplin.grid.GridRowSelectionModel, the caplin.grid.GridColumnModel and/or the caplin.grid.GridView itself — the caplin.component.ComponentLifecycleEvents events are forwarded on by the caplin.grid.GridView to any interested decorators.

Constructor Summary

Attributes Name and Description
caplin.grid.decorator.GridDecorator()

Method Summary

Attributes Name and Description
void setGridView(caplin.grid.GridView oGridView)

The opportunity for the decorator to add itself as a listener to the caplin.grid.GridRowModel, the caplin.grid.GridRowSelectionModel, the caplin.grid.GridColumnModel and/or the caplin.grid.GridView itself.

Constructor Detail

caplin.grid.decorator.GridDecorator()

Method Detail

void setGridView(caplin.grid.GridView oGridView)

The opportunity for the decorator to add itself as a listener to the caplin.grid.GridRowModel, the caplin.grid.GridRowSelectionModel, the caplin.grid.GridColumnModel and/or the 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 caplin.grid.GridView, and wait for the caplin.grid.GridViewListener#onContainerHtmlRendered event to be fired.

Parameters
caplin.grid.GridView oGridView The grid view to which this decorator is being attached.