com.redhat.rhn.frontend.taglibs.list.decorators

Interface ListDecorator

All Known Implementing Classes:

AddToSsmDecorator, BaseListDecorator, ElaborationDecorator, ExpansionDecorator, ExtraButtonDecorator, PageSizeDecorator, SelectableDecorator, SystemCurrencyIconDecorator, SystemIconDecorator

public interface ListDecorator

Decorator for a given list Decorators receive callbacks corresponding to events which occur during the rendering of list. These callbacks can be used to modify the appearance of the list widget on the page.

Method Summary

Modifier and Type	Method and Description
void	addColumn() Notifies the decorator that a column has been detected
void	afterBottomPagination() Notifies the decorator that bottom pagination controls have been rendered
void	afterList() Notifies the decorator that list rendering is complete
void	afterTopPagination() Notifies the decorator that top pagination controls have been rendered
void	beforeList() Notifies the decorator that list rendering is about to begin
void	beforeTopPagination() Use this hook to insert content before the top pagination
void	onBottomExtraAddons() With this hook one can insert extra addons after the list
void	onBottomExtraContent() With this hook one can insert content after the list
void	onFooterExtraAddons() With this hook one can insert extra addons in the footer
void	onFooterExtraContent() With this hook one can insert content in the footer
void	onHeadExtraAddons() With this hook one can insert extra addons in the heading
void	onHeadExtraContent() With this hook one can insert content in the heading
void	onTopExtraAddons() With this hook one can insert extra addons in the before the list
void	onTopExtraContent() With this hook one can insert content before the list
void	setCurrentList(ListTag currentList) Sets a refernce to the currently rendering list tag
void	setEnvironment(javax.servlet.jsp.PageContext ctx, ListSetTag parent, java.lang.String listName) Sets up the runtime environment for the decorator

Method Detail

addColumn

void addColumn()

Notifies the decorator that a column has been detected

beforeList

void beforeList()
         throws javax.servlet.jsp.JspException

Notifies the decorator that list rendering is about to begin

Throws:

javax.servlet.jsp.JspException - something bad happened

afterTopPagination

void afterTopPagination()
                 throws javax.servlet.jsp.JspException

Notifies the decorator that top pagination controls have been rendered

Throws:

javax.servlet.jsp.JspException - something bad happened

afterBottomPagination

void afterBottomPagination()
                    throws javax.servlet.jsp.JspException

Notifies the decorator that bottom pagination controls have been rendered

Throws:

javax.servlet.jsp.JspException - something bad happened

afterList

void afterList()
        throws javax.servlet.jsp.JspException

Notifies the decorator that list rendering is complete

Throws:

javax.servlet.jsp.JspException - something bad happened

setEnvironment

void setEnvironment(javax.servlet.jsp.PageContext ctx,
                    ListSetTag parent,
                    java.lang.String listName)

Sets up the runtime environment for the decorator

Parameters:

ctx - current JSP PageContext

parent - enclosing ListSetTag

listName - name of list

setCurrentList

void setCurrentList(ListTag currentList)

Sets a refernce to the currently rendering list tag

Parameters:

currentList - the current list tag

beforeTopPagination

void beforeTopPagination()
                  throws javax.servlet.jsp.JspException

Use this hook to insert content before the top pagination

Throws:

javax.servlet.jsp.JspException - exception

onTopExtraContent

void onTopExtraContent()
                throws javax.servlet.jsp.JspException

With this hook one can insert content before the list

Throws:

javax.servlet.jsp.JspException - exception

onHeadExtraContent

void onHeadExtraContent()
                 throws javax.servlet.jsp.JspException

With this hook one can insert content in the heading

Throws:

javax.servlet.jsp.JspException - exception

onFooterExtraContent

void onFooterExtraContent()
                   throws javax.servlet.jsp.JspException

With this hook one can insert content in the footer

Throws:

javax.servlet.jsp.JspException - exception

onBottomExtraContent

void onBottomExtraContent()
                   throws javax.servlet.jsp.JspException

With this hook one can insert content after the list

Throws:

javax.servlet.jsp.JspException - exception

onTopExtraAddons

void onTopExtraAddons()
               throws javax.servlet.jsp.JspException

With this hook one can insert extra addons in the before the list

Throws:

javax.servlet.jsp.JspException - something bad happened

onHeadExtraAddons

void onHeadExtraAddons()
                throws javax.servlet.jsp.JspException

With this hook one can insert extra addons in the heading

Throws:

javax.servlet.jsp.JspException - something bad happened

onFooterExtraAddons

void onFooterExtraAddons()
                  throws javax.servlet.jsp.JspException

With this hook one can insert extra addons in the footer

Throws:

javax.servlet.jsp.JspException - something bad happened

onBottomExtraAddons

void onBottomExtraAddons()
                  throws javax.servlet.jsp.JspException

With this hook one can insert extra addons after the list

Throws:

javax.servlet.jsp.JspException - something bad happened