com.sencha.gxt.data.shared.loader

Class PagingLoader<C extends PagingLoadConfig,D extends PagingLoadResult<?>>

java.lang.Object

com.sencha.gxt.data.shared.loader.Loader<C,D>

com.sencha.gxt.data.shared.loader.ListLoader<C,D>

com.sencha.gxt.data.shared.loader.PagingLoader<C,D>

Type Parameters:

C - the type of data for the input object

D - the type of data to be returned by the loader

All Implemented Interfaces:

BeforeLoadEvent.HasBeforeLoadHandlers<C>, LoaderHandler.HasLoaderHandlers<C,D>, LoadExceptionEvent.HasLoadExceptionHandlers<C>, LoadHandler.HasLoadHandlers<C,D>

public class PagingLoader<C extends PagingLoadConfig,D extends PagingLoadResult<?>>
extends ListLoader<C,D>

A ListLoader subclass which adds support for paged data (offset, limit, and total count).

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.data.shared.loader.Loader

Loader.WrapperProxy<M,C,T>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	limit
protected int	offset
protected int	totalCount

Fields inherited from class com.sencha.gxt.data.shared.loader.ListLoader

remoteSort, sortInfo

Fields inherited from class com.sencha.gxt.data.shared.loader.Loader

eventBus, lastLoadConfig, proxy, reuseLoadConfig

Constructor Summary

Constructors

Constructor and Description
PagingLoader(DataProxy<C,D> proxy) Creates a new paging loader instance.
PagingLoader(DataProxy<C,T> proxy, DataReader<D,T> reader) Creates a new paging loader instance.

Method Summary

Modifier and Type	Method and Description
int	getLimit() Returns the current limit.
int	getOffset() Returns the offset of the first record.
int	getTotalCount() Returns the total number of models in the dataset as returned by the server.
void	load(int offset, int limit) Loads the data using the specified configuration.
protected C	newLoadConfig() Template method to allow custom BaseLoader subclasses to provide their own implementation of LoadConfig
protected void	onLoadSuccess(C loadConfig, D result) Called when the remote data has been received.
protected C	prepareLoadConfig(C config) Template method to allow custom subclasses to prepare the load config prior to loading data
void	setLimit(int limit) Sets the limit size.
void	setOffset(int offset) Sets the offset.
void	useLoadConfig(C loadConfig) Use the specified LoadConfig for all load calls, Loader.setReuseLoadConfig(boolean) will be set to true.

Methods inherited from class com.sencha.gxt.data.shared.loader.ListLoader

addSortInfo, addSortInfo, clearSortInfo, getSortInfo, isRemoteSort, removeSortInfo, setRemoteSort

Methods inherited from class com.sencha.gxt.data.shared.loader.Loader

addBeforeLoadHandler, addHandler, addLoaderHandler, addLoadExceptionHandler, addLoadHandler, fireEvent, getLastLoadConfig, getProxy, isReuseLoadConfig, load, load, loadData, loadData, onLoadFailure, setLastLoadConfig, setReuseLoadConfig

Methods inherited from class java.lang.Object

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

Field Detail

offset

protected int offset

limit

protected int limit

totalCount

protected int totalCount

Constructor Detail

PagingLoader

public PagingLoader(DataProxy<C,D> proxy)

Creates a new paging loader instance.

Parameters:

proxy - the data proxy

PagingLoader

public PagingLoader(DataProxy<C,T> proxy,
                    DataReader<D,T> reader)

Creates a new paging loader instance.

Type Parameters:

T - the type of data being proxied

Parameters:

proxy - the data proxy

reader - the data reader

Method Detail

getLimit

public int getLimit()

Returns the current limit.

Returns:

the current limit

getOffset

public int getOffset()

Returns the offset of the first record.

Returns:

the current offset

getTotalCount

public int getTotalCount()

Returns the total number of models in the dataset as returned by the server.

Returns:

the number of models as passed from the server

load

public void load(int offset,
                 int limit)

Loads the data using the specified configuration.

Parameters:

offset - the offset of the first record to return

limit - the page size

setLimit

public void setLimit(int limit)

Sets the limit size.

Parameters:

limit - the limit

setOffset

public void setOffset(int offset)

Sets the offset.

Parameters:

offset - the offset

useLoadConfig

public void useLoadConfig(C loadConfig)

Use the specified LoadConfig for all load calls, Loader.setReuseLoadConfig(boolean) will be set to true.

Overrides:

useLoadConfig in class ListLoader<C extends PagingLoadConfig,D extends PagingLoadResult<?>>

Parameters:

loadConfig - the load config

newLoadConfig

protected C newLoadConfig()

Description copied from class: ListLoader

Template method to allow custom BaseLoader subclasses to provide their own implementation of LoadConfig

Overrides:

newLoadConfig in class ListLoader<C extends PagingLoadConfig,D extends PagingLoadResult<?>>

onLoadSuccess

protected void onLoadSuccess(C loadConfig,
                             D result)

Called when the remote data has been received.

Any subclass that overrides onLoadSuccess should call super.onLoadSuccess with the result to make sure the loader and the result have consistent data.

Overrides:

onLoadSuccess in class Loader<C extends PagingLoadConfig,D extends PagingLoadResult<?>>

Parameters:

loadConfig - the load config

result - data

prepareLoadConfig

protected C prepareLoadConfig(C config)

Description copied from class: ListLoader

Template method to allow custom subclasses to prepare the load config prior to loading data

Overrides:

prepareLoadConfig in class ListLoader<C extends PagingLoadConfig,D extends PagingLoadResult<?>>