Package org.kuali.rice.krad.uif.element

Class Pager

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
org.kuali.rice.krad.uif.component.ComponentBase
org.kuali.rice.krad.uif.element.ContentElementBase
org.kuali.rice.krad.uif.element.Pager
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, ContentElement, LifecycleElement, org.springframework.core.Ordered
Direct Known Subclasses:
NextPager, NumberedPager
public abstract class Pager extends ContentElementBase
Pager widgets are used to page a set of information which has multiple pages.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • Pager

      public Pager()

  • Method Details

    • performFinalize

      public void performFinalize(Object model, LifecycleElement parent)
      performFinalize calculates the pagesStart and pagesEnd properties (using numberOfPages, currentPage, and maxNumberedLinksShown - these must be set) which determines pages shown by the widget
      Specified by:
      performFinalize in interface LifecycleElement
      Overrides:
      performFinalize in class ComponentBase
      Parameters:
      model - the current model
      parent - parent container

    • getLinkScript

      public String getLinkScript()
      The script to execute when a link is clicked (should probably use the "this" var in most cases, to determine page number selected - see retrieveStackedPage(linkElement, collectionId) js function)
      Returns:
      the script to execute when a link is clicked

    • setLinkScript

      public void setLinkScript(String linkScript)
      Set the link js script
      Parameters:
      linkScript - the link js script

    • getNumberOfPages

      public int getNumberOfPages()
      Number of pages TOTAL that make up the component being paged (this must be set by the framework based on some list size)
      Returns:
      the number of pages used in this pager

    • setNumberOfPages

      public void setNumberOfPages(int numberOfPages)
      Set the TOTAL number of pages
      Parameters:
      numberOfPages -

    • getCurrentPage

      public int getCurrentPage()
      The current page being shown by this pager widget (this must be set when the page is changed)
      Returns:
      the current page being shown

    • setCurrentPage

      public void setCurrentPage(int currentPage)
      Set the current page
      Parameters:
      currentPage -

    • getPrevText

      public String getPrevText()
      The text to use on the previous link.
      Returns:
      the previous link text

    • setPrevText

      public void setPrevText(String prevText)
      See Also:

    • getNextText

      public String getNextText()
      The text to use on the next link.
      Returns:
      the next link text

    • setNextText

      public void setNextText(String nextText)
      See Also: