| java.lang.Object
 com.ivata.groupware.web.tree.TreeNodeRenderer
com.ivata.groupware.web.tree.DefaultTreeNodeRenderer
All known Subclasses: com.ivata.groupware.web.tree.person.PersonTreeNodeRenderer, com.ivata.groupware.web.tree.comment.CommentTreeNodeRenderer,
| DefaultTreeNodeRenderer | | public class DefaultTreeNodeRenderer extends TreeNodeRenderer (Code) | | Create a default tree node renderer to draw your tree. This
renderer
calls
com.ivata.groupware.web.theme.Theme.parseSectionTheme.parseSection to parse the standard tree theme sections 'treeOpen', 'treeClosed',
'treeNoChildren' and 'treeLeaf'.
The object you provide must implement
com.ivata.groupware.web.DefaultTreeNodeTreeNode .
In each of these sections, the property 'caption' is parsed out
to the
com.ivata.groupware.web.DefaultTreeNode.getName getName value
of the node
provided, and the property 'id' is parsed out to the value of
com.ivata.groupware.web.DefaultTreeNode.getNamegetId .
since:
2002-05-16
author:
Colin MacLeod
author:
colin.macleod@ivata.com
version:
$Revision: 1.3 $
See Also: TreeNodeRenderer
See Also: com.ivata.groupware.web.theme.Theme.parseSection |
| Method Summary | |
| public PageContext | getPageContext()
| | public void | initialize(HttpSession session, HttpServletRequest request, JspWriter out, PageContext pageContextParam)
| | public String | render(TreeModel model, Object node, boolean expanded, int level, boolean last, Theme theme, Properties properties)
Render a standard tree using the theme sections 'treeOpen',
'treeClosed',
'treeNoChildren' and 'treeLeaf'.
The following properties will be defined:
| property |
description |
| caption |
The value returned by node.toString( ). |
| id |
The id of the node. |
| last |
'Last' if this is the last node in the current branch,
otherwise
this property is not set. |
These properties are evaluated by calling
com.ivata.groupware.web.theme.Theme.parseSection(String sNamejava.util.Properties properties)Theme.parseSection(String sName, java.util.Propertiesproperties) for each of the relevant theme sections.
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. | | public Properties | setAdditionalProperties(TreeNode treeNode, int level, Properties properties)
Can be overridden by super-class to provide addtional property
information
for a node.
Parameters:
treeNode - the current node in the tree being drawn.
Parameters:
level - the depth of this node within the tree, with 0 beingroot.
Parameters:
properties - all the properties are already defined. | | public void | setPageContext(PageContext pageContextParam)
|
| getPageContext | | public PageContext getPageContext()(Code) | |
Get the PageContext for the current JSP page we are
processing.
The PageContext for the current JSP page we areprocessing. |
| initialize | | public void initialize(HttpSession session, HttpServletRequest request, JspWriter out, PageContext pageContextParam) 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:
pageContextParam - the current PageContext
throws:
JspException - not thrown by this class but can be thrown bysubclasses who experience an error on initialization. |
| render | | public String render(TreeModel model, Object node, boolean expanded, int level, boolean last, Theme theme, Properties properties) throws JspException(Code) | | Render a standard tree using the theme sections 'treeOpen',
'treeClosed',
'treeNoChildren' and 'treeLeaf'.
The following properties will be defined:
| property |
description |
| caption |
The value returned by node.toString( ). |
| id |
The id of the node. |
| last |
'Last' if this is the last node in the current branch,
otherwise
this property is not set. |
These properties are evaluated by calling
com.ivata.groupware.web.theme.Theme.parseSection(String sNamejava.util.Properties properties)Theme.parseSection(String sName, java.util.Propertiesproperties) for each of the relevant theme sections.
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 'treeOpen','treeClosed''treeNoChildren' or 'treeLeaf' have not been defined. |
| setAdditionalProperties | | public Properties setAdditionalProperties(TreeNode treeNode, int level, Properties properties) throws JspException(Code) | | Can be overridden by super-class to provide addtional property
information
for a node.
Parameters:
treeNode - the current node in the tree being drawn.
Parameters:
level - the depth of this node within the tree, with 0 beingroot.
Parameters:
properties - all the properties are already defined. Newpropertiesshould be added to this instance and returned. all of the properties which should be evaluated in theclient themesection.
throws:
JspException - thrown by subclasses if there is a formattingerror. |
| Methods inherited from com.ivata.groupware.web.tree.TreeNodeRenderer | public void finalize(HttpSession session, HttpServletRequest request, JspWriter out) throws JspException(Code)(Java Doc)
public TreeTag getTreeTag()(Code)(Java Doc)
abstract public void initialize(HttpSession session, HttpServletRequest request, JspWriter out, PageContext pageContext) throws JspException(Code)(Java Doc)
abstract public String render(TreeModel model, Object node, boolean expanded, int level, boolean last, Theme theme, Properties properties) throws JspException(Code)(Java Doc)
public void setTreeTag(TreeTag treeTagParam)(Code)(Java Doc)
|
|
|