Package com.webmethods.caf.faces.data.tree.object

Class BoundChildrenTreeContentProvider

java.lang.Object

com.webmethods.caf.faces.bean.PageFlowScopeAdapter

com.webmethods.caf.faces.data.object.ListTableContentProvider

com.webmethods.caf.faces.data.object.SelectableListTableContentProvider

com.webmethods.caf.faces.data.object.FilterableSelectableListTableContentProvider

com.webmethods.caf.faces.data.tree.object.NodeTreeContentProvider

com.webmethods.caf.faces.data.tree.object.BoundChildrenTreeContentProvider

All Implemented Interfaces:

IPageFlowScopeAdapter, IAddressableTableContentProvider, IContentProvider, IFilterableTableContentProvider, IRefreshable, IRefreshableContentProvider, IReorderableTableContentProvider, ISelectableTableContentProvider, ISortableTableContentProvider, ITableContentProvider, IUpdateableContentProvider, IUpdateableTableContentProvider, ISelectableTreeContentProvider, ITreeContentProvider, Serializable

public class BoundChildrenTreeContentProvider
extends NodeTreeContentProvider

Tree provider initialized with a list of roots, where the tree structure is defined by a set of children bindings. For each node, these bindings are evaluated to determine the current node's list of children.

The nodes of this content provider may be arbitrary java objects (they will be wrapped by BoundChildrenNodes). If the object has tree children, one of the configured children binding expressions should resolve to the List or Object[] (array) of children.

This provider must be initialized with a list (or array) of root nodes, a row variable (used in binding expressions to indicate the current node), a row id binding (a value-binding which evaluates to the unique id of the current node), and a children binding (a value-binding which evaluates to the list or array of children for the current node).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.caf.faces.data.tree.object.NodeTreeContentProvider

NodeTreeContentProvider.DummyValueExpression, NodeTreeContentProvider.NodeComparator, NodeTreeContentProvider.NodeIdsIterator

Nested classes/interfaces inherited from class com.webmethods.caf.faces.data.object.FilterableSelectableListTableContentProvider

FilterableSelectableListTableContentProvider.RowFilterableValueDecorator

Nested classes/interfaces inherited from class com.webmethods.caf.faces.data.object.SelectableListTableContentProvider

SelectableListTableContentProvider.Row, SelectableListTableContentProvider.RowComparator

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ValueExpression>	m_childrenBinding

Fields inherited from class com.webmethods.caf.faces.data.tree.object.NodeTreeContentProvider

m_helper, m_roots, openToDepth

Fields inherited from class com.webmethods.caf.faces.data.object.FilterableSelectableListTableContentProvider

m_filter, m_filterable, m_filterValue, m_unfilteredlist

Fields inherited from class com.webmethods.caf.faces.data.object.SelectableListTableContentProvider

m_autoIdCounter, m_map, m_originalList, m_selectableHelper

Fields inherited from class com.webmethods.caf.faces.data.object.ListTableContentProvider

m_array, m_canTemplateRow, m_index, m_list, m_onCreateRow, m_onDeleteRow, m_rowId, m_rowType, m_sort, m_templateRow, m_var

Fields inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter

fExpireWithPageFlow

Constructor Summary

Constructors

Constructor	Description
BoundChildrenTreeContentProvider()	New, un-initialized tree provider.
BoundChildrenTreeContentProvider(Object[] roots, String rowVariable, String rowIdBinding, String childrenBinding)	New tree provider initialized with an array of root nodes.
BoundChildrenTreeContentProvider(Object root, String rowVariable, String rowIdBinding, String childrenBinding)	New tree provider initialized with a single root node.
BoundChildrenTreeContentProvider(List<?> roots, String rowVariable, String rowIdBinding, String childrenBinding)	New tree provider initialized with a list of root nodes.

Method Summary

Modifier and Type	Method	Description
List<ValueBinding>	getChildrenBinding()	Deprecated. use getChildrenExpression() instead
List<ValueExpression>	getChildrenExpression()
void	setChildrenBinding(String binding)	Deprecated. use setChildrenExpression(String) instead
void	setChildrenBinding(List<ValueBinding> binding)	Deprecated. use setChildrenExpression(List) instead
void	setChildrenExpression(String binding)	Set children binding list.
void	setChildrenExpression(List<ValueExpression> binding)	Set children binding list.
void	setList(List<?> list)	Sets a list to wrap
void	setRowIdBinding(String binding)	Construct value binding using the binding string and set it to row id binding.

Methods inherited from class com.webmethods.caf.faces.data.tree.object.NodeTreeContentProvider

calculateRowId, flatten, getCanTemplateRow, getChildIds, getCurrentNode, getCurrentRow, getDepth, getHasChildren, getLastChildAncestors, getOpenIds, getOpenToDepth, getParentId, getRootIds, getUnopenIds, getUseUnopenModel, isFirstChild, isLastChild, isOpen, isRowMixed, isVisible, openTreeNodes, setOpen, setOpenIds, setOpenToDepth, setUnopenIds, sort, sort

Methods inherited from class com.webmethods.caf.faces.data.object.FilterableSelectableListTableContentProvider

filter, getFilter, getRowFilterValueBinding, getRowFilterValueBindingAsString, getRowFilterValueExpression, isFilterable, setFilter, setFilterable, setRowFilterValueBinding, setRowFilterValueBindingAsString, setRowFilterValueExpression

Methods inherited from class com.webmethods.caf.faces.data.object.SelectableListTableContentProvider

createRow, deleteRow, getList, getNeedRefresh, getRowId, getRowSelectedCount, getRowSelectedIds, getRowUnselectedIds, getSelectedRows, getUseUnselectedModel, isAddressable, isAutoRefresh, isRowSelected, moveTo, refresh, setAutoRefresh, setCurrentRow, setNeedRefresh, setRowById, setRowSelected, setRowSelectedIds, setRowUnselectedIds, setRowVariable, setTemplateRow, supportsAutoRefresh, updateOriginalList

Methods inherited from class com.webmethods.caf.faces.data.object.ListTableContentProvider

calculateRowId, getArray, getOnCreateRow, getOnCreateRowExpression, getOnDeleteRow, getOnDeleteRowExpression, getPropertyKeys, getRowCount, getRowIdBinding, getRowIdExpression, getRowIndex, getRowType, getRowVariable, getSort, getType, getValue, hasProperty, isReadOnly, isReorderable, isRowAvailable, isTemplateRow, newRow, setArray, setCanTemplateRow, setOnCreateRow, setOnCreateRowExpression, setOnDeleteRow, setOnDeleteRowExpression, setRowId, setRowIdBinding, setRowIdExpression, setRowIndex, setRowType, setSort, setValue, toString

Methods inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter

getExpireWithPageFlow, setExpireWithPageFlow

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webmethods.caf.faces.data.IAddressableTableContentProvider

getRowId, isAddressable, setRowById

Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider

getPropertyKeys, getType, getValue, hasProperty, toString

Methods inherited from interface com.webmethods.caf.faces.data.ISelectableTableContentProvider

getRowSelectedCount, getRowSelectedIds, getRowUnselectedIds, getUseUnselectedModel, isRowSelected, setRowSelected, setRowSelectedIds, setRowUnselectedIds

Methods inherited from interface com.webmethods.caf.faces.data.ITableContentProvider

getRowCount, getRowIndex, getRowVariable, isRowAvailable, setRowIndex, setRowVariable

Field Details

m_childrenBinding

protected List<ValueExpression> m_childrenBinding

Constructor Details

BoundChildrenTreeContentProvider

public BoundChildrenTreeContentProvider()

New, un-initialized tree provider. This provider must be initialized with a list (or array) of root nodes, a row variable (used in binding expressions to indicate the current node), a row id binding (a value-binding which evaluates to the unique id of the current node), and a children binding (a value-binding which evaluates to the list or array of children for the current node).

BoundChildrenTreeContentProvider

public BoundChildrenTreeContentProvider(Object root,
 String rowVariable,
 String rowIdBinding,
 String childrenBinding)

New tree provider initialized with a single root node.

BoundChildrenTreeContentProvider

public BoundChildrenTreeContentProvider(List<?> roots,
 String rowVariable,
 String rowIdBinding,
 String childrenBinding)

New tree provider initialized with a list of root nodes.

BoundChildrenTreeContentProvider

public BoundChildrenTreeContentProvider(Object[] roots,
 String rowVariable,
 String rowIdBinding,
 String childrenBinding)

New tree provider initialized with an array of root nodes.

Method Details

setList

public void setList(List<?> list)

Description copied from class: SelectableListTableContentProvider

Sets a list to wrap

Overrides:

setList in class NodeTreeContentProvider

Parameters:

list - a list

setRowIdBinding

public void setRowIdBinding(String binding)

Construct value binding using the binding string and set it to row id binding.

See Also:

• ListTableContentProvider.setRowIdExpression(ValueExpression)

getChildrenBinding

@Deprecated
public List<ValueBinding> getChildrenBinding()

Deprecated.

use getChildrenExpression() instead

Returns:

children binding list

setChildrenBinding

@Deprecated
public void setChildrenBinding(List<ValueBinding> binding)

Deprecated.

use setChildrenExpression(List) instead

Set children binding list.

Parameters:

binding -

getChildrenExpression

public List<ValueExpression> getChildrenExpression()

Returns:

children binding list

setChildrenExpression

public void setChildrenExpression(List<ValueExpression> binding)

Set children binding list.

Parameters:

binding -

setChildrenBinding

@Deprecated
public void setChildrenBinding(String binding)

Deprecated.

use setChildrenExpression(String) instead

Set children binding list. The binding string will be converted to list using ListTools.stringToList(String) and the children bindings are constructed based on the list.

Parameters:

binding -

setChildrenExpression

public void setChildrenExpression(String binding)

Set children binding list. The binding string will be converted to list using ListTools.stringToList(String) and the children bindings are constructed based on the list.

Parameters:

binding -