com.ideo.sweetdevria.taglib.tree
Class TreeTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.ideo.sweetdevria.taglib.AbstractTagDrawer
          com.ideo.sweetdevria.taglib.AbstractComponentTagSupport
              com.ideo.sweetdevria.taglib.BaseTagSupport
                  com.ideo.sweetdevria.taglib.BaseStateTagSupport
                      com.ideo.sweetdevria.taglib.tree.TreeTag

All Implemented Interfaces:

Hideable, IRiaTag, ITreeTag, java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class TreeTag
extends BaseStateTagSupport
implements IRiaTag, Hideable, ITreeTag

See Also:

Serialized Form

Field Summary

protected static java.lang.String	BUILDER_ID Builder ID.
protected boolean	canAdd
protected boolean	canDelete
protected boolean	canModify
protected NodeModel	checkedNodes
protected ITreeDataProvider	dataProvider
protected int	displayedLevels
protected boolean	displayRoot
protected TreeModel	model
protected int	nodeHeight
protected NodeModel	nodes Tree nodes.
protected java.util.List	nodeTypes
protected java.lang.Class	treeModelClass Model

Fields inherited from class com.ideo.sweetdevria.taglib.BaseStateTagSupport

stateful

Fields inherited from class com.ideo.sweetdevria.taglib.BaseTagSupport

frameDisplayed, style, styleClass

Fields inherited from class com.ideo.sweetdevria.taglib.AbstractComponentTagSupport

bodyContent, rendered

Fields inherited from class com.ideo.sweetdevria.taglib.AbstractTagDrawer

builder, messageKeys, templateEnd, templateStart

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

TreeTag()
Default constructor.

Method Summary

void	addChild(NodeModel rootNode) Adds a node as a child of this current one
int	doEndTag() Default processing of the end tag returning EVAL_PAGE.
int	doStartTag() Default processing of the start tag.
java.lang.String	getBuilderId() Return the targeted builder id for this component as specified in the configuration file.
ITreeDataProvider	getDataProvider()
int	getDisplayedLevels() Get displayed level.
TreeModel	getModel()
int	getNodeHeight() Get node height.
NodeModel	getNodes() Get nodes.
java.util.List	getNodeTypes()
java.lang.Class	getTreeModelClass()
boolean	isCanAdd()
boolean	isCanDelete()
boolean	isCanModify()
boolean	isDisplayRoot()
void	release() Release method which must call super.release !
void	setCanAdd(boolean canAdd) Set the add action on the tree
void	setCanDelete(boolean canDelete) Set the delete action on the tree
void	setCanModify(boolean canModify) Set the modify action on the tree
void	setDataProvider(ITreeDataProvider dataProvider) Set a custom data provider for this tree
void	setDisplayedLevels(int displayedLevels) Set number of displayed levels.
void	setDisplayRoot(boolean displayRoot) Set the visibility of the root node
void	setNodeHeight(int nodeHeight) Set new node height.
void	setNodes(NodeModel nodes) Set the nodes which will be displayed in the Tree.
void	setNodeTypes(java.util.List nodeTypes) Set the node types for this tree
void	setTreeModelClass(java.lang.Class treeModelClass) Set the class of Tree Model which will be used.

Methods inherited from class com.ideo.sweetdevria.taglib.BaseStateTagSupport

isStateful, setId, setStateful

Methods inherited from class com.ideo.sweetdevria.taglib.BaseTagSupport

addCssClass, addCssStyle, getStyle, getStyleClass, setStyle, setStyleClass

Methods inherited from class com.ideo.sweetdevria.taglib.AbstractComponentTagSupport

checkId, doAfterBody, doInitBody, getBodyContent, getId, isRendered, refractorContext, setBodyContent, setRendered

Methods inherited from class com.ideo.sweetdevria.taglib.AbstractTagDrawer

generateHtmlContent, getBuilder, getMessageKeys, getPageContext, getTemplateEnd, getTemplateStart, setPageContext, setTemplateEnd, setTemplateStart

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getParent, getValue, getValues, removeValue, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ideo.sweetdevria.taglib.IRiaTag

getMessageKeys, getPageContext, getTemplateEnd, getTemplateStart, setPageContext, setTemplateEnd, setTemplateStart

Methods inherited from interface com.ideo.sweetdevria.taglib.Hideable

isRendered, setRendered

Methods inherited from interface javax.servlet.jsp.tagext.BodyTag

doInitBody, setBodyContent

Methods inherited from interface javax.servlet.jsp.tagext.IterationTag

doAfterBody

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

BUILDER_ID

protected static final java.lang.String BUILDER_ID

Builder ID.

See Also:

Constant Field Values

nodes

protected NodeModel nodes

Tree nodes.

checkedNodes

protected NodeModel checkedNodes

nodeTypes

protected java.util.List nodeTypes

dataProvider

protected ITreeDataProvider dataProvider

treeModelClass

protected java.lang.Class treeModelClass

Model

model

protected TreeModel model

displayedLevels

protected int displayedLevels

nodeHeight

protected int nodeHeight

displayRoot

protected boolean displayRoot

canAdd

protected boolean canAdd

canDelete

protected boolean canDelete

canModify

protected boolean canModify

Constructor Detail

TreeTag

public TreeTag()

Default constructor.

Method Detail

release

public void release()

Description copied from interface: IRiaTag

Release method which must call super.release !

Specified by:

release in interface IRiaTag

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class BaseStateTagSupport

See Also:

IRiaTag.release()

getBuilderId

public java.lang.String getBuilderId()

Description copied from interface: IRiaTag

Return the targeted builder id for this component as specified in the configuration file.

Specified by:

getBuilderId in interface IRiaTag

Specified by:

getBuilderId in class AbstractTagDrawer

Returns:

id targeted builder id

See Also:

AbstractTagDrawer.getBuilderId()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Description copied from interface: IRiaTag

Default processing of the start tag.

Specified by:

doStartTag in interface IRiaTag

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class AbstractComponentTagSupport

Returns:

EVAL_BODY_AGAIN, EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY or SKIP_PAGE.

Throws:

javax.servlet.jsp.JspException

See Also:

IRiaTag.doStartTag()

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Description copied from interface: IRiaTag

Default processing of the end tag returning EVAL_PAGE.

Specified by:

doEndTag in interface IRiaTag

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class AbstractComponentTagSupport

Returns:

EVAL_PAGE or SKIP_PAGE.

Throws:

javax.servlet.jsp.JspException

See Also:

IRiaTag.doEndTag()

addChild

public void addChild(NodeModel rootNode)
              throws javax.servlet.jsp.JspException

Description copied from interface: ITreeTag

Adds a node as a child of this current one

Specified by:

addChild in interface ITreeTag

Parameters:

rootNode - the child node to add

Throws:

javax.servlet.jsp.JspException - if any error occurs

getModel

public TreeModel getModel()

Returns:

the model associated for this tag

getDisplayedLevels

public int getDisplayedLevels()

Get displayed level.

Returns:

displayed level.

setDisplayedLevels

public void setDisplayedLevels(int displayedLevels)

Set number of displayed levels.

Parameters:

displayedLevels -

getNodeHeight

public int getNodeHeight()

Get node height.

Returns:

nodeHeight.

setNodeHeight

public void setNodeHeight(int nodeHeight)

Set new node height.

Parameters:

nodeHeight -

isDisplayRoot

public boolean isDisplayRoot()

setDisplayRoot

public void setDisplayRoot(boolean displayRoot)

Set the visibility of the root node

Parameters:

displayRoot -

getNodeTypes

public java.util.List getNodeTypes()

setNodeTypes

public void setNodeTypes(java.util.List nodeTypes)

Set the node types for this tree

Parameters:

nodeTypes - a list of node types

getNodes

public NodeModel getNodes()

Get nodes.

Returns:

nodes

setNodes

public void setNodes(NodeModel nodes)

Set the nodes which will be displayed in the Tree.

Parameters:

nodes - Nodes.

getDataProvider

public ITreeDataProvider getDataProvider()

setDataProvider

public void setDataProvider(ITreeDataProvider dataProvider)

Set a custom data provider for this tree

Parameters:

dataProvider - a custom data provider for this tree

isCanAdd

public boolean isCanAdd()

setCanAdd

public void setCanAdd(boolean canAdd)

Set the add action on the tree

Parameters:

canAdd - specify if the node addition is allowed

isCanDelete

public boolean isCanDelete()

setCanDelete

public void setCanDelete(boolean canDelete)

Set the delete action on the tree

Parameters:

canDelete - specify if the node suppression is allowed

isCanModify

public boolean isCanModify()

setCanModify

public void setCanModify(boolean canModify)

Set the modify action on the tree

Parameters:

canModify - specify if the node modification is allowed

getTreeModelClass

public java.lang.Class getTreeModelClass()

setTreeModelClass

public void setTreeModelClass(java.lang.Class treeModelClass)

Set the class of Tree Model which will be used.

Parameters:

treeModelClass -