Paginator (ins-framework-mybatis 6.0.13 API)

java.lang.Object
- ins.framework.mybatis.paginator.domain.Paginator

All Implemented Interfaces:

Serializable
```
public class Paginator
extends Object
implements Serializable
```
分页器，根据page,limit,totalCount用于页面上分页显示多项内容，计算页码和当前页的偏移量，方便页面分页使用.

Author:

badqiu, miemiedev

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Paginator(int page, int limit, int totalCount)

Constructors
Constructor and Description
`Paginator(int page, int limit, int totalCount)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getEndRow()` 结束行，可以用于oracle分页使用 (1-based)。
`int`	`getLimit()`
`int`	`getNextPage()`
`int`	`getOffset()` offset，计数从0开始，可以用于mysql分页使用(0-based)
`int`	`getPage()` 取得当前页号。
`int`	`getPrePage()`
`Integer[]`	`getSlider()` 页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。
`int`	`getStartRow()` 开始行，可以用于oracle分页使用 (1-based)。
`int`	`getTotalCount()` 取得总项数。
`int`	`getTotalPages()` 得到总页数
`boolean`	`isDisabledPage(int page)` 判断指定页码是否被禁止，也就是说指定页码超出了范围或等于当前页码。
`boolean`	`isFirstPage()` 是否是首页（第一页），第一页页码为1
`boolean`	`isHasNextPage()` 是否有下一页
`boolean`	`isHasPrePage()` 是否有上一页
`boolean`	`isLastPage()` 是否是最后一页
`Integer[]`	`slider(int slidersCount)` 页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。注意:不可以使用 getSlider(1)方法名称，因为在JSP中会与 getSlider()方法冲突，报exception
`String`	`toString()`

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

- Constructor Detail
  - Paginator
```
public Paginator(int page,
                 int limit,
                 int totalCount)
```
- Method Detail
  - getPage
```
public int getPage()
```
    取得当前页号。
    
    Returns:
    
    当前页号
  - getLimit
```
public int getLimit()
```
  - getTotalCount
```
public int getTotalCount()
```
    取得总项数。
    
    Returns:
    
    总项数
  - isFirstPage
```
public boolean isFirstPage()
```
    是否是首页（第一页），第一页页码为1
    
    Returns:
    
    首页标识
  - isLastPage
```
public boolean isLastPage()
```
    是否是最后一页
    
    Returns:
    
    末页标识
  - getPrePage
```
public int getPrePage()
```
  - getNextPage
```
public int getNextPage()
```
  - isDisabledPage
```
public boolean isDisabledPage(int page)
```
    判断指定页码是否被禁止，也就是说指定页码超出了范围或等于当前页码。
    
    Parameters:
    
    page - 页码
    
    Returns:
    
    boolean 是否为禁止的页码
  - isHasPrePage
```
public boolean isHasPrePage()
```
    是否有上一页
    
    Returns:
    
    上一页标识
  - isHasNextPage
```
public boolean isHasNextPage()
```
    是否有下一页
    
    Returns:
    
    下一页标识
  - getStartRow
```
public int getStartRow()
```
    开始行，可以用于oracle分页使用 (1-based)。
    
    Returns:
    
    开始行
  - getEndRow
```
public int getEndRow()
```
    结束行，可以用于oracle分页使用 (1-based)。
    
    Returns:
    
    结束行
  - getOffset
```
public int getOffset()
```
    offset，计数从0开始，可以用于mysql分页使用(0-based)
    
    Returns:
    
    偏移量
  - getTotalPages
```
public int getTotalPages()
```
    得到总页数
    
    Returns:
    
    总页数
  - getSlider
```
public Integer[] getSlider()
```
    页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。
    
    Returns:
    
    Slider
  - slider
```
public Integer[] slider(int slidersCount)
```
    页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。注意:不可以使用 getSlider(1)方法名称，因为在JSP中会与 getSlider()方法冲突，报exception
    
    Parameters:
    
    slidersCount - 窗口数量
    
    Returns:
    
    页码滑动窗口
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Paginator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Paginator

Method Detail

getPage

getLimit

getTotalCount

isFirstPage

isLastPage

getPrePage

getNextPage

isDisabledPage

isHasPrePage

isHasNextPage

getStartRow

getEndRow

getOffset

getTotalPages

getSlider

slider

toString