org.objectweb.jonas.webapp.taglib.TreeControlTag Class Reference

Inherited by org.objectweb.jonas.webapp.taglib.TreeControlRenderTag.

List of all members.

Public Member Functions
int	doEndTag () throws JspException
void	release ()
Protected Member Functions
TreeControl	getTreeControl () throws JspException
void	render (JspWriter out, TreeControlNode node, int level, int width, boolean last) throws IOException
String	replace (String template, String placeholder, String value)
Protected Attributes
String	action = null
String	images = DEFAULT_IMAGES
String	scope = null
String	style = null
String	styleSelected = null
String	styleUnselected = null
String	tree = null
Static Package Attributes
final String	DEFAULT_IMAGES = "images"
final String	IMAGE_HANDLE_DOWN_LAST = "handledownlast.gif"

---

Detailed Description

JSP custom tag that renders a tree control represented by the TreeControl and TreeControlNode classes. This tag has the following user-settable attributes:

• action - Hyperlink to which expand/contract actions should be sent, with a string "${node} marking where the node name of the affected node should be included.
• images - Name of the directory containing the images for our icons, relative to the page including this tag. If not specified, defaults to "images".
• scope - Attribute scope in which the tree attribute is to be found (page, request, session, application). If not specified, the attribute is searched for in all scopes.
• style - CSS style class to be applied to be applied to the entire rendered output of the tree control. If not specified, no style class is applied.
• styleSelected - CSS style class to be applied to the text of any element that is currently selected. If not specified, no additional style class is applied.
• styleUnselected - CSS style class to be applied to the text of any element that is not currently selected. If not specified, no additional style class is applied.
• tree - Attribute name under which the TreeControl bean of the tree we are rendering is stored, in the scope specified by the scope attribute. This attribute is required.

FIXME - Internationalize the exception messages!

Author:

Craig R. McClanahan

Version:

Revision

1.2

Date

2003/11/12 17:19:38

Definition at line 109 of file TreeControlTag.java.

---

Member Function Documentation

int org.objectweb.jonas.webapp.taglib.TreeControlTag.doEndTag (   )  throws JspException

Render this tree control. Exceptions: JspException  if a processing error occurs Definition at line 240 of file TreeControlTag.java. References org.objectweb.jonas.webapp.taglib.TreeControl.getRoot(), org.objectweb.jonas.webapp.taglib.TreeControlTag.getTreeControl(), org.objectweb.jonas.webapp.taglib.TreeControl.getWidth(), org.objectweb.jonas.webapp.taglib.TreeControlTag.render(), and org.objectweb.jonas.webapp.taglib.TreeControlTag.style.

Here is the call graph for this function:

TreeControl org.objectweb.jonas.webapp.taglib.TreeControlTag.getTreeControl (   )  throws JspException [protected]

Return the TreeControl instance for the tree control that we are rendering. Exceptions: JspException  if no TreeControl instance can be found Definition at line 289 of file TreeControlTag.java. References org.objectweb.jonas.webapp.taglib.TreeControlTag.scope, and org.objectweb.jonas.webapp.taglib.TreeControlTag.tree. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.doEndTag().

void org.objectweb.jonas.webapp.taglib.TreeControlTag.release (   )

Release all state information set by this tag. Definition at line 269 of file TreeControlTag.java. References org.objectweb.jonas.webapp.taglib.TreeControlNode.action, and org.objectweb.jonas.webapp.taglib.TreeControlNode.tree.

void org.objectweb.jonas.webapp.taglib.TreeControlTag.render (  JspWriter  out, TreeControlNode  node, int  level, int  width, boolean  last )  throws IOException [protected]

Render the specified node, as controlled by the specified parameters. Parameters: out  The JspWriter to which we are writing node  The TreeControlNode we are currently rendering level  The indentation level of this node in the tree width  Total displayable width of the tree last  Is this the last node in a list? Exceptions: IOException  if an input/output error occurs Definition at line 332 of file TreeControlTag.java. References org.objectweb.jonas.webapp.taglib.TreeControlTag.action, org.objectweb.jonas.webapp.taglib.TreeControlNode.findChildren(), org.objectweb.jonas.webapp.taglib.TreeControlNode.getParent(), org.objectweb.jonas.webapp.taglib.TreeControlNode.getTarget(), org.objectweb.jonas.webapp.taglib.TreeControlTag.IMAGE_HANDLE_DOWN_LAST, org.objectweb.jonas.webapp.taglib.TreeControlTag.images, org.objectweb.jonas.webapp.taglib.TreeControlNode.isLast(), org.objectweb.jonas.webapp.taglib.TreeControlTag.replace(), org.objectweb.jonas.webapp.taglib.TreeControlTag.styleSelected, and org.objectweb.jonas.webapp.taglib.TreeControlTag.styleUnselected. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.doEndTag().

Here is the call graph for this function:

String org.objectweb.jonas.webapp.taglib.TreeControlTag.replace (  String  template, String  placeholder, String  value )  [protected]

Replace any occurrence of the specified placeholder in the specified template string with the specified replacement value. Parameters: template  Pattern string possibly containing the placeholder placeholder  Placeholder expression to be replaced value  Replacement value for the placeholder Definition at line 535 of file TreeControlTag.java. References org.objectweb.jonas.webapp.taglib.TreeControlNode.toString(). Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.render().

Here is the call graph for this function:

---

Member Data Documentation

String org.objectweb.jonas.webapp.taglib.TreeControlTag.action = null [protected]

The hyperlink to be used for submitting requests to expand and contract tree nodes. The placeholder "<code>${name}</code>" will be replaced by the name property of the current tree node. Definition at line 135 of file TreeControlTag.java. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.render().

final String org.objectweb.jonas.webapp.taglib.TreeControlTag.DEFAULT_IMAGES = "images" [static, package]

The default directory name for icon images. Definition at line 114 of file TreeControlTag.java.

final String org.objectweb.jonas.webapp.taglib.TreeControlTag.IMAGE_HANDLE_DOWN_LAST = "handledownlast.gif" [static, package]

The names of tree state images that we need. Definition at line 119 of file TreeControlTag.java. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.render().

String org.objectweb.jonas.webapp.taglib.TreeControlTag.images = DEFAULT_IMAGES [protected]

The name of the directory containing the images for our icons, relative to the page including this tag. Definition at line 149 of file TreeControlTag.java. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.render().

String org.objectweb.jonas.webapp.taglib.TreeControlTag.scope = null [protected]

The name of the scope in which to search for the tree attribute. Must be "page", "request", "session", or "application" (or null for an ascending-visibility search). Definition at line 164 of file TreeControlTag.java. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.getTreeControl().

String org.objectweb.jonas.webapp.taglib.TreeControlTag.style = null [protected]

The CSS style class to be applied to the entire tree. Definition at line 181 of file TreeControlTag.java. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.doEndTag().

String org.objectweb.jonas.webapp.taglib.TreeControlTag.styleSelected = null [protected]

The CSS style class to be applied to the text of selected nodes. Definition at line 195 of file TreeControlTag.java. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.render().

String org.objectweb.jonas.webapp.taglib.TreeControlTag.styleUnselected = null [protected]

The CSS style class to be applied to the text of unselected nodes. Definition at line 209 of file TreeControlTag.java. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.render().

String org.objectweb.jonas.webapp.taglib.TreeControlTag.tree = null [protected]

The name of the attribute (in the specified scope) under which our TreeControl instance is stored. Definition at line 223 of file TreeControlTag.java. Referenced by org.objectweb.jonas.webapp.taglib.TreeControlTag.getTreeControl().

---

The documentation for this class was generated from the following file:

• src/org/objectweb/jonas/webapp/taglib/TreeControlTag.java

---