|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectTreeRenderer
public class TreeRenderer
This class renders the HTML markup for the NetUI Tree. The render(org.apache.beehive.netui.tags.rendering.AbstractRenderAppender, org.apache.beehive.netui.tags.tree.TreeElement, int, org.apache.beehive.netui.tags.tree.AttributeRenderer, org.apache.beehive.netui.tags.tree.InheritableState)
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>
Field Summary | |
---|---|
protected HttpServletRequest |
_req
|
protected HttpServletResponse |
_res
|
protected ServletContext |
_servletContext
|
protected TreeRenderState |
_trs
|
protected static String |
FORMAT_INDENT
|
protected static String |
FORMAT_NBSP
|
protected static String |
FORMAT_NEWLINE
|
protected static String |
FORMAT_NEWLINE_INDENT
|
protected static String |
FORMAT_NEWLINE_SHORT_INDENT
|
protected static String |
FORMAT_SHORT_INDENT
|
Constructor Summary | |
---|---|
TreeRenderer()
|
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()
|
void |
init(TreeRenderState trs,
HttpServletRequest request,
HttpServletResponse response,
ServletContext servletContext)
|
protected void |
registerTagError(String message,
Throwable e)
|
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. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String FORMAT_INDENT
protected static final String FORMAT_NBSP
protected static final String FORMAT_NEWLINE
protected static final String FORMAT_SHORT_INDENT
protected static final String FORMAT_NEWLINE_INDENT
protected static final String FORMAT_NEWLINE_SHORT_INDENT
protected TreeRenderState _trs
protected ServletContext _servletContext
protected HttpServletRequest _req
protected HttpServletResponse _res
Constructor Detail |
---|
public TreeRenderer()
Method Detail |
---|
public void init(TreeRenderState trs, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
protected void setTreeRenderSupport(TreeRenderSupport treeRenderSupport)
treeRenderSupport
- the class to handle NetUI specific issues while
rendering the tree.protected TreeRenderSupport getTreeRenderSupport()
protected void registerTagError(String message, Throwable e) throws JspException
JspException
protected String renderTagId(HttpServletRequest request, String tagId, AbstractHtmlState state)
protected void renderBeforeNode(AbstractRenderAppender writer, TreeElement node)
protected void renderAfterNode(AbstractRenderAppender writer, TreeElement node)
public void render(AbstractRenderAppender writer, TreeElement node, int level, AttributeRenderer attrs, InheritableState state) throws JspException
writer
- the appender where the tree markup is appendednode
- the node to renderlevel
- the level or depth of the node within the treeattrs
- renderer for supported attributesstate
- the set of tree properties that are used to render the tree markup
JspException
protected void renderIndentation(AbstractRenderAppender writer, TreeElement node, int level, InheritableState state)
writer
- the appender where the node indentation images are appendednode
- the node to renderlevel
- the level or depth of the node within the treestate
- the set of tree properties that are used to render the tree markupprotected void renderConnectionImage(AbstractRenderAppender writer, TreeElement node, String nodeName, InheritableState state) throws JspException
writer
- the appender where the tree markup is appendednode
- the node to rendernodeName
- the unique name of the nodestate
- the set of tree properties that are used to render the tree markup
JspException
protected TagRenderingBase renderSelectionLink(AbstractRenderAppender writer, TreeElement node, String nodeName, AttributeRenderer attrs, InheritableState state) throws JspException
writer
- the appender where the tree markup is appendednode
- the node to rendernodeName
- the unique name of the nodeattrs
- renderer for supported attributesstate
- the set of tree properties that are used to render the tree markup
JspException
protected String getSelectionlink(TreeElement node, String nodeName, InheritableState state) throws JspException
node
- the node to rendernodeName
- the unique name of the nodestate
- the set of tree properties that are used to render the tree markup
JspException
protected void renderItemIcon(AbstractRenderAppender writer, TreeElement node, AttributeRenderer attrs, InheritableState state)
writer
- the appender where the tree markup is appendednode
- the node to renderattrs
- renderer for supported attributesstate
- the set of tree properties that are used to render the tree markupprotected void renderLabel(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderContent(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderSpacerPrefix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderSpacerSuffix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderVerticalLinePrefix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderVerticalLineSuffix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderConnectionImagePrefix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderConnectionImageSuffix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderSelectionLinkPrefix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderSelectionLinkSuffix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderItemIconPrefix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderItemIconSuffix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderLabelPrefix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderLabelSuffix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderContentPrefix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderContentSuffix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderStartDivPrefix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderStartDivSuffix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderEndDivPrefix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to renderprotected void renderEndDivSuffix(AbstractRenderAppender writer, TreeElement node)
writer
- the appender where the tree markup is appendednode
- the node to render
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |