com.redhat.rhn.frontend.taglibs

Class ListTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

com.redhat.rhn.frontend.taglibs.ListTag

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

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

The ListTag is the outer most tag of a ListView. The ListTag has two attributes pageList and noDataText. The pageList is a DataResult which contains the data to display. If the pageList is null or empty, the ListTag will skip the body and display the message defined by the noDataText attribute.

Both the pageList and noDataText attributes are REQUIRED.

The ListTag should include at least one ListDisplayTag

Example usage of the ListTag:

 <rhn:list pageList="${requestScope.pageList}"
           noDataText="l10n.jsp.messagekey">
   <rhn:listdisplay>
   ...
   </rhn:listdisplay>
 </rhn:list>
 

See Also:

ColumnTag, ListDisplayTag, SetTag, Serialized Form

Field Summary

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
ListTag() Public constructor

Method Summary

Modifier and Type	Method and Description
int	doStartTag()
java.lang.String	getLegend()
DataResult	getPageList() Get the pageList for this tag
void	release()
void	setFormatMessage(boolean formatMessageIn)
void	setLegend(java.lang.String l)
void	setNoDataText(java.lang.String noDataTextIn) Set the string to print if there is no data in the list
void	setPageList(DataResult list) Set the pagelist for this tag

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

doAfterBody, doEndTag, doInitBody, 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

Constructor Detail

ListTag

public ListTag()

Public constructor

Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

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

Overrides:

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

Throws:

javax.servlet.jsp.JspException

getLegend

public java.lang.String getLegend()

Returns:

Returns the legend.

setLegend

public void setLegend(java.lang.String l)

Parameters:

l - The legend to set.

setPageList

public void setPageList(DataResult list)

Set the pagelist for this tag

Parameters:

list - the list to display

getPageList

public DataResult getPageList()

Get the pageList for this tag

Returns:

The page list to be displayed.

setNoDataText

public void setNoDataText(java.lang.String noDataTextIn)

Set the string to print if there is no data in the list

Parameters:

noDataTextIn - The string to print if there is no data.

release

public void release()

Specified by:

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

Overrides:

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

setFormatMessage

public void setFormatMessage(boolean formatMessageIn)

Parameters:

formatMessageIn - The formatMessage to set.