com.redhat.rhn.frontend.nav

Class TextRenderer

java.lang.Object

com.redhat.rhn.frontend.nav.Renderable

com.redhat.rhn.frontend.nav.TextRenderer

public class TextRenderer
extends Renderable

TextRenderer renders each node in the Navigation Tree as a formatted text string.

Each level is indented two (2) spaces for each level. For example, a tree with three levels will be indented by six (6) spaces at the third level. This is a great renderer for test cases.

     (*) Node 'name': url [acl: acl] "
 

Constructor Summary

Constructors

Constructor and Description
TextRenderer() Public constructor

Method Summary

Modifier and Type	Method and Description
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)
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)
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)
void	postNav(java.lang.StringBuffer sb) called after the full nav is rendered
void	postNavLevel(java.lang.StringBuffer sb, int depth) called after a nav level is rendered
void	postNavNode(java.lang.StringBuffer sb, int depth) called after a nav node is rendered
void	preNav(java.lang.StringBuffer sb) called before the nav is rendered
void	preNavLevel(java.lang.StringBuffer sb, int depth) called before a nav level is rendered
void	preNavNode(java.lang.StringBuffer sb, int depth) called before a nav node is rendered

Methods inherited from class com.redhat.rhn.frontend.nav.Renderable

canRender, setRenderGuard

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextRenderer

public TextRenderer()

Public constructor

Method Detail

preNavLevel

public void preNavLevel(java.lang.StringBuffer sb,
                        int depth)

called before a nav level is rendered

Specified by:

preNavLevel in class Renderable

Parameters:

sb - string buffer to append to

depth - current depth of rendering

preNavNode

public void preNavNode(java.lang.StringBuffer sb,
                       int depth)

called before a nav node is rendered

Specified by:

preNavNode in class Renderable

Parameters:

sb - string buffer to append to

depth - current depth of rendering

navNodeActive

public 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)

Specified by:

navNodeActive in class Renderable

Parameters:

sb - string buffer to append to

node - the node being rendered

treeIndex - the index for the tree we are insde of

parameters - name value pair of generic parameters for the node.

depth - the current render depth

navNodeInactive

public 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)

Specified by:

navNodeInactive in class Renderable

Parameters:

sb - string buffer to append to

node - the node being rendered

treeIndex - the index for the tree we are insde of

parameters - name value pair of generic parameters for the node.

depth - the current render depth

postNavNode

public void postNavNode(java.lang.StringBuffer sb,
                        int depth)

called after a nav node is rendered

Specified by:

postNavNode in class Renderable

Parameters:

sb - string buffer to append to

depth - current depth of rendering

postNavLevel

public void postNavLevel(java.lang.StringBuffer sb,
                         int depth)

called after a nav level is rendered

Specified by:

postNavLevel in class Renderable

Parameters:

sb - string buffer to append to

depth - current depth of rendering

nodeRenderInline

public 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)

Specified by:

nodeRenderInline in class Renderable

Parameters:

depth - the depth of the current node

Returns:

boolean if to render inline

preNav

public void preNav(java.lang.StringBuffer sb)

called before the nav is rendered

Specified by:

preNav in class Renderable

Parameters:

sb - string buffer to append to

postNav

public void postNav(java.lang.StringBuffer sb)

called after the full nav is rendered

Specified by:

postNav in class Renderable

Parameters:

sb - string buffer to append to