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

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

Methods

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.

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

addBeforeLoadHandler, addLoaderHandler, addLoadExceptionHandler, addLoadHandler, getLastLoadConfig, getProxy, isReuseLoadConfig, load, load, setReuseLoadConfig

Methods inherited from class java.lang.Object

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

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.

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