PageData (Jodd API Documentation)

java.lang.Object
- jodd.joy.page.PageData<T>

```
public class PageData<T>
extends java.lang.Object
```
Holds information about single page of results. Item indexes are zero-based and page numbers are one-based.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`currentPage`
`protected int`	`firstIndex`
`protected java.util.List<T>`	`items`
`protected int`	`lastIndex`
`protected int`	`pageItemsCount`
`protected int`	`pageSize`
`protected int`	`totalItems`
`protected int`	`totalPages`

Constructor Summary

Constructors
Constructor and Description
`PageData()`
`PageData(int page, int size)`
`PageData(int page, int size, int pageSize)`
`PageData(int page, int size, int pageSize, java.util.List<T> items)` Main constructor.
`PageData(PageRequest req, int size, java.util.List<T> items)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`calcFirstItemIndexOfPage(int page, int pageSize, int total)` Calculates the first item index of requested page.
`static int`	`calcFirstItemIndexOfPage(PageRequest pageRequest, int total)` Calculates first item index of the page.
`static int`	`calcPageOfItem(int itemIndex, int pageSize)` Calculates page number that contains some item.
`int`	`getCurrentPage()` Returns current page number.
`int`	`getFirstIndex()` Returns index of the first item on this page.
`java.util.List<T>`	`getItems()` Returns the list of items on this page.
`int`	`getLastIndex()` Returns index of last item of page.
`int`	`getPageItemsCount()` Returns the number of shown items per page.
`int`	`getPageSize()` Returns page size, i.e. number of items per page.
`int`	`getTotalItems()` Returns total number of items.
`int`	`getTotalPages()` Returns total number of pages.
`boolean`	`hasNextPage()` Returns `true` if there is a next page, i.e. we are not at the last page.
`boolean`	`hasPreviousPage()` Returns `true` if there is a previous page, i.e. we are not at the first page.
`boolean`	`isFirstPage()` Returns `true` id we are on the first page.
`boolean`	`isLastPage()` Returns `true` if we are on the last page.
`java.lang.String`	`toString()` Convenient report method that can be used as JSON array.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pageSize
```
protected final int pageSize
```

firstIndex
```
protected final int firstIndex
```

lastIndex
```
protected final int lastIndex
```

items

protected final java.util.List<T> items

totalItems
```
protected final int totalItems
```

totalPages
```
protected final int totalPages
```

currentPage
```
protected int currentPage
```

pageItemsCount
```
protected final int pageItemsCount
```

Constructor Detail

PageData
```
public PageData()
```

PageData

public PageData(int page,
                int size)

PageData

public PageData(int page,
                int size,
                int pageSize)

PageData

public PageData(PageRequest req,
                int size,
                java.util.List<T> items)

PageData
```
public PageData(int page,
                int size,
                int pageSize,
                java.util.List<T> items)
```
Main constructor.

Parameters:

page - current page

size - total number of items

pageSize - number of items per page

items - list of fetched items

Method Detail
- getPageSize
```
public int getPageSize()
```
  Returns page size, i.e. number of items per page.
- getFirstIndex
```
public int getFirstIndex()
```
  Returns index of the first item on this page.
- getLastIndex
```
public int getLastIndex()
```
  Returns index of last item of page. On every page but last, last index equals to first index plus page size.
- getItems
```
public java.util.List<T> getItems()
```
  Returns the list of items on this page.
- getTotalItems
```
public int getTotalItems()
```
  Returns total number of items.
- getTotalPages
```
public int getTotalPages()
```
  Returns total number of pages.
- getCurrentPage
```
public int getCurrentPage()
```
  Returns current page number.
- getPageItemsCount
```
public int getPageItemsCount()
```
  Returns the number of shown items per page. Note that this value is calculated.
- hasNextPage
```
public boolean hasNextPage()
```
  Returns true if there is a next page, i.e. we are not at the last page.
- isLastPage
```
public boolean isLastPage()
```
  Returns true if we are on the last page.
- hasPreviousPage
```
public boolean hasPreviousPage()
```
  Returns true if there is a previous page, i.e. we are not at the first page.
- isFirstPage
```
public boolean isFirstPage()
```
  Returns true id we are on the first page.
- toString
```
public java.lang.String toString()
```
  Convenient report method that can be used as JSON array.
  
  Overrides:
  
  toString in class java.lang.Object
- calcPageOfItem
```
public static int calcPageOfItem(int itemIndex,
                                 int pageSize)
```
  Calculates page number that contains some item.
- calcFirstItemIndexOfPage
```
public static int calcFirstItemIndexOfPage(int page,
                                           int pageSize,
                                           int total)
```
  Calculates the first item index of requested page.
- calcFirstItemIndexOfPage
```
public static int calcFirstItemIndexOfPage(PageRequest pageRequest,
                                           int total)
```
  Calculates first item index of the page.

Class PageData<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pageSize

firstIndex

lastIndex

items

totalItems

totalPages

currentPage

pageItemsCount

Constructor Detail

PageData

PageData

PageData

PageData

PageData

Method Detail

getPageSize

getFirstIndex

getLastIndex

getItems

getTotalItems

getTotalPages

getCurrentPage

getPageItemsCount

hasNextPage

isLastPage

hasPreviousPage

isFirstPage

toString

calcPageOfItem

calcFirstItemIndexOfPage

calcFirstItemIndexOfPage