public abstract class Renderable
extends java.lang.Object
Constructor and Description |
---|
Renderable() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canRender(NavNode node,
int depth)
check to see if a given node element at a given depth can be
rendered
|
abstract void |
navNodeActive(java.lang.StringBuffer sb,
NavNode node,
NavTreeIndex treeIndex,
java.util.Map parameters,
int depth)
called to render an active node (ie, one that should be
highlighted)
|
abstract void |
navNodeInactive(java.lang.StringBuffer sb,
NavNode node,
NavTreeIndex treeIndex,
java.util.Map parameters,
int depth)
called to render an active node (ie, one that should not be
highlighted)
|
abstract boolean |
nodeRenderInline(int depth)
returns true if a child node should render inline with its
parent (like leftnav) vs rendering after all the current node's
siblins (like the dialog tabbed nav)
|
abstract void |
postNav(java.lang.StringBuffer sb)
called after the full nav is rendered
|
abstract void |
postNavLevel(java.lang.StringBuffer sb,
int depth)
called after a nav level is rendered
|
abstract void |
postNavNode(java.lang.StringBuffer sb,
int depth)
called after a nav node is rendered
|
abstract void |
preNav(java.lang.StringBuffer sb)
called before the nav is rendered
|
abstract void |
preNavLevel(java.lang.StringBuffer sb,
int depth)
called before a nav level is rendered
|
abstract void |
preNavNode(java.lang.StringBuffer sb,
int depth)
called before a nav node is rendered
|
void |
setRenderGuard(RenderGuard guardIn)
sets the RenderGuard for this Renderable
|
public abstract void preNav(java.lang.StringBuffer sb)
sb
- string buffer to append topublic abstract void preNavLevel(java.lang.StringBuffer sb, int depth)
sb
- string buffer to append todepth
- current depth of renderingpublic abstract void preNavNode(java.lang.StringBuffer sb, int depth)
sb
- string buffer to append todepth
- current depth of renderingpublic abstract void navNodeActive(java.lang.StringBuffer sb, NavNode node, NavTreeIndex treeIndex, java.util.Map parameters, int depth)
sb
- string buffer to append tonode
- the node being renderedtreeIndex
- the index for the tree we are insde ofparameters
- name value pair of generic parameters for the node.depth
- the current render depthpublic abstract void navNodeInactive(java.lang.StringBuffer sb, NavNode node, NavTreeIndex treeIndex, java.util.Map parameters, int depth)
sb
- string buffer to append tonode
- the node being renderedtreeIndex
- the index for the tree we are insde ofparameters
- name value pair of generic parameters for the node.depth
- the current render depthpublic abstract void postNavNode(java.lang.StringBuffer sb, int depth)
sb
- string buffer to append todepth
- current depth of renderingpublic abstract void postNavLevel(java.lang.StringBuffer sb, int depth)
sb
- string buffer to append todepth
- current depth of renderingpublic abstract void postNav(java.lang.StringBuffer sb)
sb
- string buffer to append topublic abstract boolean nodeRenderInline(int depth)
depth
- the depth of the current nodepublic final void setRenderGuard(RenderGuard guardIn)
guardIn
- the guardianprotected final boolean canRender(NavNode node, int depth)
node
- the node in questiondepth
- the depth in question