com.jalios.jcms.taglib

Class TreeViewTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

com.jalios.jcms.taglib.IncludeTag

com.jalios.jcms.taglib.TreeViewTag

All Implemented Interfaces:

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

Direct Known Subclasses:

TreeCatViewTag

public class TreeViewTag
extends IncludeTag

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeViewTag.TreeView

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASCENDANT
static int	DESCENDANT
static int	NONE
static java.lang.String	REVISION
static java.lang.String	RXP_CURRENT_CID
static java.lang.String	RXP_CURRENT_URL
static java.lang.String	RXP_DISPLAY
static java.lang.String	RXP_DISPLAY_URL
static java.lang.String	RXP_NODE_ID
static java.lang.String	RXP_PORTAL_CID
static java.lang.String	RXP_PORTAL_ID
static java.lang.String	RXP_WORKSPACE_ID
static java.lang.String	TREE_ID_ATTR
static java.lang.String	TREE_PREFIX_ATTR
static java.lang.String	TREEVIEW_ATTR

Fields inherited from class com.jalios.jcms.taglib.IncludeTag

INCLUDE_BODY, INCLUDE_CONTEXT, JCMS_RESOURCE_INCLUDE_PREFIX_PROP

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

bodyContent

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

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

Constructors

Constructor and Description
TreeViewTag()

Method Summary

Modifier and Type	Method and Description
void	clean()
int	doEndTag()
int	doStartTag()
java.lang.String	getCss()
java.lang.String	getFooter(TreeViewTag.TreeView treeView)
java.lang.String	getHeader(TreeViewTag.TreeView treeView)
TreeViewTag.TreeView	getTreeView()
protected java.lang.Class<? extends TreeViewTag.TreeView>	getTreeViewClass()
protected void	handleTreePrefix()
protected void	initTag()
static boolean	isMatchCollection(java.lang.Object node, java.util.Collection collec, boolean descendant, boolean parent) Check if the given TreeNode is, is descendant or is parent of the given TreeNode Set.
void	setAjax(boolean ajaxLink)
void	setChecked(java.util.Collection treeChecked)
void	setCollection(java.util.Collection treeCollection)
void	setCss(java.lang.String treeCSS)
void	setDecorator(TreeViewDecorator decorator)
void	setDisable(int treeDisable)
void	setDisabled(java.util.Collection treeDisabled)
void	setDragdrop(boolean dragdrop)
void	setHighlight(int treeHighlight)
void	setHighlighted(java.util.Collection treeHighlighted)
void	setHint(java.lang.String treeHint)
void	setInput(java.lang.String treeInput)
void	setLevel(int treeLevel)
void	setLink(java.lang.String treeLink)
void	setMemo(java.lang.Object memo)
void	setNode(java.lang.Object treeNode)
void	setOpened(java.util.Collection treeOpened)
void	setPrefix(java.lang.String treePrefix)
void	setRemoved(java.util.Collection treeRemoved)
void	setRetains(java.util.Collection treeRetains)
void	setType(java.lang.String treeType)
void	setWrapper(boolean wrapper)

Methods inherited from class com.jalios.jcms.taglib.IncludeTag

doAfterBody, doBeforeBody, doInitBody, getClazz, getFile, getId, getIncludeObject, getIncludeString, getJsp, getPub, getResource, getTarget, getTargetContext, getUsage, include, include, notRecusiveInclude, printErrorMessage, setClazz, setContext, setFile, setId, setIncludeString, setJsp, setPub, setResource, setTarget, setTargetContext, setUsage, skipInclude

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

getBodyContent, getPreviousOut, release, setBodyContent

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

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

Methods inherited from class java.lang.Object

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

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

getParent, setPageContext, setParent

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

ASCENDANT

public static final int ASCENDANT

See Also:

Constant Field Values

DESCENDANT

public static final int DESCENDANT

See Also:

Constant Field Values

TREE_PREFIX_ATTR

public static final java.lang.String TREE_PREFIX_ATTR

See Also:

Constant Field Values

TREE_ID_ATTR

public static final java.lang.String TREE_ID_ATTR

See Also:

Constant Field Values

TREEVIEW_ATTR

public static final java.lang.String TREEVIEW_ATTR

See Also:

Constant Field Values

RXP_DISPLAY

public static final java.lang.String RXP_DISPLAY

See Also:

Constant Field Values

RXP_DISPLAY_URL

public static final java.lang.String RXP_DISPLAY_URL

See Also:

Constant Field Values

RXP_NODE_ID

public static final java.lang.String RXP_NODE_ID

See Also:

Constant Field Values

RXP_CURRENT_URL

public static final java.lang.String RXP_CURRENT_URL

See Also:

Constant Field Values

RXP_PORTAL_ID

public static final java.lang.String RXP_PORTAL_ID

See Also:

Constant Field Values

RXP_CURRENT_CID

public static final java.lang.String RXP_CURRENT_CID

See Also:

Constant Field Values

RXP_PORTAL_CID

public static final java.lang.String RXP_PORTAL_CID

See Also:

Constant Field Values

RXP_WORKSPACE_ID

public static final java.lang.String RXP_WORKSPACE_ID

See Also:

Constant Field Values

Constructor Detail

TreeViewTag

public TreeViewTag()

Method Detail

doStartTag

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

Specified by:

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

Overrides:

doStartTag in class IncludeTag

Throws:

javax.servlet.jsp.JspException

doEndTag

public int doEndTag()

Specified by:

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

Overrides:

doEndTag in class IncludeTag

initTag

protected void initTag()

handleTreePrefix

protected void handleTreePrefix()

getHeader

public java.lang.String getHeader(TreeViewTag.TreeView treeView)

getFooter

public java.lang.String getFooter(TreeViewTag.TreeView treeView)

setPrefix

public void setPrefix(java.lang.String treePrefix)

setNode

public void setNode(java.lang.Object treeNode)

setHint

public void setHint(java.lang.String treeHint)

getCss

public java.lang.String getCss()

setCss

public void setCss(java.lang.String treeCSS)

setWrapper

public void setWrapper(boolean wrapper)

setLevel

public void setLevel(int treeLevel)

setDragdrop

public void setDragdrop(boolean dragdrop)

setCollection

public void setCollection(java.util.Collection treeCollection)

setLink

public void setLink(java.lang.String treeLink)

setAjax

public void setAjax(boolean ajaxLink)

setInput

public void setInput(java.lang.String treeInput)

setType

public void setType(java.lang.String treeType)

setChecked

public void setChecked(java.util.Collection treeChecked)

setDisabled

public void setDisabled(java.util.Collection treeDisabled)

setDisable

public void setDisable(int treeDisable)

setHighlighted

public void setHighlighted(java.util.Collection treeHighlighted)

setHighlight

public void setHighlight(int treeHighlight)

setRemoved

public void setRemoved(java.util.Collection treeRemoved)

setRetains

public void setRetains(java.util.Collection treeRetains)

setOpened

public void setOpened(java.util.Collection treeOpened)

setMemo

public void setMemo(java.lang.Object memo)

setDecorator

public void setDecorator(TreeViewDecorator decorator)

clean

public void clean()

Overrides:

clean in class IncludeTag

isMatchCollection

public static boolean isMatchCollection(java.lang.Object node,
                                        java.util.Collection collec,
                                        boolean descendant,
                                        boolean parent)

Check if the given TreeNode is, is descendant or is parent of the given TreeNode Set.

Parameters:

node - the node Object to work with

collec - a Collection of node to look for

descendant - Check if given node Object is Descendant of given Set

parent - Check if given node Object is parent of given Set

Returns:

boolean true if the node Object matches

getTreeView

public TreeViewTag.TreeView getTreeView()

getTreeViewClass

protected java.lang.Class<? extends TreeViewTag.TreeView> getTreeViewClass()