public class SidebarTag
extends javax.servlet.jsp.tagext.BodyTagSupport
A simple JSP tag for displaying sidebar information in the admin console. The
TabsTag
is similiar to this one.
Attributes:
bean
(required) - the id of the request attribute which is a
AdminPageBean
instance. This class holds information
needed to properly render the admin console sidebar.css
(optional) - the CSS class name used to decorate the LI of the sidebar items.currentcss
(optional) - the CSS class name used to decorate the LI of the
currently selected sidebar item.heaadercss
(optional) - the CSS class name used to decorate the LI of the header
section.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:
<jive:sidebar bean="jivepageinfo"> <br>
<a href="[url]" title="[description]">[name]</a> <br>
<jive:subsidebar> ... </jive:subsidebar> <br>
</jive:sidebar>
There is a subsidebar tag for rendering the sub-sidebars. For more info, see the
SubSidebarTag
class.
Available tokens for the "A" tag are:
[id]
- the ID of the sidebar item, usually not needed.[name]
- the name of the sidebar item, should be thought of as the display name.[url]
- the URL of the sidebar item.[description]
- the description of the sidebar item, good for mouse rollovers.Constructor and Description |
---|
SidebarTag() |
Modifier and Type | Method and Description |
---|---|
int |
doEndTag()
Gets the
AdminPageBean instance from the request. |
int |
doStartTag()
Does nothing, returns
BodyTag.EVAL_BODY_BUFFERED always. |
String |
getCss()
Returns the value of the CSS class to be used for tab decoration.
|
String |
getCurrentcss()
Returns the value of the CSS class to be used for the currently selected LI (tab).
|
String |
getHeadercss()
Returns the value of the CSS class to be used for sidebar header sections.
|
SubSidebarTag |
getSubsidebarTag()
Returns the subsidebar tag - should be declared in the body of this tag (see class description).
|
void |
setCss(String css)
Sets the CSS used for tab decoration.
|
void |
setCurrentcss(String currentcss)
Sets the CSS class value for the currently selected tab.
|
void |
setHeadercss(String headercss)
Sets the CSS value used for the sidebar header sections.
|
void |
setSubSidebar(SubSidebarTag subsidebarTag)
Sets the subsidebar tag - used by the container.
|
doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
public String getCss()
public void setCss(String css)
css
- the CSSpublic String getCurrentcss()
public void setCurrentcss(String currentcss)
currentcss
- the CSS classpublic String getHeadercss()
public void setHeadercss(String headercss)
headercss
- the CSSpublic SubSidebarTag getSubsidebarTag()
public void setSubSidebar(SubSidebarTag subsidebarTag)
subsidebarTag
- the sidebar tagpublic int doStartTag() throws javax.servlet.jsp.JspException
BodyTag.EVAL_BODY_BUFFERED
always.doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
public int doEndTag() throws javax.servlet.jsp.JspException
AdminPageBean
instance from the request. If it doesn't exist then execution is stopped
and nothing is printed. If it exists, retrieve values from it and render the sidebar items. The body content
of the tag is assumed to have an A tag in it with tokens to replace (see class description) as well
as having a subsidebar tag..doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class javax.servlet.jsp.tagext.BodyTagSupport
Tag.EVAL_PAGE
after rendering the tabs.javax.servlet.jsp.JspException
- if an exception occurs while rendering the sidebar items.Copyright © 2003–2020 Ignite Realtime. All rights reserved.