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

Class BaseListDecorator

java.lang.Object

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

All Implemented Interfaces:

ListDecorator

Direct Known Subclasses:

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

public abstract class BaseListDecorator
extends java.lang.Object
implements ListDecorator

General-use base class for writing decorators

Field Summary

Fields

Modifier and Type	Field and Description
protected int	columnCount
protected ListTag	currentList
protected java.lang.String	listName
protected javax.servlet.jsp.PageContext	pageContext
protected ListSetTag	parent

Constructor Summary

Constructors

Constructor and Description
BaseListDecorator()

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
protected ListTag	getCurrentList()
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 current) Sets a refernce to the currently rendering list tag
void	setEnvironment(javax.servlet.jsp.PageContext ctx, ListSetTag parentIn, java.lang.String name) Sets up the runtime environment for the decorator

Methods inherited from class java.lang.Object

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

Field Detail

pageContext

protected javax.servlet.jsp.PageContext pageContext

parent

protected ListSetTag parent

listName

protected java.lang.String listName

columnCount

protected int columnCount

currentList

protected ListTag currentList

Constructor Detail

BaseListDecorator

public BaseListDecorator()

Method Detail

setEnvironment

public void setEnvironment(javax.servlet.jsp.PageContext ctx,
                           ListSetTag parentIn,
                           java.lang.String name)

Sets up the runtime environment for the decorator

Specified by:

setEnvironment in interface ListDecorator

Parameters:

ctx - current JSP PageContext

parentIn - enclosing ListSetTag

name - name of list

addColumn

public void addColumn()

Notifies the decorator that a column has been detected

Specified by:

addColumn in interface ListDecorator

setCurrentList

public void setCurrentList(ListTag current)

Sets a refernce to the currently rendering list tag

Specified by:

setCurrentList in interface ListDecorator

Parameters:

current - the current list tag

getCurrentList

protected ListTag getCurrentList()

Returns:

the associated list tag.

afterList

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

Notifies the decorator that list rendering is complete

Specified by:

afterList in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - something bad happened

afterBottomPagination

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

Notifies the decorator that bottom pagination controls have been rendered

Specified by:

afterBottomPagination in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - something bad happened

afterTopPagination

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

Notifies the decorator that top pagination controls have been rendered

Specified by:

afterTopPagination in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - something bad happened

beforeList

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

Notifies the decorator that list rendering is about to begin

Specified by:

beforeList in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - something bad happened

beforeTopPagination

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

Use this hook to insert content before the top pagination

Specified by:

beforeTopPagination in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - exception

onTopExtraContent

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

With this hook one can insert content before the list

Specified by:

onTopExtraContent in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - exception

onHeadExtraContent

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

With this hook one can insert content in the heading

Specified by:

onHeadExtraContent in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - exception

onFooterExtraContent

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

With this hook one can insert content in the footer

Specified by:

onFooterExtraContent in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - exception

onBottomExtraContent

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

With this hook one can insert content after the list

Specified by:

onBottomExtraContent in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - exception

onTopExtraAddons

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

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

Specified by:

onTopExtraAddons in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - something bad happened

onHeadExtraAddons

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

With this hook one can insert extra addons in the heading

Specified by:

onHeadExtraAddons in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - something bad happened

onFooterExtraAddons

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

With this hook one can insert extra addons in the footer

Specified by:

onFooterExtraAddons in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - something bad happened

onBottomExtraAddons

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

With this hook one can insert extra addons after the list

Specified by:

onBottomExtraAddons in interface ListDecorator

Throws:

javax.servlet.jsp.JspException - something bad happened