AbstractDataView (Gwt Material Table 2.0 API)

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

Type Parameters:

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>, ViewSettings

Direct Known Subclasses:

InfiniteDataView, StandardDataView
```
public abstract class AbstractDataView<T>
extends Object
implements DataView<T>
```
Abstract DataView handles the creation, preparation and UI logic for the table rows and subheaders (if enabled). All of the basic table rendering is handled.

Author:

Ben Dol

Field Summary

Fields
Modifier and Type	Field and Description
`protected JsTableElement`	`$table`
`protected com.google.gwt.event.shared.HandlerRegistration`	`attachHandler`
`protected Column<T,?>`	`autoSortColumn`
`protected Components<CategoryComponent>`	`categories`
`protected ComponentFactory<? extends CategoryComponent,String>`	`categoryFactory`
`protected int`	`categoryHeight`
`protected List<Column<T,?>>`	`columns`
`protected gwt.material.design.jquery.client.api.JQueryElement`	`container`
`protected DataSource<T>`	`dataSource`
`protected DataDisplay<T>`	`display`
`protected TableRow`	`headerRow`
`protected List<TableHeader>`	`headers`
`protected String`	`height`
`protected String`	`id`
`protected com.google.gwt.view.client.ProvidesKey<T>`	`keyProvider`
`protected int`	`longPressDuration`
`protected gwt.material.design.jquery.client.api.JQueryElement`	`maskElement`
`static String`	`maskHtml`
`static String`	`ORPHAN_PATTERN`
`protected Components<RowComponent<T>>`	`pendingRows`
`protected gwt.material.design.client.ui.MaterialProgress`	`progressWidget`
`protected com.google.gwt.view.client.Range`	`range`
`protected boolean`	`redraw`
`protected boolean`	`redrawCategories`
`protected Renderer<T>`	`renderer`
`protected boolean`	`rendering`
`protected RowComponentFactory<T>`	`rowFactory`
`protected Components<RowComponent<T>>`	`rows`
`protected SortContext<T>`	`sortContext`
`protected JsTableSubHeaders`	`subheaderLib`
`protected Table`	`table`
`protected gwt.material.design.jquery.client.api.JQueryElement`	`tableBody`
`protected gwt.material.design.client.base.MaterialWidget`	`tbody`
`protected gwt.material.design.client.base.MaterialWidget`	`thead`
`protected gwt.material.design.jquery.client.api.JQueryElement`	`topPanel`
`protected int`	`totalRows`
`static String`	`transitionEvents`

Constructor Summary

Constructors
Constructor and Description
`AbstractDataView()`
`AbstractDataView(com.google.gwt.view.client.ProvidesKey<T> keyProvider)`
`AbstractDataView(String id)`
`AbstractDataView(String id, com.google.gwt.view.client.ProvidesKey<T> keyProvider)`

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.
`void`	`addCategory(String category)` Explicitly add a category, which will be drawn to the table.
`void`	`addColumn(Column<T,?> column)` Add a new column to the data view.
`void`	`addColumn(Column<T,?> column, String header)` Add a new column to the data view.
`protected void`	`addHeader(int index, TableHeader header)`
`protected TableSubHeader`	`bindCategoryEvents(TableSubHeader category)`
`protected CategoryComponent`	`buildCategoryComponent(RowComponent<T> row)`
`protected CategoryComponent`	`buildCategoryComponent(String categoryName)`
`protected RowComponent<T>`	`buildRowComponent(T data)`
`void`	`clearCategories()` Clear all categories.
`protected void`	`clearExpansions()`
`void`	`clearRows(boolean clearData)` Clear data rows.
`void`	`clearRowsAndCategories(boolean clearData)` Clear all rows and categories.
`void`	`closeCategory(CategoryComponent category)` Close an existing Category.
`void`	`closeCategory(String categoryName)` Close an existing Category.
`void`	`deselectRow(com.google.gwt.dom.client.Element row, boolean fireEvent)` Unselect a selected row.
`void`	`destroy()` Destroy the data view.
`void`	`disableCategory(String categoryName)` Disable a data view category.
`protected boolean`	`doSort(SortContext<T> sortContext, Components<RowComponent<T>> rows)` Perform a sort on the a set of `RowComponent`'s.
`void`	`enableCategory(String categoryName)` Enable a data view category.
`void`	`fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)`
`protected Column<T,?>`	`getAutoSortColumn()` Get the auto sorting column, or null if no column is auto sorting.
`protected int`	`getCalculatedRowHeight()`
`List<CategoryComponent>`	`getCategories()` Get all registered category components.
`CategoryComponent`	`getCategory(String name)` Get a stored data category by name.
`ComponentFactory<? extends CategoryComponent,String>`	`getCategoryFactory()`
`int`	`getCategoryHeight()`
`protected int`	`getCategoryRowCount(String category)`
`int`	`getColumnCount()` Get the number of columns in the table.
`int`	`getColumnOffset()` Get the offset column index (used when selection mode is on).
`List<Column<T,?>>`	`getColumns()` Get the current defined columns.
`com.google.gwt.user.client.ui.Widget`	`getContainer()` Get the displays main container.
`protected List<T>`	`getData()`
`DataSource<T>`	`getDataSource()` Get the configured data source.
`List<TableHeader>`	`getHeaders()` Get the list of rendered header widgets.
`String`	`getHeight()` Get the table body height.
`protected List<CategoryComponent>`	`getHiddenCategories()`
`String`	`getId()` Get the data views id.
`com.google.gwt.view.client.ProvidesKey<T>`	`getKeyProvider()`
`int`	`getLongPressDuration()` Get the long press duration requirement.
`protected T`	`getModelByRowElement(com.google.gwt.dom.client.Element rowElement)`
`protected List<T>`	`getModelsByRowElements(List<com.google.gwt.dom.client.Element> rowElements)`
`List<CategoryComponent>`	`getOpenCategories()` Get all the open `CategoryComponent`'s or null if categories are disabled.
`protected CategoryComponent.OrphanCategoryComponent`	`getOrphansCategory()` Get the `CategoryComponent.OrphanCategoryComponent` for orphan rows.
`protected List<CategoryComponent>`	`getPassedCategories()`
`gwt.material.design.client.ui.MaterialProgress`	`getProgressWidget()` Get the data views progress widget.
`Renderer<T>`	`getRenderer()`
`RowComponent<T>`	`getRow(int index)` Get a row by its rendered index.
`RowComponent<T>`	`getRow(T model)` Get a row by its representing model.
`RowComponent<T>`	`getRowByModel(T model)` Get a models `RowComponent` or null if not found.
`int`	`getRowCount()` Get the exact count of all rows.
`protected com.google.gwt.dom.client.Element`	`getRowElementByModel(T model)`
`RowComponentFactory<T>`	`getRowFactory()` Get the views row factory.
`int`	`getRowHeight()` Get the maximum row height.
`protected int`	`getRowIndexByElement(com.google.gwt.dom.client.Element rowElement)`
`List<RowComponent<T>>`	`getRows()` Get all data views `RowComponent`'s.
`protected List<RowComponent<T>>`	`getRowsByCategory(Components<RowComponent<T>> rows, CategoryComponent category)`
`List<T>`	`getSelectedRowModels(boolean visibleOnly)` Get all the selected row models.
`SelectionType`	`getSelectionType()` Get the data views row selection type.
`SortContext<T>`	`getSortContext()` Get the data views current sort context, or null if no sort context is applied.
`JsTableSubHeaders`	`getSubheaderLib()` Get the subheader library API.
`protected TableSubHeader`	`getTableSubHeader(gwt.material.design.jquery.client.api.JQueryElement elem)` Get a stored data categories subheader by jquery element.
`protected TableSubHeader`	`getTableSubHeader(String name)` Get a stored data categories subheader by name.
`int`	`getTotalRows()` Get the configured total rows count.
`Object`	`getValueKey(T value)` Get the key for the specified value.
`protected List<CategoryComponent>`	`getVisibleCategories()`
`int`	`getVisibleItemCount()` Get the visible item count of the data view.
`com.google.gwt.view.client.Range`	`getVisibleRange()` Get the range of visible rows.
`boolean`	`hasCategory(String categoryName)` Has this data view got an existing `CategoryComponent` with given name.
`boolean`	`hasDeselectedRows(boolean visibleOnly)` Does this view have unselected rows.
`boolean`	`hasSelectedRows(boolean visibleOnly)` Does this view have selected rows.
`void`	`insertColumn(int beforeIndex, Column<T,?> column, String header)` Inserts a column into the table at the specified index.
`boolean`	`isCategoryEmpty(CategoryComponent category)` Check if a category has data to provide.
`boolean`	`isHeaderVisible(int colIndex)` Check if a header with the given index is visible.
`boolean`	`isLoadMask()` Is the data views loading mask applied.
`boolean`	`isRedraw()` Is redrawing the data view.
`boolean`	`isRendering()` Is the data view rendering.
`boolean`	`isSetup()` Is the data view setup.
`boolean`	`isShiftDown()`
`boolean`	`isUseCategories()` Is the data view using categories where possible.
`boolean`	`isUseLoadOverlay()` Is the data view using loading overlay mask.
`boolean`	`isUseRowExpansion()` Is the data view using row expansion.
`boolean`	`isUseStickyHeader()` True if we are using sticky table header.
`protected boolean`	`isWithinView(int start, int length)`
`protected boolean`	`isWithinView(int start, int length, boolean canOverflow)`
`void`	`loaded(int startIndex, List<T> data)` Data views loader has loaded data for use.
`protected boolean`	`maybeApplyAutoSortColumn()` Check and apply the auto sort column `Column.setAutoSort(boolean)` if no sort has been invoked.
`protected void`	`onConstructed()` Called after the data view is constructed.
`protected void`	`onSetup(TableScaffolding scaffolding)`
`void`	`openCategory(CategoryComponent category)` Open an existing Category.
`void`	`openCategory(String categoryName)` Open an existing Category.
`protected void`	`prepareRows()` Prepare all row specific functionality.
`void`	`refresh()` Invoke a view refresh.
`protected void`	`reindexColumns()`
`void`	`removeColumn(int colIndex)` Remove an existing column by index.
`void`	`removeColumn(int colIndex, boolean hardRemove)`
`void`	`removeColumns()` Remove all columns.
`protected void`	`removeHeader(int index)`
`void`	`render(Components<Component<?>> components)` Render the data view components to DOM.
`protected void`	`renderCategory(CategoryComponent category)`
`void`	`renderColumn(Column<T,?> column)`
`protected void`	`renderColumns()`
`protected void`	`renderComponent(Component<?> component)`
`protected boolean`	`renderRows(Components<RowComponent<T>> rows)` Compile list of `RowComponent`'s and invoke a render.
`void`	`selectAllRows(boolean select)` Select or deselect all rows.
`void`	`selectAllRows(boolean select, boolean fireEvent)` Select or deselect all rows.
`void`	`selectRow(com.google.gwt.dom.client.Element row, boolean fireEvent)` Select a given row.
`void`	`setCategoryFactory(ComponentFactory<? extends CategoryComponent,String> categoryFactory)` Set your own custom `CategoryComponentFactory` to generate your categories.
`void`	`setDataSource(DataSource<T> dataSource)` Set a `DataSource` for data loading.
`void`	`setDisplay(DataDisplay<T> display)` Set the data views display view.
`void`	`setHeight(String height)` Set the table body height.
`void`	`setLoadMask(boolean loadMask)` Set the data views loading mask.
`void`	`setLongPressDuration(int longPressDuration)` Set the long press duration requirement.
`void`	`setRedraw(boolean redraw)` Set redraw data view elements.
`protected void`	`setRedrawCategories(boolean redrawCategories)`
`void`	`setRenderer(Renderer<T> renderer)` Set your own custom renderer.
`void`	`setRowData(int start, List<? extends T> values)` Set values associated with the rows in the visible range.
`void`	`setRowFactory(RowComponentFactory<T> rowFactory)` Set your own custom `RowComponentFactory` to generate your row components.
`void`	`setRowHeight(int rowHeight)` Set maximum row height.
`void`	`setSelectionType(SelectionType selectionType)` Set the data views row selection type.
`void`	`setTotalRows(int totalRows)` Set the total row count.
`void`	`setup(TableScaffolding scaffolding)` Setup the data view.
`protected void`	`setupHeaderSelectionBox()`
`protected void`	`setupShiftDetection()`
`protected void`	`setupStickyHeader()`
`protected void`	`setupSubHeaders()`
`void`	`setUseCategories(boolean useCategories)` Allow the data view to generate categories, or use added categories for row data.
`void`	`setUseLoadOverlay(boolean useLoadOverlay)` Use the loading overlay mask.
`void`	`setUseRowExpansion(boolean useRowExpansion)` Use row expansion functionality, giving the user a way to expand rows for extra information.
`void`	`setUseStickyHeader(boolean stickyHeader)` Enable the use of sticky table header bar.
`void`	`setVisibleRange(int start, int length)` Set the visible range or rows.
`void`	`setVisibleRange(com.google.gwt.view.client.Range range)` Set the visible range or rows.
`protected void`	`setVisibleRange(com.google.gwt.view.client.Range range, boolean forceRangeChangeEvent)`
`void`	`sort(Column<T,?> column)` Sort a column.
`void`	`sort(Column<T,?> column, SortDir dir)` Sort a column.
`protected Components<RowComponent<T>>`	`sort(Components<RowComponent<T>> rows, TableHeader th, Column<T,?> column, int index)`
`protected Components<RowComponent<T>>`	`sort(Components<RowComponent<T>> rows, TableHeader th, Column<T,?> column, int index, boolean renderRows)`
`protected Components<RowComponent<T>>`	`sort(Components<RowComponent<T>> rows, TableHeader th, Column<T,?> column, int index, SortDir dir)`
`protected Components<RowComponent<T>>`	`sort(Components<RowComponent<T>> rows, TableHeader th, Column<T,?> column, int index, SortDir dir, boolean renderRows)`
`void`	`sort(int columnIndex)` Sort a column matching the given index (the index excludes the selection box row).
`void`	`sort(int columnIndex, SortDir dir)` Sort a column matching the given index (the index excludes the selection box row).
`void`	`toggleRowSelect(gwt.material.design.jquery.client.api.Event event, com.google.gwt.dom.client.Element row)` Select a row by given element.
`void`	`toggleRowSelect(gwt.material.design.jquery.client.api.Event event, com.google.gwt.dom.client.Element row, boolean fireEvent)` Select a row by given element.
`void`	`updateCheckAllInputState()`
`protected void`	`updateCheckAllInputState(gwt.material.design.jquery.client.api.JQueryElement input)`
`void`	`updateRow(T model)` Update a models row within the table.
`protected void`	`updateSortContext(TableHeader th, Column<T,?> column)`
`protected void`	`updateSortContext(TableHeader th, Column<T,?> column, SortDir dir)`

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

- Field Detail
  - id
```
protected final String id
```
  - display
```
protected DataDisplay<T> display
```
  - dataSource
```
protected DataSource<T> dataSource
```
  - renderer
```
protected Renderer<T> renderer
```
  - sortContext
```
protected SortContext<T> sortContext
```
  - autoSortColumn
```
protected Column<T,?> autoSortColumn
```
  - rowFactory
```
protected RowComponentFactory<T> rowFactory
```
  - categoryFactory
```
protected ComponentFactory<? extends CategoryComponent,String> categoryFactory
```
  - keyProvider
```
protected com.google.gwt.view.client.ProvidesKey<T> keyProvider
```
  - subheaderLib
```
protected JsTableSubHeaders subheaderLib
```
  - categoryHeight
```
protected int categoryHeight
```
  - height
```
protected String height
```
  - rendering
```
protected boolean rendering
```
  - redraw
```
protected boolean redraw
```
  - redrawCategories
```
protected boolean redrawCategories
```
  - table
```
protected Table table
```
  - thead
```
protected gwt.material.design.client.base.MaterialWidget thead
```
  - tbody
```
protected gwt.material.design.client.base.MaterialWidget tbody
```
  - progressWidget
```
protected gwt.material.design.client.ui.MaterialProgress progressWidget
```
  - headerRow
```
protected TableRow headerRow
```
  - container
```
protected gwt.material.design.jquery.client.api.JQueryElement container
```
  - $table
```
protected JsTableElement $table
```
  - maskElement
```
protected gwt.material.design.jquery.client.api.JQueryElement maskElement
```
  - tableBody
```
protected gwt.material.design.jquery.client.api.JQueryElement tableBody
```
  - topPanel
```
protected gwt.material.design.jquery.client.api.JQueryElement topPanel
```
  - range
```
protected com.google.gwt.view.client.Range range
```
  - totalRows
```
protected int totalRows
```
  - longPressDuration
```
protected int longPressDuration
```
  - rows
```
protected final Components<RowComponent<T>> rows
```
  - pendingRows
```
protected final Components<RowComponent<T>> pendingRows
```
  - categories
```
protected final Components<CategoryComponent> categories
```
  - columns
```
protected final List<Column<T,?>> columns
```
  - headers
```
protected final List<TableHeader> headers
```
  - attachHandler
```
protected com.google.gwt.event.shared.HandlerRegistration attachHandler
```
  - ORPHAN_PATTERN
```
public static final String ORPHAN_PATTERN
```
    See Also:
    
    Constant Field Values
  - maskHtml
```
public static final String maskHtml
```
    See Also:
    
    Constant Field Values
  - transitionEvents
```
public static final String transitionEvents
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractDataView
```
public AbstractDataView()
```
  - AbstractDataView
```
public AbstractDataView(String id)
```
  - AbstractDataView
```
public AbstractDataView(com.google.gwt.view.client.ProvidesKey<T> keyProvider)
```
  - AbstractDataView
```
public AbstractDataView(String id,
                        com.google.gwt.view.client.ProvidesKey<T> keyProvider)
```
- Method Detail
  - onConstructed
```
protected void onConstructed()
```
    Called after the data view is constructed. Note that this is not when the data view is attached, see setup(TableScaffolding).
  - 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>
  - renderRows
```
protected boolean renderRows(Components<RowComponent<T>> rows)
```
    Compile list of RowComponent's and invoke a render. Controls the building of category components and custom components. Which then 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.
    
    Parameters:
    
    rows - list of rows to be rendered against the existing rows.
  - renderComponent
```
protected void renderComponent(Component<?> component)
```
  - renderColumns
```
protected void renderColumns()
```
  - renderColumn
```
public void renderColumn(Column<T,?> column)
```
  - refresh
```
public void refresh()
```
    Description copied from interface: DataView
    
    Invoke a view refresh.
    
    Specified by:
    
    refresh in interface DataView<T>
  - setRenderer
```
public void setRenderer(Renderer<T> renderer)
```
    Description copied from interface: HasRenderer
    
    Set your own custom renderer. See BaseRenderer for the standard rendering.
    
    Specified by:
    
    setRenderer in interface HasRenderer<T>
  - getRenderer
```
public Renderer<T> getRenderer()
```
  - setDataSource
```
public void setDataSource(DataSource<T> dataSource)
```
    Description copied from interface: HasDataSource
    
    Set a DataSource for data loading.
    
    Specified by:
    
    setDataSource in interface HasDataSource<T>
  - getDataSource
```
public DataSource<T> getDataSource()
```
    Description copied from interface: HasDataSource
    
    Get the configured data source.
    
    Specified by:
    
    getDataSource in interface HasDataSource<T>
  - getSubheaderLib
```
public JsTableSubHeaders getSubheaderLib()
```
    Description copied from interface: DataView
    
    Get the subheader library API.
    
    Specified by:
    
    getSubheaderLib in interface DataView<T>
  - setup
```
public void setup(TableScaffolding scaffolding)
           throws Exception
```
    Description copied from interface: DataView
    
    Setup the data view.
    
    Specified by:
    
    setup in interface DataView<T>
    
    Throws:
    
    Exception
  - onSetup
```
protected void onSetup(TableScaffolding scaffolding)
```
  - destroy
```
public void destroy()
```
    Description copied from interface: DataView
    
    Destroy the data view.
    
    Specified by:
    
    destroy in interface DataView<T>
  - prepareRows
```
protected void prepareRows()
```
    Prepare all row specific functionality.
  - setupStickyHeader
```
protected void setupStickyHeader()
```
  - setupSubHeaders
```
protected void setupSubHeaders()
```
  - isWithinView
```
protected boolean isWithinView(int start,
                               int length)
```
  - isWithinView
```
protected boolean isWithinView(int start,
                               int length,
                               boolean canOverflow)
```
  - getRowCount
```
public int getRowCount()
```
    Description copied from interface: HasRows
    
    Get the exact count of all rows.
    
    Specified by:
    
    getRowCount in interface HasRows<T>
    
    Returns:
    
    the exact row count
  - getVisibleRange
```
public com.google.gwt.view.client.Range getVisibleRange()
```
    Description copied from interface: HasRows
    
    Get the range of visible rows.
    
    Specified by:
    
    getVisibleRange in interface HasRows<T>
    
    Returns:
    
    the visible range
    
    See Also:
    
    HasRows.setVisibleRange(Range), HasRows.setVisibleRange(int, int)
  - setVisibleRange
```
public void setVisibleRange(int start,
                            int length)
```
    Description copied from interface: HasRows
    
    Set the visible range or rows. This method defers to HasRows.setVisibleRange(Range).
    
    Specified by:
    
    setVisibleRange in interface HasRows<T>
    
    Parameters:
    
    start - the start index
    
    length - the length
    
    See Also:
    
    HasRows.getVisibleRange()
  - setVisibleRange
```
public void setVisibleRange(com.google.gwt.view.client.Range range)
```
    Description copied from interface: HasRows
    
    Set the visible range or rows.
    
    Specified by:
    
    setVisibleRange in interface HasRows<T>
    
    Parameters:
    
    range - the visible range
    
    See Also:
    
    HasRows.getVisibleRange()
  - setVisibleRange
```
protected void setVisibleRange(com.google.gwt.view.client.Range range,
                               boolean forceRangeChangeEvent)
```
  - isHeaderVisible
```
public boolean isHeaderVisible(int colIndex)
```
    Description copied from interface: DataView
    
    Check if a header with the given index is visible.
    
    Specified by:
    
    isHeaderVisible in interface DataView<T>
  - addColumn
```
public void addColumn(Column<T,?> column)
```
    Description copied from interface: HasColumns
    
    Add a new column to the data view.
    
    Specified by:
    
    addColumn in interface HasColumns<T>
    
    Parameters:
    
    column - the column object
  - addColumn
```
public void addColumn(Column<T,?> column,
                      String header)
```
    Description copied from interface: HasColumns
    
    Add a new column to the data view.
    
    Specified by:
    
    addColumn in interface HasColumns<T>
    
    Parameters:
    
    column - the column object
  - insertColumn
```
public void insertColumn(int beforeIndex,
                         Column<T,?> column,
                         String header)
```
    Description copied from interface: HasColumns
    
    Inserts a column into the table at the specified index.
    
    Specified by:
    
    insertColumn in interface HasColumns<T>
    
    Parameters:
    
    beforeIndex - the index to insert the column
    
    column - the column to be added
  - updateSortContext
```
protected void updateSortContext(TableHeader th,
                                 Column<T,?> column)
```
  - updateSortContext
```
protected void updateSortContext(TableHeader th,
                                 Column<T,?> column,
                                 SortDir dir)
```
  - sort
```
public void sort(int columnIndex)
```
    Description copied from interface: HasColumns
    
    Sort a column matching the given index (the index excludes the selection box row).
    
    Specified by:
    
    sort in interface HasColumns<T>
    
    Parameters:
    
    columnIndex - valid index to the user added Columns.
  - sort
```
public void sort(int columnIndex,
                 SortDir dir)
```
    Description copied from interface: HasColumns
    
    Sort a column matching the given index (the index excludes the selection box row).
    
    Specified by:
    
    sort in interface HasColumns<T>
    
    Parameters:
    
    columnIndex - valid index to the user added Columns.
    
    dir - the sort direction or null for auto reversing.
  - sort
```
public void sort(Column<T,?> column)
```
    Description copied from interface: HasColumns
    
    Sort a column.
    
    Specified by:
    
    sort in interface HasColumns<T>
    
    Parameters:
    
    column - matching column that was added via ##addColumn(Column).
  - sort
```
public void sort(Column<T,?> column,
                 SortDir dir)
```
    Description copied from interface: HasColumns
    
    Sort a column.
    
    Specified by:
    
    sort in interface HasColumns<T>
    
    Parameters:
    
    column - matching column that was added via ##addColumn(Column).
    
    dir - the sort direction or null for auto reversing.
  - sort
```
protected Components<RowComponent<T>> sort(Components<RowComponent<T>> rows,
                                           TableHeader th,
                                           Column<T,?> column,
                                           int index)
```
  - sort
```
protected Components<RowComponent<T>> sort(Components<RowComponent<T>> rows,
                                           TableHeader th,
                                           Column<T,?> column,
                                           int index,
                                           SortDir dir)
```
  - sort
```
protected Components<RowComponent<T>> sort(Components<RowComponent<T>> rows,
                                           TableHeader th,
                                           Column<T,?> column,
                                           int index,
                                           boolean renderRows)
```
  - sort
```
protected Components<RowComponent<T>> sort(Components<RowComponent<T>> rows,
                                           TableHeader th,
                                           Column<T,?> column,
                                           int index,
                                           SortDir dir,
                                           boolean renderRows)
```
  - doSort
```
protected boolean doSort(SortContext<T> sortContext,
                         Components<RowComponent<T>> rows)
```
    Perform a sort on the a set of RowComponent's. Sorting will check for each components category and sort per category if found.
    
    Returns:
    
    true if the data was sorted, false if no sorting was performed.
  - removeColumn
```
public void removeColumn(int colIndex)
```
    Description copied from interface: HasColumns
    
    Remove an existing column by index.
    
    Specified by:
    
    removeColumn in interface HasColumns<T>
    
    Parameters:
    
    colIndex - the columns placement index
  - removeColumn
```
public void removeColumn(int colIndex,
                         boolean hardRemove)
```
  - removeColumns
```
public void removeColumns()
```
    Description copied from interface: HasColumns
    
    Remove all columns.
    
    Specified by:
    
    removeColumns in interface HasColumns<T>
  - getColumns
```
public List<Column<T,?>> getColumns()
```
    Description copied from interface: HasColumns
    
    Get the current defined columns.
    
    Specified by:
    
    getColumns in interface HasColumns<T>
  - getColumnOffset
```
public int getColumnOffset()
```
    Description copied from interface: HasColumns
    
    Get the offset column index (used when selection mode is on).
    
    Specified by:
    
    getColumnOffset in interface HasColumns<T>
  - getColumnCount
```
public int getColumnCount()
```
    Get the number of columns in the table.
    
    Returns:
    
    the column count
  - getSelectionType
```
public SelectionType getSelectionType()
```
    Description copied from interface: HasRows
    
    Get the data views row selection type.
    
    Specified by:
    
    getSelectionType in interface HasRows<T>
  - setSelectionType
```
public void setSelectionType(SelectionType selectionType)
```
    Description copied from interface: HasRows
    
    Set the data views row selection type.
    
    Specified by:
    
    setSelectionType in interface HasRows<T>
  - setupHeaderSelectionBox
```
protected void setupHeaderSelectionBox()
```
  - setupShiftDetection
```
protected void setupShiftDetection()
```
  - reindexColumns
```
protected void reindexColumns()
```
  - isSetup
```
public boolean isSetup()
```
    Description copied from interface: DataView
    
    Is the data view setup.
    
    Specified by:
    
    isSetup in interface DataView<T>
  - isRendering
```
public boolean isRendering()
```
    Description copied from interface: DataView
    
    Is the data view rendering.
    
    Specified by:
    
    isRendering in interface DataView<T>
  - setUseStickyHeader
```
public void setUseStickyHeader(boolean stickyHeader)
```
    Description copied from interface: ViewSettings
    
    Enable the use of sticky table header bar.
    
    Specified by:
    
    setUseStickyHeader in interface ViewSettings
  - isUseStickyHeader
```
public boolean isUseStickyHeader()
```
    Description copied from interface: ViewSettings
    
    True if we are using sticky table header.
    
    Specified by:
    
    isUseStickyHeader in interface ViewSettings
  - selectAllRows
```
public void selectAllRows(boolean select)
```
    Description copied from interface: HasRows
    
    Select or deselect all rows.
    
    Specified by:
    
    selectAllRows in interface HasRows<T>
    
    Parameters:
    
    select - true will select, false with deselect
  - selectAllRows
```
public void selectAllRows(boolean select,
                          boolean fireEvent)
```
    Description copied from interface: HasRows
    
    Select or deselect all rows.
    
    Specified by:
    
    selectAllRows in interface HasRows<T>
    
    Parameters:
    
    select - true will select, false with deselect
    
    fireEvent - fire the '' event.
  - toggleRowSelect
```
public void toggleRowSelect(gwt.material.design.jquery.client.api.Event event,
                            com.google.gwt.dom.client.Element row)
```
    Select a row by given element.
    
    Parameters:
    
    event - sourced even (can be null)
    
    row - element of the row selection
  - toggleRowSelect
```
public void toggleRowSelect(gwt.material.design.jquery.client.api.Event event,
                            com.google.gwt.dom.client.Element row,
                            boolean fireEvent)
```
    Select a row by given element.
    
    Parameters:
    
    event - sourced even (can be null)
    
    row - element of the row selection
    
    fireEvent - fire the row select event.
  - selectRow
```
public void selectRow(com.google.gwt.dom.client.Element row,
                      boolean fireEvent)
```
    Description copied from interface: HasRows
    
    Select a given row.
    
    Specified by:
    
    selectRow in interface HasRows<T>
  - deselectRow
```
public void deselectRow(com.google.gwt.dom.client.Element row,
                        boolean fireEvent)
```
    Description copied from interface: HasRows
    
    Unselect a selected row.
    
    Specified by:
    
    deselectRow in interface HasRows<T>
  - hasDeselectedRows
```
public boolean hasDeselectedRows(boolean visibleOnly)
```
    Description copied from interface: HasRows
    
    Does this view have unselected rows.
    
    Specified by:
    
    hasDeselectedRows in interface HasRows<T>
    
    Parameters:
    
    visibleOnly - should we restrict this check to visible rows only.
    
    Returns:
    
    true if there are unselected rows in this view.
  - hasSelectedRows
```
public boolean hasSelectedRows(boolean visibleOnly)
```
    Description copied from interface: HasRows
    
    Does this view have selected rows.
    
    Specified by:
    
    hasSelectedRows in interface HasRows<T>
    
    Parameters:
    
    visibleOnly - should we restrict this check to visible rows only.
    
    Returns:
    
    true if there are selected rows in this view.
  - 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>
    
    Parameters:
    
    visibleOnly - should we restrict this check to visible rows only.
    
    Returns:
    
    list of the currently selected row models.
  - setRowData
```
public void setRowData(int start,
                       List<? extends T> values)
```
    Description copied from interface: HasRows
    
    Set values associated with the rows in the visible range.
    
    Specified by:
    
    setRowData in interface HasRows<T>
    
    Parameters:
    
    start - the start index of the data
    
    values - the values within the range
  - maybeApplyAutoSortColumn
```
protected boolean maybeApplyAutoSortColumn()
```
    Check and apply the auto sort column Column.setAutoSort(boolean) if no sort has been invoked.
    
    Returns:
    
    true if the auto sort column is assigned.
  - getAutoSortColumn
```
protected Column<T,?> getAutoSortColumn()
```
    Get the auto sorting column, or null if no column is auto sorting.
  - getCategoryFactory
```
public ComponentFactory<? extends CategoryComponent,String> getCategoryFactory()
```
  - buildRowComponent
```
protected RowComponent<T> buildRowComponent(T data)
```
  - buildCategoryComponent
```
protected CategoryComponent buildCategoryComponent(RowComponent<T> row)
```
  - buildCategoryComponent
```
protected CategoryComponent buildCategoryComponent(String categoryName)
```
  - getValueKey
```
public Object getValueKey(T value)
```
    Get the key for the specified value. If a keyProvider is not specified or the value is null, the value is returned. If the key provider is specified, it is used to get the key from the value.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the key
  - getKeyProvider
```
public com.google.gwt.view.client.ProvidesKey<T> getKeyProvider()
```
    Specified by:
    
    getKeyProvider in interface com.google.gwt.view.client.HasKeyProvider<T>
  - getVisibleItemCount
```
public int getVisibleItemCount()
```
    Description copied from interface: DataView
    
    Get the visible item count of the data view.
    
    Specified by:
    
    getVisibleItemCount in interface DataView<T>
  - getRowHeight
```
public int getRowHeight()
```
    Description copied from interface: HasRows
    
    Get the maximum row height.
    
    Specified by:
    
    getRowHeight in interface HasRows<T>
  - 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>
  - getCalculatedRowHeight
```
protected int getCalculatedRowHeight()
```
  - addCategory
```
public void addCategory(String category)
```
    Description copied from interface: HasCategories
    
    Explicitly add a category, which will be drawn to the table. If the category already exists then it will be ignored.
    
    Specified by:
    
    addCategory in interface HasCategories
    
    Parameters:
    
    category - The category name.
  - 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
    
    Parameters:
    
    category - The category data defined.
  - renderCategory
```
protected void renderCategory(CategoryComponent category)
```
  - hasCategory
```
public boolean hasCategory(String categoryName)
```
    Description copied from interface: HasCategories
    
    Has this data view got an existing CategoryComponent with given name.
    
    Specified by:
    
    hasCategory in interface HasCategories
  - disableCategory
```
public void disableCategory(String categoryName)
```
    Description copied from interface: HasCategories
    
    Disable a data view category.
    
    Specified by:
    
    disableCategory in interface HasCategories
  - enableCategory
```
public void enableCategory(String categoryName)
```
    Description copied from interface: HasCategories
    
    Enable a data view category.
    
    Specified by:
    
    enableCategory in interface HasCategories
  - getCategories
```
public List<CategoryComponent> getCategories()
```
    Description copied from interface: HasCategories
    
    Get all registered category components.
    
    Specified by:
    
    getCategories in interface HasCategories
  - getOpenCategories
```
public List<CategoryComponent> getOpenCategories()
```
    Description copied from interface: HasCategories
    
    Get all the open CategoryComponent's or null if categories are disabled.
    
    Specified by:
    
    getOpenCategories in interface HasCategories
  - isCategoryEmpty
```
public boolean isCategoryEmpty(CategoryComponent category)
```
    Description copied from interface: HasCategories
    
    Check if a category has data to provide.
    
    Specified by:
    
    isCategoryEmpty in interface HasCategories
  - getSortContext
```
public SortContext<T> getSortContext()
```
    Description copied from interface: DataView
    
    Get the data views current sort context, or null if no sort context is applied.
    
    Specified by:
    
    getSortContext in interface DataView<T>
  - isRedraw
```
public boolean isRedraw()
```
    Description copied from interface: DataView
    
    Is redrawing the data view.
    
    Specified by:
    
    isRedraw in interface DataView<T>
  - setRedraw
```
public void setRedraw(boolean redraw)
```
    Description copied from interface: DataView
    
    Set redraw data view elements.
    
    Specified by:
    
    setRedraw in interface DataView<T>
  - updateRow
```
public void updateRow(T model)
```
    Description copied from interface: HasRows
    
    Update a models row within the table.
    
    Specified by:
    
    updateRow in interface HasRows<T>
    
    Parameters:
    
    model - a model with a valid equals method.
  - getRow
```
public RowComponent<T> getRow(T model)
```
    Description copied from interface: HasRows
    
    Get a row by its representing model.
    
    Specified by:
    
    getRow in interface HasRows<T>
    
    Parameters:
    
    model - the model assigned to a row.
  - getRow
```
public RowComponent<T> getRow(int index)
```
    Description copied from interface: HasRows
    
    Get a row by its rendered index.
    
    Specified by:
    
    getRow in interface HasRows<T>
    
    Parameters:
    
    index - the value of the render index.
  - getRowByModel
```
public RowComponent<T> getRowByModel(T model)
```
    Description copied from interface: HasRows
    
    Get a models RowComponent or null if not found.
    
    Specified by:
    
    getRowByModel in interface HasRows<T>
    
    Parameters:
    
    model - a model with a valid equals method.
    
    Returns:
    
    the models representing RowComponent.
  - getRowIndexByElement
```
protected int getRowIndexByElement(com.google.gwt.dom.client.Element rowElement)
```
  - getRowElementByModel
```
protected com.google.gwt.dom.client.Element getRowElementByModel(T model)
```
  - getModelByRowElement
```
protected T getModelByRowElement(com.google.gwt.dom.client.Element rowElement)
```
  - getModelsByRowElements
```
protected List<T> getModelsByRowElements(List<com.google.gwt.dom.client.Element> rowElements)
```
  - getRowsByCategory
```
protected List<RowComponent<T>> getRowsByCategory(Components<RowComponent<T>> rows,
                                                  CategoryComponent category)
```
  - getHiddenCategories
```
protected List<CategoryComponent> getHiddenCategories()
```
  - getVisibleCategories
```
protected List<CategoryComponent> getVisibleCategories()
```
  - getPassedCategories
```
protected List<CategoryComponent> getPassedCategories()
```
  - setRowFactory
```
public void setRowFactory(RowComponentFactory<T> rowFactory)
```
    Description copied from interface: HasRows
    
    Set your own custom RowComponentFactory to generate your row components.
    
    Specified by:
    
    setRowFactory in interface HasRows<T>
  - getRowFactory
```
public RowComponentFactory<T> getRowFactory()
```
    Description copied from interface: HasRows
    
    Get the views row factory.
    
    Specified by:
    
    getRowFactory in interface HasRows<T>
  - setCategoryFactory
```
public void setCategoryFactory(ComponentFactory<? extends CategoryComponent,String> categoryFactory)
```
    Description copied from interface: HasCategories
    
    Set your own custom CategoryComponentFactory to generate your categories.
    
    Specified by:
    
    setCategoryFactory in interface HasCategories
  - setLoadMask
```
public void setLoadMask(boolean loadMask)
```
    Description copied from interface: DataView
    
    Set the data views loading mask.
    
    Specified by:
    
    setLoadMask in interface DataView<T>
  - isLoadMask
```
public boolean isLoadMask()
```
    Description copied from interface: DataView
    
    Is the data views loading mask applied.
    
    Specified by:
    
    isLoadMask in interface DataView<T>
  - getProgressWidget
```
public gwt.material.design.client.ui.MaterialProgress getProgressWidget()
```
    Description copied from interface: DataView
    
    Get the data views progress widget.
    
    Specified by:
    
    getProgressWidget in interface DataView<T>
  - getTotalRows
```
public int getTotalRows()
```
    Description copied from interface: HasRows
    
    Get the configured total rows count.
    
    Specified by:
    
    getTotalRows in interface HasRows<T>
  - setTotalRows
```
public void setTotalRows(int totalRows)
```
    Description copied from interface: HasRows
    
    Set the total row count.
    
    Specified by:
    
    setTotalRows in interface HasRows<T>
  - isUseCategories
```
public boolean isUseCategories()
```
    Description copied from interface: ViewSettings
    
    Is the data view using categories where possible.
    
    Specified by:
    
    isUseCategories in interface ViewSettings
  - setUseCategories
```
public void setUseCategories(boolean useCategories)
```
    Description copied from interface: ViewSettings
    
    Allow the data view to generate categories, or use added categories for row data.
    
    Specified by:
    
    setUseCategories in interface ViewSettings
  - isUseLoadOverlay
```
public boolean isUseLoadOverlay()
```
    Description copied from interface: ViewSettings
    
    Is the data view using loading overlay mask.
    
    Specified by:
    
    isUseLoadOverlay in interface ViewSettings
  - setUseLoadOverlay
```
public void setUseLoadOverlay(boolean useLoadOverlay)
```
    Description copied from interface: ViewSettings
    
    Use the loading overlay mask.
    
    Specified by:
    
    setUseLoadOverlay in interface ViewSettings
  - isUseRowExpansion
```
public boolean isUseRowExpansion()
```
    Description copied from interface: ViewSettings
    
    Is the data view using row expansion.
    
    Specified by:
    
    isUseRowExpansion in interface ViewSettings
  - setUseRowExpansion
```
public void setUseRowExpansion(boolean useRowExpansion)
```
    Description copied from interface: ViewSettings
    
    Use row expansion functionality, giving the user a way to expand rows for extra information.
    
    Specified by:
    
    setUseRowExpansion in interface ViewSettings
  - getLongPressDuration
```
public int getLongPressDuration()
```
    Description copied from interface: ViewSettings
    
    Get the long press duration requirement.
    
    Specified by:
    
    getLongPressDuration in interface ViewSettings
  - setLongPressDuration
```
public void setLongPressDuration(int longPressDuration)
```
    Description copied from interface: ViewSettings
    
    Set the long press duration requirement.
    
    Specified by:
    
    setLongPressDuration in interface ViewSettings
  - 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>
  - getContainer
```
public com.google.gwt.user.client.ui.Widget getContainer()
```
    Description copied from interface: DataView
    
    Get the displays main container.
    
    Specified by:
    
    getContainer in interface DataView<T>
  - getId
```
public String getId()
```
    Description copied from interface: DataView
    
    Get the data views id.
    
    Specified by:
    
    getId in interface DataView<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>
  - fireEvent
```
public final void fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)
```
    Specified by:
    
    fireEvent in interface com.google.gwt.event.shared.HasHandlers
  - bindCategoryEvents
```
protected TableSubHeader bindCategoryEvents(TableSubHeader category)
```
  - updateCheckAllInputState
```
public void updateCheckAllInputState()
```
  - updateCheckAllInputState
```
protected void updateCheckAllInputState(gwt.material.design.jquery.client.api.JQueryElement input)
```
  - getRows
```
public List<RowComponent<T>> getRows()
```
    Description copied from interface: HasRows
    
    Get all data views RowComponent's.
    
    Specified by:
    
    getRows in interface HasRows<T>
  - getData
```
protected List<T> getData()
```
  - getCategory
```
public CategoryComponent getCategory(String name)
```
    Get a stored data category by name.
    
    Specified by:
    
    getCategory in interface HasCategories
    
    Parameters:
    
    name - name of the category component.
  - getOrphansCategory
```
protected CategoryComponent.OrphanCategoryComponent getOrphansCategory()
```
    Get the CategoryComponent.OrphanCategoryComponent for orphan rows.
  - getCategoryHeight
```
public int getCategoryHeight()
```
  - openCategory
```
public void openCategory(String categoryName)
```
    Description copied from interface: HasCategories
    
    Open an existing Category.
    
    Specified by:
    
    openCategory in interface HasCategories
  - openCategory
```
public void openCategory(CategoryComponent category)
```
    Description copied from interface: HasCategories
    
    Open an existing Category.
    
    Specified by:
    
    openCategory in interface HasCategories
  - closeCategory
```
public void closeCategory(String categoryName)
```
    Description copied from interface: HasCategories
    
    Close an existing Category.
    
    Specified by:
    
    closeCategory in interface HasCategories
  - closeCategory
```
public void closeCategory(CategoryComponent category)
```
    Description copied from interface: HasCategories
    
    Close an existing Category.
    
    Specified by:
    
    closeCategory in interface HasCategories
  - getTableSubHeader
```
protected TableSubHeader getTableSubHeader(String name)
```
    Get a stored data categories subheader by name.
  - getTableSubHeader
```
protected TableSubHeader getTableSubHeader(gwt.material.design.jquery.client.api.JQueryElement elem)
```
    Get a stored data categories subheader by jquery element.
  - clearExpansions
```
protected void clearExpansions()
```
  - clearRows
```
public void clearRows(boolean clearData)
```
    Description copied from interface: HasRows
    
    Clear data rows.
    
    Specified by:
    
    clearRows in interface HasRows<T>
    
    Parameters:
    
    clearData - should we also clear the stored data.
  - clearCategories
```
public void clearCategories()
```
    Description copied from interface: HasCategories
    
    Clear all categories.
    
    Specified by:
    
    clearCategories in interface HasCategories
  - clearRowsAndCategories
```
public void clearRowsAndCategories(boolean clearData)
```
    Description copied from interface: HasCategories
    
    Clear all rows and categories.
    
    Specified by:
    
    clearRowsAndCategories in interface HasCategories
    
    Parameters:
    
    clearData - should we also clear the stored data.
  - getHeaders
```
public List<TableHeader> getHeaders()
```
    Description copied from interface: DataView
    
    Get the list of rendered header widgets.
    
    Specified by:
    
    getHeaders in interface DataView<T>
  - addHeader
```
protected void addHeader(int index,
                         TableHeader header)
```
  - removeHeader
```
protected void removeHeader(int index)
```
  - getCategoryRowCount
```
protected int getCategoryRowCount(String category)
```
  - setRedrawCategories
```
protected void setRedrawCategories(boolean redrawCategories)
```
  - setHeight
```
public void setHeight(String height)
```
    Description copied from interface: ViewSettings
    
    Set the table body height.
    
    Specified by:
    
    setHeight in interface ViewSettings
  - getHeight
```
public String getHeight()
```
    Description copied from interface: ViewSettings
    
    Get the table body height.
    
    Specified by:
    
    getHeight in interface ViewSettings
  - isShiftDown
```
public boolean isShiftDown()
```

Class AbstractDataView<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

display

dataSource

renderer

sortContext

autoSortColumn

rowFactory

categoryFactory

keyProvider

subheaderLib

categoryHeight

height

rendering

redraw

redrawCategories

table

thead

tbody

progressWidget

headerRow

container

$table

maskElement

tableBody

topPanel

range

totalRows

longPressDuration

rows

pendingRows

categories

columns

headers

attachHandler

ORPHAN_PATTERN

maskHtml

transitionEvents

Constructor Detail

AbstractDataView

AbstractDataView

AbstractDataView

AbstractDataView

Method Detail

onConstructed

render

renderRows

renderComponent

renderColumns

renderColumn

refresh

setRenderer

getRenderer

setDataSource

getDataSource

getSubheaderLib

setup

onSetup

destroy

prepareRows

setupStickyHeader

setupSubHeaders

isWithinView

isWithinView

getRowCount

getVisibleRange

setVisibleRange

setVisibleRange

setVisibleRange

isHeaderVisible

addColumn

addColumn

insertColumn

updateSortContext

updateSortContext