com.redhat.rhn.frontend.taglibs.list

Class ListTagUtil

java.lang.Object

com.redhat.rhn.frontend.taglibs.list.ListTagUtil

public class ListTagUtil
extends java.lang.Object

Provides various utility functions for the ListTag, ColumnTag, and SpanTag

Method Summary

Modifier and Type	Method and Description
static void	clearPersistentCounter(javax.servlet.jsp.PageContext ctx, java.lang.String name) Clears a "persistent" counter.
static java.lang.String	getBeanValue(java.lang.Object bean, java.lang.String attribute) Gets the value of a data bean attribute
static ListCommand	getCurrentCommand(javax.servlet.jsp.tagext.Tag caller, javax.servlet.jsp.PageContext ctx) Locates the current ListCommand
static long	getPersistentCounterValue(javax.servlet.jsp.PageContext ctx, java.lang.String name) Gets the current value of a "persistent" counter
static void	includeContent(javax.servlet.jsp.PageContext ctx, java.lang.String url) Includes arbitrary _local_ url as content
static java.lang.Long	incrementPersistentCounter(javax.servlet.jsp.PageContext ctx, java.lang.String name) Increments a "persistent" counter.
static java.lang.String	makeColumnSortLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName, java.lang.String attrName, java.lang.String sortDir) Builds sort link
static java.lang.String	makeExtraButtonName(java.lang.String listName) Returns the name of the extra buttonattribute
static java.lang.String	makeFilterAttributeByLabel(java.lang.String listName) provides the filter label (what to sort by) url key
static java.lang.String	makeFilterByLabel(java.lang.String listName) provides the filter label (what to sort by) url key
static java.lang.String	makeFilterClassLabel(java.lang.String listName) provides the label to set/get the filter class
static java.lang.String	makeFilterFormUrl(javax.servlet.http.HttpServletRequest request, java.lang.String listName) Builds URL for the filter form
static java.lang.String	makeFilterNameByLabel(java.lang.String listName) provides the filter name (the name value for the go button on the filter box)
static java.lang.String	makeFilterValueByLabel(java.lang.String listName) provides the filter label (what to sort by) url key
static java.lang.String	makeFirstPageLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName) Make first page link
static java.lang.String	makeImageNameByLabel(java.lang.String listName) provides the filter label (what to sort by) url key
static java.lang.String	makeLastPageLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName) Make last page link
static java.lang.String	makeNextPageLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName, int currentPage) Make next page link
static java.lang.String	makeOldFilterValueByLabel(java.lang.String listName) provides the filter label (what to sort by) url key
static java.lang.String	makePageItemsName(java.lang.String listName) Returns the name of the attribute that holds the all the row items on the page.
static java.lang.String	makePageNumberName(java.lang.String listName) Returns the name of the attribute that holds the current page number.
static java.lang.String	makeParamsLink(javax.servlet.ServletRequest request, java.lang.String listName, java.util.Map<java.lang.String,java.lang.String> paramsToAdd, java.util.List<java.lang.String> paramsToIgnore) Returns a link containing the URL + ALL the parameters of the request query string minus the sort links, and the alpha link + the additional params passed in the paramsToAdd map.
static java.lang.String	makeParentIsAnElementLabel(java.lang.String listName) Returns the name of the attribute that holds the parent is an element value (used by list tag)
static java.lang.String	makePrevPageLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName, int currentPage) Make prev page link
static java.lang.String	makeSelectActionName(java.lang.String listName) Returns the name of the Select Action attribute For example the Select All, Unselect All and Update buttons use this name..
static java.lang.String	makeSelectedAmountName(java.lang.String listName) Returns the name of the attribute that holds the selected amount
static java.lang.String	makeSelectedItemsName(java.lang.String listName) Returns the name of the attribute that holds the selected check box items
static java.lang.String	makeSortById(java.lang.String listName) provides the sort label (what to sort by) url key
static java.lang.String	makeSortByLabel(java.lang.String listName) provides the sort label (what to sort by) url key
static java.lang.String	makeSortDirId(java.lang.String listName) provides the sort direction url key
static java.lang.String	makeSortDirLabel(java.lang.String listName) provides the sort direction url key
static java.lang.String[]	parseStyles(java.lang.String styles) Parses a list of style classes into a string array
static void	renderFilterSubmit(javax.servlet.jsp.PageContext pageContext, java.lang.String uniqueName) Renders the hidden input for filter to work
static void	renderFilterUI(javax.servlet.jsp.PageContext pageContext, ListFilter filter, java.lang.String uniqueName, java.lang.String width, int columnCount) Renders the filter UI
static void	renderPaginationLinks(javax.servlet.jsp.PageContext pageContext, java.lang.String[] linkNames, java.util.Map links) Renders the pagingation links for a given list.
static void	setCurrentCommand(javax.servlet.jsp.PageContext ctx, java.lang.String uniqueName, ListCommand cmd) Stores a ListCommand in the page context and makes it current
static boolean	toBoolean(java.lang.String value) Converts a series of string values to their boolean equivalents True values: true, t, yes, y, 1 False values: Everything else
static void	write(javax.servlet.jsp.PageContext ctx, java.lang.String text) Writes arbitrary text to the client (browser)

Methods inherited from class java.lang.Object

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

Method Detail

incrementPersistentCounter

public static java.lang.Long incrementPersistentCounter(javax.servlet.jsp.PageContext ctx,
                                                        java.lang.String name)

Increments a "persistent" counter. These counters are used by column tags to track and increment values across column render passes.

Parameters:

ctx - active PageContext

name - name of counter

Returns:

next value

clearPersistentCounter

public static void clearPersistentCounter(javax.servlet.jsp.PageContext ctx,
                                          java.lang.String name)

Clears a "persistent" counter.

Parameters:

ctx - active PageContext

name - name of counter

getPersistentCounterValue

public static long getPersistentCounterValue(javax.servlet.jsp.PageContext ctx,
                                             java.lang.String name)

Gets the current value of a "persistent" counter

Parameters:

ctx - active PageContext

name - name of counter

Returns:

current value if counter exists, else -1

getCurrentCommand

public static ListCommand getCurrentCommand(javax.servlet.jsp.tagext.Tag caller,
                                            javax.servlet.jsp.PageContext ctx)

Locates the current ListCommand

Parameters:

caller - tag calling the method

ctx - caller's page context

Returns:

ListCommand if found, otherwise null

setCurrentCommand

public static void setCurrentCommand(javax.servlet.jsp.PageContext ctx,
                                     java.lang.String uniqueName,
                                     ListCommand cmd)

Stores a ListCommand in the page context and makes it current

Parameters:

ctx - caller's page context

uniqueName - owning list's unique name

cmd - new current command

makeFilterFormUrl

public static java.lang.String makeFilterFormUrl(javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String listName)

Builds URL for the filter form

Parameters:

request - current request

listName - unique list name

Returns:

url pointing to this list

write

public static void write(javax.servlet.jsp.PageContext ctx,
                         java.lang.String text)
                  throws javax.servlet.jsp.JspException

Writes arbitrary text to the client (browser)

Parameters:

ctx - caller's page context

text - text to write

Throws:

javax.servlet.jsp.JspException - if an error occurs

makeParamsLink

public static java.lang.String makeParamsLink(javax.servlet.ServletRequest request,
                                              java.lang.String listName,
                                              java.util.Map<java.lang.String,java.lang.String> paramsToAdd,
                                              java.util.List<java.lang.String> paramsToIgnore)

Returns a link containing the URL + ALL the parameters of the request query string minus the sort links, and the alpha link + the additional params passed in the paramsToAdd map. The resulting string is urlEncode'd with & encoded as & so it can be used in a href directly.

Parameters:

request - the Servlet Request

listName - the current list name

paramsToAdd - the params you might want to append to the url for example makeSortLink passes in sortByLabel while alpha bar passes in params that are specific to it.

paramsToIgnore - params to not include that would be normally

Returns:

a link containing the URL + (OtherParams - Sort - Alpha) + paramsToAdd

makeColumnSortLink

public static java.lang.String makeColumnSortLink(javax.servlet.http.HttpServletRequest request,
                                                  java.lang.String listName,
                                                  java.lang.String attrName,
                                                  java.lang.String sortDir)

Builds sort link

Parameters:

request - current request

listName - list's unique name

attrName - attribute to sort on

sortDir - sort direction: RequestContext.SORT_ASC for ascending, RequestContext.SORT_DESC for descending

Returns:

link

makeSortDirLabel

public static java.lang.String makeSortDirLabel(java.lang.String listName)

provides the sort direction url key

Parameters:

listName - the name of the list

Returns:

the url key for sort direction

makeSortByLabel

public static java.lang.String makeSortByLabel(java.lang.String listName)

provides the sort label (what to sort by) url key

Parameters:

listName - the list name

Returns:

the url key for sort label

makeSortDirId

public static java.lang.String makeSortDirId(java.lang.String listName)

provides the sort direction url key

Parameters:

listName - the name of the list

Returns:

the url key for sort direction

makeSortById

public static java.lang.String makeSortById(java.lang.String listName)

provides the sort label (what to sort by) url key

Parameters:

listName - the list name

Returns:

the url key for sort label

makeFilterByLabel

public static java.lang.String makeFilterByLabel(java.lang.String listName)

provides the filter label (what to sort by) url key

Parameters:

listName - the list name

Returns:

the url key for filter label

makeFilterValueByLabel

public static java.lang.String makeFilterValueByLabel(java.lang.String listName)

provides the filter label (what to sort by) url key

Parameters:

listName - the list name

Returns:

the url key for filter value label

makeFilterAttributeByLabel

public static java.lang.String makeFilterAttributeByLabel(java.lang.String listName)

provides the filter label (what to sort by) url key

Parameters:

listName - the list name

Returns:

the url key for filter value label

makeImageNameByLabel

public static java.lang.String makeImageNameByLabel(java.lang.String listName)

provides the filter label (what to sort by) url key

Parameters:

listName - the list name

Returns:

the url key for filter value label

makeFilterNameByLabel

public static java.lang.String makeFilterNameByLabel(java.lang.String listName)

provides the filter name (the name value for the go button on the filter box)

Parameters:

listName - the list name

Returns:

the key for filter name label

makeOldFilterValueByLabel

public static java.lang.String makeOldFilterValueByLabel(java.lang.String listName)

provides the filter label (what to sort by) url key

Parameters:

listName - the list name

Returns:

the url key for filter value label

makeFilterClassLabel

public static java.lang.String makeFilterClassLabel(java.lang.String listName)

provides the label to set/get the filter class

Parameters:

listName - the list name

Returns:

the filter class label

makeSelectActionName

public static java.lang.String makeSelectActionName(java.lang.String listName)

Returns the name of the Select Action attribute For example the Select All, Unselect All and Update buttons use this name..

Parameters:

listName - the name of the table tag

Returns:

the label of the select action

makeExtraButtonName

public static java.lang.String makeExtraButtonName(java.lang.String listName)

Returns the name of the extra buttonattribute

Parameters:

listName - the name of the table tag

Returns:

the label of the select action

makeSelectedAmountName

public static java.lang.String makeSelectedAmountName(java.lang.String listName)

Returns the name of the attribute that holds the selected amount

Parameters:

listName - the list name

Returns:

the label of the select amount attribute

makeSelectedItemsName

public static java.lang.String makeSelectedItemsName(java.lang.String listName)

Returns the name of the attribute that holds the selected check box items

Parameters:

listName - the list name

Returns:

the name of selected items

makePageItemsName

public static java.lang.String makePageItemsName(java.lang.String listName)

Returns the name of the attribute that holds the all the row items on the page.

Parameters:

listName - the list name

Returns:

the name of attribute holding all the row items in the page

makePageNumberName

public static java.lang.String makePageNumberName(java.lang.String listName)

Returns the name of the attribute that holds the current page number.

Parameters:

listName - the list name

Returns:

the name of the attribute that holds the current page number.

makeFirstPageLink

public static java.lang.String makeFirstPageLink(javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String listName)

Make first page link

Parameters:

request - current request

listName - list unique name

Returns:

url

makeLastPageLink

public static java.lang.String makeLastPageLink(javax.servlet.http.HttpServletRequest request,
                                                java.lang.String listName)

Make last page link

Parameters:

request - current request

listName - list unique name

Returns:

url

makePrevPageLink

public static java.lang.String makePrevPageLink(javax.servlet.http.HttpServletRequest request,
                                                java.lang.String listName,
                                                int currentPage)

Make prev page link

Parameters:

request - current request

listName - list unique name

currentPage - current page #

Returns:

url

makeNextPageLink

public static java.lang.String makeNextPageLink(javax.servlet.http.HttpServletRequest request,
                                                java.lang.String listName,
                                                int currentPage)

Make next page link

Parameters:

request - current request

listName - list unique name

currentPage - current page #

Returns:

url

getBeanValue

public static java.lang.String getBeanValue(java.lang.Object bean,
                                            java.lang.String attribute)

Gets the value of a data bean attribute

Parameters:

bean - target

attribute - attribute name - should be in Java bean notation

Returns:

String value, null if no value

toBoolean

public static boolean toBoolean(java.lang.String value)

Converts a series of string values to their boolean equivalents True values: true, t, yes, y, 1 False values: Everything else

Parameters:

value - value to interpret

Returns:

true or valse

includeContent

public static void includeContent(javax.servlet.jsp.PageContext ctx,
                                  java.lang.String url)
                           throws javax.servlet.jsp.JspException

Includes arbitrary _local_ url as content

Parameters:

ctx - caller's page context

url - local url

Throws:

javax.servlet.jsp.JspException - if something goes wrong Note: Local means Urls in the same application

parseStyles

public static java.lang.String[] parseStyles(java.lang.String styles)

Parses a list of style classes into a string array

Parameters:

styles - list of style classes separated by "|"

Returns:

array of sytles

renderPaginationLinks

public static void renderPaginationLinks(javax.servlet.jsp.PageContext pageContext,
                                         java.lang.String[] linkNames,
                                         java.util.Map links)
                                  throws javax.servlet.jsp.JspException

Renders the pagingation links for a given list.

Parameters:

pageContext - caller's page context

linkNames - name of links to use, in render order

links - map of string arrays key on link name

Throws:

javax.servlet.jsp.JspException - if something bad happens writing to the page

makeParentIsAnElementLabel

public static java.lang.String makeParentIsAnElementLabel(java.lang.String listName)

Returns the name of the attribute that holds the parent is an element value (used by list tag)

Parameters:

listName - the list name

Returns:

the label of the parent is an element attribute

renderFilterUI

public static void renderFilterUI(javax.servlet.jsp.PageContext pageContext,
                                  ListFilter filter,
                                  java.lang.String uniqueName,
                                  java.lang.String width,
                                  int columnCount)
                           throws javax.servlet.jsp.JspException

Renders the filter UI

Parameters:

pageContext - caller's page context

filter - ListFilter instance

uniqueName - name of the list

width - width of the list

columnCount - list's column count

Throws:

javax.servlet.jsp.JspException - if something bad happens writing to the page

renderFilterSubmit

public static void renderFilterSubmit(javax.servlet.jsp.PageContext pageContext,
                                      java.lang.String uniqueName)
                               throws javax.servlet.jsp.JspException

Renders the hidden input for filter to work

Parameters:

pageContext - caller's page context

uniqueName - name of the list

Throws:

javax.servlet.jsp.JspException - if something bad happens writing to the page