com.jalios.jcms.taglib
Class TreeCatTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by com.jalios.jcms.taglib.TreeCatTag
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class TreeCatTag
extends javax.servlet.jsp.tagext.TagSupport

This class display a Category Tree using <UL> <LI> tags.
Many options allow customisation of the Tree look&feel and behaviour.
The generated tree works with treecat.css and treecat.js and TreeCat.java This class may be called by AJAX RPC Method.

Since:
jcms-5.5.0
Version:
$Revision: 35802 $
Author:
Jean-Philippe Encausse
See Also:
TreeCat, Serialized Form

Field Summary
protected  String fieldName
           
protected  EditPublicationHandler formHandler
           
protected  int level
           
static String REVISION
           
protected  boolean rootDisplay
           
protected  Set rootSet
           
protected  TreeCat treecat
           
protected  String widgetCounterName
           
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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
TreeCatTag()
           
 
Method Summary
protected  void clean()
          Clean Up parameters to avoid errors with tags pooling
 int doEndTag()
           
 int doStartTag()
           
 void setCss(String css)
           
 void setCtxCategories(Category[] ctxCategories)
           
 void setCtxMenu(boolean ctxmenu)
           
 void setDragdrop(boolean isDragDrop)
           
 void setEditDisplay(boolean isEditDisplay)
           
 void setEditParam(String editParam)
           
 void setFieldName(String fieldName)
           
 void setFilterMember(short filterMember)
           
 void setFilterWorkspace(boolean filterWorkspace)
           
 void setFormHandler(EditPublicationHandler formHandler)
           
 void setHelpDisplay(boolean isHelpDisplay)
           
 void setHighlightCatSet(Set highlightCatSet)
           
 void setHighlightDescendant(boolean highlightDescendant)
           
 void setLevel(int level)
          This method define the level of category to generate before using ajax.
 void setLoggedMember(Member loggedMember)
           
 void setNameLink(String nameLink)
           
 void setNameLinkNavigate(boolean nameLinkNavigate)
           
 void setNameLinkPubCount(boolean nameLinkPubCount)
           
 void setNameLinkRegexp(boolean nameLinkRegexp)
           
 void setNameStrong(boolean nameStrong)
           
 void setNodeAjaxSuffix(String nodeAjaxSuffix)
           
 void setNodeFunction(String nodeFunction)
           
 void setOpenedCatSet(Set openedCatSet)
           
 void setOpenHighlighted(boolean openHighlighted)
           
 void setOpenLevel(int openLevel)
           
 void setOpenParent(boolean openParent)
           
 void setOpenWidgetSelected(boolean openWidgetSelected)
           
 void setParameterMap(Map parameterMap)
           
 void setPortalDisplay(boolean isPortalDisplay)
           
 void setPortalLink(String portalLink)
           
 void setPortalLinkRegexp(boolean portalLinkRegexp)
           
 void setProxy(TreeCatProxy proxy)
           
 void setPubCountClass(Class pubCountClass)
           
 void setPubCountDisplay(boolean isPubCountDisplay)
           
 void setPubCountDisplayCat(boolean isPubCountDisplayCat)
           
 void setPubCountPstatus(boolean pubCountPstatus)
           
 void setPubCountSet(Set pubCountSet)
           
 void setPubReadableDisplay(boolean isPubReadableDisplay)
           
 void setRedirect(String redirect)
           
 void setRemovedCatSet(Set removedCatSet)
           
 void setResourcePath(String resourcePath)
           
 void setRetainedCatSet(Set retainedCatSet)
           
 void setRightsDisplay(boolean isRightsDisplay)
           
 void setRootCat(Category rootCat)
          This method define a scategory to display has root category.
 void setRootDisplay(boolean rootDisplay)
          This method define that given roots must be displayed or not.
 void setRootSet(Set rootSet)
          This method define a set of categories to display has root category.
 void setToggleLink(boolean toggleLink)
           
 void setUserLang(String userLang)
           
 void setWidget(short widget)
           
 void setWidgetCounterName(String widgetCounterName)
          This method define the generated variable name of the form element counter.
 void setWidgetDisableDescendant(boolean widgetDisableDescendant)
           
 void setWidgetDisabledSet(Set widgetDisabledSet)
           
 void setWidgetDisableParent(boolean widgetDisableParent)
           
 void setWidgetDisablePubCount(boolean widgetDisablePubCount)
           
 void setWidgetDisableSelectable(boolean widgetDisableSelectable)
           
 void setWidgetExclusive(boolean widgetExclusive)
           
 void setWidgetFunction(String widgetFunction)
           
 void setWidgetName(String widgetName)
           
 void setWidgetSelectDescendant(boolean widgetSelectDescendant)
           
 void setWidgetSelectedSet(Set widgetSelectedSet)
           
 void setWidgetSelectParent(boolean widgetSelectParent)
           
 void setWorkspace(Workspace workspace)
           
 void setWorkspaceDisplay(boolean isWorkspaceDisplay)
           
 void setWorkspaceModelDisplay(boolean isWorkspaceModelDisplay)
           
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values

treecat

protected TreeCat treecat

rootSet

protected Set rootSet

level

protected int level

widgetCounterName

protected String widgetCounterName

rootDisplay

protected boolean rootDisplay

fieldName

protected String fieldName

formHandler

protected EditPublicationHandler formHandler
Constructor Detail

TreeCatTag

public TreeCatTag()
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 javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException

doEndTag

public int doEndTag()
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport

clean

protected void clean()
Clean Up parameters to avoid errors with tags pooling


setLevel

public void setLevel(int level)
This method define the level of category to generate before using ajax. Default value is 0. May be overrided by openLevel if inferior to open level

Parameters:
level - int the generated level

setWidgetCounterName

public void setWidgetCounterName(String widgetCounterName)
This method define the generated variable name of the form element counter.

Parameters:
widgetCounterName - String the name of the counter

setRootSet

public void setRootSet(Set rootSet)
This method define a set of categories to display has root category.

Parameters:
rootSet - Set of category.

setRootCat

public void setRootCat(Category rootCat)
This method define a scategory to display has root category.

Parameters:
rootCat - Category root

setRootDisplay

public void setRootDisplay(boolean rootDisplay)
This method define that given roots must be displayed or not. Default value is true.

Parameters:
rootDisplay - boolean true to display roots

setFormHandler

public void setFormHandler(EditPublicationHandler formHandler)

setFieldName

public void setFieldName(String fieldName)

setNodeFunction

public void setNodeFunction(String nodeFunction)
See Also:
TreeCat.setNodeFunction(String)

setNodeAjaxSuffix

public void setNodeAjaxSuffix(String nodeAjaxSuffix)
See Also:
TreeCat.setNodeAjaxSuffix(String)

setOpenedCatSet

public void setOpenedCatSet(Set openedCatSet)
See Also:
TreeCat.setOpenedCatSet(Set)

setOpenParent

public void setOpenParent(boolean openParent)
See Also:
TreeCat.setOpenParent(boolean)

setOpenLevel

public void setOpenLevel(int openLevel)
See Also:
TreeCat.setOpenLevel(int)

setRemovedCatSet

public void setRemovedCatSet(Set removedCatSet)
See Also:
TreeCat.setRemovedCatSet(Set)

setRetainedCatSet

public void setRetainedCatSet(Set retainedCatSet)
See Also:
TreeCat.setRetainedCatSet(Set)

setHighlightCatSet

public void setHighlightCatSet(Set highlightCatSet)
See Also:
TreeCat.setHighlightCatSet(Set)

setOpenHighlighted

public void setOpenHighlighted(boolean openHighlighted)
See Also:
TreeCat.setOpenHighlighted(boolean)

setHighlightDescendant

public void setHighlightDescendant(boolean highlightDescendant)
See Also:
TreeCat.setHighlightDescendant(boolean)

setWidget

public void setWidget(short widget)
See Also:
TreeCat.setWidget(short)

setWidgetName

public void setWidgetName(String widgetName)
See Also:
TreeCat.setWidgetName(String)

setWidgetSelectedSet

public void setWidgetSelectedSet(Set widgetSelectedSet)
See Also:
TreeCat.setWidgetSelectedSet(Set)

setOpenWidgetSelected

public void setOpenWidgetSelected(boolean openWidgetSelected)
See Also:
TreeCat.setOpenWidgetSelected(boolean)

setWidgetSelectDescendant

public void setWidgetSelectDescendant(boolean widgetSelectDescendant)
See Also:
TreeCat.setWidgetSelectDescendant(boolean)

setWidgetSelectParent

public void setWidgetSelectParent(boolean widgetSelectParent)
See Also:
TreeCat.setWidgetSelectParent(boolean)

setWidgetDisabledSet

public void setWidgetDisabledSet(Set widgetDisabledSet)
See Also:
TreeCat.setWidgetDisabledSet(Set)

setWidgetDisableDescendant

public void setWidgetDisableDescendant(boolean widgetDisableDescendant)
See Also:
TreeCat.setWidgetDisableDescendant(boolean)

setWidgetDisableParent

public void setWidgetDisableParent(boolean widgetDisableParent)
See Also:
TreeCat.setWidgetDisableParent(boolean)

setWidgetDisableSelectable

public void setWidgetDisableSelectable(boolean widgetDisableSelectable)
See Also:
TreeCat.setWidgetDisableSelectable(boolean)

setWidgetFunction

public void setWidgetFunction(String widgetFunction)
See Also:
TreeCat.setWidgetFunction(String)

setWidgetExclusive

public void setWidgetExclusive(boolean widgetExclusive)
See Also:
TreeCat.setWidgetExclusive(boolean)

setWidgetDisablePubCount

public void setWidgetDisablePubCount(boolean widgetDisablePubCount)
See Also:
TreeCat.setWidgetDisablePubCount(boolean)

setRightsDisplay

public void setRightsDisplay(boolean isRightsDisplay)
See Also:
TreeCat.setRightsDisplay(boolean)

setHelpDisplay

public void setHelpDisplay(boolean isHelpDisplay)
See Also:
TreeCat.setHelpDisplay(boolean)

setPortalDisplay

public void setPortalDisplay(boolean isPortalDisplay)
See Also:
TreeCat.setPortalDisplay(boolean)

setWorkspaceDisplay

public void setWorkspaceDisplay(boolean isWorkspaceDisplay)
See Also:
TreeCat.setWorkspaceDisplay(boolean)

setWorkspaceModelDisplay

public void setWorkspaceModelDisplay(boolean isWorkspaceModelDisplay)
See Also:
TreeCat.setWorkspaceModelDisplay(boolean)

setEditDisplay

public void setEditDisplay(boolean isEditDisplay)
See Also:
TreeCat.setEditDisplay(boolean)

setPubCountDisplay

public void setPubCountDisplay(boolean isPubCountDisplay)
See Also:
TreeCat.setPubCountDisplay(boolean)

setPubCountDisplayCat

public void setPubCountDisplayCat(boolean isPubCountDisplayCat)
See Also:
TreeCat.setPubCountDisplayCat(boolean)

setPubReadableDisplay

public void setPubReadableDisplay(boolean isPubReadableDisplay)
See Also:
TreeCat.setPubReadableDisplay(boolean)

setFilterMember

public void setFilterMember(short filterMember)
See Also:
TreeCat.setFilterMember(short)

setFilterWorkspace

public void setFilterWorkspace(boolean filterWorkspace)
See Also:
TreeCat.setFilterWorkspace(boolean)

setPubCountClass

public void setPubCountClass(Class pubCountClass)
See Also:
TreeCat.setPubCountClass(Class)

setPubCountPstatus

public void setPubCountPstatus(boolean pubCountPstatus)
See Also:
TreeCat.setPubCountPstatus(boolean)

setPubCountSet

public void setPubCountSet(Set pubCountSet)
See Also:
TreeCat.setPubCountSet(Set)

setEditParam

public void setEditParam(String editParam)
See Also:
TreeCat.setEditParam(String)

setNameStrong

public void setNameStrong(boolean nameStrong)
See Also:
TreeCat.setNameStrong(boolean)

setNameLink

public void setNameLink(String nameLink)
See Also:
TreeCat.setNameLink(String)

setNameLinkPubCount

public void setNameLinkPubCount(boolean nameLinkPubCount)
See Also:
TreeCat.setNameLinkPubCount(boolean)

setNameLinkNavigate

public void setNameLinkNavigate(boolean nameLinkNavigate)
See Also:
TreeCat.setNameLinkNavigate(boolean)

setNameLinkRegexp

public void setNameLinkRegexp(boolean nameLinkRegexp)
See Also:
TreeCat.setNameLinkRegexp(boolean)

setToggleLink

public void setToggleLink(boolean toggleLink)
See Also:
TreeCat.setToggleLink(boolean)

setRedirect

public void setRedirect(String redirect)
See Also:
TreeCat.setRedirect(String)

setLoggedMember

public void setLoggedMember(Member loggedMember)
See Also:
AbstractJcmsAjaxContext.setLoggedMember(Member)

setUserLang

public void setUserLang(String userLang)
See Also:
AbstractJcmsAjaxContext.setUserLang(String)

setWorkspace

public void setWorkspace(Workspace workspace)
See Also:
AbstractJcmsAjaxContext.setWorkspace(Workspace)

setCtxCategories

public void setCtxCategories(Category[] ctxCategories)
See Also:
AbstractJcmsAjaxContext.setCtxCategories(Category[])

setResourcePath

public void setResourcePath(String resourcePath)
See Also:
AbstractJcmsAjaxContext.setResourcePath(String)

setParameterMap

public void setParameterMap(Map parameterMap)
See Also:
AbstractJcmsAjaxContext.setParameterMap(Map)

setPortalLink

public void setPortalLink(String portalLink)
See Also:
TreeCat.setPortalLink(String)

setPortalLinkRegexp

public void setPortalLinkRegexp(boolean portalLinkRegexp)
See Also:
TreeCat.setPortalLinkRegexp(boolean)

setProxy

public void setProxy(TreeCatProxy proxy)
See Also:
TreeCat.setProxy(TreeCatProxy)

setCss

public void setCss(String css)
See Also:
TreeCat.setCss(String)

setCtxMenu

public void setCtxMenu(boolean ctxmenu)
See Also:
TreeCat.setCtxMenu(boolean)

setDragdrop

public void setDragdrop(boolean isDragDrop)
See Also:
TreeCat.setDragDrop(boolean)


Copyright © 2001-2010 Jalios SA. All Rights Reserved.