com.smartgwt.client.docs

Interface RowRangeDisplay

public interface RowRangeDisplay

Grid row-range and row-count display

ListGrids are able to create a specialized label that will display the currently visible range of rows in the viewport along with a total row count for the current data set.

When progressive loading is active, the reported row count for list grid's data may not accurately reflect the true number of rows in the data set.

See RowCountStatus for more details. Note that for custom dataSources where progressive loading is active, the DSResponse.estimatedTotalRows may be used to explictly provide either an estimated or exact row count for the data set (distinct from the reported DSResponse.totalRows.

When the true size of the data set is not known, the rowRangeDisplay will format the reported length in a way that indicates it is not an exact count (see ListGrid.getFormattedRowCount()). If ListGrid.autoFetchRowCount is set to true, a separate row count fetch will be intiated as soon as data arrives, so an accurate row count will be displayed as soon as that fetch completes. Alternatively, if ListGrid.canRequestRowCount is set to true, the user may click the label to issue a row count fetch request and get back an accurate row count to display to the user.

As an alternative to using the rowRangeDisplay autoChild, developers may also make use of various list grid APIs such as ListGrid.getRowCountStatus(), ListGrid.getRowCount(), ListGrid.getRowRangeDisplayValue() and ListGrid.fetchRowCount() to directly display or retrieve row counts.

See Also:

RowCountStatus, RowRangeDisplayStyle, ResultSet.getRowCountStatus(), ResultSet.getRowCount(), ResultSet.getRowCountRange(), ResultSet.fetchRowCount(), ListGrid.getRowRangeDisplay(), ListGrid.getRowRangeDisplayValue(), ListGrid.getFormattedRowCount(), ListGrid.getRowCount(), ListGrid.getRowCountRange(), ListGrid.getRowCountStatus(), ListGrid.fetchRowCount(), RowRangeDisplay.setSourceGrid(com.smartgwt.client.widgets.grid.ListGrid), RowRangeDisplay, ResultSet.getApplyRowCountToLength(), ResultSet.getRowCountOperation(), ResultSet.getRowCountContext(), ResultSet.getBlockingRowCountFetch(), ListGrid.getRowRangeDisplay(), ListGrid.getCanRequestRowCount(), ListGrid.getApplyRowCountToLength(), ListGrid.getBlockingRowCountFetch(), ListGrid.getRowRangeDisplayStyle(), ListGrid.getLoadingRowCountDisplayIcon(), ListGrid.getLoadingRowCountDisplayIconWidth(), ListGrid.getLoadingRowCountDisplayIcoHeight(), ListGrid.getExactRowCountFormat(), ListGrid.getMinimumRowCountFormat(), ListGrid.getApproximateRowCountFormat(), ListGrid.getMaximumRowCountFormat(), ListGrid.getRangeRowCountFormat(), ListGrid.getRowCountDisplayPrecision(), RowRangeDisplay.getWrap(), RowRangeDisplay.getAlign(), RowRangeDisplay.getVlign(), RowRangeDisplay.getSourceGrid(), RowRangeDisplay.getCanRequestRowCount(), RowRangeDisplay.getInteractiveStyleName()