com.sencha.gxt.widget.core.client.grid

Class LiveGridView<M>

java.lang.Object

com.sencha.gxt.widget.core.client.grid.GridView<M>

com.sencha.gxt.widget.core.client.grid.LiveGridView<M>

public class LiveGridView<M>
extends GridView<M>

LiveGridView for displaying large amount of data. Data is loaded on demand as the user scrolls the grid.

Constructor Summary

Constructors

Constructor and Description
LiveGridView()

Method Summary

Methods

Modifier and Type	Method and Description
int	getCacheSize() Returns the numbers of rows that should be cached.
int	getLoadDelay() Returns the amount of time before loading is done.
double	getPrefetchFactor() Returns the prefetchFactor.
int	getRowHeight() Returns the height of one row.
int	getVisibleRowCount()
void	refresh() Refreshed the view.
void	refresh(boolean headerToo) Rebuilds the grid using its current configuration and data.
void	scrollToTop() Scrolls the grid to the top.
void	setCacheSize(int cacheSize) Sets the amount of rows that should be cached (default to 200).
void	setLoadDelay(int loadDelay) Sets the amount of time before loading is done (defaults to 200).
void	setPrefetchFactor(double prefetchFactor) Sets the pre-fetch factor (defaults to .2).
void	setRowHeight(int rowHeight) Sets the height of one row (defaults to 20).

Methods inherited from class com.sencha.gxt.widget.core.client.grid.GridView

ensureVisible, findCell, findCellIndex, findRow, findRowIndex, focusCell, focusRow, getAutoExpandColumn, getAutoExpandMax, getAutoExpandMin, getBody, getCell, getCellSelectorDepth, getEditorParent, getEmptyText, getHeader, getHeaderCell, getInnerCellElement, getRow, getRow, getRowSelectorDepth, getScroller, getScrollState, getViewConfig, isAdjustForHScroll, isAutoFill, isForceFit, isSelectableTarget, isShowDirtyCells, isSortingEnabled, layout, setAdjustForHScroll, setAutoExpandColumn, setAutoExpandMax, setAutoExpandMin, setAutoFill, setCellSelectorDepth, setEmptyText, setForceFit, setRowSelectorDepth, setShowDirtyCells, setSortingEnabled, setViewConfig

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LiveGridView

public LiveGridView()

Method Detail

getCacheSize

public int getCacheSize()

Returns the numbers of rows that should be cached.

Returns:

the cache size

getLoadDelay

public int getLoadDelay()

Returns the amount of time before loading is done.

Returns:

the load delay in milliseconds

getPrefetchFactor

public double getPrefetchFactor()

Returns the prefetchFactor.

Returns:

the prefetchFactor

getRowHeight

public int getRowHeight()

Returns the height of one row.

Returns:

the height of one row

getVisibleRowCount

public int getVisibleRowCount()

refresh

public void refresh()

Refreshed the view. Reloads the store based on the current settings

refresh

public void refresh(boolean headerToo)

Description copied from class: GridView

Rebuilds the grid using its current configuration and data.

Overrides:

refresh in class GridView<M>

Parameters:

headerToo - true to refresh the header

scrollToTop

public void scrollToTop()

Description copied from class: GridView

Scrolls the grid to the top.

Overrides:

scrollToTop in class GridView<M>

setCacheSize

public void setCacheSize(int cacheSize)

Sets the amount of rows that should be cached (default to 200). The cache size is the number of rows that are retrieved each time a data request is made. The cache size should always be greater than the number of visible rows of the grid. The number of visible rows will vary depending on the grid height and the height of each row. If the set cache size is smaller than the number of visible rows of the grid than it gets set to the number of visible rows of the grid.

Parameters:

cacheSize - the new cache size

setLoadDelay

public void setLoadDelay(int loadDelay)

Sets the amount of time before loading is done (defaults to 200).

Parameters:

loadDelay - the new load delay in milliseconds

setPrefetchFactor

public void setPrefetchFactor(double prefetchFactor)

Sets the pre-fetch factor (defaults to .2). The pre-fetch factor is used to determine when new data should be fetched as the user scrolls the grid. The factor is used with the cache size.

For example, if the cache size is 1000 with a pre-fetch of .20, the grid will request new data when the 800th (1000 * .20) row of the grid becomes visible.

Parameters:

prefetchFactor - the pre-fetch factor

setRowHeight

public void setRowHeight(int rowHeight)

Sets the height of one row (defaults to 20). LiveGridView will only work with fixed row heights with all rows being the same height. Changing this value will not physically resize the row heights, rather, the specified height will be used internally for calculations.

Parameters:

rowHeight - the new row height.