jp.terasoluna.fw.web.struts.taglib
クラス PageLinksTag

java.lang.Object
  上位を拡張 javax.servlet.jsp.tagext.TagSupport
      上位を拡張 jp.terasoluna.fw.web.struts.taglib.PageLinksTag
すべての実装されたインタフェース:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class PageLinksTag
extends javax.servlet.jsp.tagext.TagSupport

ページ単位にページを遷移する機能。

Strutsの<logic:iterate>要素によって定義された一覧の ページ遷移のリンクを表示する。 リンクは、同一JSPであれば対応する一覧の上下左右のどこへでも表示することが可能である。

ページリンク機能を使用する場合は、 アクションフォームに以下のフィールドを用意して、 この機能の属性に対して指定する必要がある。



タグがサポートする属性

ページリンク機能では、以下の属性をサポートする。

属性名 デフォルト値 必須性 実行時式 概要
id - false true この属性に文字列が指定された場合、 ページリンクの出力先を画面ではなくページコンテキストに保存する。 この属性は保存するキーとなる。
action - false true 一覧表示画面の表示を行うアクションパス名を指定する。
submit属性がfalseの場合は必須属性となる。
name - false true 表示行数、開始行インデックス、一覧情報全行数を取得するBeanを指定する。
rowProperty - true true 表示行数を保持するフィールドを指定する。 name属性が指定されていない場合は直接値を取得する。
indexProperty - true true 表示開始インデックスを保持するフィールドを指定する。 name属性が指定されていない場合は直接値を取得する。
totalProperty - true true <logic:iterate>要素によって 定義された一覧情報の全行数を保持するフィールドを指定する。 name属性が指定されていない場合は直接値を取得する。
scope - false true name属性で指定したBeanを取得するスコープを指定する。
submit false false true リンクではなく、サブミットを行う場合はtrueを指定する。デフォルトはfalse。 falseの場合、action属性が必須属性となる。 なお、この属性をtrueに設定するとaction属性は無効となる。
forward false false true TERASOLUNAのDispatchActionを使用してフォワードによる振り分けを行う場合に 使用する属性。trueを指定するとevent属性に設定された値のHiddenタグを出力する。 また、そのHiddenタグのvalue属性を"forward_pageLinks"とする。 デフォルトはfalse。
event "event" false true TERASOLUNAのDispatchActionを使用してフォワードによる振り分けを行う場合に 使用する属性。forward属性をtrueにした場合、この属性に指定した名前の Hiddenタグが生成される。デフォルトは"event"となる。
resetIndex false false true サブミット時に有効になる属性で、trueに設定すると 指定範囲リセットを行うためのstartIndexとendIndexのHiddenタグを出力する。 デフォルトはfalse。
currentPageIndex "currentPageIndex" false true 対応する一覧の現在ページ数をページコンテキストに保存する際のキーとなる。 デフォルトは"currentPageIndex"となる。
totalPageCount "totalPageCount" false true 対応する一覧の総ページ数をページコンテキストに保存する際のキーとなる。 デフォルトは"totalPageCount"となる。


カスタムタグのスクリプティング変数

PageLinksTag では以下の変数をサポートする。

変数名 有効範囲 記述
カスタムタグのid属性で指定された名前。 java.lang.String カスタムタグ以降 画面へ出力するページリンク(タグなど)を保持する。
カスタムタグのcurrentPageIndex属性で指定された名前、 またはデフォルト値。 java.lang.Integer カスタムタグ以降 対応する一覧情報の現在のページ番号を保持する。
カスタムタグのtotalPageCount属性で指定された名前、 またはデフォルト値。 java.lang.Integer カスタムタグ以降 対応する一覧情報の総ページ数を保持する。

使用方法
  • プロパティファイルの設定
  • 画面に出力するリンクの設定はプロパティファイルに記述を行う。 記述するのは、現在のページからジャンプページ数と、表示記号の設定である。 なお、リンクは以下の書式にそっていれば複数記述することも可能である。


  • プロパティファイル設定の書式解説
  •   pageLinks.<遷移方向><遷移 ページ数>.char=<表示文字列>
      遷移方向 : 現在の表示ページ番号よりも前方(nextの場合は後方)。
      遷移ページ数 : 現在の表示ページ番号からのジャンプページ数。数値は自由に設定可能。
      表示文字列 : 画面に表示させる文字。この文字がリンク対象となる。


      pageLinks.maxDspLinkSize = <表示ページ数>
      表示ページ数 : ページ数を直接指定するリンクの最大表示数


  • プロパティファイル設定例
  •   pageLinks.prev10.char=&lt;&lt;
      pageLinks.prev1.char=&lt;
      pageLinks.next1.char=&gt;
      pageLinks.next10.char=&gt;&gt;
      pageLinks.maxDirectLinkCount=10



  • 一覧情報をページ単位にデータベースから取得する使用例
  • 以下に、ページリンク機能を使用した例を示す。この例は、ページを切り替えるごとに データベースにアクセスを行い表示する一覧情報のみを取得する例である。 この例の場合は、一覧表示画面へ最初に遷移するアクションと、 ページリンク機能のアクション(action属性)が同一でも問題ない。 以下の例では、ページリンクに設定するフィールドにStringを使用しているが、 String以外のオブジェクトの設定も可能である。

    Struts設定ファイルの例

    <form-beans>
      <form-bean name="dynaFormBean"
        type="org.apache.struts.action.DynaActionForm" >
        <!-- 取得した一覧情報を保持するフィールド -->
        <form-property name="userBeans"
          type="jp.terasoluna.strutspring.blogic.UserBean[]"/>
        <!-- 1ページに表示する件数を保持したフィールド -->
        <form-property name="row"
          type="java.lang.String" initial="10"/>
        <!-- 表示するページの開始インデックスを保持したフィールド -->
        <form-property name="startIndex"
          type="java.lang.String" initial="0"/>
        <!-- 一覧情報の全件数を保持したフィールド -->
        <form-property name="totalCount"
          type="java.lang.String"/>
      </form-bean>
    </form-beans>

    <!-- ページ単位の一覧情報を取得するアクション -->
    <action path="/list"
          type="jp.terasoluna.strutspring.action.ListAction"
          name="dynaFormBean" scope="session">
      <forward name="success" path="/listSRC.do"/>
    </action>
    <action path="/listSRC"
          type="org.apache.struts.actions.ForwardAction"
          parameter="/daoTestList.jsp">
    </action>

    JSPの例

    <ts:pageLinks action="/list" name="dynaFormBean" rowProperty="row"
        totalProperty="totalCount" indexProperty="startIndex" />

    <table border="1" frame="box">
      <logic:iterate id="userBean" name="dynaFormBean" property="userBeans">
      <tr>
        <td><bean:write name="userBean" property="id"/></td>
        <td><bean:write name="userBean" property="name"/></td>
        <td><bean:write name="userBean" property="age"/></td>
        <td><bean:write name="userBean" property="param1"/></td>
        <td><bean:write name="userBean" property="param2"/></td>
        <td><bean:write name="userBean" property="param3"/></td>
        <td><bean:write name="userBean" property="param4"/></td>
        <td><bean:write name="userBean" property="param5"/></td>
        <td><bean:write name="userBean" property="param6"/></td>
        <td><bean:write name="userBean" property="param7"/></td>
      </tr>
      </logic:iterate>
    </table>

    サービス層の例

    DynaActionForm dynaForm = (DynaActionForm) form;
    //表示件数の取得
    String strRow = (String) dynaForm.get("row");
    //開始行インデックスの取得
    String strIndex = (String) dynaForm.get("startIndex");
    int row = 10;
    int startIndex = 0;

    //intへの変換処理
    ......

    //全体件数取得
    String totalCount
    = dao.executeForObject("getUserCount", null, String.class);

    //一覧情報取得
    UserBean[] bean = dao.executeForObjectList("getUserList", null, UserBean.class, startIndex, row);

    //アクションフォームへの設定
    dynaForm.set("totalCount", totalCount);
    dynaForm.set("userBeans", bean);



  • 一覧情報をアクションフォームから取得する使用例
  • 以下に、ページリンク機能を使用した例を示す。この例は、ページを切り替えるときは すでに取得済みの一覧情報(全件数)をアクションフォームから取得する例である。 この例の場合は、一覧表示画面へ最初に遷移するアクションと、 ページリンク機能のアクション(action属性)は別のアクションとする。 一覧表示画面へ最初に遷移するアクションでは、一覧情報の全件数を取得し、 ページリンク機能のアクションはあくまで画面を表示するのみのアクションとする。 以下の例では、ページリンクに設定するフィールドにStringを使用しているが、 String以外のオブジェクトの設定も可能である。

    Struts設定ファイルの例

    <form-beans>
      <form-bean name="dynaFormBean"
        type="org.apache.struts.action.DynaActionForm" >
        <!-- 取得した一覧情報を保持するフィールド -->
        <form-property name="userBeans"
          type="jp.terasoluna.strutspring.blogic.UserBean[]"/>
        <!-- 1ページに表示する件数を保持したフィールド -->
        <form-property name="row"
          type="java.lang.String" initial="10"/>
        <!-- 表示するページの開始インデックスを保持したフィールド -->
        <form-property name="startIndex"
          type="java.lang.String" initial="0"/>
        <!-- 一覧情報の全件数を保持したフィールド -->
        <form-property name="totalCount"
          type="java.lang.String"/>
      </form-bean>
    </form-beans>

    <!-- 一覧情報すべてを取得するアクション -->
    <action path="/list"
          type="jp.terasoluna.strutspring.action.ListAction"
          name="dynaFormBean" scope="session">
      <forward name="success" path="/listSRC.do"/>
    </action>
    <!-- 画面表示のみのアクション -->
    <action path="/listSRC"
          type="org.apache.struts.actions.ForwardAction"
          parameter="/daoTestList.jsp">
    </action>

    JSPの例

    <ts:pageLinks action="/listSRC" name="dynaFormBean" rowProperty="row"
        totalProperty="totalCount" indexProperty="startIndex" />

    <table border="1" frame="box">
      <bean:define id="startIndex" name="dynaFormBean"
        property="startIndex" type="java.lang.String" />
      <logic:iterate id="userBean" name="dynaFormBean" length="10"
        property="userBeans" offset="<%=startIndex%>">

      <tr>
        <td><bean:write name="userBean" property="id"/></td>
        <td><bean:write name="userBean" property="name"/></td>
        <td><bean:write name="userBean" property="age"/></td>
        <td><bean:write name="userBean" property="param1"/></td>
        <td><bean:write name="userBean" property="param2"/></td>
        <td><bean:write name="userBean" property="param3"/></td>
        <td><bean:write name="userBean" property="param4"/></td>
        <td><bean:write name="userBean" property="param5"/></td>
        <td><bean:write name="userBean" property="param6"/></td>
        <td><bean:write name="userBean" property="param7"/></td>
      </tr>
      </logic:iterate>
    </table>

    サービス層の例(最初の一覧画面表示のみ)

    DynaActionForm dynaForm = (DynaActionForm) form;

    //全体件数取得
    String totalCount
    = dao.executeForObject("getUserCount", null, String.class);

    //一覧情報取得
    UserBean[] bean = dao.executeForObjectList("getUserList", null, UserBean.class);

    //アクションフォームへの設定
    dynaForm.set("totalCount", totalCount);
    dynaForm.set("userBeans", bean);



  • サブミットを行いたい場合の使用例
  • ページリンク機能は、デフォルトでは<a>を使用して、指定されたアクションへの リンクを作成するため、サブミットを行わない。 サブミットを行う場合は、submit属性をtrueに設定する。 この設定を行うと、ページリンク押下時に、JavaScriptによるサブミット処理を行う。 なお、submit属性をtrueに設定すると action属性は無効となる。

    JSPの例(一部)

    <ts:pageLinks submit="true" name="dynaFormBean" rowProperty="row"
        totalProperty="totalCount" indexProperty="startIndex" />



  • DispatchActionを使用してフォワードを行う場合の使用例
  • TERASOLUNAのDispatchActionを使用してフォワードを行う場合は、 forward属性を"true"にする必要がある。forward属性を"true"とした場合、画面に 「<input type="hidden" name="event" value="forward_pageLinks" />」を 出力する。また、出力するHiddenタグのname属性の値はevent属性に指定された値となる。 デフォルトは"event"であるため、指定しない場合は上記のHiddenタグが出力される。

    JSPの例(一部)

    <ts:pageLinks submit="true" name="dynaFormBean" rowProperty="row"
         totalProperty="totalCount" indexProperty="startIndex"
         forward="true" event="forwardParameter" />

    上記のJSPによって出力されたHTMLの例(Hiddenタグ)

    <input type="hidden" name="forwardParameter" value="forward_pageLinks" />

    Struts設定ファイルの例

    <action path="/list"
            name="dynaFormBean" scope="request">
        <forward name="pageLinks" path="/pageLinks.do" />
        <forward name="regist" path="/regist.do" />
    </action>

    Bean定義ファイルの例

    <bean name="/list"
          class="jp.terasoluna.fw.web.struts.actions.DispatchAction">
        <property name="event"> <value>forwardParameter</value> </property>
    </bean>



  • 現在ページ数、総ページ数の出力
  • ページリンク機能では、現在ページ数と総ページ数をpageContextに 保存する。保存するキーは、currentPageIndex属性と totalPageCount属性にて指定可能である。 属性のデフォルト値は上記を参照のこと。 現在ページおよび総ページ数を画面に表示する場合は、以下のように使用する。

    JSPの例(一部)

    <ts:pageLinks action="/pageLink" rowProperty="row"
        totalProperty="totalCount" indexProperty="startIndex" />
    ・・・
    現在は[<bean:write name="currentPageIndex"/>]ページです。
    全部で[<bean:write name="totalPageCount"/>]ページあります。



  • id属性の使用例
  • id属性を指定すると、ページリンクを画面に出力せずに、指定された文字列をキーで pageContextに保存するため、出力場所を自由に変更することができる。 現在ページや総ページ数をページリンクの上部に出力したいときなどに使用する。

    JSPの例(一部)

    <ts:pageLinks action="/pageLink" id="reservePageLinks" rowProperty="row"
        totalProperty="totalCount" indexProperty="startIndex"
        currentPageIndex="reserveCurrentPageIndex" totalPageCount="reserveTotalPageCount" />
    ・・・
    現在は[<bean:write name="reserveCurrentPageIndex"/>]ページです。
    全部で[<bean:write name="reserveTotalPageCount"/>]ページあります。
    <bean:write name="reservePageLinks"/>



    関連項目:
    直列化された形式

    フィールドの概要
    protected  java.lang.String action
              ページリンク押下時に起動するアクション名。
    protected static java.lang.String CHAR_LINKS
              ApplicationResources ファイルにおける記号表示の ページジャンプ用リンクのプロパティ名の構成要素。
    protected static java.lang.String CURRENT_PAGE_INDEX
              現在ページ数をページコンテキストに登録するキー。
    protected  java.lang.String currentPageIndex
              現在ページ番号保存用パラメータ。
    protected static java.lang.String DEFAULT_EVENT
              デフォルトイベントパラメータ。
    protected static java.lang.String ERROR_MESSAGE_ACTION_REQUIRED
              アクション属性が必須のエラーメッセージ。
    protected  java.lang.String event
              イベントパラメータ。
    protected  boolean forward
              フォワードフラグ。
    protected static java.lang.String FORWARD_NAME
              フォワード名。
    protected  java.lang.String id
              出力先変更用ID。
    protected  java.lang.String indexProperty
              表示開始インデックスのフィールド名。
    protected  java.util.Map<java.lang.String,java.lang.String> links
              プロパティファイルのリンク登録IDをキーとして表示リンクを格納するマップ。
    private static org.apache.commons.logging.Log log
              ログクラス。
    protected static java.lang.String MAX_DSP_SIZE
              ApplicationResources ファイルにおける ページジャンプ用リンクの直接番号指定の表示最大数の プロパティ名の構成要素。
    protected  int maxLinkNo
              最大ページジャンプ数。
    protected  int maxPageCount
              最大直接指定リンク番号数。
    protected  java.lang.String name
              表示開始インデックスと全件数を保持したBean名。
    protected static java.lang.String NEXT_LINKS
              ApplicationResources ファイルにおける後方への ページジャンプ用リンクのプロパティ名の構成要素。
    protected static java.lang.String PAGE_LINKS_PREFIX
              ApplicationResources ファイルにおける ページジャンプ用リンクのプロパティ名のプリフィックス。
    protected static java.lang.String PAGELINKS_JAVASCRIPT_KEY
              ページリンク機能で出力するJavaScriptの出力フラグ
    protected static java.lang.String PREV_LINKS
              ApplicationResources ファイルにおける前方への ページジャンプ用リンクのプロパティ名の構成要素。
    protected  boolean resetIndex
              指定範囲インデックス出力フラグ。
    protected  java.lang.String rowProperty
              表示行数のフィールド名。
    protected  java.lang.String scope
              取得するBeanのスコープ。
    private static long serialVersionUID
              シリアルバージョンID
    protected  boolean submit
              サブミットフラグ。
    protected static java.lang.String TOTAL_PAGE_COUNT
              総ページ数をページコンテキストに登録するキー。
    protected  java.lang.String totalPageCount
              現在ページ番号保存用パラメータ。
    protected  java.lang.String totalProperty
              全件数のフィールド名。
    protected static java.lang.String WARN_MESSAGE_ILLEGAL_ROW
              取得した表示行数(row)が0以下の場合のエラーメッセージ。
     
    クラス javax.servlet.jsp.tagext.TagSupport から継承されたフィールド
    pageContext
     
    インタフェース javax.servlet.jsp.tagext.IterationTag から継承されたフィールド
    EVAL_BODY_AGAIN
     
    インタフェース javax.servlet.jsp.tagext.Tag から継承されたフィールド
    EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
     
    コンストラクタの概要
    PageLinksTag()
               
     
    メソッドの概要
    protected  void addDirectLink(java.lang.StringBuilder sb, int row, int startIndex, int totalCount)
              ページ番号リンクを引数のStringBuilderに追加する。
    protected  void addDirectSubmit(java.lang.StringBuilder sb, int row, int startIndex, int totalCount)
              ページ番号リンクを引数のStringBuilderに追加する。
    protected  void addNextLink(java.lang.StringBuilder sb, int row, int startIndex, int totalCount)
              次ページに遷移するリンクを引数のStringBuilderに追加する。
    protected  void addNextSubmit(java.lang.StringBuilder sb, int row, int startIndex, int totalCount)
              次ページに遷移するリンクを引数のStringBuilderに追加する。
    protected  void addPrevLink(java.lang.StringBuilder sb, int row, int startIndex, int totalCount)
              前ページに遷移するリンクを引数のStringBuilderに追加する。
    protected  void addPrevSubmit(java.lang.StringBuilder sb, int row, int startIndex, int totalCount)
              前ページに遷移するリンクを引数のStringBuilderに追加する。
    protected  void attributePageCount(int now, int total)
              現在ページ数、総ページ数をページコンテキストに保存する。
    protected  void defineHtml(int row, int startIndex, int totalCount)
              HTMLの定義を出力する。
     int doStartTag()
              タグ評価開始時に呼ばれるメソッド。
     java.lang.String getAction()
              設定されているaction属性値を返却する。
     java.lang.String getCurrentPageIndex()
              設定されているcurrentPageIndex属性値を返却する。
     java.lang.String getEvent()
              設定されているevent属性値を返却する。
     boolean getForward()
              設定されているforward属性値を返却する。
     java.lang.String getId()
              設定されているid属性値を返却する。
     java.lang.String getIndexProperty()
              設定されているindexProperty属性値を返却する。
    protected  int getInt(java.lang.Object obj)
              引数のオブジェクトをintに変換して返却する。
    private  void getLinkProperty()
              プロパティファイルに定義されているページジャンプ用リンク定義を取得する。
     java.lang.String getName()
              設定されているid属性値を返却する。
    protected  boolean getPageContextFlg(javax.servlet.jsp.PageContext pageContext, java.lang.String key)
              指定されたKEYにて取得した値を真偽値に変換して返却する。
    protected  int getPageCount(int row, int totalCount)
              ページ数を算出して返却する。
    protected  int getPageIndex(int row, int startIndex)
              表示ページ番号を算出して返却する。
     boolean getResetIndex()
              設定されているresetIndex属性値を返却する。
     java.lang.String getRowProperty()
              設定されているrowProperty属性値を返却する。
     java.lang.String getScope()
              設定されているscope属性値を返却する。
     boolean getSubmit()
              設定されているsubmit属性値を返却する。
     java.lang.String getTotalPageCount()
              設定されているtotalPageCount属性値を返却する。
     java.lang.String getTotalProperty()
              設定されているtotalProperty属性値を返却する。
    protected  java.lang.Object lookup(javax.servlet.jsp.PageContext pageContext, java.lang.String name, java.lang.String property, java.lang.String scope)
              nameが指定されてない場合は、propertyの値を直接取得する。
     void release()
              すべてのアロケートされた資源を解放する。
     void setAction(java.lang.String action)
              action属性に値を設定する。
     void setCurrentPageIndex(java.lang.String currentPageIndex)
              currentPageIndex属性に値を設定する。
     void setEvent(java.lang.String event)
              event属性に値を設定する。
     void setForward(boolean forward)
              forward属性に値を設定する。
     void setId(java.lang.String id)
              id属性に値を設定する。
     void setIndexProperty(java.lang.String indexProperty)
              indexProperty属性に値を設定する。
     void setName(java.lang.String name)
              name属性に値を設定する。
    protected  void setPageContextFlg(javax.servlet.jsp.PageContext pageContext, java.lang.String key)
              ページコンテキストに対して、指定されたKEYのフラグを設定する。
     void setResetIndex(boolean resetIndex)
              resetIndex属性に値を設定する。
     void setRowProperty(java.lang.String rowProperty)
              rowProperty属性に値を設定する。
     void setScope(java.lang.String scope)
              scope属性に値を設定する。
     void setSubmit(boolean submit)
              submit属性に値を設定する。
     void setTotalPageCount(java.lang.String totalPageCount)
              totalPageCount属性に値を設定する。
     void setTotalProperty(java.lang.String totalProperty)
              totalProperty属性に値を設定する。
     
    クラス javax.servlet.jsp.tagext.TagSupport から継承されたメソッド
    doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue
     
    クラス java.lang.Object から継承されたメソッド
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    フィールドの詳細

    serialVersionUID

    private static final long serialVersionUID
    シリアルバージョンID

    関連項目:
    定数フィールド値

    log

    private static org.apache.commons.logging.Log log
    ログクラス。


    id

    protected java.lang.String id
    出力先変更用ID。


    action

    protected java.lang.String action
    ページリンク押下時に起動するアクション名。


    name

    protected java.lang.String name
    表示開始インデックスと全件数を保持したBean名。


    rowProperty

    protected java.lang.String rowProperty
    表示行数のフィールド名。


    indexProperty

    protected java.lang.String indexProperty
    表示開始インデックスのフィールド名。


    totalProperty

    protected java.lang.String totalProperty
    全件数のフィールド名。


    scope

    protected java.lang.String scope
    取得するBeanのスコープ。


    submit

    protected boolean submit
    サブミットフラグ。


    forward

    protected boolean forward
    フォワードフラグ。


    event

    protected java.lang.String event
    イベントパラメータ。


    resetIndex

    protected boolean resetIndex
    指定範囲インデックス出力フラグ。


    currentPageIndex

    protected java.lang.String currentPageIndex
    現在ページ番号保存用パラメータ。


    totalPageCount

    protected java.lang.String totalPageCount
    現在ページ番号保存用パラメータ。


    ERROR_MESSAGE_ACTION_REQUIRED

    protected static java.lang.String ERROR_MESSAGE_ACTION_REQUIRED
    アクション属性が必須のエラーメッセージ。


    WARN_MESSAGE_ILLEGAL_ROW

    protected static java.lang.String WARN_MESSAGE_ILLEGAL_ROW
    取得した表示行数(row)が0以下の場合のエラーメッセージ。


    PAGE_LINKS_PREFIX

    protected static java.lang.String PAGE_LINKS_PREFIX
    ApplicationResources ファイルにおける ページジャンプ用リンクのプロパティ名のプリフィックス。


    PREV_LINKS

    protected static java.lang.String PREV_LINKS
    ApplicationResources ファイルにおける前方への ページジャンプ用リンクのプロパティ名の構成要素。


    NEXT_LINKS

    protected static java.lang.String NEXT_LINKS
    ApplicationResources ファイルにおける後方への ページジャンプ用リンクのプロパティ名の構成要素。


    CHAR_LINKS

    protected static java.lang.String CHAR_LINKS
    ApplicationResources ファイルにおける記号表示の ページジャンプ用リンクのプロパティ名の構成要素。


    MAX_DSP_SIZE

    protected static java.lang.String MAX_DSP_SIZE
    ApplicationResources ファイルにおける ページジャンプ用リンクの直接番号指定の表示最大数の プロパティ名の構成要素。


    PAGELINKS_JAVASCRIPT_KEY

    protected static java.lang.String PAGELINKS_JAVASCRIPT_KEY
    ページリンク機能で出力するJavaScriptの出力フラグ


    FORWARD_NAME

    protected static java.lang.String FORWARD_NAME
    フォワード名。


    DEFAULT_EVENT

    protected static java.lang.String DEFAULT_EVENT
    デフォルトイベントパラメータ。


    TOTAL_PAGE_COUNT

    protected static java.lang.String TOTAL_PAGE_COUNT
    総ページ数をページコンテキストに登録するキー。


    CURRENT_PAGE_INDEX

    protected static java.lang.String CURRENT_PAGE_INDEX
    現在ページ数をページコンテキストに登録するキー。


    links

    protected java.util.Map<java.lang.String,java.lang.String> links
    プロパティファイルのリンク登録IDをキーとして表示リンクを格納するマップ。


    maxLinkNo

    protected int maxLinkNo
    最大ページジャンプ数。


    maxPageCount

    protected int maxPageCount
    最大直接指定リンク番号数。

    コンストラクタの詳細

    PageLinksTag

    public PageLinksTag()
    メソッドの詳細

    getId

    public java.lang.String getId()
    設定されているid属性値を返却する。

    オーバーライド:
    クラス javax.servlet.jsp.tagext.TagSupport 内の getId
    戻り値:
    設定されている値

    setId

    public void setId(java.lang.String id)
    id属性に値を設定する。

    オーバーライド:
    クラス javax.servlet.jsp.tagext.TagSupport 内の setId
    パラメータ:
    id - 設定する値

    getAction

    public java.lang.String getAction()
    設定されているaction属性値を返却する。

    戻り値:
    設定されている値

    setAction

    public void setAction(java.lang.String action)
    action属性に値を設定する。

    パラメータ:
    action - 設定する値

    getName

    public java.lang.String getName()
    設定されているid属性値を返却する。

    戻り値:
    設定されている値

    setName

    public void setName(java.lang.String name)
    name属性に値を設定する。

    パラメータ:
    name - 設定する値

    getRowProperty

    public java.lang.String getRowProperty()
    設定されているrowProperty属性値を返却する。

    戻り値:
    設定されている値

    setRowProperty

    public void setRowProperty(java.lang.String rowProperty)
    rowProperty属性に値を設定する。

    パラメータ:
    rowProperty - 設定する値

    getIndexProperty

    public java.lang.String getIndexProperty()
    設定されているindexProperty属性値を返却する。

    戻り値:
    設定されている値

    setIndexProperty

    public void setIndexProperty(java.lang.String indexProperty)
    indexProperty属性に値を設定する。

    パラメータ:
    indexProperty - 設定する値

    getTotalProperty

    public java.lang.String getTotalProperty()
    設定されているtotalProperty属性値を返却する。

    戻り値:
    設定されている値

    setTotalProperty

    public void setTotalProperty(java.lang.String totalProperty)
    totalProperty属性に値を設定する。

    パラメータ:
    totalProperty - 設定する値

    getScope

    public java.lang.String getScope()
    設定されているscope属性値を返却する。

    戻り値:
    設定されている値

    setScope

    public void setScope(java.lang.String scope)
    scope属性に値を設定する。

    パラメータ:
    scope - 設定する値

    getSubmit

    public boolean getSubmit()
    設定されているsubmit属性値を返却する。

    戻り値:
    設定されている値

    setSubmit

    public void setSubmit(boolean submit)
    submit属性に値を設定する。

    パラメータ:
    submit - 設定する値

    getForward

    public boolean getForward()
    設定されているforward属性値を返却する。

    戻り値:
    設定されている値

    setForward

    public void setForward(boolean forward)
    forward属性に値を設定する。

    パラメータ:
    forward - 設定する値

    getEvent

    public java.lang.String getEvent()
    設定されているevent属性値を返却する。

    戻り値:
    設定されている値

    setEvent

    public void setEvent(java.lang.String event)
    event属性に値を設定する。

    パラメータ:
    event - 設定する値

    getResetIndex

    public boolean getResetIndex()
    設定されているresetIndex属性値を返却する。

    戻り値:
    設定されている値

    setResetIndex

    public void setResetIndex(boolean resetIndex)
    resetIndex属性に値を設定する。

    パラメータ:
    resetIndex - 設定する値

    getCurrentPageIndex

    public java.lang.String getCurrentPageIndex()
    設定されているcurrentPageIndex属性値を返却する。

    戻り値:
    設定されている値

    setCurrentPageIndex

    public void setCurrentPageIndex(java.lang.String currentPageIndex)
    currentPageIndex属性に値を設定する。

    パラメータ:
    currentPageIndex - 設定する値

    getTotalPageCount

    public java.lang.String getTotalPageCount()
    設定されているtotalPageCount属性値を返却する。

    戻り値:
    設定されている値

    setTotalPageCount

    public void setTotalPageCount(java.lang.String totalPageCount)
    totalPageCount属性に値を設定する。

    パラメータ:
    totalPageCount - 設定する値

    doStartTag

    public int doStartTag()
                   throws javax.servlet.jsp.JspException
    タグ評価開始時に呼ばれるメソッド。

    定義:
    インタフェース javax.servlet.jsp.tagext.Tag 内の doStartTag
    オーバーライド:
    クラス javax.servlet.jsp.tagext.TagSupport 内の doStartTag
    戻り値:
    処理制御指示
    例外:
    javax.servlet.jsp.JspException - JSP例外

    defineHtml

    protected void defineHtml(int row,
                              int startIndex,
                              int totalCount)
                       throws javax.servlet.jsp.JspException
    HTMLの定義を出力する。

    パラメータ:
    row - 表示行数
    startIndex - 表示開始インデックス
    totalCount - 全件数
    例外:
    javax.servlet.jsp.JspException - JSP例外

    addPrevSubmit

    protected void addPrevSubmit(java.lang.StringBuilder sb,
                                 int row,
                                 int startIndex,
                                 int totalCount)
    前ページに遷移するリンクを引数のStringBuilderに追加する。

    パラメータ:
    sb - 追加対象のStringBuilder
    row - 表示行数
    startIndex - 表示開始インデックス
    totalCount - 一覧情報の全件数

    addDirectSubmit

    protected void addDirectSubmit(java.lang.StringBuilder sb,
                                   int row,
                                   int startIndex,
                                   int totalCount)
    ページ番号リンクを引数のStringBuilderに追加する。

    パラメータ:
    sb - 追加対象のStringBuilder
    row - 表示行数
    startIndex - 表示開始インデックス
    totalCount - 一覧情報の全件数

    addNextSubmit

    protected void addNextSubmit(java.lang.StringBuilder sb,
                                 int row,
                                 int startIndex,
                                 int totalCount)
    次ページに遷移するリンクを引数のStringBuilderに追加する。

    パラメータ:
    sb - 追加対象のStringBuilder
    row - 表示行数
    startIndex - 表示開始インデックス
    totalCount - 一覧情報の全件数

    addPrevLink

    protected void addPrevLink(java.lang.StringBuilder sb,
                               int row,
                               int startIndex,
                               int totalCount)
    前ページに遷移するリンクを引数のStringBuilderに追加する。

    パラメータ:
    sb - 追加対象のStringBuilder
    row - 表示行数
    startIndex - 表示開始インデックス
    totalCount - 一覧情報の全件数

    addDirectLink

    protected void addDirectLink(java.lang.StringBuilder sb,
                                 int row,
                                 int startIndex,
                                 int totalCount)
    ページ番号リンクを引数のStringBuilderに追加する。

    パラメータ:
    sb - 追加対象のStringBuilder
    row - 表示行数
    startIndex - 表示開始インデックス
    totalCount - 一覧情報の全件数

    addNextLink

    protected void addNextLink(java.lang.StringBuilder sb,
                               int row,
                               int startIndex,
                               int totalCount)
    次ページに遷移するリンクを引数のStringBuilderに追加する。

    パラメータ:
    sb - 追加対象のStringBuilder
    row - 表示行数
    startIndex - 表示開始インデックス
    totalCount - 一覧情報の全件数

    getLinkProperty

    private void getLinkProperty()
    プロパティファイルに定義されているページジャンプ用リンク定義を取得する。 取得したクラス変数に格納する。


    getPageIndex

    protected int getPageIndex(int row,
                               int startIndex)
    表示ページ番号を算出して返却する。

    パラメータ:
    row - 表示行数
    startIndex - 現在表示されているページの表示開始インデックス
    戻り値:
    算出した表示ページ番号

    getPageCount

    protected int getPageCount(int row,
                               int totalCount)
    ページ数を算出して返却する。

    パラメータ:
    row - 表示行数
    totalCount - 全件数
    戻り値:
    算出したページ数

    getPageContextFlg

    protected boolean getPageContextFlg(javax.servlet.jsp.PageContext pageContext,
                                        java.lang.String key)
    指定されたKEYにて取得した値を真偽値に変換して返却する。 なお、引数keyがnullの場合は、IllegalArgumentExceptionが発生する。

    パラメータ:
    pageContext - ページコンテキスト
    key - FLGを取得するKEY
    戻り値:
    指定されたKEYにて取得した出力状態フラグ

    setPageContextFlg

    protected void setPageContextFlg(javax.servlet.jsp.PageContext pageContext,
                                     java.lang.String key)
    ページコンテキストに対して、指定されたKEYのフラグを設定する。 なお、引数keyがnullの場合は、IllegalArgumentExceptionが発生する。

    パラメータ:
    pageContext - ページコンテキスト
    key - FLGを設定するKEY

    lookup

    protected java.lang.Object lookup(javax.servlet.jsp.PageContext pageContext,
                                      java.lang.String name,
                                      java.lang.String property,
                                      java.lang.String scope)
                               throws javax.servlet.jsp.JspException
    nameが指定されてない場合は、propertyの値を直接取得する。

    パラメータ:
    pageContext - ページコンテキスト
    name - プロパティを保持したBean名
    property - プロパティ
    scope - スコープ
    戻り値:
    取得した値
    例外:
    javax.servlet.jsp.JspException - JSP例外

    getInt

    protected int getInt(java.lang.Object obj)
                  throws javax.servlet.jsp.JspException
    引数のオブジェクトをintに変換して返却する。

    パラメータ:
    obj - intに変換するオブジェクト
    戻り値:
    取得した値
    例外:
    javax.servlet.jsp.JspException - JSP例外

    attributePageCount

    protected void attributePageCount(int now,
                                      int total)
    現在ページ数、総ページ数をページコンテキストに保存する。

    パラメータ:
    now - 現在ページ数
    total - 総ページ数

    release

    public void release()
    すべてのアロケートされた資源を解放する。

    定義:
    インタフェース javax.servlet.jsp.tagext.Tag 内の release
    オーバーライド:
    クラス javax.servlet.jsp.tagext.TagSupport 内の release