Commit 0109c2b7 authored by Bill Lynch's avatar Bill Lynch Committed by bill

Dox


git-svn-id: http://svn.igniterealtime.org/svn/repos/messenger/trunk@290 b35dd754-fafc-0310-a699-88a17e54d16e
parent b107c20d
...@@ -20,11 +20,43 @@ import java.util.Collection; ...@@ -20,11 +20,43 @@ import java.util.Collection;
import java.util.Iterator; import java.util.Iterator;
import java.io.IOException; import java.io.IOException;
/**
* <p>A simple JSP tag for displaying sidebar information in the admin console. The
* {@link TabsTag} is similiar to this one.</p>
*
* <p>Attributes: <ul>
* <li><tt>bean</tt> (required) - the id of the request attribute which is a
* {@link AdminPageBean} instance. This class holds information
* needed to properly render the admin console sidebar.</li>
* <li><tt>css</tt> (optional) - the CSS class name used to decorate the LI of the sidebar items.</li>
* <li><tt>currentcss</tt> (optional) - the CSS class name used to decorate the LI of the
* currently selected sidebar item.</li>
* <li><tt>heaadercss</tt> (optional) - the CSS class name used to decorate the LI of the header
* section.</li></ul></p>
*
* <p>This class assumes there is a request attribute with the name specified by the bean attribute.</p>
*
* <p>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: <ul><tt>
*
* &lt;jive:sidebar bean="jivepageinfo"&gt; <br>
* &nbsp;&nbsp;&nbsp;&lt;a href="[url]" title="[description]"&gt;[name]&lt;/a&gt; <br>
* &nbsp;&nbsp;&nbsp;&lt;jive:subsidebar&gt; ... &lt;/jive:subsidebar&gt; <br>
* &lt;/jive:sidebar&gt;</tt></ul>
*
* There is a subsidebar tag for rendering the sub-sidebars. For more info, see the
* {@link SubSidebarTag} class.</p>
*
* <p>Available tokens for the "A" tag are: <ul>
* <li><tt>[id]</tt> - the ID of the sidebar item, usually not needed.</li>
* <li><tt>[name]</tt> - the name of the sidebar item, should be thought of as the display name.</li>
* <li><tt>[url]</tt> - the URL of the sidebar item.</li>
* <li><tt>[description]</tt> - the description of the sidebar item, good for mouse rollovers.</li></ul></p>
*/
public class SidebarTag extends BodyTagSupport { public class SidebarTag extends BodyTagSupport {
private String bean; private String bean;
private String role;
private String minEdition;
private String css; private String css;
private String currentcss; private String currentcss;
private String headercss; private String headercss;
...@@ -44,22 +76,6 @@ public class SidebarTag extends BodyTagSupport { ...@@ -44,22 +76,6 @@ public class SidebarTag extends BodyTagSupport {
this.bean = bean; this.bean = bean;
} }
public String getRole() {
return role;
}
public void setRole(String role) {
this.role = role;
}
public String getMinEdition() {
return minEdition;
}
public void setMinEdition(String minEdition) {
this.minEdition = minEdition;
}
/** /**
* Returns the value of the CSS class to be used for tab decoration. If not set will return a blank string. * Returns the value of the CSS class to be used for tab decoration. If not set will return a blank string.
*/ */
......
...@@ -13,6 +13,21 @@ package org.jivesoftware.admin; ...@@ -13,6 +13,21 @@ package org.jivesoftware.admin;
import javax.servlet.jsp.JspException; import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspTagException; import javax.servlet.jsp.JspTagException;
/**
* <p>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 {@link SidebarTag}.</p>
*
* <p>Sample usage:<ul><tt>
*
* &lt;jive:sidebar bean="jivepageinfo"&gt; <br>
* &nbsp;&nbsp;&nbsp;&lt;a href="[url]" title="[description]"&gt;[name]&lt;/a&gt; <br>
* &nbsp;&nbsp;&nbsp;&lt;jive:subsidebar&gt; <br>
* &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;a href="[url]"&gt;[name]&lt;/a&gt; <br>
* &nbsp;&nbsp;&nbsp;&lt;/jive:subsidebar&gt; <br>
* &lt;/jive:sidebar&gt;</tt></ul></p>
*
* <p>Note, this class has no attributes.</p>
*/
public class SubSidebarTag extends SidebarTag { public class SubSidebarTag extends SidebarTag {
private SidebarTag parent; private SidebarTag parent;
......
...@@ -20,11 +20,37 @@ import java.util.Collection; ...@@ -20,11 +20,37 @@ import java.util.Collection;
import java.util.Iterator; import java.util.Iterator;
import java.io.IOException; import java.io.IOException;
/**
* <p>A simple JSP tag for displaying tab information in the admin console. The
* {@link SidebarTag} is similiar to this one.</p>
*
* <p>Attributes: <ul>
* <li><tt>bean</tt> (required) - the id of the request attribute which is a
* {@link AdminPageBean} instance. This class holds information
* needed to properly render the admin console tabs.</li>
* <li><tt>css</tt> (optional) - the CSS class name used to decorate the LI of the tab.</li>
* <li><tt>currentcss</tt> (optional) - the CSS class name used to decorate the LI of the
* currently selected tab.</li></ul></p>
*
* <p>This class assumes there is a request attribute with the name specified by the bean attribute.</p>
*
* <p>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: <ul><tt>
*
* &lt;jive:tabs bean="jivepageinfo"&gt; <br>
* &nbsp;&nbsp;&nbsp;&lt;a href="[url]" title="[description]"&gt;[name]&lt;/a&gt; <br>
* &lt;/jive:tabs&gt;</tt></ul>
*
* Available token are: <ul>
* <li><tt>[id]</tt> - the ID of the tab, usually not needed.</li>
* <li><tt>[name]</tt> - the name of the tab, should be thought of as the display name.</li>
* <li><tt>[url]</tt> - the URL of the tab.</li>
* <li><tt>[description]</tt> - the description of the tab, good for mouse rollovers.</li></ul></p>
*/
public class TabsTag extends BodyTagSupport { public class TabsTag extends BodyTagSupport {
private String bean; private String bean;
private String role;
private String minEdition;
private String css; private String css;
private String currentcss; private String currentcss;
...@@ -42,22 +68,6 @@ public class TabsTag extends BodyTagSupport { ...@@ -42,22 +68,6 @@ public class TabsTag extends BodyTagSupport {
this.bean = bean; this.bean = bean;
} }
public String getRole() {
return role;
}
public void setRole(String role) {
this.role = role;
}
public String getMinEdition() {
return minEdition;
}
public void setMinEdition(String minEdition) {
this.minEdition = minEdition;
}
/** /**
* Returns the value of the CSS class to be used for tab decoration. If not set will return a blank string. * Returns the value of the CSS class to be used for tab decoration. If not set will return a blank string.
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment