com.sencha.gxt.data.shared.loader

Class TreeLoader<M>

java.lang.Object

com.sencha.gxt.data.shared.loader.Loader<M,List<M>>

com.sencha.gxt.data.shared.loader.TreeLoader<M>

Type Parameters:

M - the model data type

All Implemented Interfaces:

BeforeLoadEvent.HasBeforeLoadHandlers<M>, LoaderHandler.HasLoaderHandlers<M,List<M>>, LoadExceptionEvent.HasLoadExceptionHandlers<M>, LoadHandler.HasLoadHandlers<M,List<M>>

public class TreeLoader<M>
extends Loader<M,List<M>>

Default implementation of the TreeLoader interface.

Events:

BeforeLoadEvent

LoadEvent

LoadExceptionEvent

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 Set<M>	children

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

eventBus, lastLoadConfig, proxy, reuseLoadConfig

Constructor Summary

Constructors

Constructor and Description
TreeLoader(DataProxy<M,List<M>> proxy) Creates a new tree loader instance.
TreeLoader(DataProxy<M,T> proxy, DataReader<List<M>,T> reader) Creates a new tree loader instance.

Method Summary

Modifier and Type	Method and Description
boolean	hasChildren(M parent) Returns true if the model has children.
boolean	loadChildren(M parent) Initiates a load request for the parent's children.
protected void	onLoadFailure(M loadConfig, Throwable t) Called when a load operation fails.
protected void	onLoadSuccess(M loadConfig, List<M> result) Called when the remote data has been received.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

children

protected Set<M> children

Constructor Detail

TreeLoader

public TreeLoader(DataProxy<M,List<M>> proxy)

Creates a new tree loader instance.

Parameters:

proxy - the data reader

TreeLoader

public TreeLoader(DataProxy<M,T> proxy,
                  DataReader<List<M>,T> reader)

Creates a new tree loader instance.

Type Parameters:

T - the type of data being proxied

Parameters:

proxy - the data proxy

reader - the data reader

Method Detail

hasChildren

public boolean hasChildren(M parent)

Returns true if the model has children. This method allows tree based components to determine if the expand icon should be displayed next to a node.

Parameters:

parent - the parent model

Returns:

true if the model has children, otherwise false

loadChildren

public boolean loadChildren(M parent)

Initiates a load request for the parent's children.

Parameters:

parent - the parent

Returns:

true if the load was requested

onLoadFailure

protected void onLoadFailure(M loadConfig,
                             Throwable t)

Description copied from class: Loader

Called when a load operation fails.

Overrides:

onLoadFailure in class Loader<M,List<M>>

Parameters:

loadConfig - the load config

t - the exception

onLoadSuccess

protected void onLoadSuccess(M loadConfig,
                             List<M> result)

Description copied from class: Loader

Called when the remote data has been received.

Overrides:

onLoadSuccess in class Loader<M,List<M>>

Parameters:

loadConfig - the load config

result - data