Pager (dexcoder-commons 2.3.1 API)

java.lang.Object
- com.dexcoder.commons.pager.Pager

所有已实现的接口:: Serializable

public class Pager
extends Object
implements Serializable

分页工具类

此类用于分页时显示多项内容，计算页码和当前页的偏移量。

该类只需要知道总的数据项数，当前显示第几页，每页显示几项，就可以帮你计算出其它数据，而且保证所有计算都得出合理的值，不用担心页码超出边界之类的问题。

使用方法如下:

    >>
   //        ^      ^                             ^               ^    ^
   //       第一页 前一页                       当前页          后一页 最后一页
   //
   // 以上例子就是一个大小为7的滑动窗口，当前页码被尽可能摆在中间，除非当前页位于开头或结尾。
   // 使用下面的调用，就可以得到指定大小的滑动窗口中的页码数组。
   int[] slider = pg.getSlider(7);

   // 这样可以判断指定页码是否有效，或者是当前页。无效的页码在web页面上不需要链接。
   if (pg.isDisabledPage(slider[i])) {
       show = "page " + slider[i];
   } else {
       show = " page " + slider[i] + " ";
   }

   // 可以直接打印出pg，用于调试程序。
   System.out.println(pg);
   log.debug(pg);

 ]]>

版本:: $Id: Pager.java, v 0.1 2012-4-19 上午9:38:48 liyd Exp $
作者:: liyd
另请参阅:: 序列化表格

字段概要

字段
限定符和类型字段和说明

static int DEFAULT_ITEMS_PER_PAGE
每页默认的项数

static int DEFAULT_SLIDER_SIZE
滑动窗口默认的大小

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_ITEMS_PER_PAGE` 每页默认的项数
`static int`	`DEFAULT_SLIDER_SIZE` 滑动窗口默认的大小

构造器概要

构造器
构造器和说明

Pager()
创建一个分页器，默认每页显示50项。

构造器
构造器和说明
`Pager()` 创建一个分页器，默认每页显示`50`项。

方法概要

方法
限定符和类型	方法和说明
`protected int`	`calcPage(int page)` 计算页数，但不改变当前页。
`int`	`getActualLength()` 取得当前页的长度，即当前页的实际项数。
`int`	`getBeginIndex()` 取得当前页显示的项的起始序号 (1-based)。
`int`	`getCurPage()` 取得当前页。
`int`	`getEndIndex()` 取得当前页显示的末项序号 (1-based)。
`int`	`getFirstPage()` 取得首页页码。
`int`	`getItemsPerPage()` 取得每页项数。
`int`	`getItemsTotal()` 取得总项数。
`int`	`getLastPage()` 取得末页页码。
`List<?>`	`getList()`
`<E> List<E>`	`getList(Class<E> clazz)` 返回转换后的数据
`int`	`getNextPage()` 取得后一页页码。
`int`	`getNextPage(int n)` 取得后n页页码。
`int`	`getOffset()` 取得当前页第一项在全部项中的偏移量 (0-based)。
`int`	`getPages()` 取得总页数。
`int`	`getPreviousPage()` 取得前一页页码。
`int`	`getPreviousPage(int n)` 取得前n页页码
`int[]`	`getSlider()` 取得默认大小(`DEFAULT_SLIDER_SIZE`)的页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。
`int[]`	`getSlider(int pWidth)` 取得指定大小的页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。
`boolean`	`isDisabledPage(int page)` 判断指定页码是否被禁止，也就是说指定页码超出了范围或等于当前页码。
`int`	`setCurPage(int page)` 设置并取得当前页。
`int`	`setItemsPerPage(int itemsPerPage)` 设置并取得每页项数。
`int`	`setItemsTotal(int items)` 设置并取得总项数。
`void`	`setList(List<?> list)`
`int`	`setOffset(int offset)` 设置第几条记录，使之返回该条记录所在的页数据项如每页显示10条，设置25，将返回第25条记录所在页的数据项(21-30)
`String`	`toString()` 转换成字符串表示。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - DEFAULT_ITEMS_PER_PAGE
```
public static final int DEFAULT_ITEMS_PER_PAGE
```
    每页默认的项数
    
    另请参阅:
    常量字段值
  - DEFAULT_SLIDER_SIZE
```
public static final int DEFAULT_SLIDER_SIZE
```
    滑动窗口默认的大小
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - Pager
```
public Pager()
```
    创建一个分页器，默认每页显示50项。
- 方法详细资料
  - getPages
```
public int getPages()
```
    取得总页数。
    
    返回:
    总页数
  - getCurPage
```
public int getCurPage()
```
    取得当前页。
    
    返回:
    当前页
  - setCurPage
```
public int setCurPage(int page)
```
    设置并取得当前页。实际的当前页值被确保在正确的范围内。
    
    参数:
    page - 当前页
    
    返回:
    设置后的当前页
  - getItemsTotal
```
public int getItemsTotal()
```
    取得总项数。
    
    返回:
    总项数
  - getList
```
public List<?> getList()
```
  - setList
```
public void setList(List<?> list)
```
  - getList
```
public <E> List<E> getList(Class<E> clazz)
```
    返回转换后的数据
    
    返回:
  - setItemsTotal
```
public int setItemsTotal(int items)
```
    设置并取得总项数。如果指定的总项数小于0，则被看作0。自动调整当前页，确保当前页值在正确的范围内。
    
    参数:
    items - 总项数
    
    返回:
    设置以后的总项数
  - getItemsPerPage
```
public int getItemsPerPage()
```
    取得每页项数。
    
    返回:
    每页项数
  - setItemsPerPage
```
public int setItemsPerPage(int itemsPerPage)
```
    设置并取得每页项数。如果指定的每页项数小于等于0，则使用默认值DEFAULT_ITEMS_PER_PAGE。并调整当前页使之在改变每页项数前后显示相同的项。
    
    参数:
    itemsPerPage - 每页项数
    
    返回:
    设置后的每页项数
  - getOffset
```
public int getOffset()
```
    取得当前页第一项在全部项中的偏移量 (0-based)。
    
    返回:
    偏移量
  - getActualLength
```
public int getActualLength()
```
    取得当前页的长度，即当前页的实际项数。相当于 endIndex() - beginIndex() + 1
    
    返回:
    当前页的长度
  - getBeginIndex
```
public int getBeginIndex()
```
    取得当前页显示的项的起始序号 (1-based)。
    
    返回:
    起始序号
  - getEndIndex
```
public int getEndIndex()
```
    取得当前页显示的末项序号 (1-based)。
    
    返回:
    末项序号
  - setOffset
```
public int setOffset(int offset)
```
    设置第几条记录，使之返回该条记录所在的页数据项
    如每页显示10条，设置25，将返回第25条记录所在页的数据项(21-30)
    
    参数:
    offset - 要显示的项位置
    
    返回:
    指定项所在的页
  - getFirstPage
```
public int getFirstPage()
```
    取得首页页码。
    
    返回:
    首页页码
  - getLastPage
```
public int getLastPage()
```
    取得末页页码。
    
    返回:
    末页页码
  - getPreviousPage
```
public int getPreviousPage()
```
    取得前一页页码。
    
    返回:
    前一页页码
  - getPreviousPage
```
public int getPreviousPage(int n)
```
    取得前n页页码
    
    参数:
    n - 前n页
    
    返回:
    前n页页码
  - getNextPage
```
public int getNextPage()
```
    取得后一页页码。
    
    返回:
    后一页页码
  - getNextPage
```
public int getNextPage(int n)
```
    取得后n页页码。
    
    参数:
    n - 后n面
    
    返回:
    后n页页码
  - isDisabledPage
```
public boolean isDisabledPage(int page)
```
    判断指定页码是否被禁止，也就是说指定页码超出了范围或等于当前页码。
    
    参数:
    page - 页码
    
    返回:
    boolean 是否为禁止的页码
  - getSlider
```
public int[] getSlider()
```
    取得默认大小(DEFAULT_SLIDER_SIZE)的页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。参见getSlider(int n)。
    
    返回:
    包含页码的数组
  - getSlider
```
public int[] getSlider(int pWidth)
```
    取得指定大小的页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。例如: 总共有13页，当前页是第5页，取得一个大小为5的滑动窗口，将包括 3，4，5，6, 7这几个页码，第5页被放在中间。如果当前页是12，则返回页码为 9，10，11，12，13。
    
    参数:
    pWidth - 滑动窗口大小
    
    返回:
    包含页码的数组，如果指定滑动窗口大小小于1或总页数为0，则返回空数组。
  - calcPage
```
protected int calcPage(int page)
```
    计算页数，但不改变当前页。
    
    参数:
    page - 页码
    
    返回:
    返回正确的页码(保证不会出边界)
  - toString
```
public String toString()
```
    转换成字符串表示。
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    字符串表示。

类 Pager

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_ITEMS_PER_PAGE

DEFAULT_SLIDER_SIZE

构造器详细资料

Pager

方法详细资料

getPages

getCurPage

setCurPage

getItemsTotal

getList

setList

getList

setItemsTotal

getItemsPerPage

setItemsPerPage

getOffset

getActualLength

getBeginIndex

getEndIndex

setOffset

getFirstPage

getLastPage

getPreviousPage

getPreviousPage

getNextPage

getNextPage

isDisabledPage

getSlider

getSlider

calcPage

toString