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

Class NumberedPager

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
org.kuali.rice.krad.uif.element.NumberedPager
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, ContentElement, LifecycleElement, org.springframework.core.Ordered
public class NumberedPager extends Pager
The NumberedPager widget is used to display a list of links horizontally in a page selection user interface. The user can select a page to jump to, go to prev/next page, or go to the first or last page. This widget needs to know the numberOfPages total, and the currentPage the user is on currently, so this widget must be fed this information from the code.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Field Details

    • pagesStart

      protected int pagesStart

    • pagesEnd

      protected int pagesEnd

  • Constructor Details

    • NumberedPager

      public NumberedPager()

  • 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 Pager
      Parameters:
      model - the current model
      parent - parent container

    • getMaxNumberedLinksShown

      public int getMaxNumberedLinksShown()
      The maximum number of NUMBERED links shown at once for pages, if number of pages that exist exceed this value, the pager omits some pages before and/or after the current page (which are revealed during while navigating using a carousel effect)
      Returns:
      the maximum number of NUMBERED links to show

    • setMaxNumberedLinksShown

      public void setMaxNumberedLinksShown(int maxNumberedLinksShown)
      Set the maximum number of NUMBERED links shown
      Parameters:
      maxNumberedLinksShown -

    • isRenderFirstLast

      public boolean isRenderFirstLast()
      Returns true if this pager widget is rendering the "First" and "Last" links
      Returns:
      true if rendering "First" and "Last" links

    • setRenderFirstLast

      public void setRenderFirstLast(boolean renderFirstLast)
      Set renderFirstLast
      Parameters:
      renderFirstLast -

    • isRenderPrevNext

      public boolean isRenderPrevNext()
      Returns true if this pager widget is rendering the "Prev" and "Next" links
      Returns:
      true if rendering "First" and "Last" links

    • setRenderPrevNext

      public void setRenderPrevNext(boolean renderPrevNext)
      Set renderPrevNext
      Parameters:
      renderPrevNext -

    • getPagesStart

      public int getPagesStart()
      The first page number to render; this is set by the framework
      Returns:
      pages start

    • getPagesEnd

      public int getPagesEnd()
      The last page number to render; this is set by the framework
      Returns:
      last page number to render

    • getFirstText

      public String getFirstText()
      The text to use on the first link.
      Returns:
      the first link text

    • setFirstText

      public void setFirstText(String firstText)
      See Also:

    • getLastText

      public String getLastText()
      The text to use for the last link.
      Returns:
      the last link text

    • setLastText

      public void setLastText(String lastText)
      See Also: