クラス BackGamenTag

すべての実装されたインタフェース:
BodyTag, DynamicAttributes, IterationTag, JspTag, Tag, TryCatchFinally, Serializable

public class BackGamenTag extends HTMLTagSupport
戻るボタン/戻るリンクを表示するHTML拡張タグです(通常はcustom/query_info.jspに組込み)。 custom/query_info.jsp に組み込むことで、全てのquery.jspに組込む事ができます。 戻るボタン/リンクを表示するかどうかの条件判定は、 条件1:自分自身へ戻る機能はサポートできません。 条件2:BACK_GAMENID が存在するか、または、gamenId で指示された場合のみ表示。 条件3:command="NEW" で、キャッシュに設定しておく必要がある。
関連項目:
変更履歴:
3.1.8.0 (2003/05/16) 新規作成
機能分類
画面制御
形式サンプル:
●形式:<og:backGamen keys="・・・" vals="・・・" > ・・Body・・ </og:backGamen> ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します) ●Tag定義: <og:backGamen type 【TAG】ボタンのタイプ[link/button/relLink/relButton/historyBack]を指定します(初期値:link) command 【TAG】(通常は使いません)戻る時に指定する command を設定できます(初期値:RENEW) gamenId 【TAG】(通常は使いません)戻り先の画面をセットします(初期値:BACK_GAMENID) keys 【TAG】リンク先に渡すキーをCSV形式で複数指定します vals 【TAG】keys属性に対応する値をCSV形式で複数指定します lbl 【TAG】ラベルリソースのラベルIDを指定します title 【HTML】要素に対する補足的情報(title)を設定します accesskey 【HTML】アクセスキー(alt+キーで直接指定)を割り当てます(初期値:R) clazz 【HTML】要素に対して class 属性を設定します language 【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します useAttStrict 【TAG】XHTMLTag に指定されている Attributes のみ使えるかどうか [true/false]を指定します(初期値:true) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) > ... Body ... </og:backGamen> ●使用例 <og:backGamen keys="displayMsg,clear" vals="MSG0065,true" > <og:img src="{@SYS.JSP}/image/back.gif" alt="{@BACK_GAMENID}" /> <og:message lbl="MSG0049" /> </og:backGamen> 7.3.1.0 (2021/02/02) リンクタグで、useBackLink 属性を使用することで、戻るリンクをある程度制御できます。 何も指定しない場合(null)は、従来通りです。 true:相手先に(条件が成立すれば)戻るリンクを表示。条件が成立しない場合は、自身へのリンクが表示。 false:必ず表示しない 未指定(null):従来通り…自分自身では戻るリンクを表示せず、別画面の場合のみ表示します。
導入されたバージョン:
JDK5.0,
  • コンストラクタの詳細

    • BackGamenTag

      public BackGamenTag()
      デフォルトコンストラクター
      変更履歴:
      6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
  • メソッドの詳細

    • doStartTag

      public int doStartTag()
      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
      定義:
      doStartTag インタフェース内 Tag
      オーバーライド:
      doStartTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示( EVAL_BODY_BUFFERED )
    • doAfterBody

      public int doAfterBody()
      Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
      定義:
      doAfterBody インタフェース内 IterationTag
      オーバーライド:
      doAfterBody クラス内 CommonTagSupport
      戻り値:
      後続処理の指示(SKIP_BODY)
    • release2

      protected void release2()
      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
      release2 クラス内 HTMLTagSupport
    • makeTag

      protected String makeTag()
      戻るボタン/戻るリンクを作成します。
      定義:
      makeTag クラス内 HTMLTagSupport
      戻り値:
      戻るボタン/戻るリンク
      変更履歴:
      3.1.8.0 (2003/05/16) BACK_GAMENID のキャッシュの取り出し先を変更する。, 3.5.4.0 (2003/11/25) 履歴(history)オブジェクトのback() メソッドを利用した戻る機能を追加します。, 4.0.1.0 (2007/12/17) BackAddress対応, 5.0.2.0 (2009/11/01) 相対パスでの戻るリンク対応
    • setType

      public void setType(String tp)
      【TAG】ボタンのタイプ[link/button/relLink/relButton/historyBack]を指定します(初期値:link)。
      パラメータ:
      tp - ボタンのタイプ [link/button/relLink/relButton/historyBack]
      変更履歴:
      5.0.2.0 (2009/11/01) 相対パスでの戻るリンク対応
      説明:
      button と設定すると、戻るボタンに、link と設定すると、戻るリンクになります。 historyBack は、IE等の戻る操作と同じで、JavaScriptのヒストリーバックを行います。 また、relButton、relLinkとすると、それぞれ相対パス(画面IDから飛び先のアドレスを元に生成) で戻り先のアドレスが生成されます。 初期値は、戻るリンク(link)です。 ※ 6.9.4.1 (2018/04/09) FILEFILTER使用時(紙芝居作成時)は、相対リンクを出力します。
      ボタンのタイプ説明
      タイプ 説明
      link 戻るリンク
      button 戻るボタン
      relLink 戻るリンク(相対パス)
      relButton 戻るボタン(相対パス)
      historyBack通常のヒストリバックボタン
    • setCommand

      public void setCommand(String cmd)
      【TAG】(通常は使いません)戻る時に指定する command を設定できます(初期値:RENEW)。
      パラメータ:
      cmd - コマンド
      説明:
      通常は、RENEW で戻ります。 (初期値は、RENEW なので設定不要です。)
    • setGamenId

      public void setGamenId(String id)
      【TAG】(通常は使いません)戻り先の画面をセットします(初期値:BACK_GAMENID)。
      パラメータ:
      id - 戻り先の画面ID
      説明:
      通常は、自動的に、BACK_GAMENID の値がセットされますが、 先祖に戻る(画面A⇒画面B⇒画面C のときに、画面Aに戻る)場合や、 別の画面に、進む場合に、直接指定します。 (初期値は、来た画面:BACK_GAMENID ですので、設定不要です。) 値は、キャッシュではなく、session より HybsSystem.BACK_GAMENID_KEY をキーに 取り出します。 これは、command="NEW" で、BACK_GAMENID リクエストが存在し、BACK_GAMENID と 自分自身の画面IDが異なる場合のみ、RequestCacheTag#backGamenIdSet メソッドで session に登録されます。
    • setKeys

      public void setKeys(String key)
      【TAG】リンク先に渡すキーをCSV形式で複数指定します。
      パラメータ:
      key - リンク先に渡すキー (例:keys="displayMsg,clear")
      関連項目:
      変更履歴:
      3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用
      説明:
      戻る時に、検索時のキャッシュに指定した引数以外に指定したり、別の値に置き換えたり する場合のキーを設定できます。CSV形式で複数指定できます。 vals 属性には、キーに対応する値を、設定してください。 例:keys="displayMsg,clear" vals="MSG0065,true" 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
    • setVals

      public void setVals(String val)
      【TAG】keys属性に対応する値をCSV形式で複数指定します。
      パラメータ:
      val - keys属性に対応する値 (例:vals="MSG0065,true")
      関連項目:
      変更履歴:
      3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用
      説明:
      キーに設定した値を、CSV形式で複数して出来ます。 指定順序は、キーと同じにしておいて下さい。 例:keys="displayMsg,clear" vals="MSG0065,true" 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。