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

java.lang.Object
  com.extjs.gxt.ui.client.event.BaseObservable
      com.extjs.gxt.ui.client.binder.StoreBinder<TreeStore<M>,Tree,M>
          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.

Field Summary

protected boolean	autoLoad Deprecated.
protected java.lang.String	displayProperty Deprecated.
protected TreeLoader<M>	loader Deprecated.
protected TreeStore<M>	store Deprecated.
protected Tree	tree Deprecated.

Fields inherited from class com.extjs.gxt.ui.client.binder.StoreBinder

component, defaultStringProvider, iconProvider, listener, stringProvider, styleProvider

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.
protected void	createAll() Deprecated.
protected TreeItem	createItem(M model) Deprecated.
Component	findItem(M model) Deprecated. Returns the matching component for the given model.
protected void	fireCheckChanged(java.util.List<M> selection) Deprecated.
java.util.List<M>	getCheckedSelection() Deprecated. Returns the current checked selection.
java.lang.String	getDisplayProperty() Deprecated. Returns the display property.
protected java.util.List<M>	getSelectionFromComponent() Deprecated.
Tree	getTree() Deprecated. Returns the binder's tree.
TreeStore<M>	getTreeStore() Deprecated. Returns the binder's tree store.
protected boolean	hasChildren(M parent) Deprecated.
protected void	hook() Deprecated.
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.
protected void	loadChildren(TreeItem item, boolean expand) Deprecated.
protected void	onAdd(StoreEvent<M> se) Deprecated.
protected void	onBeforeExpand(TreeEvent te) Deprecated.
protected void	onCollapse(TreeEvent te) Deprecated.
protected void	onDataChanged(StoreEvent<M> se) Deprecated.
protected void	onFilter(StoreEvent<M> se) Deprecated.
protected void	onRemove(StoreEvent<M> se) Deprecated.
protected void	onRenderChildren(TreeStoreEvent<M> te) Deprecated.
protected void	onSort(StoreEvent<M> se) Deprecated.
protected void	onUpdate(StoreEvent<M> se) Deprecated.
protected void	removeAll() Deprecated.
void	removeCheckListener(CheckChangedListener<M> listener) Deprecated. Removes the check change listener.
protected void	renderChildren(M parent, java.util.List<M> children) Deprecated.
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).
protected void	setSelectionFromProvider(java.util.List<M> selection) Deprecated.
protected void	update(M model) Deprecated.
protected void	update(TreeItem item, M model) Deprecated.

Methods inherited from class com.extjs.gxt.ui.client.binder.StoreBinder

addSelectionChangedListener, bind, fireSelectionChanged, getIconValue, getSelection, getStore, getTextValue, getTextValue, init, isAutoSelect, isFiltered, isMask, onBeforeDataChanged, onClear, removeSelectionListener, setAutoSelect, setIconProvider, setMask, setModel, setSelection, setSelection, setStringProvider, setStyleProvider

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

Field Detail

tree

protected Tree tree

Deprecated.

store

protected TreeStore<M extends ModelData> store

Deprecated.

loader

protected TreeLoader<M extends ModelData> loader

Deprecated.

displayProperty

protected java.lang.String displayProperty

Deprecated.

autoLoad

protected boolean autoLoad

Deprecated.

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

createAll

protected void createAll()

Deprecated.

Specified by:

createAll in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

createItem

protected TreeItem createItem(M model)

Deprecated.

fireCheckChanged

protected void fireCheckChanged(java.util.List<M> selection)

Deprecated.

getSelectionFromComponent

protected java.util.List<M> getSelectionFromComponent()

Deprecated.

Specified by:

getSelectionFromComponent in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

hasChildren

protected boolean hasChildren(M parent)

Deprecated.

hook

protected void hook()

Deprecated.

Overrides:

hook in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

loadChildren

protected void loadChildren(TreeItem item,
                            boolean expand)

Deprecated.

onAdd

protected void onAdd(StoreEvent<M> se)

Deprecated.

Specified by:

onAdd in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

onBeforeExpand

protected void onBeforeExpand(TreeEvent te)

Deprecated.

onCollapse

protected void onCollapse(TreeEvent te)

Deprecated.

onDataChanged

protected void onDataChanged(StoreEvent<M> se)

Deprecated.

Overrides:

onDataChanged in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

onFilter

protected void onFilter(StoreEvent<M> se)

Deprecated.

Overrides:

onFilter in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

onRemove

protected void onRemove(StoreEvent<M> se)

Deprecated.

Specified by:

onRemove in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

onRenderChildren

protected void onRenderChildren(TreeStoreEvent<M> te)

Deprecated.

onSort

protected void onSort(StoreEvent<M> se)

Deprecated.

Overrides:

onSort in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

onUpdate

protected void onUpdate(StoreEvent<M> se)

Deprecated.

Specified by:

onUpdate in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

removeAll

protected void removeAll()

Deprecated.

Specified by:

removeAll in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

renderChildren

protected void renderChildren(M parent,
                              java.util.List<M> children)

Deprecated.

setSelectionFromProvider

protected void setSelectionFromProvider(java.util.List<M> selection)

Deprecated.

Specified by:

setSelectionFromProvider in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

update

protected void update(M model)

Deprecated.

Specified by:

update in class StoreBinder<TreeStore<M extends ModelData>,Tree,M extends ModelData>

update

protected void update(TreeItem item,
                      M model)

Deprecated.