Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.admin
Class SubSidebar

java.lang.Object
  extended by com.opensymphony.webwork.components.Component
      extended by com.jivesoftware.base.admin.Sidebar
          extended by com.jivesoftware.base.admin.SubSidebar

public class SubSidebar
extends Sidebar

A simple tag to gather its body content and pass it to the parent tag. This tag must be used as a child of the SidebarTag.

Sample usage:

Note, this class has no attributes.


Field Summary
 
Fields inherited from class com.opensymphony.webwork.components.Component
COMPONENT_STACK, id, parameters, stack
 
Constructor Summary
SubSidebar(com.opensymphony.xwork.util.OgnlValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 
Method Summary
 boolean end(java.io.Writer writer, java.lang.String body)
          Gets the AdminPageBean instance from the request.
 java.lang.String getBody()
           
 void setBody(java.lang.String body)
           
 
Methods inherited from class com.jivesoftware.base.admin.Sidebar
getBean, getCss, getCurrentcss, getHeadercss, getMinEdition, getProduct, getRole, getSubsidebar, setBean, setCss, setCurrentcss, setHeadercss, setMinEdition, setProduct, setRole, setSubsidebar, usesBody
 
Methods inherited from class com.opensymphony.webwork.components.Component
addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, start, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubSidebar

public SubSidebar(com.opensymphony.xwork.util.OgnlValueStack stack,
                  javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
Method Detail

getBody

public java.lang.String getBody()

setBody

public void setBody(java.lang.String body)

end

public boolean end(java.io.Writer writer,
                   java.lang.String body)
Description copied from class: Sidebar
Gets the 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..

Overrides:
end in class Sidebar

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.