com.extjs.gxt.ui.client.data
Class BaseRemoteSortTreeLoader<M extends ModelData>

java.lang.Object
  com.extjs.gxt.ui.client.event.BaseObservable
      com.extjs.gxt.ui.client.data.BaseLoader<java.util.List<M>>
          com.extjs.gxt.ui.client.data.BaseTreeLoader<M>
              com.extjs.gxt.ui.client.data.BaseRemoteSortTreeLoader<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

Loader<java.util.List<M>>, RemoteSortTreeLoader<M>, TreeLoader<M>, Observable

public class BaseRemoteSortTreeLoader<M extends ModelData>
extends BaseTreeLoader<M>
implements RemoteSortTreeLoader<M>

Default implementation of the RemoteSortTreeLoader interface.

Field Summary

Fields inherited from class com.extjs.gxt.ui.client.data.BaseTreeLoader

children

Fields inherited from class com.extjs.gxt.ui.client.data.BaseLoader

lastConfig, proxy, reader, reuseConfig

Fields inherited from interface com.extjs.gxt.ui.client.data.Loader

BeforeLoad, Load, LoadException

Constructor Summary

BaseRemoteSortTreeLoader(DataProxy proxy)

BaseRemoteSortTreeLoader(DataProxy proxy, DataReader reader)

BaseRemoteSortTreeLoader(DataReader reader)

Method Summary

Style.SortDir	getSortDir() Returns the current sort direction.
java.lang.String	getSortField() Returns the current sort field.
boolean	isRemoteSort() Returns true if remote sorting is enabled.
boolean	loadChildren(M parent) Initiates a load request for the parent's children.
protected java.lang.Object	newLoadConfig() Template method to allow custom BaseLoader subclasses to provide their own implementation of LoadConfig
protected void	onLoadFailure(java.lang.Object loadConfig, java.lang.Throwable t) Called when a load operation fails.
protected void	onLoadSuccess(java.lang.Object loadConfig, java.util.List<M> result) Called when the remote data has been received.
protected java.lang.Object	prepareLoadConfig(java.lang.Object config) Template method to allow custom subclasses to prepare the load config prior to loading data
void	setRemoteSort(boolean remoteSort) Sets the remote sort state.
void	setSortDir(Style.SortDir sortDir) Sets the current sort direction.
void	setSortField(java.lang.String sortField) Sets the current sort field.

Methods inherited from class com.extjs.gxt.ui.client.data.BaseTreeLoader

hasChildren, loadData

Methods inherited from class com.extjs.gxt.ui.client.data.BaseLoader

addLoadListener, getLastConfig, getProxy, isReuseLoadConfig, load, load, loadData, removeLoadListener, setReuseLoadConfig

Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable

addListener, callListener, fireEvent, fireEvent, getFiresEvents, getListeners, hasActiveEvent, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.extjs.gxt.ui.client.data.TreeLoader

hasChildren

Methods inherited from interface com.extjs.gxt.ui.client.data.Loader

addLoadListener, load, load, removeLoadListener

Methods inherited from interface com.extjs.gxt.ui.client.event.Observable

addListener, fireEvent, getListeners, hasListeners, hasListeners, removeAllListeners, removeListener

Constructor Detail

BaseRemoteSortTreeLoader

public BaseRemoteSortTreeLoader(DataProxy proxy)

BaseRemoteSortTreeLoader

public BaseRemoteSortTreeLoader(DataProxy proxy,
                                DataReader reader)

BaseRemoteSortTreeLoader

public BaseRemoteSortTreeLoader(DataReader reader)

Method Detail

getSortDir

public Style.SortDir getSortDir()

Description copied from interface: RemoteSortTreeLoader

Returns the current sort direction.

Specified by:

getSortDir in interface RemoteSortTreeLoader<M extends ModelData>

Returns:

the sort direction

getSortField

public java.lang.String getSortField()

Description copied from interface: RemoteSortTreeLoader

Returns the current sort field.

Specified by:

getSortField in interface RemoteSortTreeLoader<M extends ModelData>

Returns:

the sort field

isRemoteSort

public boolean isRemoteSort()

Description copied from interface: RemoteSortTreeLoader

Returns true if remote sorting is enabled.

Specified by:

isRemoteSort in interface RemoteSortTreeLoader<M extends ModelData>

Returns:

the remote sort state

loadChildren

public boolean loadChildren(M parent)

Description copied from interface: TreeLoader

Initiates a load request for the parent's children.

Specified by:

loadChildren in interface TreeLoader<M extends ModelData>

Overrides:

loadChildren in class BaseTreeLoader<M extends ModelData>

Parameters:

parent - the parent

Returns:

true if the load was requested

newLoadConfig

protected java.lang.Object newLoadConfig()

Description copied from class: BaseLoader

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

Overrides:

newLoadConfig in class BaseLoader<java.util.List<M extends ModelData>>

onLoadFailure

protected void onLoadFailure(java.lang.Object loadConfig,
                             java.lang.Throwable t)

Description copied from class: BaseLoader

Called when a load operation fails.

Overrides:

onLoadFailure in class BaseTreeLoader<M extends ModelData>

Parameters:

loadConfig - the load config

t - the exception

onLoadSuccess

protected void onLoadSuccess(java.lang.Object loadConfig,
                             java.util.List<M> result)

Description copied from class: BaseLoader

Called when the remote data has been received.

Overrides:

onLoadSuccess in class BaseTreeLoader<M extends ModelData>

Parameters:

loadConfig - the load config

result - data

prepareLoadConfig

protected java.lang.Object prepareLoadConfig(java.lang.Object config)

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

Overrides:

prepareLoadConfig in class BaseLoader<java.util.List<M extends ModelData>>

setRemoteSort

public void setRemoteSort(boolean remoteSort)

Description copied from interface: RemoteSortTreeLoader

Sets the remote sort state.

Specified by:

setRemoteSort in interface RemoteSortTreeLoader<M extends ModelData>

Parameters:

remoteSort - true for remote sort, false for local sorting

setSortDir

public void setSortDir(Style.SortDir sortDir)

Description copied from interface: RemoteSortTreeLoader

Sets the current sort direction.

Specified by:

setSortDir in interface RemoteSortTreeLoader<M extends ModelData>

Parameters:

sortDir - the sort direction

setSortField

public void setSortField(java.lang.String sortField)

Description copied from interface: RemoteSortTreeLoader

Sets the current sort field.

Specified by:

setSortField in interface RemoteSortTreeLoader<M extends ModelData>

Parameters:

sortField - the sort field