Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.admin
Class SidebarTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by com.opensymphony.webwork.views.jsp.WebWorkBodyTagSupport
              extended by com.opensymphony.webwork.views.jsp.ComponentTagSupport
                  extended by com.jivesoftware.base.admin.SidebarTag
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:
SubSidebarTag

public class SidebarTag
extends com.opensymphony.webwork.views.jsp.ComponentTagSupport

A simple JSP tag for displaying sidebar information in the admin console. The TabsTag is similiar to this one.

Attributes:

This class assumes there is a request attribute with the name specified by the bean attribute.

This tag prints out minimal HTML. It basically prints an unordered list (UL element) with each LI containing an "A" tag specfied by the body content of this tag. For example, the body should contain a template A tag which will have its values replaced at runtime:

There is a subsidebar tag for rendering the sub-sidebars. For more info, see the SubSidebarTag class.

Available tokens for the "A" tag are:

See Also:
Serialized Form

Field Summary
protected  java.lang.String bean
           
protected  java.lang.String css
           
protected  java.lang.String currentcss
           
protected  java.lang.String headercss
           
protected  java.lang.String minEdition
           
protected  java.lang.String product
           
protected  java.lang.String role
           
 
Fields inherited from class com.opensymphony.webwork.views.jsp.ComponentTagSupport
component
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
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
SidebarTag()
           
 
Method Summary
 com.opensymphony.webwork.components.Component getBean(com.opensymphony.xwork.util.OgnlValueStack stack, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
           
 java.lang.String getProduct()
           
 void setBean(java.lang.String bean)
           
 void setCss(java.lang.String css)
          Sets the CSS used for tab decoration.
 void setCurrentcss(java.lang.String currentcss)
          Sets the CSS class value for the currently selected tab.
 void setHeadercss(java.lang.String headercss)
          Sets the CSS value used for the sidebar header sections.
 void setMinEdition(java.lang.String minEdition)
           
 void setProduct(java.lang.String product)
           
 void setRole(java.lang.String role)
           
 
Methods inherited from class com.opensymphony.webwork.views.jsp.ComponentTagSupport
doEndTag, doStartTag, getComponent, populateParams
 
Methods inherited from class com.opensymphony.webwork.views.jsp.WebWorkBodyTagSupport
altSyntax, findString, findValue, findValue, getBody, getStack, setId, toString, translateVariables
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, 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

css

protected java.lang.String css

currentcss

protected java.lang.String currentcss

headercss

protected java.lang.String headercss

minEdition

protected java.lang.String minEdition

product

protected java.lang.String product

role

protected java.lang.String role

bean

protected java.lang.String bean
Constructor Detail

SidebarTag

public SidebarTag()
Method Detail

setCss

public void setCss(java.lang.String css)
Sets the CSS used for tab decoration.


setCurrentcss

public void setCurrentcss(java.lang.String currentcss)
Sets the CSS class value for the currently selected tab.


setHeadercss

public void setHeadercss(java.lang.String headercss)
Sets the CSS value used for the sidebar header sections.


setMinEdition

public void setMinEdition(java.lang.String minEdition)

getProduct

public java.lang.String getProduct()

setProduct

public void setProduct(java.lang.String product)

setRole

public void setRole(java.lang.String role)

setBean

public void setBean(java.lang.String bean)

getBean

public com.opensymphony.webwork.components.Component getBean(com.opensymphony.xwork.util.OgnlValueStack stack,
                                                             javax.servlet.http.HttpServletRequest req,
                                                             javax.servlet.http.HttpServletResponse res)
Specified by:
getBean in class com.opensymphony.webwork.views.jsp.ComponentTagSupport

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.