Summary: Methods | [Expand All]
public interface

PaginationSupport

bucket.core.PaginationSupport<T>
Known Indirect Subclasses

Class Overview

Calculates the page values and indexes for a list of items

Summary

Public Methods
int getNextStartIndex()
Returns the next start index.
int[] getNextStartIndexes()
Returns an array of start indexes for pages that appear after the current page If there are no further pages, null is returned
int getNiceEndIndex()
Returns an end index for use in the UI.
int getNiceStartIndex()
Returns a start index for use in the UI.
List<T> getPage()
Returns a sub-list of items that are shown on the page.
int getPageSize()
Returns the number of items available on the current page.
int getPreviousStartIndex()
Returns the previous start index.
int[] getPreviousStartIndexes()
Returns an array of start indexes for pages that appear before the current page If there are no preceding pages, null is returned
int getStartIndex()
Returns the start index.
int getStartIndexValue()
Always return the start index value, regardless of whether the pagination has any total.
int getTotal()
Returns the total number of items in the list

Public Methods

public int getNextStartIndex ()

Returns the next start index. Returns -1 if we are on the last page (there is no next page).

Returns
  • the next start index. Returns -1 if we are on the last page (there is no next page).

public int[] getNextStartIndexes ()

Returns an array of start indexes for pages that appear after the current page If there are no further pages, null is returned

Returns
  • an array of start indexes for pages that appear after the current page

public int getNiceEndIndex ()

Returns an end index for use in the UI. It returns the end index - 1

Returns
  • a nice end index

public int getNiceStartIndex ()

Returns a start index for use in the UI. It returns the start index + 1

Returns
  • a nice start index

public List<T> getPage ()

Returns a sub-list of items that are shown on the page.

Returns
  • a sub-list of items that are available on the page.

public int getPageSize ()

Returns the number of items available on the current page.

Returns
  • the number of items available on the current page.

public int getPreviousStartIndex ()

Returns the previous start index. Returns -1 if we are on the first page (there is no previous page).

Returns
  • the previous start index. Returns -1 if we are on the first page (there is no previous page).

public int[] getPreviousStartIndexes ()

Returns an array of start indexes for pages that appear before the current page If there are no preceding pages, null is returned

Returns
  • an array of start indexes for pages that appear before the current page

public int getStartIndex ()

Returns the start index. If the start index exceeds the index of the last element, the index of the last element is returned. If the start index is less than 0, 0 is returned.

Returns
  • the start index.

public int getStartIndexValue ()

Always return the start index value, regardless of whether the pagination has any total.

Returns
  • the start index value, regardless of whether the pagination has any total.

public int getTotal ()

Returns the total number of items in the list

Returns
  • total number of items in the list