org.ofbiz.widget.tree
Class ModelTree

java.lang.Object
  extended by org.ofbiz.widget.ModelWidget
      extended by org.ofbiz.widget.tree.ModelTree
All Implemented Interfaces:
java.io.Serializable

public class ModelTree
extends ModelWidget

Widget Library - Tree model class

See Also:
Serialized Form

Nested Class Summary
static class ModelTree.ModelNode
           
 
Field Summary
protected  java.lang.String defaultEntityName
           
protected  java.lang.String defaultPkName
           
protected  java.lang.String defaultRenderStyle
           
protected  FlexibleStringExpander defaultWrapStyleExdr
           
protected  GenericDelegator delegator
           
protected  LocalDispatcher dispatcher
           
protected  FlexibleStringExpander expandCollapseRequestExdr
           
protected  boolean forceChildCheck
           
static java.lang.String module
           
protected  java.util.List<ModelTree.ModelNode> nodeList
           
protected  java.util.Map<java.lang.String,ModelTree.ModelNode> nodeMap
           
protected  int openDepth
           
protected  int postTrailOpenDepth
           
protected  java.lang.String rootNodeName
           
protected  FlexibleStringExpander trailNameExdr
           
protected  java.lang.String treeLocation
           
 
Fields inherited from class org.ofbiz.widget.ModelWidget
enableBoundaryCommentsParam, enableWidgetBoundaryComments, name
 
Constructor Summary
ModelTree()
          XML Constructor
ModelTree(org.w3c.dom.Element treeElement, GenericDelegator delegator, LocalDispatcher dispatcher)
           
 
Method Summary
 java.lang.String getBoundaryCommentName()
          Returns the widget's name to be used in boundary comments.
 java.lang.String getDefaultEntityName()
           
 java.lang.String getDefaultPkName()
           
 GenericDelegator getDelegator()
           
 LocalDispatcher getDispatcher()
           
 java.lang.String getExpandCollapseRequest(java.util.Map<java.lang.String,java.lang.Object> context)
           
 int getOpenDepth()
           
 int getPostTrailOpenDepth()
           
 java.lang.String getRenderStyle()
           
 java.lang.String getRootNodeName()
           
 java.lang.String getTrailName(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getWrapStyle(java.util.Map<java.lang.String,java.lang.Object> context)
           
 void renderTreeString(java.lang.StringBuffer buf, java.util.Map<java.lang.String,java.lang.Object> context, TreeStringRenderer treeStringRenderer)
          Renders this tree to a String, i.e.
 void setDefaultEntityName(java.lang.String name)
           
 void setTreeLocation(java.lang.String treeLocation)
           
 
Methods inherited from class org.ofbiz.widget.ModelWidget
boundaryCommentsEnabled, getName, getPaginatorNumber, incrementPaginatorNumber, setWidgetBoundaryComments, widgetBoundaryCommentsEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

module

public static final java.lang.String module

treeLocation

protected java.lang.String treeLocation

rootNodeName

protected java.lang.String rootNodeName

defaultRenderStyle

protected java.lang.String defaultRenderStyle

defaultWrapStyleExdr

protected FlexibleStringExpander defaultWrapStyleExdr

nodeList

protected java.util.List<ModelTree.ModelNode> nodeList

nodeMap

protected java.util.Map<java.lang.String,ModelTree.ModelNode> nodeMap

delegator

protected GenericDelegator delegator

dispatcher

protected LocalDispatcher dispatcher

expandCollapseRequestExdr

protected FlexibleStringExpander expandCollapseRequestExdr

trailNameExdr

protected FlexibleStringExpander trailNameExdr

openDepth

protected int openDepth

postTrailOpenDepth

protected int postTrailOpenDepth

defaultEntityName

protected java.lang.String defaultEntityName

defaultPkName

protected java.lang.String defaultPkName

forceChildCheck

protected boolean forceChildCheck
Constructor Detail

ModelTree

public ModelTree()
XML Constructor


ModelTree

public ModelTree(org.w3c.dom.Element treeElement,
                 GenericDelegator delegator,
                 LocalDispatcher dispatcher)
Method Detail

setDefaultEntityName

public void setDefaultEntityName(java.lang.String name)

getDefaultEntityName

public java.lang.String getDefaultEntityName()

getDefaultPkName

public java.lang.String getDefaultPkName()

getRootNodeName

public java.lang.String getRootNodeName()

getWrapStyle

public java.lang.String getWrapStyle(java.util.Map<java.lang.String,java.lang.Object> context)

getOpenDepth

public int getOpenDepth()

getPostTrailOpenDepth

public int getPostTrailOpenDepth()

getExpandCollapseRequest

public java.lang.String getExpandCollapseRequest(java.util.Map<java.lang.String,java.lang.Object> context)

getTrailName

public java.lang.String getTrailName(java.util.Map<java.lang.String,java.lang.Object> context)

getBoundaryCommentName

public java.lang.String getBoundaryCommentName()
Description copied from class: ModelWidget
Returns the widget's name to be used in boundary comments. The default action is to return the widget's name. Derived classes can override this method to return a customized name.

Overrides:
getBoundaryCommentName in class ModelWidget
Returns:
Name to be used in boundary comments

setTreeLocation

public void setTreeLocation(java.lang.String treeLocation)

renderTreeString

public void renderTreeString(java.lang.StringBuffer buf,
                             java.util.Map<java.lang.String,java.lang.Object> context,
                             TreeStringRenderer treeStringRenderer)
                      throws GeneralException
Renders this tree to a String, i.e. in a text format, as defined with the TreeStringRenderer implementation.

Parameters:
writer - The Writer that the tree text will be written to
context - Map containing the tree context; the following are reserved words in this context: parameters (Map), isError (Boolean), itemIndex (Integer, for lists only, otherwise null), bshInterpreter, treeName (String, optional alternate name for tree, defaults to the value of the name attribute)
treeStringRenderer - An implementation of the TreeStringRenderer interface that is responsible for the actual text generation for different tree elements; implementing your own makes it possible to use the same tree definitions for many types of tree UIs
Throws:
GeneralException

getDispatcher

public LocalDispatcher getDispatcher()

getDelegator

public GenericDelegator getDelegator()

getRenderStyle

public java.lang.String getRenderStyle()