jp.littlesoft.web
クラス WebDataTable.PageContext

java.lang.Object
  jp.littlesoft.web.WebDataTable.PageContext

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

Serializable

含まれているクラス:

WebDataTable<E extends Serializable>

public static class WebDataTable.PageContext
extends Object
implements Serializable

WebDataTable オブジェクトの内容をHTMLテンプレートからアクセスできるように変換するクラス。

ActionPageクラスにpublicフィールドとして定義された WebDataTable オブジェクトは自動的に HTMLテンプレートからアクセスできるようになっていますが、これは擬似的なものであり、 WebDataTable オブジェクトに対する直接アクセスではありません。

実際には、ActionPage クラスの show() メソッドや getMergedString() メソッドの中で当PageContextクラスが生成され、 WebDataTable オブジェクトの内容がコピーされています。

※注意： HTMLテンプレート内のスクリプトから呼び出される動作は、当クラスのpublicメソッドである点に注意してください。

作成者:

LittleSoft Corporation

関連項目:

直列化された形式

コンストラクタの概要

WebDataTable.PageContext(WebDataTable<?> dataTable)
引数 dataTable で指定されたWebデータテーブルを変換して、 PageContext オブジェクトを生成します。

メソッドの概要

boolean	getactive() WebDataTable オブジェクトが活性化しているかどうかを取得します。
boolean	getActive() WebDataTable オブジェクトが活性化しているかどうかを取得します。
int	getendRow() getRows() メソッドで返される末尾行のインデックスを取得します。
int	getEndRow() getRows() メソッドで返される末尾行のインデックスを取得します。
int	getendRowNum() getRows() メソッドで返される末尾行の行番号を取得します。
int	getEndRowNum() getRows() メソッドで返される末尾行の行番号を取得します。
ArrayList<String>	geterrors() エラーメッセージのリストを取得します。
ArrayList<String>	getErrors() エラーメッセージのリストを取得します。
boolean	gethasError() エラーメッセージが存在するかどうかを取得します。
boolean	getHasError() エラーメッセージが存在するかどうかを取得します。
boolean	gethasNextPage() スクロール可能な次ページが存在するかどうかを取得します。
boolean	getHasNextPage() スクロール可能な次ページが存在するかどうを取得します。
boolean	gethasPrevPage() スクロール可能な前ページが存在するかどうかを取得します。
boolean	getHasPrevPage() スクロール可能な前ページが存在するかどうかを取得します。
String	getpager() WebDataTable オブジェクトのページャーを取得します。
String	getPager() WebDataTable オブジェクトのページャーを取得します。
WebDataTable.PageRow<String,String>	getparams() Webデータテーブルの Params オブジェクトの内容を取得します。
WebDataTable.PageRow<String,String>	getParams() Webデータテーブルの Params オブジェクトの内容を取得します。
WebDataTable.PageRow<String,String>	getrow(String index) 引数 index で指定された行オブジェクトを PageRow オブジェクトに変換して取得します。
WebDataTable.PageRow<String,String>	getRow(String index) 引数 index で指定された行オブジェクトを PageRow オブジェクトに変換して取得します。
int	getrowCount() WebDataTable オブジェクトの行数を取得します。
int	getRowCount() WebDataTable オブジェクトの行数を取得します。
ArrayList<WebDataTable.PageRow<String,String>>	getrows() 行オブジェクトの内容をリストで取得します。
ArrayList<WebDataTable.PageRow<String,String>>	getRows() 行オブジェクトの内容をリストで取得します。
int	getshowRows() getRows() メソッドで返される行数を取得します。
int	getShowRows() getRows() メソッドで返される行数を取得します。
int	getstartRow() getRows() メソッドで返される先頭行のインデックスを取得します。
int	getStartRow() getRows() メソッドで返される先頭行のインデックスを取得します。
int	getstartRowNum() getRows() メソッドで返される先頭行の行番号を取得します。
int	getStartRowNum() getRows() メソッドで返される先頭行の行番号を取得します。

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

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

コンストラクタの詳細

WebDataTable.PageContext

public WebDataTable.PageContext(WebDataTable<?> dataTable)

引数 dataTable で指定されたWebデータテーブルを変換して、 PageContext オブジェクトを生成します。

パラメータ:

dataTable - Webデータテーブル

メソッドの詳細

getactive

public boolean getactive()

WebDataTable オブジェクトが活性化しているかどうかを取得します。

HTMLテンプレートでは以下のような記述となります。

   #if($table.active) ...
 

戻り値:

True：活性化、False：非活性化

getActive

public boolean getActive()

WebDataTable オブジェクトが活性化しているかどうかを取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getactive() メソッドと同様です。

戻り値:

True：活性化、False：非活性化

gethasPrevPage

public boolean gethasPrevPage()

スクロール可能な前ページが存在するかどうかを取得します。

HTMLテンプレートでは以下のような記述となります。

   #if($table.hasPrevPage) ...
 

戻り値:

True：存在する、False：存在しない

getHasPrevPage

public boolean getHasPrevPage()

スクロール可能な前ページが存在するかどうかを取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き gethasPrevPage() メソッドと同様です。

戻り値:

True：存在する、False：存在しない

gethasNextPage

public boolean gethasNextPage()

スクロール可能な次ページが存在するかどうかを取得します。

HTMLテンプレートでは以下のような記述となります。

   #if($table.hasNextPage) ...
 

戻り値:

True：存在する、False：存在しない

getHasNextPage

public boolean getHasNextPage()

スクロール可能な次ページが存在するかどうを取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き gethasNextPage() メソッドと同様です。

戻り値:

True：存在する、False：存在しない

getrowCount

public int getrowCount()

WebDataTable オブジェクトの行数を取得します。

HTMLテンプレートでは以下のような記述となります。

   $table.rowCount
 

戻り値:

行数

getRowCount

public int getRowCount()

WebDataTable オブジェクトの行数を取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getrowCount() メソッドと同様です。

戻り値:

行数

getpager

public String getpager()

WebDataTable オブジェクトのページャーを取得します。

HTMLテンプレートでは以下のような記述となります。

   $table.pager
 

戻り値:

行数

getPager

public String getPager()

WebDataTable オブジェクトのページャーを取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getpager() メソッドと同様です。

戻り値:

行数

getrows

public ArrayList<WebDataTable.PageRow<String,String>> getrows()

行オブジェクトの内容をリストで取得します。

HTMLテンプレートからは次のような記述でリストから行オブジェクトを取り出し、その内容にアクセスすることができます。

   #foreach( $dept in $tableDept.rows )
     <li> $dept.get('dept_code') $dept.get('dept_name')</li>
   #end
 

※注意： 当メソッドで取得できるリストの内容はWebデータテーブルのShowRowsプロパティによって変化します。
ディフォルトでは全ての行がリストに含まれますが、ShowRowsプロパティに値が設定されている場合、 設定値を上限とした行のみを取得することができます。

これを利用して、リストのページング表示を行うことが可能となります。

リストに含まれる行の範囲を変更する場合は、Webデータテーブルの以下メソッドを使用します。

• pageFirst()
• pageNext()
• pageLast()
• pagePrevious()



戻り値:

行オブジェクトのArrayList

関連項目:

WebDataTable.setShowRows(int), WebDataTable.pageFirst(), WebDataTable.pageLast(), WebDataTable.pageNext(), WebDataTable.pagePrevious()

getRows

public ArrayList<WebDataTable.PageRow<String,String>> getRows()

行オブジェクトの内容をリストで取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getrows() メソッドと同様です。

戻り値:

行オブジェクトのArrayList

getrow

public WebDataTable.PageRow<String,String> getrow(String index)

引数 index で指定された行オブジェクトを PageRow オブジェクトに変換して取得します。

HTMLテンプレートからは次のような記述でリストから行オブジェクトを取り出し、その内容にアクセスすることができます。

   #set( $emp = $tableEmp.getRow('0') )
 

注意： 当メソッドで取得できる行オブジェクトはjp.littlesoft.data.Rowクラスではなく、PageRowクラスである点に注意してください。
WebDataTable内部の 行オブジェクトをHTMLテンプレートからアクセス可能にする為、PageRow オブジェクト へ変換しています。

パラメータ:

index - 行インデックス

戻り値:

PageRow テンプレート用の行オブジェクト

getRow

public WebDataTable.PageRow<String,String> getRow(String index)

引数 index で指定された行オブジェクトを PageRow オブジェクトに変換して取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getrow(String) メソッドと同様です。

パラメータ:

index - 行インデックス

戻り値:

PageRow テンプレート用の行オブジェクト

getstartRow

public int getstartRow()

getRows() メソッドで返される先頭行のインデックスを取得します。

このインデックスはWebDataTable内での Row オブジェクトの位置を示すものです。

HTMLテンプレートでは以下のような記述となります。

   $table.startRow
 

戻り値:

開始行インデックス

getStartRow

public int getStartRow()

getRows() メソッドで返される先頭行のインデックスを取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getstartRow() メソッドと同様です。

戻り値:

開始行インデックス

getendRow

public int getendRow()

getRows() メソッドで返される末尾行のインデックスを取得します。

このインデックスはWebDataTable内での Row オブジェクトの位置を示すものです。

HTMLテンプレートでは以下のような記述となります。

   $table.endRow
 

戻り値:

末尾行インデックス

getEndRow

public int getEndRow()

getRows() メソッドで返される末尾行のインデックスを取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getendRow() メソッドと同様です。

戻り値:

末尾行インデックス

getstartRowNum

public int getstartRowNum()

getRows() メソッドで返される先頭行の行番号を取得します。
HTMLテンプレートでは以下のような記述となります。

   $table.startRowNum
 

戻り値:

開始行インデックス

getStartRowNum

public int getStartRowNum()

getRows() メソッドで返される先頭行の行番号を取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getstartRowNum() メソッドと同様です。

戻り値:

開始行インデックス

getendRowNum

public int getendRowNum()

getRows() メソッドで返される末尾行の行番号を取得します。
HTMLテンプレートでは以下のような記述となります。

   $table.endRowNum
 

戻り値:

末尾行インデックス

getEndRowNum

public int getEndRowNum()

getRows() メソッドで返される末尾行の行番号を取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getendRowNum() メソッドと同様です。

戻り値:

末尾行インデックス

getshowRows

public int getshowRows()

getRows() メソッドで返される行数を取得します。

HTMLテンプレートでは以下のような記述となります。

   $table.showRows
 

戻り値:

行数

getShowRows

public int getShowRows()

getRows() メソッドで返される行数を取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getshowRows() メソッドと同様です。

戻り値:

行数

geterrors

public ArrayList<String> geterrors()

エラーメッセージのリストを取得します。

HTMLテンプレートでは以下のような記述となります。

   #foreach( $err in $table.errors )
      <li> $err </li>
   #end
 

戻り値:

メッセージ文字列のリスト

getErrors

public ArrayList<String> getErrors()

エラーメッセージのリストを取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き geterrors() メソッドと同様です。

戻り値:

メッセージ文字列のリスト

gethasError

public boolean gethasError()

エラーメッセージが存在するかどうかを取得します。

HTMLテンプレートでは以下のような記述となります。

   #if($table.hasError) .....
 

戻り値:

True：エラーメッセージ有り、False：無し

getHasError

public boolean getHasError()

エラーメッセージが存在するかどうかを取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き gethasError() メソッドと同様です。

戻り値:

True：エラーメッセージ有り、False：無し

getparams

public WebDataTable.PageRow<String,String> getparams()

Webデータテーブルの Params オブジェクトの内容を取得します。

このメソッドで取得できるのは実際の Params オブジェクトではなく、その値がコピーされた PageRow オブジェクトです。

HTMLテンプレートでは以下のような記述となります。

   $table.params.[PageRowのメソッド]
 

戻り値:

Paramsの内容がコピーされた PageRow オブジェクト

getParams

public WebDataTable.PageRow<String,String> getParams()

Webデータテーブルの Params オブジェクトの内容を取得します。

HTMLテンプレートでの記述が、先頭が大文字になる点を除き getparams() メソッドと同様です。

戻り値:

Paramsの内容がコピーされた PageRow オブジェクト