com.redhat.rhn.frontend.taglibs.list

Class ListTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

com.redhat.rhn.frontend.taglibs.list.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

Renders a list of data bean in a page The list is rendered as a bootstrap 3.x panel The title of the list is put in the panel-heading Pagination, alphabars and addons go into the panel-body Bottom pagination and reflinks g into the panel-footer The table goes as is, for seamless display into the panel

See Also:

http://getbootstrap.com/components/#panels, 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()

Method Summary

Modifier and Type	Method and Description
void	addColumn() Bumps up the column count
void	addDecorator(java.lang.String decName) Adds a decorator to the parent class..
int	doAfterBody() $
int	doEndTag() $
int	doStartTag() $
java.lang.String	getAlphaBarColumn()
int	getColumnCount() Gets column count
javax.servlet.jsp.PageContext	getContext()
java.lang.Object	getCurrentObject() The current object being displayed
DataSetManipulator	getManip()
java.lang.String	getName() The name of the list
java.util.List	getPageData() Returns the data in use for the current page
int	getPageRowCount() Get current page row count
int	getPageSize() provides the current page size
java.lang.Object	getParentObject() The parent if this list is dealing with expandable objects
java.lang.String	getRefLink()
java.lang.String	getRefLinkKey()
java.lang.String	getRefLinkKeyArg0()
java.lang.String	getStyleId()
java.lang.String	getUniqueName() Build the list's unique name Algorithm for the unique name is: Take the CRC value of the following string: request url + ";" + name
boolean	isEmpty() Returns
boolean	isParentAnElement() if set to true, the parent in a tree setup will be considered as an element by itself
void	release() $
void	setAlphabarcolumn(java.lang.String alphaBarColumnIn)
void	setDataset(java.lang.String nameIn) Sets the name of the dataset to use Tries to locate the list in the following order: page context, request attribute, session attribute
void	setDecorator(java.lang.String nameIn) Sets the decorator class name to use for a list
void	setEmptykey(java.lang.String key) Sets the localized message key used when the list is empty
void	setFilter(java.lang.String filterIn) Sets the filter used to filter list data
void	setHidepagenums(java.lang.String value) if set to true, the page numbers at the top and bottom of the list will not be displayed
void	setName(java.lang.String nameIn) Stores the "name" of the list.
void	setParentiselement(java.lang.String value) if set to true, the parent in a tree setup will be considered as an element by itself
void	setReflink(java.lang.String refLinkIn)
void	setReflinkkey(java.lang.String refLinkKeyIn)
void	setReflinkkeyarg0(java.lang.String refLinkKeyArg0In)
void	setRowname(java.lang.String nameIn) Name used to store the currentObject in the page
void	setRowRenderer(RowRenderer newRender) Set the row renderer
void	setStyleclass(java.lang.String styleIn) Sets the CSS style class This applies to the enclosing table tag
void	setStyleId(java.lang.String styleIdIn)
void	setTitle(java.lang.String titleIn) Sets the title row needed for this page
void	setWidth(java.lang.String widthIn) Total width of the table, either in px or percent

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

Constructor Detail

ListTag

public ListTag()

Method Detail

addDecorator

public void addDecorator(java.lang.String decName)
                  throws javax.servlet.jsp.JspException

Adds a decorator to the parent class..

Parameters:

decName - the name of the decorator

Throws:

javax.servlet.jsp.JspException - if the decorator can't be loaded.

setRowRenderer

public void setRowRenderer(RowRenderer newRender)

Set the row renderer

Parameters:

newRender - the row renderer

setDecorator

public void setDecorator(java.lang.String nameIn)

Sets the decorator class name to use for a list

Parameters:

nameIn - decorator class name

setEmptykey

public void setEmptykey(java.lang.String key)

Sets the localized message key used when the list is empty

Parameters:

key - message key

addColumn

public void addColumn()

Bumps up the column count

isEmpty

public boolean isEmpty()

Returns

Returns:

true if the data in use for the current page is empty

getPageData

public java.util.List getPageData()

Returns the data in use for the current page

Returns:

list of data

getColumnCount

public int getColumnCount()

Gets column count

Returns:

column count

setName

public void setName(java.lang.String nameIn)

Stores the "name" of the list. This is the "salt" used to build the uniqueName used by the ListTag and ColumnTag.

Parameters:

nameIn - list name

getName

public java.lang.String getName()

The name of the list

Returns:

the list name

getUniqueName

public java.lang.String getUniqueName()

Build the list's unique name Algorithm for the unique name is: Take the CRC value of the following string: request url + ";" + name

Returns:

unique name

setStyleclass

public void setStyleclass(java.lang.String styleIn)

Sets the CSS style class This applies to the enclosing table tag

Parameters:

styleIn - class name

setWidth

public void setWidth(java.lang.String widthIn)

Total width of the table, either in px or percent

Parameters:

widthIn - table width

setFilter

public void setFilter(java.lang.String filterIn)
               throws javax.servlet.jsp.JspException

Sets the filter used to filter list data

Parameters:

filterIn - name of the filter class to use

Throws:

javax.servlet.jsp.JspException - error occurred creating an instance of the filter

setTitle

public void setTitle(java.lang.String titleIn)

Sets the title row needed for this page

Parameters:

titleIn - the title row..

getPageRowCount

public int getPageRowCount()

Get current page row count

Returns:

number of rows on current page

setDataset

public void setDataset(java.lang.String nameIn)
                throws javax.servlet.jsp.JspException

Sets the name of the dataset to use Tries to locate the list in the following order: page context, request attribute, session attribute

Parameters:

nameIn - name of dataset

Throws:

javax.servlet.jsp.JspException - indicates something went wrong

getCurrentObject

public java.lang.Object getCurrentObject()

The current object being displayed

Returns:

current object being displayed

getParentObject

public java.lang.Object getParentObject()

The parent if this list is dealing with expandable objects

Returns:

the parent of the current object being displayed

setRowname

public void setRowname(java.lang.String nameIn)
                throws javax.servlet.jsp.JspException

Name used to store the currentObject in the page

Parameters:

nameIn - row name

Throws:

javax.servlet.jsp.JspException - if row name is empty

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

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

release

public void release()

$

Specified by:

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

Overrides:

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

getContext

public javax.servlet.jsp.PageContext getContext()

Returns:

returns the page context

getManip

public DataSetManipulator getManip()

Returns:

Returns the manip.

setAlphabarcolumn

public void setAlphabarcolumn(java.lang.String alphaBarColumnIn)

Parameters:

alphaBarColumnIn - The alphaBarColumn to set.

getPageSize

public int getPageSize()

provides the current page size

Returns:

the page size

getAlphaBarColumn

public java.lang.String getAlphaBarColumn()

Returns:

Returns the alphaBarColumn.

setHidepagenums

public void setHidepagenums(java.lang.String value)

if set to true, the page numbers at the top and bottom of the list will not be displayed

Parameters:

value - true or false

setParentiselement

public void setParentiselement(java.lang.String value)

if set to true, the parent in a tree setup will be considered as an element by itself

Parameters:

value - true or false

isParentAnElement

public boolean isParentAnElement()

if set to true, the parent in a tree setup will be considered as an element by itself

Returns:

true if the parent itself is an element

getStyleId

public java.lang.String getStyleId()

Returns:

CSS ID for <table>

setStyleId

public void setStyleId(java.lang.String styleIdIn)

Parameters:

styleIdIn - CSS ID to set for HTML table tag

getRefLink

public java.lang.String getRefLink()

Returns:

the optional reference link that will be included in the last row of the table

setReflink

public void setReflink(java.lang.String refLinkIn)

Parameters:

refLinkIn - the optional reference link that will be added to the last row of the table

getRefLinkKey

public java.lang.String getRefLinkKey()

Returns:

the key for the reference link

setReflinkkey

public void setReflinkkey(java.lang.String refLinkKeyIn)

Parameters:

refLinkKeyIn - the key for the reference link

getRefLinkKeyArg0

public java.lang.String getRefLinkKeyArg0()

Returns:

the optional argument that may be included in the reference link

setReflinkkeyarg0

public void setReflinkkeyarg0(java.lang.String refLinkKeyArg0In)

Parameters:

refLinkKeyArg0In - the optional argument that may be included in the reference link