com.redhat.rhn.frontend.action.renderers

Class BaseFragmentRenderer

java.lang.Object

com.redhat.rhn.frontend.action.renderers.BaseFragmentRenderer

All Implemented Interfaces:

FragmentRenderer

Direct Known Subclasses:

CriticalSystemsRenderer, InactiveSystemsRenderer, LatestErrataRenderer, PendingActionsRenderer, RecentSystemsRenderer, SystemGroupsRenderer, TasksRenderer

public abstract class BaseFragmentRenderer
extends java.lang.Object
implements FragmentRenderer

Simple implementation of a fragment renderer which automates the boilerplate work done rendering a fragment

Field Summary

Fields inherited from interface com.redhat.rhn.frontend.action.renderers.FragmentRenderer

NEXT_TABLE_STYLE

Constructor Summary

Constructors

Constructor and Description
BaseFragmentRenderer()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	getPageUrl() Hook method for child classes to return a URL to the page which renders the generated content
protected java.lang.String	makePaginationMessage(int end, int totalSize, java.lang.String descriptionKey) Util method to return the page size in a accessible way.
protected abstract void	render(User user, PageControl pc, javax.servlet.http.HttpServletRequest req) Gentlemen, render your fragments!
java.lang.String	renderAsync() Render content, please

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseFragmentRenderer

public BaseFragmentRenderer()

Method Detail

renderAsync

public java.lang.String renderAsync()
                             throws java.lang.Exception

Render content, please

Specified by:

renderAsync in interface FragmentRenderer

Returns:

generated content

Throws:

java.lang.Exception - sometimes things just don't work out

render

protected abstract void render(User user,
                               PageControl pc,
                               javax.servlet.http.HttpServletRequest req)
                        throws java.lang.Exception

Gentlemen, render your fragments!

Parameters:

user - logged in user

pc - controls list displays

req - incoming request

Throws:

java.lang.Exception - sometimes things just don't work out

getPageUrl

protected abstract java.lang.String getPageUrl()

Hook method for child classes to return a URL to the page which renders the generated content

Returns:

page url

makePaginationMessage

protected java.lang.String makePaginationMessage(int end,
                                                 int totalSize,
                                                 java.lang.String descriptionKey)

Util method to return the page size in a accessible way.

Parameters:

end - end of message range

totalSize - the total size of page

descriptionKey - the message key for description

Returns:

the appropriate pagination message.