| java.lang.Object
 com.ivata.groupware.web.tree.TreeNodeRenderer
All known Subclasses: com.ivata.groupware.web.tree.DefaultTreeNodeRenderer,
| TreeNodeRenderer | | abstract public class TreeNodeRenderer (Code) | | This interface defines the methods of an HTML tree renderer as
used in
the ivata groupware
com.ivata.groupware.web.tag.webgui.TreeTagtreetag .
since:
2002-05-16
author:
Colin MacLeod
author:
colin.macleod@ivata.com
version:
$Revision: 1.3 $ |
| Method Summary | |
| public void | finalize(HttpSession session, HttpServletRequest request, JspWriter out)
Is called by the tree tag after the tree has been drawn. | | public TreeTag | getTreeTag()
| | abstract public void | initialize(HttpSession session, HttpServletRequest request, JspWriter out, PageContext pageContext)
| | abstract public String | render(TreeModel model, Object node, boolean expanded, int level, boolean last, Theme theme, Properties properties)
Get a string which will be used in the tree representation of
the tree node. | | public void | setTreeTag(TreeTag treeTagParam)
|
| finalize | | public void finalize(HttpSession session, HttpServletRequest request, JspWriter out) throws JspException(Code) | | Is called by the tree tag after the tree has been drawn. Can be
overridden
by subclasses to provide finalization.
This default implementation does nothing.
Parameters:
session - the current session which can be used to retrievesettings.
Parameters:
request - the current servlet request which can be used toretrievesettings.
Parameters:
out - jsp writer which can be used to output HTML.
throws:
JspException - not thrown by this class but can be thrown bysubclasseswho experience an error on finalization. |
| getTreeTag | | public TreeTag getTreeTag()(Code) | | Get the internal reference to the tree tag.
internal reference to the treetag which owns this renderer. |
| initialize | | abstract public void initialize(HttpSession session, HttpServletRequest request, JspWriter out, PageContext pageContext) throws JspException(Code) | | This method is called by the tree tag during
doStartTag to
allow the renderer to open or close folders as apropriate.
Parameters:
session - the current session which can be used to retrievesettings.
Parameters:
request - the current servlet request which can be used toretrievesettings.
Parameters:
out - jsp writer which can be used to output HTML.
Parameters:
pageContext - the current PageContext
throws:
JspException - not thrown by this class but can be thrown bysubclasseswho experience an error on initialization. |
| render | | abstract public String render(TreeModel model, Object node, boolean expanded, int level, boolean last, Theme theme, Properties properties) throws JspException(Code) | | Get a string which will be used in the tree representation of
the tree node. This can contain caption information and image
paths, for
example, as properties which are evaluated by
com.ivata.groupware.web.theme.Theme.parseSection(String namejava.util.Properties properties)Theme.parseSection(String name, java.util.Propertiesproperties) .
Parameters:
model - TreeModel representing the data of thetree.
Parameters:
node - Object representing a node in the tree.ThetoString( ) of this node will be used as the'caption'properties when parsing.
Parameters:
expanded - true if this node is 'open', otherwisefalse.
Parameters:
level - the depth of this node within the tree, with 0 beingroot.
Parameters:
last - true if this node is the last in thecurrent branch,otherwise false.
Parameters:
theme - this theme does the parsing.
Parameters:
properties - existing properties to parse. the parsed string.
throws:
JspException - if the theme sections required by therenderer have not been defined. |
| setTreeTag | | public void setTreeTag(TreeTag treeTagParam)(Code) | | This method initializes the internal reference to the tree
tag.
Parameters:
treeTagParam - internal reference to the treetag which owns thisrenderer. |
|
|