Operation |
Details |
public BasePaginatorListSessionBean(): |
Sequential Notes: | Initializes a new BasePaginatorListSessionBean | |
protected abstract beforeRedirect():void |
Sequential Notes: | Method is called before a redirection. Subclasses can save states here. | |
public changeElementsPerPageBottom():String |
Sequential Notes: | Used as action when the user changes the lower number of elements menu. @return | |
public changeElementsPerPageTop():String |
Sequential Notes: | Used as action when the user changes the upper number of elements menu. @return | |
public abstract getAdditionalFilters():FilterType |
Sequential Notes: | When calling this method, implementing subclasses can return additional filters that are typical for the list elements and that should be always passed to the BaseListRetrieverRequestBean when retrieving a new list, e.g. for sorting @return | |
public getCurrentPageNumber():int |
Sequential Notes: | Returns the current page number of the paginator @return | |
public getCurrentPartList():List |
Sequential Notes: | Returns the current list with the specified elements @return | |
public getElementsPerPage():int |
Sequential Notes: | Returns the currently selected number of elements per page @return | |
public getElementsPerPageBottom():int |
Sequential Tags: | annotations=@Deprecated
| Notes: | WARNING: USE THIS METHOD ONLY FROM UPPER PAGINATOR SELECTION MENU IN JSPF. For getting the value manually, use getElementsPerPage(). @param elementsPerPageTop | |
public getElementsPerPageSelectItems():List |
Sequential Notes: | Returns the menu entries of the elements per page menu @return | |
public getElementsPerPageTop():int |
Sequential Tags: | annotations=@Deprecated
| Notes: | WARNING: USE THIS METHOD ONLY FROM UPPER PAGINATOR SELECTION MENU IN JSPF. For getting the value manually, use getElementsPerPage(). @param elementsPerPageTop | |
public getFirstPaginatorPageNumber():int |
Sequential Notes: | Returns the number of the paginator page button that should be displayed as first button of the paginator in order to always display exactly seven paginator page buttons @return | |
public getGoToPage():String |
Sequential Notes: | Returns the value of the go to input fields. @return | |
public getGoToPageBottom():String |
Sequential Tags: | annotations=@Deprecated
| Notes: | WARNING: USE THIS METHOD ONLY FROM LOWER GO TO INPUT FIELD MENU IN JSPF. For getting the value manually, use getGoToPage(). @param elementsPerPageTop | |
public getGoToPageTop():String |
Sequential Tags: | annotations=@Deprecated
| Notes: | WARNING: USE THIS METHOD ONLY FROM UPPER GO TO INPUT FIELD MENU IN JSPF. For getting the value manually, use getGoToPage(). @param elementsPerPageTop | |
private getHasChanged():boolean |
Sequential Notes: | Returns the value of hasChanged and resets it to false. @return | |
public getLinkForFirstPage():String |
Sequential Notes: | Returns the link for the "First Page"-Button of the Paginator @return | |
public getLinkForLastPage():String |
Sequential Notes: | Returns the link for the "Last Page"-Button of the Paginator @return | |
public getLinkForNextPage():String |
Sequential Notes: | Returns the link for the "Next"-Button of the Paginator @return | |
public getLinkForPreviousPage():String |
Sequential Notes: | Returns the link for the "Previous"-Button of the Paginator @return | |
protected getModifiedLink( String key, String value):String |
Sequential Notes: | Returns a link of which one GET parameter is modified @return | |
public getOffset():int |
Sequential Notes: | Returns the current offset (starting with 0) | |
public getPageType():String |
Sequential Notes: | Returns the pageType, a String that describes the current page with which this list is used. @return | |
protected getPaginatorListRetriever():BaseListRetrieverRequestBean |
Sequential Notes: | Returns the corresponding BaseListRetrieverRequestBean. @return | |
public getPaginatorPages():List |
Sequential Notes: | Returns a list with the paginator pages. Used from jsf to iterate over the numbers @return | |
public getPaginatorPageSize():int |
Sequential Notes: | Returns the number of all paginator pages, not only the visible ones @return | |
public getParameterElementsPerPage():String |
Sequential |
public getParameterMap():Map |
Sequential Notes: | Returns a map that contains all HTTP GET parameters as key-value pairs. If you want to redirect please add your parameters here first. @return | |
public getParameterPageNumber():String |
Sequential |
public getPartListSize():int |
Sequential Notes: | Returns the size of the current list @return | |
public getRedirectUrl():String |
Sequential Notes: | Returns the url to redirect, including the page path (drawn from BaseListRetrieverRequestBean and all get parameters from the parameterMap. @return | |
public getTotalNumberOfElements():int |
Sequential Notes: | Returns the total number of elements, without offset and limit filters. Drawn from BaseRetrieverRequestBean | |
private getUrlParameterString():String |
Sequential Notes: | Returns the GET parameters from the parameter map as string that can be appended to the URL @return | |
public goToPageBottom():String |
Sequential Notes: | Used as action when the user sends an value from the lower go to input field @return | |
public goToPageTop():String |
Sequential Notes: | Used as action when the user sends an value from the upper go to input field @return | |
protected abstract listUpdated():void |
Sequential Notes: | Called whenever a new list is retrieved and set. | |
protected abstract pageTypeChanged():void |
Sequential Notes: | This method is called whenever a new pageType is used. You can reset session-specific variables here, e.g. | |
private parametersChanged():boolean |
Sequential Notes: | Compares the parameters from the current request with the ones from the last request. Returns true if parameters have changed or if there are more/less parameters since the last request. This is done in order to avoid the list update if only e.g. a new menu should be displayed. @return | |
protected abstract readOutParameters():void |
Sequential Notes: | Implementing subclasses have to read out and set GET parameters within this method. If parameters are set, please do not forget to add them to the parameterMap of this class. Otherwise they won't be in the redirect URL. | |
public redirect():void |
Sequential Notes: | Redirects to the current list page using all parameters from the parameterMap and the path to the jsp page (drawn form BaseListretrieverRequestBean= | |
public saveOldParameters():void |
Sequential Notes: | Copies the current parameters in the parameter store | |
public setCurrentPageNumber( int currentPageNumber):void |
Sequential Notes: | Sets the current paginator page number | |
public setElementsPerPage( int elementsPerPage):void |
Sequential Notes: | Sets the current value for 'element per pages' | |
public setElementsPerPageBottom( int elementsPerPageBottom):void |
Sequential Tags: | annotations=@Deprecated
| Notes: | WARNING: USE THIS METHOD ONLY FROM LOWER PAGINATOR SELECTION MENU IN JSPF. For setting the value manually, use setElementsPerPage(). @param elementsPerPageTop | |
public setElementsPerPageSelectItems( List elementsPerPageSelectItems):void |
Sequential Notes: | Sets the menu entries of the elements per page menu | |
public setElementsPerPageTop( int elementsPerPageTop):void |
Sequential Tags: | annotations=@Deprecated
| Notes: | WARNING: USE THIS METHOD ONLY FROM UPPER PAGINATOR SELECTION MENU IN JSPF. For setting the value manually, use setElementsPerPage(). | |
public setGoToPage( String goToPage):void |
Sequential Notes: | Sets the value of the go to input fields. | |
public setGoToPageBottom( String goToPage):void |
Sequential Tags: | annotations=@Deprecated
| Notes: | WARNING: USE THIS METHOD ONLY FROM LOWER GO TO INPUT FIELD MENU IN JSPF. For setting the value manually, use setGoToPage(). @param elementsPerPageTop | |
public setGoToPageTop( String goToPage):void |
Sequential Tags: | annotations=@Deprecated
| Notes: | WARNING: USE THIS METHOD ONLY FROM UPPER GO TO INPUT FIELD MENU IN JSPF. For setting the value manually, use setGoToPage(). @param elementsPerPageTop | |
public setHasChanged():void |
Sequential Notes: | Set this method from outside if the list has to be updated even if no GET parameters have changed; | |
public setPageType( String pageType):void |
Sequential Notes: | Sets the pageType and, whenever a new pageType is used, calls pageTypeChanged(), clears the parameter map and the input fields of go to boxes. | |
public setPaginatorListRetriever( BaseListRetrieverRequestBean paginatorListRetriever):void |
Sequential Notes: | Sets the current BaseListRetrieverRequestBean of this SessionBean | |
public update():void |
Sequential Notes: | This method is called by the corresponding BaseListRetrieverRequestBean whenever the list has to be updated. It reads out basic parameters and calls readOutParamters on implementing subclasses. It uses the BaseListRetrieverRequestBean in order to retrieve the new list and finally calls listUpdated on implementing subclasses. | |