org.seasar.s2click.control
クラス PaginateList

java.lang.Object
  org.apache.click.control.AbstractControl
      org.seasar.s2click.control.PaginateList

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

java.io.Serializable, org.apache.click.Control

public class PaginateList
extends org.apache.click.control.AbstractControl

リストをページング処理して表示するためのコントロールです。

Velocityテンプレートを指定することで任意の表示形式でレンダリングすることができます。 Velocityテンプレートでは以下の変数が使用可能です。

• $list - 現在のページで表示する範囲のオブジェクトを格納したリスト。
• $pager - ページリンク部分のHTML。
• $format - ClickのFormatオブジェクト。通常のHTMLテンプレートの場合と同じです。
• $context - アプリケーションのコンテキストパスを表す文字列。通常のHTMLテンプレートの場合と同じです。
• $totalRows - 全件数
• $totalPages - 全ページ数
• $pageNumber - 現在のページ番号
• $startIndex - 表示範囲の開始インデックス
• $endIndex - 表示範囲の終了インデックス
• $startRow - 表示範囲の開始行（startIndex + 1）
• $endRow - 表示範囲の終了行（endIndex + 1）

導入されたバージョン:

0.5.0

作成者:

Naoki Takezoe

関連項目:

直列化された形式

フィールドの概要

protected org.apache.click.control.ActionLink	controlLink ページリンクを出力するためのコントロール。
static java.lang.String	PAGE ページリンクのパラメータ名。
protected int	pageNumber 表示するページ番号。
protected int	pageSize 1ページに表示する行の数。
protected java.util.List<?>	rowList すべてのオブジェクトを格納したリスト。
protected java.lang.String	templatePath テンプレートのパス。

クラス org.apache.click.control.AbstractControl から継承されたフィールド

actionListener, attributes, behaviors, headElements, listener, listenerMethod, messages, name, parent, styles

インタフェース org.apache.click.Control から継承されたフィールド

CONTROL_MESSAGES

コンストラクタの概要

PaginateList()
コンストラクタ。

PaginateList(java.lang.String name)
コンストラクタ。

PaginateList(java.lang.String name, java.lang.String templatePath)
コンストラクタ。

メソッドの概要

java.util.List<?>	getDisplayList() setRowList(List)でセットされたリストの中から、 現在のページで表示する範囲のオブジェクトを抽出したリストを取得します。
int	getPageNumber()
java.lang.String	getPager() ページング処理を行うリンク部分のHTMLを取得します。
int	getPageSize()
java.util.List<?>	getRowList()
java.lang.String	getTemplatePath() レンダリングに使用するテンプレートのパスを指定します。
boolean	onProcess()
void	render(org.apache.click.util.HtmlStringBuffer buffer)
void	setName(java.lang.String name)
void	setPageNumber(int pageNumber)
void	setPageSize(int pageSize)
void	setRowList(java.util.List<?> rowList)
void	setTemplatePath(java.lang.String templatePath) レンダリングに使用するテンプレートのパスを取得します。
java.lang.String	toString()

クラス org.apache.click.control.AbstractControl から継承されたメソッド

addBehavior, addStyleClass, appendAttributes, dispatchActionEvent, getActionListener, getAttribute, getAttributes, getBehaviors, getContext, getControlSizeEst, getHeadElements, getHtmlImports, getId, getMessage, getMessage, getMessages, getName, getPage, getParent, getStyle, getStyles, getTag, hasAttribute, hasAttributes, hasBehaviors, hasStyles, isAjaxTarget, onDeploy, onDestroy, onInit, onRender, removeBehavior, removeStyleClass, renderTagBegin, renderTagEnd, setActionListener, setAttribute, setId, setListener, setParent, setStyle

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

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

フィールドの詳細

PAGE

public static final java.lang.String PAGE

ページリンクのパラメータ名。

関連項目:

定数フィールド値

pageNumber

protected int pageNumber

表示するページ番号。最初のページが0になります。

pageSize

protected int pageSize

1ページに表示する行の数。0の場合は無制限になります。

rowList

protected java.util.List<?> rowList

すべてのオブジェクトを格納したリスト。

templatePath

protected java.lang.String templatePath

テンプレートのパス。

controlLink

protected org.apache.click.control.ActionLink controlLink

ページリンクを出力するためのコントロール。

コンストラクタの詳細

PaginateList

public PaginateList()

コンストラクタ。

PaginateList

public PaginateList(java.lang.String name)

コンストラクタ。

パラメータ:

name - コントロール名

PaginateList

public PaginateList(java.lang.String name,
                    java.lang.String templatePath)

コンストラクタ。

パラメータ:

name - コントロール名

templatePath - テンプレートのパス

メソッドの詳細

setName

public void setName(java.lang.String name)

定義:

インタフェース org.apache.click.Control 内の setName

オーバーライド:

クラス org.apache.click.control.AbstractControl 内の setName

getPageNumber

public int getPageNumber()

setPageNumber

public void setPageNumber(int pageNumber)

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int pageSize)

setRowList

public void setRowList(java.util.List<?> rowList)

getRowList

public java.util.List<?> getRowList()

getTemplatePath

public java.lang.String getTemplatePath()

レンダリングに使用するテンプレートのパスを指定します。

戻り値:

テンプレートのパス

setTemplatePath

public void setTemplatePath(java.lang.String templatePath)

レンダリングに使用するテンプレートのパスを取得します。

パラメータ:

templatePath - テンプレートのパス

onProcess

public boolean onProcess()

定義:

インタフェース org.apache.click.Control 内の onProcess

オーバーライド:

クラス org.apache.click.control.AbstractControl 内の onProcess

getPager

public java.lang.String getPager()

ページング処理を行うリンク部分のHTMLを取得します。

戻り値:

ページリンク部分のHTML

getDisplayList

public java.util.List<?> getDisplayList()

setRowList(List)でセットされたリストの中から、 現在のページで表示する範囲のオブジェクトを抽出したリストを取得します。

戻り値:

現在のページで表示するオブジェクトを格納したリスト

toString

public java.lang.String toString()

オーバーライド:

クラス org.apache.click.control.AbstractControl 内の toString

render

public void render(org.apache.click.util.HtmlStringBuffer buffer)

定義:

インタフェース org.apache.click.Control 内の render

オーバーライド:

クラス org.apache.click.control.AbstractControl 内の render