org.dbflute.cbean.paging.numberlink.range

クラス PageRangeBean

java.lang.Object

org.dbflute.cbean.paging.numberlink.range.PageRangeBean

すべての実装されたインタフェース:

Serializable

public class PageRangeBean
extends Object
implements Serializable

The bean of page range.

作成者:

jflute

関連項目:

直列化された形式

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected int	_allPageCount
protected List<Integer>	_cachedPageNumberList
protected int	_currentPageNumber
protected PageRangeOption	_pageRangeOption

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PageRangeBean()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	assertPageRangeValid()
<LINK extends PageNumberLink> List<LINK>	buildPageNumberLinkList(PageNumberLinkSetupper<LINK> manyArgLambda) Build the list of page number link.
protected int[]	convertListToIntArray(List<Integer> ls)
List<Integer>	createPageNumberList() Create the list of page number.
boolean	existsNextRange() Does the next range exist?
boolean	existsPreviousRange() Does the previous range exist?
int	getNextRangeNearestPageNumber() Get the value of nextRangeNearestPageNumber that is calculated.
int	getPreRangeNearestPageNumber() Get the value of preRangeNearestPageNumber that is calculated.
boolean	isExistNextPageRange() 非推奨です。 use existsNextRange()
boolean	isExistPrePageRange() 非推奨です。 use existsPreviousRange()
void	setAllPageCount(int allPageCount)
void	setCurrentPageNumber(int currentPageNumber)
void	setPageRangeOption(PageRangeOption pageRangeOption)
String	toString()

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

_currentPageNumber

protected int _currentPageNumber

_allPageCount

protected int _allPageCount

_pageRangeOption

protected PageRangeOption _pageRangeOption

_cachedPageNumberList

protected List<Integer> _cachedPageNumberList

コンストラクタの詳細

PageRangeBean

public PageRangeBean()

メソッドの詳細

buildPageNumberLinkList

public <LINK extends PageNumberLink> List<LINK> buildPageNumberLinkList(PageNumberLinkSetupper<LINK> manyArgLambda)

Build the list of page number link.

 List<PageNumberLink> linkList = page.pageRange(op -> {
     op.rangeSize(5);
 }).buildPageNumberLinkList((pageNumberElement, current) -> {
     String href = buildPagingHref(pageNumberElement); // for paging navigation links
     return new PageNumberLink().initialize(pageNumberElement, current, href);
 });
 

型パラメータ:

LINK - The type of link.

パラメータ:

manyArgLambda - The setup interface of Page number link. (NotNull, Required LINK)

戻り値:

The list of Page number link. (NotNull)

createPageNumberList

public List<Integer> createPageNumberList()

Create the list of page number.

 e.g. range-size=5, current-page=8 
 List<Integer> numberList = page.pageRange(op -> {
     op.rangeSize(5);
 }).createPageNumberList();
 
 //  8 / 23 pages (453 records)
 // previous 3 4 5 6 7 8 9 10 11 12 13 next
 

戻り値:

The list of page number. (NotNull)

existsPreviousRange

public boolean existsPreviousRange()

Does the previous range exist?
Using values are currentPageNumber and pageRangeSize and allPageCount.

 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
 // this method returns existence of 2
 

戻り値:

The determination, true or false.

existsNextRange

public boolean existsNextRange()

Does the next range exist?
Using values are currentPageNumber and pageRangeSize and allPageCount.

 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
 // this method returns existence of 14
 

戻り値:

The determination, true or false.

isExistPrePageRange

public boolean isExistPrePageRange()

非推奨です。 use existsPreviousRange()

Is existing previous page range?

 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
 // this method returns existence of 2
 

戻り値:

The determination, true or false.

isExistNextPageRange

public boolean isExistNextPageRange()

非推奨です。 use existsNextRange()

Is existing next page range?

 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
 // this method returns existence of 14
 

戻り値:

The determination, true or false.

convertListToIntArray

protected int[] convertListToIntArray(List<Integer> ls)

assertPageRangeValid

protected void assertPageRangeValid()

toString

public String toString()

オーバーライド:

toString クラス内 Object

戻り値:

The view string of all attribute values. (NotNull)

setCurrentPageNumber

public void setCurrentPageNumber(int currentPageNumber)

setAllPageCount

public void setAllPageCount(int allPageCount)

setPageRangeOption

public void setPageRangeOption(PageRangeOption pageRangeOption)

getPreRangeNearestPageNumber

public int getPreRangeNearestPageNumber()

Get the value of preRangeNearestPageNumber that is calculated.
You should use this.isExistPrePageRange() before calling this. (call only when true)

 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
 // this method returns 2
 

戻り値:

The value of preRangeNearestPageNumber.

getNextRangeNearestPageNumber

public int getNextRangeNearestPageNumber()

Get the value of nextRangeNearestPageNumber that is calculated.
You should use this.isExistNextPageRange() before calling this. (call only when true)

 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
 // this method returns 14
 

戻り値:

The value of nextRangeNearestPageNumber.