org.apache.myfaces.trinidadinternal.ui.laf.base
Interface TreeWalker


public interface TreeWalker

Callback API for walking the UINode tree. TreeWalkers can be used (with TreeWalkerUtils) to traverse the tree with proper support for composite rendering.

Version:
$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/ui/laf/base/TreeWalker.java#0 $) $Date: 10-nov-2005.18:53:08 $
Author:
The Oracle ADF Faces Team
See Also:
TreeWalkerUtils

Method Summary
 boolean walkChildren(UIXRenderingContext context, UINode node, java.lang.Object value, Path path)
          Callback method that will be called once for every node to determine if the children of that node should be walked to.
 java.lang.Object walkNode(UIXRenderingContext context, UINode node, java.lang.Object previousValue, Path path)
          Callback method that will be called once for every node the tree walker walks.
 

Method Detail

walkNode

java.lang.Object walkNode(UIXRenderingContext context,
                          UINode node,
                          java.lang.Object previousValue,
                          Path path)
                          throws java.io.IOException
Callback method that will be called once for every node the tree walker walks.

Parameters:
context - the rendering context for this node
node - the current UINode
previousValue - the last value returned from walkNode, or null on the first node walked
path - a Path object from the node where walking started
Returns:
a new value. Frequently, this will be previousValue.
Throws:
java.io.IOException - if this method writes output

walkChildren

boolean walkChildren(UIXRenderingContext context,
                     UINode node,
                     java.lang.Object value,
                     Path path)
Callback method that will be called once for every node to determine if the children of that node should be walked to.

Parameters:
context - the rendering context for this node
node - the current UINode
value - the last value returned from walkNode
path - a Path object from the node where walking started
Returns:
if true, walking continues to the children of this node. If false, the siblings of this ndoe will still be walked to.


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.