com.redhat.rhn.frontend.taglibs

Class ListDisplayTagBase

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

com.redhat.rhn.frontend.taglibs.ListDisplayTagBase

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

ListDisplayTag, UnpagedListDisplayTag

public class ListDisplayTagBase
extends javax.servlet.jsp.tagext.BodyTagSupport

Base class for ListDisplayTag implementation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILTER_DISPATCH
static java.lang.String	FILTER_MAXLENGTH

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
ListDisplayTagBase() Public constructor

Method Summary

Modifier and Type	Method and Description
protected ExportWriter	createExportWriter() Method to fetch a new ExportWriter instance.
int	getColumnCount() Get the number of the column that is being rendered at this moment.
java.lang.String	getExportColumns()
java.lang.String	getHiddenvars()
protected java.util.Iterator	getIterator()
int	getNumberOfColumns() Get the number of columns in the list.
protected DataResult	getPageList()
java.lang.String	getTitle() Returns the title message key.
java.lang.String	getType() Gets the type of the list
void	incrColumnCount() Increment the column # that is being rendered at this moment.
void	incrNumberOfColumns() Increment the total number of columns
void	release()
boolean	renderDisabled()
protected void	renderFilterBox(java.io.Writer out)
protected void	renderHeadExtraAddons(java.io.Writer out)
protected void	renderPanelHeading(javax.servlet.jsp.JspWriter out)
protected void	renderTitle(java.io.Writer out) Renders the title header if set.
void	setColumnCount(int columnCountIn) Set the column # that is being rendered at this moment Used when 'colspan' is used for an element to skip over the intervening columns.
void	setExportColumns(java.lang.String exportIn)
void	setFilterBy(java.lang.String filterByIn) Set the header of the filter on which to filter
void	setHiddenvars(java.lang.String hv)
void	setNumberOfColumns(int num) Set the number of columns in the list.
void	setRenderDisabled(java.lang.String disabled)
void	setTitle(java.lang.String titleIn) Sets the title message key.
void	setType(java.lang.String stringIn) Sets the type of the list
protected void	setupPageList()

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doEndTag, doInitBody, doStartTag, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

FILTER_DISPATCH

public static final java.lang.String FILTER_DISPATCH

See Also:

Constant Field Values

FILTER_MAXLENGTH

public static final java.lang.String FILTER_MAXLENGTH

See Also:

Constant Field Values

Constructor Detail

ListDisplayTagBase

public ListDisplayTagBase()

Public constructor

Method Detail

getIterator

protected java.util.Iterator getIterator()

Returns:

returns the iterator of the data for this list

getPageList

protected DataResult getPageList()

Returns:

returns the page list

renderDisabled

public boolean renderDisabled()

Returns:

Returns the disabled.

setRenderDisabled

public void setRenderDisabled(java.lang.String disabled)

Parameters:

disabled - The disabled to set.

getTitle

public java.lang.String getTitle()

Returns the title message key.

Returns:

Returns the title.

setTitle

public void setTitle(java.lang.String titleIn)

Sets the title message key.

Parameters:

titleIn - The title to set.

setType

public void setType(java.lang.String stringIn)

Sets the type of the list

Parameters:

stringIn - desired alignment for the list

getType

public java.lang.String getType()

Gets the type of the list

Returns:

String alignment of the list

setFilterBy

public void setFilterBy(java.lang.String filterByIn)

Set the header of the filter on which to filter

Parameters:

filterByIn - The filterBy to set.

getHiddenvars

public java.lang.String getHiddenvars()

Returns:

Returns the hiddenvars.

setHiddenvars

public void setHiddenvars(java.lang.String hv)

Parameters:

hv - The hiddenvars to set.

createExportWriter

protected ExportWriter createExportWriter()

Method to fetch a new ExportWriter instance. Override if desired to use different instance. Currently creates a new CSVWriter instance.

Returns:

new instance of an ExportWriter

incrColumnCount

public void incrColumnCount()

Increment the column # that is being rendered at this moment.

incrNumberOfColumns

public void incrNumberOfColumns()

Increment the total number of columns

getColumnCount

public int getColumnCount()

Get the number of the column that is being rendered at this moment. (0 == The first column)

Returns:

int the column number

getNumberOfColumns

public int getNumberOfColumns()

Get the number of columns in the list.

Returns:

int the number of columns

setNumberOfColumns

public void setNumberOfColumns(int num)

Set the number of columns in the list.

Parameters:

num - number of columns i nthe list

setColumnCount

public void setColumnCount(int columnCountIn)

Set the column # that is being rendered at this moment Used when 'colspan' is used for an element to skip over the intervening columns.

Parameters:

columnCountIn - The column count to set.

getExportColumns

public java.lang.String getExportColumns()

Returns:

Returns the exportColumns.

setExportColumns

public void setExportColumns(java.lang.String exportIn)

Parameters:

exportIn - The export to set.

setupPageList

protected void setupPageList()
                      throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

renderHeadExtraAddons

protected void renderHeadExtraAddons(java.io.Writer out)
                              throws java.io.IOException

Throws:

java.io.IOException

renderPanelHeading

protected void renderPanelHeading(javax.servlet.jsp.JspWriter out)
                           throws java.io.IOException

Throws:

java.io.IOException

renderTitle

protected void renderTitle(java.io.Writer out)
                    throws java.io.IOException

Renders the title header if set.

Parameters:

out - JspWriter

Throws:

java.io.IOException - thrown if there's a problem writing to the JSP

renderFilterBox

protected void renderFilterBox(java.io.Writer out)
                        throws java.io.IOException

Throws:

java.io.IOException

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.BodyTagSupport