概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.4.2.1
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.opengion.hayabusa.taglib
クラス BackGamenTag

    java.lang.Object
      javax.servlet.jsp.tagext.TagSupport
          javax.servlet.jsp.tagext.BodyTagSupport
              org.opengion.hayabusa.taglib.CommonTagSupport
                  org.opengion.hayabusa.taglib.HTMLTagSupport
                      org.opengion.hayabusa.taglib.BackGamenTag

すべての実装されたインタフェース:
  java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

    public class BackGamenTag

extends HTMLTagSupport

戻るボタン/戻るリンクを表示するHTML拡張タグです(通常はcustom/query_info.jspに組込み)。 custom/query_info.jsp に組み込むことで、全てのquery.jspに組込む事ができます。 戻るボタン/リンクを表示するかどうかの条件判定は、 　条件1：自分自身へ戻る機能はサポートできません。 　条件2：BACK_GAMENID が存在するか、または、gamenId で指示された場合のみ表示。 　条件3：command="NEW" で、キャッシュに設定しておく必要がある。

関連項目:
  直列化された形式
形式サンプル:

       ●形式：<og:backGamen keys="･･･" vals="･･･" > ･･Body･･ </og:backGamen>
       ●body：あり

       ●使用例
          <og:backGamen keys="displayMsg,clear" vals="MSG0065,true" >
              <img src="{@SYS.JSP}/image/back.gif" alt="{@BACK_GAMENID}" />
              <og:message msg="MSG0049" />
          </og:backGamen>

        デフォルトの戻るリンクを表示します。
          <og:backGamen />

        戻るリンクに使用するラベルに msg 属性で指定のメッセージリソースを使用します。
          <og:backGamen msg="MSG0049"  />

        戻るボタンを表示します。
          <og:backGamen type="button"  />

        戻るボタンにヒストリーバックをボタンを表示します。
          <og:backGamen type="historyBack"  />

        戻るボタンに、ショートカットキー(Alt+R)を指定します。
          <og:backGamen type="historyBack" msg="MSG0049" accesskey="R"  />

変更履歴:

  3.1.8.0 (2003/05/16) 新規作成

機能階層
  画面制御
バージョン
  4.0
作成者
  Kazuhiko Hasegawa
導入されたバージョン:
  JDK5.0,

フィールドの概要

クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたフィールド
`bodyContent`

クラス javax.servlet.jsp.tagext.TagSupport から継承されたフィールド
`id, pageContext`

インタフェース javax.servlet.jsp.tagext.BodyTag から継承されたフィールド
`EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

インタフェース javax.servlet.jsp.tagext.IterationTag から継承されたフィールド
`EVAL_BODY_AGAIN`

インタフェース javax.servlet.jsp.tagext.Tag から継承されたフィールド
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

コンストラクタの概要
`BackGamenTag()`

メソッドの概要
`int` | `doAfterBody()` Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
`int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
`protected java.lang.String` | `makeTag()` 戻るボタン/戻るリンクを作成します。
`protected void` | `release2()` タグリブオブジェクトをリリースします。
`void` | `setCommand(java.lang.String cmd)` 【TAG】(通常使いません)戻る時に指定する command を設定できます(初期値:RENEW)。
`void` | `setGamenId(java.lang.String id)` 【TAG】(通常使いません)戻り先の画面をセットします(初期値:BACK_GAMENID)。
`void` | `setHref(java.lang.String href)` 【HTML】リンク先のURLを指定します。
`void` | `setKeys(java.lang.String key)` 【TAG】リンク先に渡すキーをCSV形式で複数指定します。
`void` | `setTarget(java.lang.String tgt)` 【HTML】リンク先の表示ターゲットを指定します(初期値：CONTENTS)。
`void` | `setType(java.lang.String tp)` 【TAG】ボタンのタイプ(button,link,relButton,relLink,historyBack)を指定します(初期値:link)。
`void` | `setVals(java.lang.String val)` 【TAG】keys属性に対応する値をCSV形式で複数指定します。

クラス org.opengion.hayabusa.taglib.HTMLTagSupport から継承されたメソッド
`doEndTag, getMustType, makeMustHidden, setAccesskey, setClazz, setDir, setDisabled, setId, setLang, setMust, setMustAny, setOnBlur, setOnChange, setOnClick, setOndblClick, setOnFocus, setOnKeydown, setOnKeypress, setOnKeyup, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setOptionAttributes, setReadonly, setRoles, setStyle, setTabindex, setTitle`

クラス org.opengion.hayabusa.taglib.CommonTagSupport から継承されたメソッド
`add, add, addEventColumn, addEventColumn, check, check, commitTableObject, debugPrint, doCatch, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getTagName, getUser, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseKey, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, toString, useMainTrans, useQuotCheck, useTag, useXssCheck`

クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたメソッド
`doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

クラス javax.servlet.jsp.tagext.TagSupport から継承されたメソッド
`findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue`

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

インタフェース javax.servlet.jsp.tagext.Tag から継承されたメソッド
`getParent, setPageContext, setParent`

コンストラクタの詳細

### BackGamenTag

    public BackGamenTag()

メソッドの詳細

### doStartTag

    public int doStartTag()

  Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。

  定義:
    インタフェース `javax.servlet.jsp.tagext.Tag` 内の `doStartTag`
  オーバーライド:
    クラス `CommonTagSupport` 内の `doStartTag`
  戻り値:
    int 後続処理の指示( EVAL_BODY_BUFFERED )

### doAfterBody

    public int doAfterBody()

  Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。

  定義:
    インタフェース `javax.servlet.jsp.tagext.IterationTag` 内の `doAfterBody`
  オーバーライド:
    クラス `CommonTagSupport` 内の `doAfterBody`
  戻り値:
    int 後続処理の指示(SKIP_BODY)

### release2

    protected void release2()

  タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。

  オーバーライド:
    クラス `HTMLTagSupport` 内の `release2`

### makeTag

    protected java.lang.String makeTag()

  戻るボタン/戻るリンクを作成します。

  定義:
    クラス `HTMLTagSupport` 内の `makeTag`
  戻り値:
    戻るボタン/戻るリンク
  変更履歴:

    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(java.lang.String tp)

  【TAG】ボタンのタイプ(button,link,relButton,relLink,historyBack)を指定します(初期値:link)。

  パラメータ:
    `tp` - ボタンのタイプ(button,link,historyBack)
  説明:

         button と設定すると、戻るボタンに、link と設定すると、戻るリンクになります。
         historyBack は、IE等の戻る操作と同じで、JavaScriptのヒストリーバックを行います。
         また、relButton、relLinkとすると、それぞれ相対パス(画面IDから飛び先のアドレスを元に生成)
         で戻り先のアドレスが生成されます。

         初期値は、戻るリンク（link）です。

         ここでは､button,historyBack,link,relButton,relLink のみを許可します。

  変更履歴:

    5.0.2.0 (2009/11/01) 相対パスでの戻るリンク対応

### setCommand

    public void setCommand(java.lang.String cmd)

  【TAG】(通常使いません)戻る時に指定する command を設定できます(初期値:RENEW)。

  パラメータ:
    `cmd` - コマンド
  説明:

         通常は、RENEW で戻ります。
         （初期値は、RENEW なので設定不要です。）

### setGamenId

    public void setGamenId(java.lang.String id)

  【TAG】(通常使いません)戻り先の画面をセットします(初期値:BACK_GAMENID)。

  パラメータ:
    `id` - 戻り先の画面ID
  説明:

         通常は、自動的に、BACK_GAMENID の値がセットされますが、
         先祖に戻る（画面Ａ⇒画面Ｂ⇒画面Ｃ のときに、画面Ａに戻る）場合や、
         別の画面に、進む場合に、直接指定します。
         （初期値は、来た画面：BACK_GAMENID ですので、設定不要です。）
         値は、キャッシュではなく、session より HybsSystem.BACK_GAMENID_KEY をキーに
         取り出します。
         これは、command="NEW" で、BACK_GAMENID リクエストが存在し、BACK_GAMENID と
         自分自身の画面IDが異なる場合のみ、RequestCacheTag#backGamenIdSet メソッドで
         session に登録されます。

### setKeys

    public void setKeys(java.lang.String key)

  【TAG】リンク先に渡すキーをCSV形式で複数指定します。

  パラメータ:
    `key` - リンク先に渡すキー
  関連項目:
    `setVals( String )`
  説明:

         戻る時に、検索時のキャッシュに指定した引数以外に指定したり、別の値に置き換えたり
         する場合のキーを設定できます。カンマ区切りで複数指定できます。
         vals 属性には、キーに対応する値を、設定してください。
         例:keys="displayMsg,clear" vals="MSG0065,true"
         分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
         こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。

  変更履歴:

    3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用

### setVals

    public void setVals(java.lang.String val)

  【TAG】keys属性に対応する値をCSV形式で複数指定します。

  パラメータ:
    `val` - keys属性に対応する値
  関連項目:
    `setKeys( String )`
  説明:

         キーに設定した値を、カンマ区切り文字で複数して出来ます。
         指定順序は、キーと同じにしておいて下さい。
         例:keys="displayMsg,clear" vals="MSG0065,true"
         分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
         こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。

  変更履歴:

    3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用

### setTarget

    public void setTarget(java.lang.String tgt)

  【HTML】リンク先の表示ターゲットを指定します(初期値：CONTENTS)。

  パラメータ:
    `tgt` - リンク先の表示ターゲット
  説明:

         リンク先の文書を表示させるフレーム、またはウィンドウの名前を指定します。

### setHref

    public void setHref(java.lang.String href)

  【HTML】リンク先のURLを指定します。

  パラメータ:
    `href` - String
  説明:

         リンク先のURLを指定します。

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.4.2.1
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.