com.ktanx.common.model.Pager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ktanx-common Show documentation
Show all versions of ktanx-common Show documentation
Ktanx is a java development kit.
The newest version!
package com.ktanx.common.model;
import java.io.Serializable;
/**
* 分页器。
*/
public class Pager implements Serializable, Cloneable {
private static final long serialVersionUID = 7440088907736399271L;
/**
* 每页默认的项数(10)。
*/
public static final int DEFAULT_PAGE_SIZE = 20;
/**
* 滑动窗口默认的大小(7)。
*/
public static final int DEFAULT_SLIDER_SIZE = 7;
/**
* 表示项数未知(Integer.MAX_VALUE)。
*/
public static final int UNKNOWN_ITEMS = Integer.MAX_VALUE;
/**
* 当前页码
*/
private int pageNum;
/**
* 总记录数
*/
private int totalItems;
/**
* 每页条数
*/
private int pageSize;
/**
* 创建一个分页器，初始项数为无限大UNKNOWN_ITEMS
*/
public Pager() {
this(0);
}
/**
* 创建一个分页器，初始项数为无限大UNKNOWN_ITEMS，指定每页项数。
*
* @param itemsPerPage 每页项数。
*/
public Pager(int itemsPerPage) {
this(itemsPerPage, UNKNOWN_ITEMS);
}
/**
* 创建一个分页器
*
* @param pageSize 每页项数。
* @param totalItems 总项数
*/
public Pager(int pageSize, int totalItems) {
this.totalItems = (totalItems >= 0) ? totalItems : 0;
this.pageSize = (pageSize > 0) ? pageSize : DEFAULT_PAGE_SIZE;
this.pageNum = calcPage(0);
}
/**
* 取得总页数。
*
* @return 总页数
*/
public int getPages() {
return (int) Math.ceil((double) totalItems / pageSize);
}
/**
* 取得当前页。
*
* @return 当前页
*/
public int getPageNum() {
return pageNum;
}
/**
* 设置并取得当前页。实际的当前页值被确保在正确的范围内。
*
* @param pageNum 当前页
* @return 设置后的当前页
*/
public int setPageNum(int pageNum) {
return (this.pageNum = calcPage(pageNum));
}
/**
* 取得总项数。
*
* @return 总项数
*/
public int getTotalItems() {
return totalItems;
}
/**
* 设置并取得总项数。如果指定的总项数小于0，则被看作0。自动调整当前页，确保当前页值在正确的范围内。
*
* @param totalItems 总项数
* @return 设置以后的总项数
*/
public int setTotalItems(int totalItems) {
this.totalItems = (totalItems >= 0) ? totalItems : 0;
setPageNum(pageNum);
return this.totalItems;
}
/**
* 取得每页项数。
*
* @return 每页项数
*/
public int getPageSize() {
return pageSize;
}
/**
* 设置并取得每页项数。如果指定的每页项数小于等于0，则使用默认值DEFAULT_PAGE_SIZE。 并调整当前页使之在改变每页项数前后显示相同的项。
*
* @param pageSize 每页项数
* @return 设置后的每页项数
*/
public int setPageSize(int pageSize) {
int tmp = this.pageSize;
this.pageSize = (pageSize > 0) ? pageSize : DEFAULT_PAGE_SIZE;
if (pageNum > 0) {
setPageNum((int) (((double) (pageNum - 1) * tmp) / this.pageSize) + 1);
}
return this.pageSize;
}
/**
* 取得当前页第一项在全部项中的偏移量 (0-based)。
*
* @return 偏移量
*/
public int getOffset() {
return (pageNum > 0) ? (pageSize * (pageNum - 1)) : 0;
}
/**
* 设置第几条记录，使之返回该条记录所在的页数据项
*
* 如每页显示10条，设置25，将返回第25条记录所在页的数据项(21-30)
*
* @param offset 要显示的项位置
* @return 指定项所在的页
*/
public int setOffset(int offset) {
return setPageNum((offset / pageSize) + 1);
}
/**
* 取得当前页的长度，即当前页的实际项数。相当于 endIndex() - beginIndex() + 1
*
* @return 当前页的长度
*/
public int getLength() {
if (pageNum > 0) {
return Math.min(pageSize * pageNum, totalItems) - (pageSize * (pageNum - 1));
} else {
return 0;
}
}
/**
* 取得当前页显示的项的起始序号 (1-based)。
*
* @return 起始序号
*/
public int getBeginIndex() {
if (pageNum > 0) {
return (pageSize * (pageNum - 1));
} else {
return 0;
}
}
/**
* 取得当前页显示的末项序号 (1-based)。
*
* @return 末项序号
*/
public int getEndIndex() {
if (pageNum > 0) {
return Math.min(pageSize * pageNum, totalItems);
} else {
return 0;
}
}
/**
* 设置当前页，使之显示指定offset(0-based)的项。
*
* @param itemOffset 要显示的项的偏移量(0-based)
* @return 指定项所在的页
*/
public int setItem(int itemOffset) {
return setPageNum((itemOffset / pageSize) + 1);
}
/**
* 取得首页页码。
*
* @return 首页页码
*/
public int getFirstPage() {
return calcPage(1);
}
/**
* 取得末页页码。
*
* @return 末页页码
*/
public int getLastPage() {
return calcPage(getPages());
}
/**
* 取得前一页页码。
*
* @return 前一页页码
*/
public int getPreviousPage() {
return calcPage(pageNum - 1);
}
/**
* 取得前n页页码
*
* @param n 前n页
* @return 前n页页码
*/
public int getPreviousPage(int n) {
return calcPage(pageNum - n);
}
/**
* 取得后一页页码。
*
* @return 后一页页码
*/
public int getNextPage() {
return calcPage(pageNum + 1);
}
/**
* 取得后n页页码。
*
* @param n 后n面
* @return 后n页页码
*/
public int getNextPage(int n) {
return calcPage(pageNum + n);
}
/**
* 判断指定页码是否被禁止，也就是说指定页码超出了范围或等于当前页码。
*
* @param page 页码
* @return boolean 是否为禁止的页码
*/
public boolean isDisabledPage(int page) {
return ((page < 1) || (page > getPages()) || (page == this.pageNum));
}
/**
* 取得默认大小(DEFAULT_SLIDER_SIZE)的页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。参见{@link #getSlider(int
* n)}。
*
* @return 包含页码的数组
*/
public int[] getSlider() {
return getSlider(DEFAULT_SLIDER_SIZE);
}
/**
* 取得指定大小的页码滑动窗口，并将当前页尽可能地放在滑动窗口的中间部位。例如: 总共有13页，当前页是第5页，取得一个大小为5的滑动窗口，将包括 3，4，5，6,
* 7这几个页码，第5页被放在中间。如果当前页是12，则返回页码为 9，10，11，12，13。
*
* @param width 滑动窗口大小
* @return 包含页码的数组，如果指定滑动窗口大小小于1或总页数为0，则返回空数组。
*/
public int[] getSlider(int width) {
int pages = getPages();
if ((pages < 1) || (width < 1)) {
return new int[0];
} else {
if (width > pages) {
width = pages;
}
int[] slider = new int[width];
int first = pageNum - ((width - 1) / 2);
if (first < 1) {
first = 1;
}
if (((first + width) - 1) > pages) {
first = pages - width + 1;
}
for (int i = 0; i < width; i++) {
slider[i] = first + i;
}
return slider;
}
}
/**
* 计算页数，但不改变当前页。
*
* @param pageNum 页码
* @return 返回正确的页码(保证不会出边界)
*/
protected int calcPage(int pageNum) {
int pages = getPages();
if (pages > 0) {
return (pageNum < 1) ? 1 : ((pageNum > pages) ? pages : pageNum);
}
return 0;
}
/**
* 创建复本。
*
* @return 复本
*/
public Object clone() {
try {
return super.clone();
} catch (CloneNotSupportedException e) {
//ignore
return null;
}
}
/**
* 转换成字符串表示。
*
* @return 字符串表示。
*/
public String toString() {
StringBuffer sb = new StringBuffer("Pager: page ");
if (getPages() < 1) {
sb.append(getPageNum());
} else {
int[] slider = getSlider();
for (int i = 0; i < slider.length; i++) {
if (isDisabledPage(slider[i])) {
sb.append('[').append(slider[i]).append(']');
} else {
sb.append(slider[i]);
}
if (i < (slider.length - 1)) {
sb.append('\t');
}
}
}
sb.append(" of ").append(getPages()).append(",\n");
sb.append(" Showing items ").append(getBeginIndex()).append(" to ").append(getEndIndex()).append(" (total ")
.append(getTotalItems()).append(" items), ");
sb.append("offset=").append(getOffset()).append(", length=").append(getLength());
return sb.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy