Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.admin
Class Tabs

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

public class Tabs
extends com.opensymphony.webwork.components.Component

A simple JSP tag for displaying tab information in the admin console. The SidebarTag 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:

Available token are:


Field Summary
 
Fields inherited from class com.opensymphony.webwork.components.Component
COMPONENT_STACK, id, parameters, stack
 
Constructor Summary
Tabs(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 getBean()
          The name of the request attribute which holds a AdminPageBean instance.
 java.lang.String getCss()
          Returns the value of the CSS class to be used for tab decoration.
 java.lang.String getCurrentcss()
          Returns the value of the CSS class to be used for the currently selected LI (tab).
 java.lang.String getFilename()
           
 java.lang.String getMinEdition()
           
 java.lang.String getProduct()
           
 java.lang.String getRole()
           
 void setBean(java.lang.String bean)
          Sets the name of the request attribute to hold a AdminPageBean instance.
 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 setFilename(java.lang.String filename)
           
 void setMinEdition(java.lang.String minEdition)
           
 void setProduct(java.lang.String product)
           
 void setRole(java.lang.String role)
           
 boolean 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

Tabs

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

getFilename

public java.lang.String getFilename()

setFilename

public void setFilename(java.lang.String filename)

getRole

public java.lang.String getRole()

setRole

public void setRole(java.lang.String role)

getMinEdition

public java.lang.String getMinEdition()

setMinEdition

public void setMinEdition(java.lang.String minEdition)

getProduct

public java.lang.String getProduct()

setProduct

public void setProduct(java.lang.String product)

getBean

public java.lang.String getBean()
The name of the request attribute which holds a AdminPageBean instance.


setBean

public void setBean(java.lang.String bean)
Sets the name of the request attribute to hold a AdminPageBean instance.


getCss

public java.lang.String getCss()
Returns the value of the CSS class to be used for tab decoration. If not set will return a blank string.


setCss

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


getCurrentcss

public java.lang.String getCurrentcss()
Returns the value of the CSS class to be used for the currently selected LI (tab). If not set will return a blank string.


setCurrentcss

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


end

public boolean end(java.io.Writer writer,
                   java.lang.String body)
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 tabs. The body content of the tag is assumed to have an A tag in it with tokens to replace (see class description).

Overrides:
end in class com.opensymphony.webwork.components.Component
Throws:
JiveRuntimeException - if an exception occurs while rendering the tabs.

usesBody

public boolean usesBody()
Overrides:
usesBody in class com.opensymphony.webwork.components.Component

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.