InfiniteDataView (Gwt Material Table 2.0.1 API)

java.lang.Object
- gwt.material.design.client.data.AbstractDataView<T>
- - gwt.material.design.client.data.infinite.InfiniteDataView<T>

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, com.google.gwt.view.client.HasKeyProvider<T>, DataView<T>, HasCategories, HasColumns<T>, HasDataSource<T>, HasRenderer<T>, HasRows<T>, HasLoader, ViewSettings
```
public class InfiniteDataView<T>
extends AbstractDataView<T>
implements HasLoader
```
The InfiniteDataView is designed for lazy loading data, while using minimal DOM row elements.
The data source will invoke a load when the view index changes on scrolling.

How to use:
- View size can be configured manually or can be set to dynamic view using DYNAMIC_VIEW.
- Provide a valid DataSource implementation.
Author:

Ben Dol

Field Summary

Fields
Modifier and Type	Field and Description
`protected InfiniteDataCache<T>`	`dataCache`
`static int`	`DYNAMIC_VIEW` Dynamic view will detect available space for the row views.
`protected int`	`lastScrollTop`
`protected int`	`viewIndex`

Fields inherited from class gwt.material.design.client.data.AbstractDataView
$table, attachHandler, autoSortColumn, categories, categoryFactory, categoryHeight, columns, container, dataSource, display, headerRow, headers, height, id, keyProvider, longPressDuration, maskElement, maskHtml, ORPHAN_PATTERN, pendingRows, progressWidget, range, redraw, redrawCategories, renderer, rendering, rowFactory, rows, sortContext, subheaderLib, table, tableBody, tbody, thead, topPanel, totalRows, transitionEvents

Constructor Summary

Constructors
Constructor and Description
`InfiniteDataView(int totalRows, DataSource<T> dataSource)`
`InfiniteDataView(int totalRows, int viewSize, DataSource<T> dataSource)`
`InfiniteDataView(String name, int totalRows, DataSource<T> dataSource)`
`InfiniteDataView(String name, int totalRows, int viewSize, DataSource<T> dataSource)`
`InfiniteDataView(String name, int totalRows, int viewSize, com.google.gwt.view.client.ProvidesKey<T> keyProvider, DataSource<T> dataSource)`
`InfiniteDataView(String name, int totalRows, com.google.gwt.view.client.ProvidesKey<T> keyProvider, DataSource<T> dataSource)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCategory(CategoryComponent category)` Explicitly add a `CategoryComponent`, which will be drawn to the table.
`protected void`	`doLoad()`
`protected boolean`	`doSort(SortContext<T> sortContext, Components<RowComponent<T>> rows)` Perform a sort on the a set of `RowComponent`'s.
`int`	`getLoaderBuffer()`
`int`	`getLoaderDelay()`
`List<T>`	`getSelectedRowModels(boolean visibleOnly)` Get all the selected row models.
`double`	`getVisibleHeight()`
`int`	`getVisibleRowCapacity()` Returns the total number of rows that are visible given the current grid height.
`boolean`	`isDynamicView()`
`boolean`	`isLoading()` Is the loader loading.
`void`	`loaded(int startIndex, List<T> data)` Data views loader has loaded data for use.
`void`	`loaded(int startIndex, List<T> data, boolean cacheData)` Provide the option to load data with a cache parameter.
`void`	`loaded(int startIndex, List<T> data, int totalRows, boolean cacheData)` With infinite data loading it is often required to change the total rows, upon loading of new data.
`protected void`	`onConstructed()` Called after the data view is constructed.
`protected void`	`onSetup(TableScaffolding scaffolding)`
`protected Object`	`onVerticalScroll()`
`void`	`refresh()` Invoke a view refresh.
`void`	`render(Components<Component<?>> components)` Render the data view components to DOM.
`boolean`	`renderRows(Components<RowComponent<T>> rows)` Compile list of `RowComponent`'s and invoke a render.
`protected void`	`requestData(int index, boolean checkCache)`
`void`	`setDisplay(DataDisplay<T> display)` Set the data views display view.
`void`	`setLoaderBuffer(int loaderBuffer)` The amount of data that will buffer your start index and view size.
`void`	`setLoaderDelay(int loaderDelay)`
`void`	`setLoadMask(boolean loadMask)` Set the data views loading mask.
`void`	`setRowHeight(int rowHeight)` Set maximum row height.
`protected void`	`setViewSize(int viewSize)`
`protected void`	`updateRows(int newIndex, boolean reload)`

Methods inherited from class gwt.material.design.client.data.AbstractDataView
addCategory, addColumn, addColumn, addHeader, bindCategoryEvents, buildCategoryComponent, buildCategoryComponent, buildRowComponent, clearCategories, clearExpansions, clearRows, clearRowsAndCategories, closeCategory, closeCategory, deselectRow, destroy, disableCategory, enableCategory, fireEvent, getAutoSortColumn, getCalculatedRowHeight, getCategories, getCategory, getCategoryFactory, getCategoryHeight, getCategoryRowCount, getColumnCount, getColumnOffset, getColumns, getContainer, getData, getDataSource, getHeaders, getHeight, getHiddenCategories, getId, getKeyProvider, getLongPressDuration, getModelByRowElement, getModelsByRowElements, getOpenCategories, getOrphansCategory, getPassedCategories, getProgressWidget, getRenderer, getRow, getRow, getRowByModel, getRowCount, getRowElementByModel, getRowFactory, getRowHeight, getRowIndexByElement, getRows, getRowsByCategory, getSelectionType, getSortContext, getSubheaderLib, getTableSubHeader, getTableSubHeader, getTotalRows, getValueKey, getVisibleCategories, getVisibleItemCount, getVisibleRange, hasCategory, hasDeselectedRows, hasSelectedRows, insertColumn, isCategoryEmpty, isHeaderVisible, isLoadMask, isRedraw, isRendering, isSetup, isShiftDown, isUseCategories, isUseLoadOverlay, isUseRowExpansion, isUseStickyHeader, isWithinView, isWithinView, maybeApplyAutoSortColumn, openCategory, openCategory, prepareRows, reindexColumns, removeColumn, removeColumn, removeColumns, removeHeader, renderCategory, renderColumn, renderColumns, renderComponent, selectAllRows, selectAllRows, selectRow, setCategoryFactory, setDataSource, setHeight, setLongPressDuration, setRedraw, setRedrawCategories, setRenderer, setRowData, setRowFactory, setSelectionType, setTotalRows, setup, setupHeaderSelectionBox, setupShiftDetection, setupStickyHeader, setupSubHeaders, setUseCategories, setUseLoadOverlay, setUseRowExpansion, setUseStickyHeader, setVisibleRange, setVisibleRange, setVisibleRange, sort, sort, sort, sort, sort, sort, sort, sort, toggleRowSelect, toggleRowSelect, updateCheckAllInputState, updateCheckAllInputState, updateRow, updateSortContext, updateSortContext

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

- Field Detail
  - DYNAMIC_VIEW
```
public static final int DYNAMIC_VIEW
```
    Dynamic view will detect available space for the row views.
    
    See Also:
    
    Constant Field Values
  - viewIndex
```
protected int viewIndex
```
  - lastScrollTop
```
protected int lastScrollTop
```
  - dataCache
```
protected InfiniteDataCache<T> dataCache
```
- Constructor Detail
  - InfiniteDataView
```
public InfiniteDataView(int totalRows,
                        DataSource<T> dataSource)
```
  - InfiniteDataView
```
public InfiniteDataView(int totalRows,
                        int viewSize,
                        DataSource<T> dataSource)
```
  - InfiniteDataView
```
public InfiniteDataView(String name,
                        int totalRows,
                        DataSource<T> dataSource)
```
  - InfiniteDataView
```
public InfiniteDataView(String name,
                        int totalRows,
                        com.google.gwt.view.client.ProvidesKey<T> keyProvider,
                        DataSource<T> dataSource)
```
  - InfiniteDataView
```
public InfiniteDataView(String name,
                        int totalRows,
                        int viewSize,
                        DataSource<T> dataSource)
```
  - InfiniteDataView
```
public InfiniteDataView(String name,
                        int totalRows,
                        int viewSize,
                        com.google.gwt.view.client.ProvidesKey<T> keyProvider,
                        DataSource<T> dataSource)
```
- Method Detail
  - onConstructed
```
protected void onConstructed()
```
    Description copied from class: AbstractDataView
    
    Called after the data view is constructed. Note that this is not when the data view is attached, see AbstractDataView.setup(TableScaffolding).
    
    Overrides:
    
    onConstructed in class AbstractDataView<T>
  - onSetup
```
protected void onSetup(TableScaffolding scaffolding)
```
    Overrides:
    
    onSetup in class AbstractDataView<T>
  - setDisplay
```
public void setDisplay(DataDisplay<T> display)
```
    Description copied from interface: DataView
    
    Set the data views display view.
    
    Specified by:
    
    setDisplay in interface DataView<T>
    
    Overrides:
    
    setDisplay in class AbstractDataView<T>
  - render
```
public void render(Components<Component<?>> components)
```
    Description copied from interface: DataView
    
    Render the data view components to DOM.
    
    Specified by:
    
    render in interface DataView<T>
    
    Overrides:
    
    render in class AbstractDataView<T>
  - renderRows
```
public boolean renderRows(Components<RowComponent<T>> rows)
```
    Description copied from class: AbstractDataView
    
    Compile list of RowComponent's and invoke a render. Controls the building of category components and custom components. Which then AbstractDataView.render(Components) is invoked to perform DOM render. Rows which are already rendered are reprocessed based on their equals method. If the data is equal to the row in the same index it use the existing row.
    
    Overrides:
    
    renderRows in class AbstractDataView<T>
    
    Parameters:
    
    rows - list of rows to be rendered against the existing rows.
  - doSort
```
protected boolean doSort(SortContext<T> sortContext,
                         Components<RowComponent<T>> rows)
```
    Description copied from class: AbstractDataView
    
    Perform a sort on the a set of RowComponent's. Sorting will check for each components category and sort per category if found.
    
    Overrides:
    
    doSort in class AbstractDataView<T>
    
    Returns:
    
    true if the data was sorted, false if no sorting was performed.
  - setViewSize
```
protected void setViewSize(int viewSize)
```
  - refresh
```
public void refresh()
```
    Description copied from interface: DataView
    
    Invoke a view refresh.
    
    Specified by:
    
    refresh in interface DataView<T>
    
    Overrides:
    
    refresh in class AbstractDataView<T>
  - addCategory
```
public void addCategory(CategoryComponent category)
```
    Description copied from interface: HasCategories
    
    Explicitly add a CategoryComponent, which will be drawn to the table. If the category already exists then it will be ignored.
    
    Specified by:
    
    addCategory in interface HasCategories
    
    Overrides:
    
    addCategory in class AbstractDataView<T>
    
    Parameters:
    
    category - The category data defined.
  - getVisibleHeight
```
public double getVisibleHeight()
```
  - onVerticalScroll
```
protected Object onVerticalScroll()
```
  - updateRows
```
protected void updateRows(int newIndex,
                          boolean reload)
```
  - requestData
```
protected void requestData(int index,
                           boolean checkCache)
```
  - doLoad
```
protected void doLoad()
```
  - setLoadMask
```
public void setLoadMask(boolean loadMask)
```
    Description copied from interface: DataView
    
    Set the data views loading mask.
    
    Specified by:
    
    setLoadMask in interface DataView<T>
    
    Overrides:
    
    setLoadMask in class AbstractDataView<T>
  - loaded
```
public void loaded(int startIndex,
                   List<T> data)
```
    Description copied from interface: HasDataSource
    
    Data views loader has loaded data for use.
    
    Specified by:
    
    loaded in interface HasDataSource<T>
    
    Overrides:
    
    loaded in class AbstractDataView<T>
  - loaded
```
public void loaded(int startIndex,
                   List<T> data,
                   boolean cacheData)
```
    Provide the option to load data with a cache parameter.
  - loaded
```
public void loaded(int startIndex,
                   List<T> data,
                   int totalRows,
                   boolean cacheData)
```
    With infinite data loading it is often required to change the total rows, upon loading of new data. See loaded(int, List) for standard use.
    
    Parameters:
    
    startIndex - the new start index
    
    data - the new list of data loaded
    
    totalRows - the new total row count
  - getVisibleRowCapacity
```
public int getVisibleRowCapacity()
```
    Returns the total number of rows that are visible given the current grid height.
  - setRowHeight
```
public void setRowHeight(int rowHeight)
```
    Description copied from interface: HasRows
    
    Set maximum row height. The minimum row height is 33 pixels as a material design specification.
    
    Specified by:
    
    setRowHeight in interface HasRows<T>
    
    Overrides:
    
    setRowHeight in class AbstractDataView<T>
  - getSelectedRowModels
```
public List<T> getSelectedRowModels(boolean visibleOnly)
```
    Description copied from interface: HasRows
    
    Get all the selected row models.
    
    Specified by:
    
    getSelectedRowModels in interface HasRows<T>
    
    Overrides:
    
    getSelectedRowModels in class AbstractDataView<T>
    
    Parameters:
    
    visibleOnly - should we restrict this check to visible rows only.
    
    Returns:
    
    list of the currently selected row models.
  - getLoaderDelay
```
public int getLoaderDelay()
```
    Specified by:
    
    getLoaderDelay in interface HasLoader
  - setLoaderDelay
```
public void setLoaderDelay(int loaderDelay)
```
    Specified by:
    
    setLoaderDelay in interface HasLoader
  - getLoaderBuffer
```
public int getLoaderBuffer()
```
    Specified by:
    
    getLoaderBuffer in interface HasLoader
  - setLoaderBuffer
```
public void setLoaderBuffer(int loaderBuffer)
```
    Description copied from interface: HasLoader
    
    The amount of data that will buffer your start index and view size. This can be useful in removing loading delays. Defaults to 10.
    
    Specified by:
    
    setLoaderBuffer in interface HasLoader
  - isLoading
```
public boolean isLoading()
```
    Description copied from interface: HasLoader
    
    Is the loader loading.
    
    Specified by:
    
    isLoading in interface HasLoader
  - isDynamicView
```
public boolean isDynamicView()
```

Class InfiniteDataView<T>

Field Summary

Fields inherited from class gwt.material.design.client.data.AbstractDataView

Constructor Summary

Method Summary

Methods inherited from class gwt.material.design.client.data.AbstractDataView

Methods inherited from class java.lang.Object

Field Detail

DYNAMIC_VIEW

viewIndex

lastScrollTop

dataCache

Constructor Detail

InfiniteDataView

InfiniteDataView

InfiniteDataView

InfiniteDataView

InfiniteDataView

InfiniteDataView

Method Detail

onConstructed

onSetup

setDisplay

render

renderRows

doSort

setViewSize

refresh

addCategory

getVisibleHeight

onVerticalScroll

updateRows

requestData

doLoad

setLoadMask

loaded

loaded

loaded

getVisibleRowCapacity

setRowHeight

getSelectedRowModels

getLoaderDelay

setLoaderDelay

getLoaderBuffer

setLoaderBuffer

isLoading

isDynamicView