Package org.apache.ofbiz.widget.model

Class ModelTree

java.lang.Object

org.apache.ofbiz.widget.model.ModelWidget

org.apache.ofbiz.widget.model.ModelTree

All Implemented Interfaces:

java.io.Serializable

public class ModelTree
extends ModelWidget

Models the <tree> element.

See Also:

widget-tree.xsd, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelTree.ModelNode	Models the <node> element.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	forceChildCheck
static java.lang.String	module
protected java.util.Map<java.lang.String,ModelTree.ModelNode>	nodeMap

Fields inherited from class org.apache.ofbiz.widget.model.ModelWidget

enableBoundaryCommentsParam

Constructor Summary

Constructors

Constructor	Description
ModelTree(org.w3c.dom.Element treeElement, java.lang.String location)

Method Summary

Modifier and Type	Method	Description
void	accept(ModelWidgetVisitor visitor)
java.lang.String	getBoundaryCommentName()	Returns the widget's name to be used in boundary comments.
java.lang.String	getDefaultEntityName()
java.lang.String	getDefaultPkName(java.util.Map<java.lang.String,java.lang.Object> context)
java.lang.String	getDefaultRenderStyle()
FlexibleStringExpander	getDefaultWrapStyleExdr()
java.lang.String	getExpandCollapseRequest(java.util.Map<java.lang.String,java.lang.Object> context)
FlexibleStringExpander	getExpandCollapseRequestExdr()
boolean	getForceChildCheck()
java.lang.String	getLocation()
java.util.Map<java.lang.String,ModelTree.ModelNode>	getNodeMap()
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)
FlexibleStringExpander	getTrailNameExdr()
java.lang.String	getWrapStyle(java.util.Map<java.lang.String,java.lang.Object> context)
void	renderTreeString(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, TreeStringRenderer treeStringRenderer)	Renders this model.

Methods inherited from class org.apache.ofbiz.widget.model.ModelWidget

getName, getStartColumn, getStartLine, getSystemId, toString, widgetBoundaryCommentsEnabled

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final java.lang.String module

forceChildCheck

protected final boolean forceChildCheck

nodeMap

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

Constructor Detail

ModelTree

public ModelTree(org.w3c.dom.Element treeElement,
                 java.lang.String location)

Method Detail

accept

public void accept(ModelWidgetVisitor visitor)
            throws java.lang.Exception

Specified by:

accept in class ModelWidget

Throws:

java.lang.Exception

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

getDefaultEntityName

public java.lang.String getDefaultEntityName()

getDefaultPkName

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

getExpandCollapseRequest

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

getOpenDepth

public int getOpenDepth()

getPostTrailOpenDepth

public int getPostTrailOpenDepth()

getRenderStyle

public java.lang.String getRenderStyle()

getRootNodeName

public java.lang.String getRootNodeName()

getTrailName

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

getWrapStyle

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

renderTreeString

public void renderTreeString(java.lang.Appendable writer,
                             java.util.Map<java.lang.String,java.lang.Object> context,
                             TreeStringRenderer treeStringRenderer)
                      throws GeneralException

Renders this model.

Parameters:

writer -

context -

treeStringRenderer -

Throws:

GeneralException

getDefaultRenderStyle

public java.lang.String getDefaultRenderStyle()

getDefaultWrapStyleExdr

public FlexibleStringExpander getDefaultWrapStyleExdr()

getExpandCollapseRequestExdr

public FlexibleStringExpander getExpandCollapseRequestExdr()

getForceChildCheck

public boolean getForceChildCheck()

getLocation

public java.lang.String getLocation()

getNodeMap

public java.util.Map<java.lang.String,ModelTree.ModelNode> getNodeMap()

getTrailNameExdr

public FlexibleStringExpander getTrailNameExdr()