org.jsxp.framework.webroot.jsxpframework.components
Class PagerXhtmlController

java.lang.Object
  extended by org.jsxp.framework.ViewController
      extended by org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated
          extended by org.jsxp.framework.webroot.jsxpframework.components.PagerXhtmlController
All Implemented Interfaces:
ViewControllerLifeCycleExceptionHandler

public class PagerXhtmlController
extends org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated

The Class PagerXhtmlController. ViewController for the basic jsxp pager component. You can build pageable list in your view with this pager. If used on a page this pager will automatically process a given "page" input parameter to calculate the current position of the pager. Also it can be used for the result output and will render a pager (with links for the user to browse through the pageable list. You can configure the pager by using the different setters.


Nested Class Summary
 class PagerXhtmlController.InputParams
          The Class InputParams.
 
Nested classes/interfaces inherited from class org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated
org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated.Body, org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated.LinkFirst, org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated.LinkLast, org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated.LinkNext, org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated.LinkPrevious, org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated.PagerActivePage, org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated.PagerInactivePage, org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated.PagesList, org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated.SimplePager
 
Field Summary
 
Fields inherited from class org.jsxp.framework.ViewController
idElements
 
Constructor Summary
PagerXhtmlController()
           
 
Method Summary
 java.lang.String getBackText()
          Gets the back text.
 int getCount()
          Gets the count.
 int getCurrentPage()
          Gets the current page.
 java.lang.String getFirstText()
          Gets the first text.
 PagerXhtmlController.InputParams getInputParameterBean()
          Gets an instance of the input parameter bean.
 int getLastElement()
          Gets the last element.
 java.lang.String getLastText()
          Gets the last text.
 java.lang.String getNextText()
          Gets the next text.
 int getPageSize()
          Gets the page size.
 java.lang.String getQuery()
          Gets the query.
 int getStartElement()
          Gets the start element.
 void init()
          This method will be called by the jsxp framework in the initializing phase.
 void setBackText(java.lang.String backText)
          Sets the back text.
 void setCount(int last)
          Sets the count.
 void setFirstText(java.lang.String firstText)
          Sets the first text.
 void setLastText(java.lang.String lastText)
          Sets the last text.
 void setNextText(java.lang.String nextText)
          Sets the next text.
 void setPageSize(int pageSize)
          Sets the page size.
 void setQuery(java.lang.String query)
          Sets the query.
 
Methods inherited from class org.jsxp.framework.webroot.generated.jsxpframework.components.PagerXhtmlControllerGenerated
getElementBody, getElementLinkFirst, getElementLinkLast, getElementLinkNext, getElementLinkPrevious, getElementPagerActivePage, getElementPagerInactivePage, getElementPagesList, getElementSimplePager, getIdElementBody, getIdElementLinkFirst, getIdElementLinkLast, getIdElementLinkNext, getIdElementLinkPrevious, getIdElementPagerActivePage, getIdElementPagerInactivePage, getIdElementPagesList, getIdElementSimplePager
 
Methods inherited from class org.jsxp.framework.ViewController
addElement, addElementProcessor, containsVariable, execute, getCharacterEncoding, getContentType, getElement, getElement, getElement, getElement, getElement, getIdPrefix, getLifeCycle, getParent, getPreviousInputParameterBean, getRootElement, getStatusCode, getTemplatedView, getTemplateElements, getValidator, getValueForVariable, getVariables, getViewFilename, getViewTemplate, handleExecutingException, handleInitException, handleInputProcessingException, handlePreparingException, handleRenderingException, handleTemplatingException, handleValidatingException, importView, importView, isApplicationTemplateEnabled, isSkipExecution, isUsedAsImportedView, isUsedAsTemplate, needToSaveScopesToSession, replaceVariableValue, setApplicationTemplateEnabled, setNeedToSaveScopesToSession, setVariable, setViewTemplate, skipExecution, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PagerXhtmlController

public PagerXhtmlController()
Method Detail

getBackText

public java.lang.String getBackText()
Gets the back text.

Returns:
the back text

getCount

public int getCount()
Gets the count.

Returns:
the count

getCurrentPage

public int getCurrentPage()
Gets the current page.

Returns:
the current page

getFirstText

public java.lang.String getFirstText()
Gets the first text.

Returns:
the first text

getInputParameterBean

public PagerXhtmlController.InputParams getInputParameterBean()
Description copied from class: ViewController
Gets an instance of the input parameter bean. You have to override this method to use a special input parameter class. The jsxp framework will call this method to get a fresh instance and fill the bean by calling the set-method on the beans properties.

Overrides:
getInputParameterBean in class ViewController
Returns:
the input parameter

getLastElement

public int getLastElement()
Gets the last element.

Returns:
the last element

getLastText

public java.lang.String getLastText()
Gets the last text.

Returns:
the last text

getNextText

public java.lang.String getNextText()
Gets the next text.

Returns:
the next text

getPageSize

public int getPageSize()
Gets the page size.

Returns:
the page size

getQuery

public java.lang.String getQuery()
Gets the query.

Returns:
the query

getStartElement

public int getStartElement()
Gets the start element.

Returns:
the start element

init

public void init()
Description copied from class: ViewController
This method will be called by the jsxp framework in the initializing phase. It will be called for any used ViewController, also for template and for imported ViewController.

In this method you should do anything that a view controller needs to do if he is used in any way.

Overrides:
init in class ViewController

setBackText

public void setBackText(java.lang.String backText)
Sets the back text.

Parameters:
backText - the new back text

setCount

public void setCount(int last)
Sets the count.

Parameters:
last - the new count

setFirstText

public void setFirstText(java.lang.String firstText)
Sets the first text.

Parameters:
firstText - the new first text

setLastText

public void setLastText(java.lang.String lastText)
Sets the last text.

Parameters:
lastText - the new last text

setNextText

public void setNextText(java.lang.String nextText)
Sets the next text.

Parameters:
nextText - the new next text

setPageSize

public void setPageSize(int pageSize)
Sets the page size.

Parameters:
pageSize - the new page size

setQuery

public void setQuery(java.lang.String query)
Sets the query.

Parameters:
query - the new query


Copyright © 2012 Oliver Szymanski & David Tanzer