com.redhat.rhn.frontend.taglibs.list

Class ListTagHelper

java.lang.Object

com.redhat.rhn.frontend.taglibs.list.ListTagHelper

public class ListTagHelper
extends java.lang.Object

Static helper class for the "new-style" list tag

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PAGE_ACTION
static java.lang.String	PAGE_LIST
static java.lang.String	PARENT_URL

Method Summary

Modifier and Type	Method and Description
static void	bindSetDeclTo(java.lang.String listName, RhnSetDecl decl, javax.servlet.ServletRequest request) Stores the declaration information of an rhnSet so as to be used by the list tag while rendering a set.
static void	bindSetDeclTo(java.lang.String listName, java.lang.String label, javax.servlet.ServletRequest request) Stores the declaration information of an rhnSet so as to be used by the list tag while rendering a set.
static java.lang.String[]	getAll(java.lang.String listName, javax.servlet.http.HttpServletRequest request) Returns the values of all the row items in a given list This is useful for example in diff'ing between the result set and the selected items on a page.
static java.lang.String	getFilterValue(javax.servlet.ServletRequest request, java.lang.String uniqueName) returns the value that the list is being filtered upon.
static java.lang.String	getListAction(java.lang.String listName, javax.servlet.http.HttpServletRequest request) Checks if any of the list actions were clicked like selectAll, unselectAll update set, pagination buttons (in which page_action will be returned)..
static java.lang.String	getObjectId(java.lang.Object current) Returns the object id given an object deals with selectable/identifiable objects or uses hashcode for general
static int	getPageNumber(java.lang.String listName, javax.servlet.http.HttpServletRequest request) Gets the current page number for the named list This is zero based
static java.lang.String	getRadioSelection(java.lang.String listName, javax.servlet.http.HttpServletRequest request) Returns the value of the selected radio button Applicable if you are using RadioColumnTag (rl:radiocolumn)
static java.lang.String[]	getSelected(java.lang.String listName, javax.servlet.http.HttpServletRequest request) Returns the values of all selected checkboxes
static boolean	isParentAnElement(javax.servlet.ServletRequest request, java.lang.String uniqueName) returns true if the list that is being filtered upon is allowed to to treat the parent as an element (always true for normal list)
static java.lang.String	lookupSetDeclFor(java.lang.String listName, javax.servlet.ServletRequest request) Returns a set declaration associated to this list if it was previously bound.
static java.lang.String	makeRowId(java.lang.String listName, java.lang.Object current) Makes the tr row ids useful especially for expandable row renderers.
static void	selectRadioValue(java.lang.String listName, java.lang.String selectionKey, javax.servlet.http.HttpServletRequest request) Given a list and a value the following method preselects a value in the list.
static void	setSelectedAmount(java.lang.String listName, int amount, javax.servlet.http.HttpServletRequest request) Stores how many objects are selected for use by the list tag

Methods inherited from class java.lang.Object

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

Field Detail

PARENT_URL

public static final java.lang.String PARENT_URL

See Also:

Constant Field Values

PAGE_LIST

public static final java.lang.String PAGE_LIST

See Also:

Constant Field Values

PAGE_ACTION

public static final java.lang.String PAGE_ACTION

See Also:

Constant Field Values

Method Detail

bindSetDeclTo

public static void bindSetDeclTo(java.lang.String listName,
                                 RhnSetDecl decl,
                                 javax.servlet.ServletRequest request)

Stores the declaration information of an rhnSet so as to be used by the list tag while rendering a set.

Parameters:

listName - name of list

decl - the set declaration to bind

request - current HttpServletRequest

bindSetDeclTo

public static void bindSetDeclTo(java.lang.String listName,
                                 java.lang.String label,
                                 javax.servlet.ServletRequest request)

Stores the declaration information of an rhnSet so as to be used by the list tag while rendering a set.

Parameters:

listName - name of list

label - the set declaration to bind

request - current HttpServletRequest

lookupSetDeclFor

public static java.lang.String lookupSetDeclFor(java.lang.String listName,
                                                javax.servlet.ServletRequest request)

Returns a set declaration associated to this list if it was previously bound.

Parameters:

listName - the name of the list to who holds the set. Note: this must be a Unique Name .. See bindSetDeclTo method for more info.

request - the servlet request object

Returns:

returns the set declaration label associated to the list.

setSelectedAmount

public static void setSelectedAmount(java.lang.String listName,
                                     int amount,
                                     javax.servlet.http.HttpServletRequest request)

Stores how many objects are selected for use by the list tag

Parameters:

listName - name of list

amount - amount of items selected

request - current HttpServletRequest

getPageNumber

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

Gets the current page number for the named list This is zero based

Parameters:

listName - name of list

request - active HttpServletRequest

Returns:

page number

getRadioSelection

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

Returns the value of the selected radio button Applicable if you are using RadioColumnTag (rl:radiocolumn)

Parameters:

listName - name of list

request - active HttpServletRequest

Returns:

string of the selected radio button or null

selectRadioValue

public static void selectRadioValue(java.lang.String listName,
                                    java.lang.String selectionKey,
                                    javax.servlet.http.HttpServletRequest request)

Given a list and a value the following method preselects a value in the list. Applicable if you are using RadioColumnTag (rl:radiocolumn) So for example if you have a list of items and you have a selection key that uniquely identifies your item and you want that selected, you 'd call this method to preselect it...

Parameters:

listName - name of the list

selectionKey - the selection key uniquely identifying the item to be selected.

request - the active http request.

getSelected

public static java.lang.String[] getSelected(java.lang.String listName,
                                             javax.servlet.http.HttpServletRequest request)

Returns the values of all selected checkboxes

Parameters:

listName - name of list

request - active HttpServletRequest

Returns:

string array if items found, else null

getAll

public static java.lang.String[] getAll(java.lang.String listName,
                                        javax.servlet.http.HttpServletRequest request)

Returns the values of all the row items in a given list This is useful for example in diff'ing between the result set and the selected items on a page.

Parameters:

listName - name of list

request - active HttpServletRequest

Returns:

string array if items found, else null

getListAction

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

Checks if any of the list actions were clicked like selectAll, unselectAll update set, pagination buttons (in which page_action will be returned).. etc and returns the appropriate value

Parameters:

listName - name of list

request - active HttpServletRequest

Returns:

List Action if any of the list actions were selected null if not.

getFilterValue

public static java.lang.String getFilterValue(javax.servlet.ServletRequest request,
                                              java.lang.String uniqueName)

returns the value that the list is being filtered upon. (null if not being filtered)

Parameters:

request - the request to look in

uniqueName - the unique (hashed) name for the list

Returns:

the filter value

isParentAnElement

public static boolean isParentAnElement(javax.servlet.ServletRequest request,
                                        java.lang.String uniqueName)

returns true if the list that is being filtered upon is allowed to to treat the parent as an element (always true for normal list)

Parameters:

request - the request to look in

uniqueName - the unique (hashed) name for the list

Returns:

true if the parent can be treated as an element.

getObjectId

public static java.lang.String getObjectId(java.lang.Object current)

Returns the object id given an object deals with selectable/identifiable objects or uses hashcode for general

Parameters:

current - the current object

Returns:

the id representing the object

makeRowId

public static java.lang.String makeRowId(java.lang.String listName,
                                         java.lang.Object current)

Makes the tr row ids useful especially for expandable row renderers.

Parameters:

listName - the name of the list

current - the object to be expanded on

Returns:

the row id value