| java.lang.Object
 org.apache.beehive.netui.tags.tree.TreeRenderer
| TreeRenderer | | public class TreeRenderer implements HtmlConstants(Code) | | This class renders the HTML markup for the NetUI Tree. The
TreeRenderer.render method
recursively renders child nodes of the tree if they're expanded.
By default, this predefined NetUI implementation is the class used
across the Web application. NetUI may be configured to use a different tree
renderer implementation as the renderer in the Web application. A custom
tree renderer is configured by setting the <tree-renderer-class> element
in the beehive-netui-config.xml file with the name of a class that extends
this class.
<tree-renderer-class>com.xyz.tree.CustomTreeRenderer</tree-renderer-class>
|
| Method Summary | |
| protected String | getSelectionlink(TreeElement node, String nodeName, InheritableState state)
Calculate the selection link for this node, if the node is disabled, we can skip
this because a disabled node may not be selected. | | protected TreeRenderSupport | getTreeRenderSupport()
| | public void | init(TreeRenderState trs, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
| | protected void | registerTagError(String message, Throwable e)
| | public void | render(AbstractRenderAppender writer, TreeElement node, int level, AttributeRenderer attrs, InheritableState state)
This is a recursive method which generates the markup for the tree. | | protected void | renderAfterNode(AbstractRenderAppender writer, TreeElement node)
| | protected void | renderBeforeNode(AbstractRenderAppender writer, TreeElement node)
| | protected void | renderConnectionImage(AbstractRenderAppender writer, TreeElement node, String nodeName, InheritableState state)
Write out the image which occurs next to the node icon. | | protected void | renderConnectionImagePrefix(AbstractRenderAppender writer, TreeElement node)
Render the formatting before the connecting/expand/collapse image. | | protected void | renderConnectionImageSuffix(AbstractRenderAppender writer, TreeElement node)
Render the formatting after the connecting/expand/collapse image. | | protected void | renderContent(AbstractRenderAppender writer, TreeElement node)
Render the Content for this node (if any). | | protected void | renderContentPrefix(AbstractRenderAppender writer, TreeElement node)
Render the formatting before the node content. | | protected void | renderContentSuffix(AbstractRenderAppender writer, TreeElement node)
Render the formatting after the node content. | | protected void | renderEndDivPrefix(AbstractRenderAppender writer, TreeElement node)
Render the indent formatting of the end div tag used after the node markup. | | protected void | renderEndDivSuffix(AbstractRenderAppender writer, TreeElement node)
Render the formatting after the end div tag that follows the node markup. | | protected void | renderIndentation(AbstractRenderAppender writer, TreeElement node, int level, InheritableState state)
Write out the images that create the leading indentation for the given node. | | protected void | renderItemIcon(AbstractRenderAppender writer, TreeElement node, AttributeRenderer attrs, InheritableState state)
Render the icon for this node. | | protected void | renderItemIconPrefix(AbstractRenderAppender writer, TreeElement node)
Render the formatting before the node icon. | | protected void | renderItemIconSuffix(AbstractRenderAppender writer, TreeElement node)
Render the formatting after the node icon. | | protected void | renderLabel(AbstractRenderAppender writer, TreeElement node)
Render the label for this node (if any). | | protected void | renderLabelPrefix(AbstractRenderAppender writer, TreeElement node)
Render the formatting before the node label. | | protected void | renderLabelSuffix(AbstractRenderAppender writer, TreeElement node)
Render the formatting after the node label. | | protected TagRenderingBase | renderSelectionLink(AbstractRenderAppender writer, TreeElement node, String nodeName, AttributeRenderer attrs, InheritableState state)
If needed, render the selection link around the icon for this node. | | protected void | renderSelectionLinkPrefix(AbstractRenderAppender writer, TreeElement node)
Render the formatting before the node selection anchor. | | protected void | renderSelectionLinkSuffix(AbstractRenderAppender writer, TreeElement node)
Render the formatting after the node selection anchor. | | protected void | renderSpacerPrefix(AbstractRenderAppender writer, TreeElement node)
Render the formatting before a spacer image. | | protected void | renderSpacerSuffix(AbstractRenderAppender writer, TreeElement node)
Render the formatting after a spacer image. | | protected void | renderStartDivPrefix(AbstractRenderAppender writer, TreeElement node)
Render the indent formatting of the start div tag used before the node markup. | | protected void | renderStartDivSuffix(AbstractRenderAppender writer, TreeElement node)
Render the formatting after the start div tag and before the node markup. | | protected String | renderTagId(HttpServletRequest request, String tagId, AbstractHtmlState state)
| | protected void | renderVerticalLinePrefix(AbstractRenderAppender writer, TreeElement node)
Render the formatting before a vertical line image. | | protected void | renderVerticalLineSuffix(AbstractRenderAppender writer, TreeElement node)
Render the formatting following a vertical line image. | | protected void | setTreeRenderSupport(TreeRenderSupport treeRenderSupport)
This method is set by the NetUI internals to defined an object that
handles issues specific to rendering a tree for certain paths of
execution in NetUI. |
| FORMAT_INDENT | | final protected static String FORMAT_INDENT(Code) | | |
| FORMAT_NEWLINE | | final protected static String FORMAT_NEWLINE(Code) | | |
| FORMAT_NEWLINE_INDENT | | final protected static String FORMAT_NEWLINE_INDENT(Code) | | |
| FORMAT_NEWLINE_SHORT_INDENT | | final protected static String FORMAT_NEWLINE_SHORT_INDENT(Code) | | |
| FORMAT_SHORT_INDENT | | final protected static String FORMAT_SHORT_INDENT(Code) | | |
| getSelectionlink | | protected String getSelectionlink(TreeElement node, String nodeName, InheritableState state) throws JspException(Code) | | Calculate the selection link for this node, if the node is disabled, we can skip
this because a disabled node may not be selected.
Parameters:
node - the node to render
Parameters:
nodeName - the unique name of the node
Parameters:
state - the set of tree properties that are used to render the tree markup the URL for the selection link
throws:
JspException - |
| render | | public void render(AbstractRenderAppender writer, TreeElement node, int level, AttributeRenderer attrs, InheritableState state) throws JspException(Code) | | This is a recursive method which generates the markup for the tree.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render
Parameters:
level - the level or depth of the node within the tree
Parameters:
attrs - renderer for supported attributes
Parameters:
state - the set of tree properties that are used to render the tree markup
throws:
javax.servlet.jsp.JspException - |
| renderConnectionImage | | protected void renderConnectionImage(AbstractRenderAppender writer, TreeElement node, String nodeName, InheritableState state) throws JspException(Code) | | Write out the image which occurs next to the node icon. This is
usually some kind of connecting line, expand, or collapse image.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render
Parameters:
nodeName - the unique name of the node
Parameters:
state - the set of tree properties that are used to render the tree markup
throws:
JspException - |
| renderConnectionImagePrefix | | protected void renderConnectionImagePrefix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting before the connecting/expand/collapse image.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderConnectionImageSuffix | | protected void renderConnectionImageSuffix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting after the connecting/expand/collapse image.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderContent | | protected void renderContent(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the Content for this node (if any).
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderContentPrefix | | protected void renderContentPrefix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting before the node content.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderContentSuffix | | protected void renderContentSuffix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting after the node content.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderEndDivPrefix | | protected void renderEndDivPrefix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the indent formatting of the end div tag used after the node markup.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderEndDivSuffix | | protected void renderEndDivSuffix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting after the end div tag that follows the node markup.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderIndentation | | protected void renderIndentation(AbstractRenderAppender writer, TreeElement node, int level, InheritableState state)(Code) | | Write out the images that create the leading indentation for the given node.
Parameters:
writer - the appender where the node indentation images are appended
Parameters:
node - the node to render
Parameters:
level - the level or depth of the node within the tree
Parameters:
state - the set of tree properties that are used to render the tree markup |
| renderItemIcon | | protected void renderItemIcon(AbstractRenderAppender writer, TreeElement node, AttributeRenderer attrs, InheritableState state)(Code) | | Render the icon for this node.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render
Parameters:
attrs - renderer for supported attributes
Parameters:
state - the set of tree properties that are used to render the tree markup |
| renderItemIconPrefix | | protected void renderItemIconPrefix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting before the node icon.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderItemIconSuffix | | protected void renderItemIconSuffix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting after the node icon.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderLabel | | protected void renderLabel(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the label for this node (if any).
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderLabelPrefix | | protected void renderLabelPrefix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting before the node label.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderLabelSuffix | | protected void renderLabelSuffix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting after the node label.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderSelectionLink | | protected TagRenderingBase renderSelectionLink(AbstractRenderAppender writer, TreeElement node, String nodeName, AttributeRenderer attrs, InheritableState state) throws JspException(Code) | | If needed, render the selection link around the icon for this node.
Note that the tag rendered here needs to be closed after the actual
icon and label are rendered.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render
Parameters:
nodeName - the unique name of the node
Parameters:
attrs - renderer for supported attributes
Parameters:
state - the set of tree properties that are used to render the tree markup the selection link (or span) tag renderer to close after the itemicon and label rendered
throws:
JspException - |
| renderSelectionLinkPrefix | | protected void renderSelectionLinkPrefix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting before the node selection anchor.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderSelectionLinkSuffix | | protected void renderSelectionLinkSuffix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting after the node selection anchor.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderSpacerPrefix | | protected void renderSpacerPrefix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting before a spacer image.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderSpacerSuffix | | protected void renderSpacerSuffix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting after a spacer image.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderStartDivPrefix | | protected void renderStartDivPrefix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the indent formatting of the start div tag used before the node markup.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderStartDivSuffix | | protected void renderStartDivSuffix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting after the start div tag and before the node markup.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderVerticalLinePrefix | | protected void renderVerticalLinePrefix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting before a vertical line image.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| renderVerticalLineSuffix | | protected void renderVerticalLineSuffix(AbstractRenderAppender writer, TreeElement node)(Code) | | Render the formatting following a vertical line image.
Parameters:
writer - the appender where the tree markup is appended
Parameters:
node - the node to render |
| setTreeRenderSupport | | protected void setTreeRenderSupport(TreeRenderSupport treeRenderSupport)(Code) | | This method is set by the NetUI internals to defined an object that
handles issues specific to rendering a tree for certain paths of
execution in NetUI.
Parameters:
treeRenderSupport - the class to handle NetUI specific issues whilerendering the tree. |
|
|