► caplin.grid.GridView(caplin.grid.GridDefinition gridDefinition, caplin.grid.GridRowModel gridRowModel, caplin.grid.GridColumnModel gridColumnModel, Array gridDecorators)

Constructs a new GridView with the specified arguments.

This constructor should not be called directly, but instead caplin.grid.GridComponentFactory should be used for the construction of all grid assemblies.

► void addColumnHeaderRendererListener(caplin.element.RendererEventListener rendererEventListener)

Adds an caplin.element.RendererEventListener listener to the grid view. Any events raised on any of the renderers on the GridView will raise an event. Use {#removeColumnHeaderRendererListener} to remove a listener.

► void addGridViewListener(caplin.grid.GridViewListener gridViewListener)

Adds a listener to the grid view, to be communicated of all grid level events.

► void addRendererEventListener(caplin.element.RendererEventListener rendererEventListener)

Adds a RendererEventListener to listen to any of the events that occur on renderers in the GridView.

See

caplin.element.RendererEventListener

► void canReceive()

► void canReceiveMultipleObjects()

► void canReceiveObjects( receivedObjects)

► HtmlElement getCellElement(int rowIndex, int columnIndex)

Returns the cell for the specified row and column.

Returns

{HtmlElement} The DOM element the cell is being rendered within.

► caplin.element.Renderer getCellRenderer(int rowIndex, int columnIndex)

Returns the cell renderer responsible for rendering the given row and column indicies.

Returns

{caplin.element.Renderer} the cell renderer responsible for rendering the given row and column indicies

► Map getElementIndicies(HtmlElement element)

Returns the map containing the row and column indices (rowIndex and columnIndex respectively) for the specified cell element. If the specified cell represents a header, only a columnIndex will be returned within the map.

Returns

{Map} A map containing the rowIndex and columnIndex for the given element.

► caplin.grid.GridColumnModel getGridColumnModel()

Returns the underlying column model being used with the grid.

Returns

{caplin.grid.GridColumnModel} The column model.

► Array getGridDecorators()

Returns the decorators held by this Grid View

Returns

{Array} The decorators held by this Grid View

► caplin.grid.GridRowModel getGridRowModel()

Returns the underlying row model being used with the grid.

Returns

{caplin.grid.GridRowModel} The row model.

► caplin.grid.GridRowSelectionModel getGridRowSelectionModel()

Returns the row selection model being used with the grid.

Returns

{caplin.grid.GridRowSelectionModel} The row selection model.

► HtmlElement getHeaderCellElement(int columnIndex)

Returns the header cell for the specified column.

Returns

{HtmlElement} The DOM element the given header cell is rendered within.

► caplin.element.Renderer getHeaderRenderer(int columnIndex)

Returns the header renderer responsible for rendering the given column index.

Returns

{caplin.element.Renderer} the header renderer responsible for rendering the given column index

► HtmlElement getHeaderRowElement()

Returns the header row.

Returns

{HtmlElement} The DOM element the header row is rendered within.

► void getLastReceiveFailureMessage()

► int getNumberOfDisplayedRows()

Returns the number of rendered rows visible in the grid at the present point in time.

Returns

{int} The number of currently displayed rows.

► Array getRendererTypes()

Returns an array containing all Renderer Types for every column.

Returns

{Array} all renderer tpyes for every column

► Map getRendererTypesIndexedByColumnName()

Returns a map containing all Renderer Types for every column, indexed by column friendly name.

Returns

{Map} all of the renderer types for every column.

► HtmlElement getRowContainerElement()

Returns the grid row container element.

Returns

{HtmlElement} The DOM element the rows are being rendered within.

► HtmlElement getRowElement(int rowIndex)

Returns the row element with the specified row index.

Returns

{HtmlElement} The DOM element the given row is rendered within.

► void getSuccessMessage()

► int getTotalRowCount()

Returns the total number of rows in the dataset.

Returns

{int} The total number of rows.

► String getUniqueComponentId()

Gets a guaranteed ID for this component instance.

Returns

{String} A unique ID

► int getVisibleRowCount()

Returns the number of visible, populated rows in the grid.

Returns

{int} The number of visible rows.

► boolean isColumnInView(int columnIndex)

Determines whether the specified column is in view.

Returns

{boolean} true if the column is in view, and false otherwise.

► boolean isRowInView(int rowIndex)

Determines whether the specified row is in view.

Returns

{boolean} true if the row is in view, and false otherwise.

► boolean isScrolling()

Test if the grid is currently being scrolled.

Returns

{boolean} true if the grid is currently being scrolled.

► void isSortable()

The grid is sortable, unless it is empty.

► void markAsDirty()

Calling this method will inform webcentric that the user's layout has changed. The layout will be marked using a *, informing the user that they must save their sheet to save any changes that have been made.

► void onAllDataReceived()

► void onColumnsAdded( gridColumns, startIndex)

► void onColumnsRemoved( gridColumns, startIndex)

► void onFiltersChanged()

► void onRendererEvent(caplin.element.Renderer renderer, Map rendererEvent, Map options)

The callback function to receive Renderer events.

See

caplin.element.RendererEventListener#onRendererEvent

► void onRowContentsChanged( indices, rowUpdates)

► void onRowDataUnavailable()

► void onRowStructureChanged( indices)

► void onScroll( nType, scrollAmount)

► void onScrollComplete( nType, scrollAmount)

► void onSizeChanged( newSize)

► void onSortColumnChanged()

► void onStartIndexChanged( newStartIndex)

► void onWidthChanged( gridColumn)

► void recalculateHeights()

Inform the grid that the styling applied to the grids has dynamically changed, affecting the current column header and/or rows heights.

Some uses of the grid may involve changing the display mode at runtime, so that the column headers or the rows themselves have a different height in these different modes. Although a display mode switch may be affected by the developer by setting a class name on the root grid element, and having different CSS rules for each mode, the grid must also be informed about this so that it's rendering logic can continue to work.

► void receiveObjects( receivedObjects)

► void removeColumnHeaderRendererListener(caplin.element.RendererEventListener rendererEventListener)

Removes a listener previously been added via {#addColumnHeaderRendererListener}.

► void removeGridViewListener(caplin.grid.GridViewListener gridViewListener)

Removes a previously registered grid view listener.

► void setStartIndex(Number startIndex)

Set the first row being displayed within the grid.