com.redhat.rhn.frontend.taglibs

Class ListDisplayTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

com.redhat.rhn.frontend.taglibs.ListDisplayTagBase

com.redhat.rhn.frontend.taglibs.ListDisplayTag

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:

VirtualListDisplayTag

public class ListDisplayTag
extends ListDisplayTagBase

The ListDisplayTag defines the structure of the ListView. This tag iterates through the DataResult contained in its parent tag, iteration the ColumnTags render the headers of the ListView, while subsequent iterations render the data contained within the DataResult.

The ListTag has the following optional attributes: filterBy set hiddenvars exportColumns renderDisabled mixins button button2 buttonAcl button2Acl domainClass title paging type reflink reflinkkey reflinkkeyarg0 description transparent When using a child SetTag, the set and hiddenvars become REQUIRED.

The filterBy attribute specifies the column name with which to filter the data.

The paging attribute determines whether or not paging buttons should be shown.

The type attribute sepcifies whether the list is a normal full list or a half-table

reflink will cause a link to display in the lower right corner of the table while reflinkkey is the localization message we wish to show that will be the key of the link. reflinkkeyarg0 is an optional argument to be passed to the LocalizationService. description is what will appear in non-paged lists in the lower left corner in the "1 of 1 description displayed." transparent if set to true will make it so that the table has no borders, and all the rows are white. Example usage of the ListDisplayTag with no sets:

 ...
 <rhn:listdisplay>
   <rhn:column header="l10n.jsp.messagekey">
      display this value
   </rhn:column>
   <rhn:column header="l10n.jsp.messagekey1">
      display this value too
   </rhn:column>
 </rhn:listdisplay>
 ...
 

The following shows how to define a ListView with a set column.

 ...
 <rhn:listdisplay set="${requestScope.set}"
                     hiddenvars="${requestScope.keep}">
   <rhn:set value="${current.id}"/>
   <rhn:column header="l10n.jsp.messagekey1">
      display this value
   </rhn:column>
 </rhn:listdisplay>
 ...
 

See Also:

ColumnTag, ListTag, SetTag, RhnSet, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADD_TO_SSM_KEY
protected int	rowCnt row count determines whether we're an even or odd row
static java.lang.String	SELECT_ALL_KEY
static java.lang.String	UNSELECT_ALL_KEY
static java.lang.String	UPDATE_LIST_KEY

Fields inherited from class com.redhat.rhn.frontend.taglibs.ListDisplayTagBase

FILTER_DISPATCH, 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
ListDisplayTag() Public constructor

Method Summary

Modifier and Type	Method and Description
int	doAfterBody()
int	doEndTag()
int	doStartTag()
java.lang.String	getButton()
java.lang.String	getButton2()
java.lang.String	getButton2Acl()
java.lang.String	getButtonAcl()
java.lang.String	getDescription()
java.lang.String	getDomainClass() domainClass is used by the page loader to display what domain object it is loading.
java.lang.String	getMixins()
java.lang.String	getReflink()
java.lang.String	getReflinkkey()
java.lang.String	getReflinkkeyarg0()
RhnSet	getSet() Get the set
java.lang.String	getTableId()
protected java.lang.String	getTrElement(java.lang.Object o)
java.lang.String	getType() Gets the type of the list
protected void	incrementChecked() Increment the count of the number of checked checkboxes.
boolean	isExport() If the User requested an Export or not.
boolean	isPaging() Returns true if this is a paging list.
boolean	isTransparent()
void	release()
void	setButton(java.lang.String buttonIn)
void	setButton2(java.lang.String button2In)
void	setButton2Acl(java.lang.String button2AclIn)
void	setButtonAcl(java.lang.String buttonAclIn)
void	setButtonsAttr(java.lang.String attrNameValue) Set the name:value pair for the request attribute controlling display of any optional buttons
void	setDescription(java.lang.String stringIn)
void	setDomainClass(java.lang.String domainClassIn)
void	setMixins(java.lang.String mixinsIn)
void	setPaging(boolean topageornottopage) Sets this list as either a paging or non-paging list.
void	setReflink(java.lang.String stringIn) sets the reflink to be used
void	setReflinkkey(java.lang.String stringIn) Sets the refLinkKey to be used
void	setReflinkkeyarg0(java.lang.String stringIn) Sets the first argument for the reflinkkey
void	setSet(RhnSet s) Set the set for this listview.
void	setTableId(java.lang.String tableIdIn)
void	setTransparent(boolean booleanIn)
void	setType(java.lang.String stringIn) Sets the type of the list
protected void	showButtons() Tells the ListDisplayTag to show Update List and Select All buttons.

Methods inherited from class com.redhat.rhn.frontend.taglibs.ListDisplayTagBase

createExportWriter, getColumnCount, getExportColumns, getHiddenvars, getIterator, getNumberOfColumns, getPageList, getTitle, incrColumnCount, incrNumberOfColumns, renderDisabled, renderFilterBox, renderHeadExtraAddons, renderPanelHeading, renderTitle, setColumnCount, setExportColumns, setFilterBy, setHiddenvars, setNumberOfColumns, setRenderDisabled, setTitle, setupPageList

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

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

Field Detail

rowCnt

protected int rowCnt

row count determines whether we're an even or odd row

UPDATE_LIST_KEY

public static final java.lang.String UPDATE_LIST_KEY

See Also:

Constant Field Values

SELECT_ALL_KEY

public static final java.lang.String SELECT_ALL_KEY

See Also:

Constant Field Values

UNSELECT_ALL_KEY

public static final java.lang.String UNSELECT_ALL_KEY

See Also:

Constant Field Values

ADD_TO_SSM_KEY

public static final java.lang.String ADD_TO_SSM_KEY

See Also:

Constant Field Values

Constructor Detail

ListDisplayTag

public ListDisplayTag()

Public constructor

Method Detail

getTableId

public java.lang.String getTableId()

Returns:

Returns the tableId.

setTableId

public void setTableId(java.lang.String tableIdIn)

Parameters:

tableIdIn - The tableId to set.

getDomainClass

public java.lang.String getDomainClass()

domainClass is used by the page loader to display what domain object it is loading. For example, if this is a system display list, the domainClass should be "systems". This is a key to the StringResource for the translated version of the domain object.

Returns:

Key for the domain object

setButtonsAttr

public void setButtonsAttr(java.lang.String attrNameValue)
                    throws javax.servlet.jsp.JspException

Set the name:value pair for the request attribute controlling display of any optional buttons

Parameters:

attrNameValue - name/value pair separated by ":"

Throws:

javax.servlet.jsp.JspException - indicates attrNameValue is in the wrong format

setDomainClass

public void setDomainClass(java.lang.String domainClassIn)

Parameters:

domainClassIn - The domainClass to set.

getButton

public java.lang.String getButton()

Returns:

Returns the button.

setButton

public void setButton(java.lang.String buttonIn)

Parameters:

buttonIn - The button to set.

getButton2

public java.lang.String getButton2()

Returns:

Returns the button2.

setButton2

public void setButton2(java.lang.String button2In)

Parameters:

button2In - The button2 to set.

getButton2Acl

public java.lang.String getButton2Acl()

Returns:

Returns the button2Acl.

setButton2Acl

public void setButton2Acl(java.lang.String button2AclIn)

Parameters:

button2AclIn - The button2Acl to set.

getButtonAcl

public java.lang.String getButtonAcl()

Returns:

Returns the buttonAcl.

setButtonAcl

public void setButtonAcl(java.lang.String buttonAclIn)

Parameters:

buttonAclIn - The buttonAcl to set.

getMixins

public java.lang.String getMixins()

Returns:

Returns the mixins.

setMixins

public void setMixins(java.lang.String mixinsIn)

Parameters:

mixinsIn - The mixins to set.

setSet

public void setSet(RhnSet s)

Set the set for this listview.

Parameters:

s - The set to set.

getSet

public RhnSet getSet()

Get the set

Returns:

The set for this page

isPaging

public boolean isPaging()

Returns true if this is a paging list.

Returns:

true if this is a paging list.

setPaging

public void setPaging(boolean topageornottopage)

Sets this list as either a paging or non-paging list.

Parameters:

topageornottopage - true for a paging list, false otherwise.

setType

public void setType(java.lang.String stringIn)

Sets the type of the list

Overrides:

setType in class ListDisplayTagBase

Parameters:

stringIn - desired alignment for the list

getType

public java.lang.String getType()

Gets the type of the list

Overrides:

getType in class ListDisplayTagBase

Returns:

String alignment of the list

setReflink

public void setReflink(java.lang.String stringIn)

sets the reflink to be used

Parameters:

stringIn - the reflink to be used

getReflink

public java.lang.String getReflink()

Returns:

returns the reflink

setReflinkkey

public void setReflinkkey(java.lang.String stringIn)

Sets the refLinkKey to be used

Parameters:

stringIn - the reflinkkey to be used

getReflinkkey

public java.lang.String getReflinkkey()

Returns:

returns the reflinkkey

setReflinkkeyarg0

public void setReflinkkeyarg0(java.lang.String stringIn)

Sets the first argument for the reflinkkey

Parameters:

stringIn - the reflinkkeyarg0 to be used

getReflinkkeyarg0

public java.lang.String getReflinkkeyarg0()

Returns:

returns reflinkeyarg1

setDescription

public void setDescription(java.lang.String stringIn)

Parameters:

stringIn - trans-unit id of the description we wish to use

getDescription

public java.lang.String getDescription()

Returns:

String that is the trans-unit id of the description we wish to use

isTransparent

public boolean isTransparent()

Returns:

returns whether or not the table is transparent

setTransparent

public void setTransparent(boolean booleanIn)

Parameters:

booleanIn - sets transparent

getTrElement

protected java.lang.String getTrElement(java.lang.Object o)

incrementChecked

protected void incrementChecked()

Increment the count of the number of checked checkboxes. Only for use with the SetTag.

showButtons

protected void showButtons()

Tells the ListDisplayTag to show Update List and Select All buttons.

isExport

public boolean isExport()

If the User requested an Export or not.

Returns:

boolean if export or not

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

doEndTag

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

Specified by:

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

Overrides:

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

Throws:

javax.servlet.jsp.JspException

doAfterBody

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

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

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

Throws:

javax.servlet.jsp.JspException

release

public void release()

Specified by:

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

Overrides:

release in class ListDisplayTagBase