com.extjs.gxt.ui.client.binder
Class TreeBinder<M extends ModelData>

java.lang.Object
  extended by com.extjs.gxt.ui.client.event.BaseObservable
      extended by com.extjs.gxt.ui.client.binder.StoreBinder<TreeStore<M>,Tree,M>
          extended by com.extjs.gxt.ui.client.binder.TreeBinder<M>
Type Parameters:
M - the model type
All Implemented Interfaces:
CheckProvider<M>, Observable, SelectionProvider<M>
Direct Known Subclasses:
TreeTableBinder

Deprecated. see TreePanel

public class TreeBinder<M extends ModelData>
extends StoreBinder<TreeStore<M>,Tree,M>
implements CheckProvider<M>

A StoreBinder implementation for Trees.


Constructor Summary
TreeBinder(Tree tree, TreeStore<M> store)
          Deprecated. Creates a new store binder.
 
Method Summary
 void addCheckListener(CheckChangedListener<M> listener)
          Deprecated. Adds the check change listener.
 Component findItem(M model)
          Deprecated. Returns the matching component for the given model.
 java.util.List<M> getCheckedSelection()
          Deprecated. Returns the current checked selection.
 java.lang.String getDisplayProperty()
          Deprecated. Returns the display property.
 Tree getTree()
          Deprecated. Returns the binder's tree.
 TreeStore<M> getTreeStore()
          Deprecated. Returns the binder's tree store.
 boolean isAutoLoad()
          Deprecated. Returns true if auto load is enabled.
 boolean isCaching()
          Deprecated. Returns true if the binder is caching.
 boolean isChecked(M model)
          Deprecated. Returns true if the model is checked.
 boolean isExpandOnFilter()
          Deprecated. Returns the if expand all and collapse all is enabled on filter changes.
 void removeCheckListener(CheckChangedListener<M> listener)
          Deprecated. Removes the check change listener.
 void setAutoLoad(boolean autoLoad)
          Deprecated. Sets whether all children should automatically be loaded.
 void setCaching(boolean caching)
          Deprecated. Sets whether the children should be cached after first being retrieved from the store (defaults to true).
 void setCheckedSelection(java.util.List<M> selection)
          Deprecated. Sets the current checked selection.
 void setDisplayProperty(java.lang.String displayProperty)
          Deprecated. Sets the display property name used to the item's text.
 void setExpandOnFilter(boolean expandOnFilter)
          Deprecated. Sets whether the tree should expand all and collapse all when filters are applied (defaults to true).
 
Methods inherited from class com.extjs.gxt.ui.client.binder.StoreBinder
addSelectionChangedListener, getSelection, getStore, init, isAutoSelect, isFiltered, isMask, removeSelectionListener, setAutoSelect, setIconProvider, setMask, setSelection, setSelection, setStringProvider, setStyleProvider
 
Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable
addListener, fireEvent, fireEvent, getFiresEvents, getListeners, hasActiveEvent, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TreeBinder

public TreeBinder(Tree tree,
                  TreeStore<M> store)
Deprecated. 
Creates a new store binder.

Parameters:
tree - the tree
store - the tree store
Method Detail

addCheckListener

public void addCheckListener(CheckChangedListener<M> listener)
Deprecated. 
Description copied from interface: CheckProvider
Adds the check change listener.

Specified by:
addCheckListener in interface CheckProvider<M extends ModelData>
Parameters:
listener - the listener to be added

findItem

public Component findItem(M model)
Deprecated. 
Description copied from class: StoreBinder
Returns the matching component for the given model.

Specified by:
findItem in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>
Parameters:
model - the model
Returns:
the component

getCheckedSelection

public java.util.List<M> getCheckedSelection()
Deprecated. 
Description copied from interface: CheckProvider
Returns the current checked selection.

Specified by:
getCheckedSelection in interface CheckProvider<M extends ModelData>
Returns:
the checked selection

getDisplayProperty

public java.lang.String getDisplayProperty()
Deprecated. 
Returns the display property.

Returns:
the display property

getTree

public Tree getTree()
Deprecated. 
Returns the binder's tree.

Returns:
the tree

getTreeStore

public TreeStore<M> getTreeStore()
Deprecated. 
Returns the binder's tree store.

Returns:
the tree store

isAutoLoad

public boolean isAutoLoad()
Deprecated. 
Returns true if auto load is enabled.

Returns:
the auto load state

isCaching

public boolean isCaching()
Deprecated. 
Returns true if the binder is caching.

Returns:
the caching state

isChecked

public boolean isChecked(M model)
Deprecated. 
Description copied from interface: CheckProvider
Returns true if the model is checked.

Specified by:
isChecked in interface CheckProvider<M extends ModelData>
Parameters:
model - the model
Returns:
the check state

isExpandOnFilter

public boolean isExpandOnFilter()
Deprecated. 
Returns the if expand all and collapse all is enabled on filter changes.

Returns:
the expand all collapse all state

removeCheckListener

public void removeCheckListener(CheckChangedListener<M> listener)
Deprecated. 
Description copied from interface: CheckProvider
Removes the check change listener.

Specified by:
removeCheckListener in interface CheckProvider<M extends ModelData>
Parameters:
listener - the listener to be removed

setAutoLoad

public void setAutoLoad(boolean autoLoad)
Deprecated. 
Sets whether all children should automatically be loaded. Useful when using filters.

Parameters:
autoLoad - true to auto load

setCaching

public void setCaching(boolean caching)
Deprecated. 
Sets whether the children should be cached after first being retrieved from the store (defaults to true). When false, the tree items will be removed when collapsed.

Parameters:
caching - the caching state

setCheckedSelection

public void setCheckedSelection(java.util.List<M> selection)
Deprecated. 
Description copied from interface: CheckProvider
Sets the current checked selection.

Specified by:
setCheckedSelection in interface CheckProvider<M extends ModelData>
Parameters:
selection - the checked selection

setDisplayProperty

public void setDisplayProperty(java.lang.String displayProperty)
Deprecated. 
Sets the display property name used to the item's text.

Parameters:
displayProperty - the property

setExpandOnFilter

public void setExpandOnFilter(boolean expandOnFilter)
Deprecated. 
Sets whether the tree should expand all and collapse all when filters are applied (defaults to true).

Parameters:
expandOnFilter - true to expand and collapse on filter changes