public class ListTagUtil
extends java.lang.Object
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)
|
public static java.lang.Long incrementPersistentCounter(javax.servlet.jsp.PageContext ctx, java.lang.String name)
ctx
- active PageContextname
- name of counterpublic static void clearPersistentCounter(javax.servlet.jsp.PageContext ctx, java.lang.String name)
ctx
- active PageContextname
- name of counterpublic static long getPersistentCounterValue(javax.servlet.jsp.PageContext ctx, java.lang.String name)
ctx
- active PageContextname
- name of counterpublic static ListCommand getCurrentCommand(javax.servlet.jsp.tagext.Tag caller, javax.servlet.jsp.PageContext ctx)
caller
- tag calling the methodctx
- caller's page contextpublic static void setCurrentCommand(javax.servlet.jsp.PageContext ctx, java.lang.String uniqueName, ListCommand cmd)
ctx
- caller's page contextuniqueName
- owning list's unique namecmd
- new current commandpublic static java.lang.String makeFilterFormUrl(javax.servlet.http.HttpServletRequest request, java.lang.String listName)
request
- current requestlistName
- unique list namepublic static void write(javax.servlet.jsp.PageContext ctx, java.lang.String text) throws javax.servlet.jsp.JspException
ctx
- caller's page contexttext
- text to writejavax.servlet.jsp.JspException
- if an error occurspublic 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)
request
- the Servlet RequestlistName
- the current list nameparamsToAdd
- 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 normallypublic static java.lang.String makeColumnSortLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName, java.lang.String attrName, java.lang.String sortDir)
request
- current requestlistName
- list's unique nameattrName
- attribute to sort onsortDir
- sort direction: RequestContext.SORT_ASC for ascending,
RequestContext.SORT_DESC for descendingpublic static java.lang.String makeSortDirLabel(java.lang.String listName)
listName
- the name of the listpublic static java.lang.String makeSortByLabel(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeSortDirId(java.lang.String listName)
listName
- the name of the listpublic static java.lang.String makeSortById(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeFilterByLabel(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeFilterValueByLabel(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeFilterAttributeByLabel(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeImageNameByLabel(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeFilterNameByLabel(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeOldFilterValueByLabel(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeFilterClassLabel(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeSelectActionName(java.lang.String listName)
listName
- the name of the table tagpublic static java.lang.String makeExtraButtonName(java.lang.String listName)
listName
- the name of the table tagpublic static java.lang.String makeSelectedAmountName(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeSelectedItemsName(java.lang.String listName)
listName
- the list namepublic static java.lang.String makePageItemsName(java.lang.String listName)
listName
- the list namepublic static java.lang.String makePageNumberName(java.lang.String listName)
listName
- the list namepublic static java.lang.String makeFirstPageLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName)
request
- current requestlistName
- list unique namepublic static java.lang.String makeLastPageLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName)
request
- current requestlistName
- list unique namepublic static java.lang.String makePrevPageLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName, int currentPage)
request
- current requestlistName
- list unique namecurrentPage
- current page #public static java.lang.String makeNextPageLink(javax.servlet.http.HttpServletRequest request, java.lang.String listName, int currentPage)
request
- current requestlistName
- list unique namecurrentPage
- current page #public static java.lang.String getBeanValue(java.lang.Object bean, java.lang.String attribute)
bean
- targetattribute
- attribute name - should be in Java bean notationpublic static boolean toBoolean(java.lang.String value)
value
- value to interpretpublic static void includeContent(javax.servlet.jsp.PageContext ctx, java.lang.String url) throws javax.servlet.jsp.JspException
ctx
- caller's page contexturl
- local urljavax.servlet.jsp.JspException
- if something goes wrong
Note: Local means Urls in the same applicationpublic static java.lang.String[] parseStyles(java.lang.String styles)
styles
- list of style classes separated by "|"public static void renderPaginationLinks(javax.servlet.jsp.PageContext pageContext, java.lang.String[] linkNames, java.util.Map links) throws javax.servlet.jsp.JspException
pageContext
- caller's page contextlinkNames
- name of links to use, in render orderlinks
- map of string arrays key on link namejavax.servlet.jsp.JspException
- if something bad happens writing to the pagepublic static java.lang.String makeParentIsAnElementLabel(java.lang.String listName)
listName
- the list namepublic 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
pageContext
- caller's page contextfilter
- ListFilter instanceuniqueName
- name of the listwidth
- width of the listcolumnCount
- list's column countjavax.servlet.jsp.JspException
- if something bad happens writing to the pagepublic static void renderFilterSubmit(javax.servlet.jsp.PageContext pageContext, java.lang.String uniqueName) throws javax.servlet.jsp.JspException
pageContext
- caller's page contextuniqueName
- name of the listjavax.servlet.jsp.JspException
- if something bad happens writing to the page