com.redhat.rhn.frontend.taglibs.helpers

Enum RenderUtils

java.lang.Object

java.lang.Enum<RenderUtils>

com.redhat.rhn.frontend.taglibs.helpers.RenderUtils

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RenderUtils>

public enum RenderUtils
extends java.lang.Enum<RenderUtils>

Utility methods for rendering navigation menus that are defined in XML files.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton instance

Method Summary

Modifier and Type	Method and Description
static RenderUtils	getInstance() Singleton implementation
java.lang.String	render(NavTreeIndex navTreeIndex, Renderable renderable, RenderGuard guard, java.util.Map<java.lang.String,java.lang.String[]> params) Call the RenderEngine to render a given Renderable.
java.lang.String	renderNavigationMenu(javax.servlet.http.HttpServletRequest request, java.lang.String menuDefinition, java.lang.String rendererClass, int minDepth, int maxDepth) Render the navigation menu for a given request and menu definition using the given renderer class.
java.lang.String	renderNavigationMenu(javax.servlet.jsp.PageContext pageContext, java.lang.String menuDefinition, java.lang.String rendererClass, int minDepth, int maxDepth) Render the navigation menu for a given page context and menu definition using the given renderer class.
static RenderUtils	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RenderUtils[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final RenderUtils INSTANCE

Singleton instance

Method Detail

values

public static RenderUtils[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RenderUtils c : RenderUtils.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RenderUtils valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getInstance

public static RenderUtils getInstance()

Singleton implementation

Returns:

an instance of this class

renderNavigationMenu

public java.lang.String renderNavigationMenu(javax.servlet.jsp.PageContext pageContext,
                                             java.lang.String menuDefinition,
                                             java.lang.String rendererClass,
                                             int minDepth,
                                             int maxDepth)
                                      throws java.lang.Exception

Render the navigation menu for a given page context and menu definition using the given renderer class.

Parameters:

pageContext - the JSP page context

menuDefinition - the menu definition XML file

rendererClass - the renderer class to use

minDepth - minimal depth

maxDepth - maximal depth

Returns:

the rendered navigation menu as string

Throws:

java.lang.Exception - in case of an error

renderNavigationMenu

public java.lang.String renderNavigationMenu(javax.servlet.http.HttpServletRequest request,
                                             java.lang.String menuDefinition,
                                             java.lang.String rendererClass,
                                             int minDepth,
                                             int maxDepth)
                                      throws java.lang.Exception

Render the navigation menu for a given request and menu definition using the given renderer class.

Parameters:

request - the request object

menuDefinition - the menu definition XML file

rendererClass - the renderer class to use

minDepth - minimal depth

maxDepth - maximal depth

Returns:

the rendered navigation menu as string

Throws:

java.lang.Exception - in case of an error

render

public java.lang.String render(NavTreeIndex navTreeIndex,
                               Renderable renderable,
                               RenderGuard guard,
                               java.util.Map<java.lang.String,java.lang.String[]> params)

Call the RenderEngine to render a given Renderable.

Parameters:

navTreeIndex - the navigation tree index

renderable - the renderable

guard - the guard

params - parameters

Returns:

the rendered string