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

java.lang.Object
  extended by com.extjs.gxt.ui.client.event.BaseObservable
      extended by com.extjs.gxt.ui.client.data.BaseLoader<java.util.List<M>>
          extended by com.extjs.gxt.ui.client.data.BaseTreeLoader<M>
Type Parameters:
M - the model data type
All Implemented Interfaces:
Loader<java.util.List<M>>, TreeLoader<M>, Observable
Direct Known Subclasses:
BaseRemoteSortTreeLoader

public class BaseTreeLoader<M extends ModelData>
extends BaseLoader<java.util.List<M>>
implements TreeLoader<M>

Default implementation of the TreeLoader interface.

Events:
BeforeLoad : LoadEvent(loader, config)
Fires before a load operation. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Load : LoadEvent(loader, config, result)
Fires after the button is selected.
LoadException : LoadEvent(loader, config, result)
Fires after the button is selected.


Field Summary
protected  java.util.List<M> 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
BaseTreeLoader(DataProxy proxy)
          Creates a new tree loader instance.
BaseTreeLoader(DataProxy proxy, DataReader reader)
          Creates a new tree loader instance.
BaseTreeLoader(DataReader reader)
          Creates a new tree loader instance.
 
Method Summary
 boolean hasChildren(M parent)
          Returns whether the given model has children.
 boolean loadChildren(M parent)
          Initiates a load request for the parent's children.
protected  void loadData(java.lang.Object config, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<M>> callback)
          Called when a proxy is not being used.
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.
 
Methods inherited from class com.extjs.gxt.ui.client.data.BaseLoader
addLoadListener, getLastConfig, getProxy, isReuseLoadConfig, load, load, loadData, newLoadConfig, prepareLoadConfig, 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.Loader
addLoadListener, load, load, removeLoadListener
 
Methods inherited from interface com.extjs.gxt.ui.client.event.Observable
addListener, fireEvent, getListeners, hasListeners, hasListeners, removeAllListeners, removeListener
 

Field Detail

children

protected java.util.List<M extends ModelData> children
Constructor Detail

BaseTreeLoader

public BaseTreeLoader(DataProxy proxy)
Creates a new tree loader instance.

Parameters:
proxy - the data reader

BaseTreeLoader

public BaseTreeLoader(DataReader reader)
Creates a new tree loader instance.

Parameters:
reader - the data reader

BaseTreeLoader

public BaseTreeLoader(DataProxy proxy,
                      DataReader reader)
Creates a new tree loader instance.

Parameters:
proxy - the data proxy
reader - the data reader
Method Detail

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>
Parameters:
parent - the parent
Returns:
true if the load was requested

hasChildren

public boolean hasChildren(M parent)
Description copied from interface: TreeLoader
Returns whether the given model has children.

Specified by:
hasChildren in interface TreeLoader<M extends ModelData>
Parameters:
parent - the parent model
Returns:
true if the given parent has children, and false if it has no children

loadData

protected void loadData(java.lang.Object config,
                        com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<M>> callback)
Description copied from class: BaseLoader
Called when a proxy is not being used.

Overrides:
loadData in class BaseLoader<java.util.List<M extends ModelData>>
Parameters:
config - the load config
callback - the callback

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 BaseLoader<java.util.List<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 BaseLoader<java.util.List<M extends ModelData>>
Parameters:
loadConfig - the load config
result - data