PageRequest (Jodd API Documentation)

java.lang.Object
- jodd.joy.page.PageRequest

public class PageRequest
extends java.lang.Object

Represents single page request.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`defaultPageSize` Default page size.
`static int`	`defaultSortIndex` Default sort index.
`protected int`	`page`
`protected java.lang.String`	`pagerId`
`protected int`	`size`
`protected int`	`sort`

Constructor Summary

Constructors
Constructor and Description

PageRequest()

Constructors
Constructor and Description
`PageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`calcOffset()` Calculates offset.
`int`	`getPage()` Returns requested page number.
`java.lang.String`	`getPagerId()` Returns pager id.
`int`	`getSize()` Returns size of the page.
`int`	`getSort()` Returns sort 1-based index of column that should be sorted.
`void`	`setPage(int page)` Specifies requested page number.
`void`	`setPagerId(java.lang.String pagerId)` Returns pager id.
`void`	`setSize(int size)` Specifies page size, i.e. number of elements per page.
`void`	`setSort(int sort)` Returns sort index.
`java.lang.String`	`toString()`

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

- Field Detail
  - defaultPageSize
```
public static int defaultPageSize
```
    Default page size.
  - defaultSortIndex
```
public static int defaultSortIndex
```
    Default sort index.
  - page
```
protected int page
```
  - size
```
protected int size
```
  - pagerId
```
protected java.lang.String pagerId
```
  - sort
```
protected int sort
```
- Constructor Detail
  - PageRequest
```
public PageRequest()
```
- Method Detail
  - getPage
```
public int getPage()
```
    Returns requested page number.
    
    See Also:
    
    setPage(int)
  - setPage
```
public void setPage(int page)
```
    Specifies requested page number. Page numbers are 1-based.
  - getSize
```
public int getSize()
```
    Returns size of the page. Page size refers to total numbers of items per page.
    
    See Also:
    
    setSize(int)
  - setSize
```
public void setSize(int size)
```
    Specifies page size, i.e. number of elements per page.
  - getSort
```
public int getSort()
```
    Returns sort 1-based index of column that should be sorted. If 0, nothing should be sorted. Positive values represents ascending order, negative values descending.
    By using the index we also hide the real column names.
  - setSort
```
public void setSort(int sort)
```
    Returns sort index.
    
    See Also:
    
    getSort()
  - getPagerId
```
public java.lang.String getPagerId()
```
    Returns pager id.
  - setPagerId
```
public void setPagerId(java.lang.String pagerId)
```
    Returns pager id.
  - calcOffset
```
public int calcOffset()
```
    Calculates offset.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PageRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultPageSize

defaultSortIndex

page

size

pagerId

sort

Constructor Detail

PageRequest

Method Detail

getPage

setPage

getSize

setSize

getSort

setSort

getPagerId

setPagerId

calcOffset

toString