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

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

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

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

    public class ForwardTag

extends CommonTagSupport

制御を別の画面にフォワードする場合に使用するタグです(通常は、entry.jsp で使用します)。 フォワード時に、指定の引数をセットできます。

関連項目:
  直列化された形式
機能階層
  画面制御
形式サンプル:

       ●形式：<og:forward page="…" gamenId="[…]" />
       ●body：なし

       ●使用例
             <og:forward
                page          = "転送先URLを指定します。(必須)"
                dbkeys        = "DBキーをCSV 形式でセットします。"
                keys          = "キーを CSV 形式でセットします。"
                vals          = "キーに対応する値を CSV 形式でセットします。"
                scope         = "キャッシュする場合のスコープ(request,page,session,applicaton)を指定します(初期値:session)。"
                gamenId       = "gamenId 属性を登録します。"
                useRedirect   = "useRedirect 属性を登録します。"
                filename      = "ファイル転送時にファイル名を指定する場合に設定します。"
                target        = "taregt 属性を登録します。"
                noTransition  = "実際にforwardせずに、id="forwardUrl"属性のbody部分に遷移先のURLを出力します。(画面遷移なしモード時に使用します)"
             />

バージョン
  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`

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

メソッドの概要
`int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
`protected void` | `release2()` タグリブオブジェクトをリリースします。
`void` | `setDbkeys(String key)` 【TAG】DBキーをCSV 形式でセットします。
`void` | `setFilename(String name)` 【TAG】ファイル転送時にファイル名の別名を指定します。
`void` | `setGamenId(String id)` 【TAG】gamenId 属性を登録します。
`void` | `setKeys(String key)` 【TAG】キーを CSV 形式でセットします。
`void` | `setNoTransition(String noTrnstn)` 【TAG】(通常は使いません)画面遷移を行わない形式の登録方法を使用するかを指定します。
`void` | `setPage(String url)` 【TAG】転送先URLを指定します。
`void` | `setTarget(String flag)` 【TAG】サブミット先の文書を表示させるフレーム、またはウィンドウの名前を指定します。
`void` | `setUseAjaxSubmit(String ajaxSubmit)` 【TAG】(通常は使いません)ajaxを利用したsubmitを利用するかどうかを指定します。
`void` | `setUseRedirect(String flag)` 【TAG】useRedirect 属性を登録します(初期値：false)。
`void` | `setVals(String val)` 【TAG】キーに対応する値を CSV 形式でセットします。
`String` | `toString()` このオブジェクトの文字列表現を返します。

クラス org.opengion.hayabusa.taglib.CommonTagSupport から継承されたメソッド
`add, add, addEventColumnSQL, check, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, 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, getRequestValues, getResource, getScope, getSessionAttribute, getTagName, getUser, getUserInfo, isAjaxSubmitSession, isDebug, isNoTransitionSession, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitSession, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setMsglbl, setNoTransitionSession, setObject, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, setUseValue, startQueryTransaction, sys, sysBool, sysInt, useQuotCheck`

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

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

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

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

コンストラクタの詳細

### ForwardTag

    public ForwardTag()

メソッドの詳細

### doEndTag

    public int doEndTag()

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

  定義:
    インタフェース `Tag` 内の `doEndTag`
  オーバーライド:
    クラス `CommonTagSupport` 内の `doEndTag`
  戻り値:
    int
  変更履歴:

    2.1.0.0 (2002/10/11) 戻り値の先頭の "?" を追加しないように変更。
    3.0.1.3 (2003/03/11) 直接転送した場合の整合性を取る為の対応。
    3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    3.1.2.0 (2003/04/07) ソースコード中の固定値を、定義ファイルを使用するように変更する。
    3.5.4.9 (2004/02/25) gamenId を指定して、フォワードできるようにします。
    3.5.6.6 (2004/08/23) useRedirect 属性を追加します。
    4.3.3.0 (2008/10/01) noTransition 属性を追加します。
    4.3.7.1 (2009/06/08) target属性に絶対パス及び"_"で始まる予約語を指定できるようにします。
    4.3.8.0 (2009/08/01) useAjaxSubmit対応、noTransition値取得メソッド名変更

### release2

    protected void release2()

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

  オーバーライド:
    クラス `CommonTagSupport` 内の `release2`
  変更履歴:

    2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
    3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    3.5.4.9 (2004/02/25) 画面ID属性（gamenId）を追加
    3.8.5.0 (2006/03/06) filename 属性を追加します。
    4.3.3.0 (2008/10/01) noTransition 属性を追加します。

### setPage

    public void setPage(String url)

  【TAG】転送先URLを指定します。

  パラメータ:
    `url` - String
  TagLib:

    転送先URLを指定します。

### setDbkeys

    public void setDbkeys(String key)

  【TAG】DBキーをCSV 形式でセットします。

  パラメータ:
    `key` - DBキー(CSV 形式)
  TagLib:

    URI の引数にセットするキーを CSV 形式でセットします。 ここの指定は,DBTableModel 上のデータを取り込みます。

### setKeys

    public void setKeys(String key)

  【TAG】キーを CSV 形式でセットします。

  パラメータ:
    `key` - キー(CSV 形式)
  TagLib:

    URI の引数にセットするキーを CSV 形式でセットします。

### setVals

    public void setVals(String val)

  【TAG】キーに対応する値を CSV 形式でセットします。

  パラメータ:
    `val` - 値(CSV 形式)
  TagLib:

    URI の引数にセットする値を CSV 形式でセットします。 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。

  変更履歴:

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

### setGamenId

    public void setGamenId(String id)

  【TAG】gamenId 属性を登録します。

  パラメータ:
    `id` - gamenId 属性
  関連項目:
    `setUseRedirect( String )`
  TagLib:

    gamenId 属性は、画面IDをキーに、実アドレスを求めるのに使用します。 画面IDが指定された場合は、実アドレスに変換する。指定されない場合は、 page 属性をそのままリダイレクトアドレスとします。 gamenId を指定した場合は、このuseRedirect属性に関係なく、Redirect されます。

  変更履歴:

    3.5.4.9 (2004/02/25) 新規追加

### setUseRedirect

    public void setUseRedirect(String flag)

  【TAG】useRedirect 属性を登録します(初期値：false)。

  パラメータ:
    `flag` - useRedirect 属性 ( false:forwrd / true:redirect )
  関連項目:
    `setGamenId( String )`
  TagLib:

    useRedirect 属性は、URLの転送方式を指定できます。 通常は、pageContext.forward しますが、この属性に true を 設定すると、response.sendRedirect します。 gamenId を指定した場合は、この属性に関係なく、Redirect されます。 初期値は、false (forward) です。

  変更履歴:

    3.5.6.6 (2004/08/23) 新規追加

### setTarget

    public void setTarget(String flag)

  【TAG】サブミット先の文書を表示させるフレーム、またはウィンドウの名前を指定します。

  パラメータ:
    `flag` - サブミット先の文書のフレーム名（ターゲット属性）
  TagLib:

    サブミット先のフレーム名（ターゲット属性）を設定します。

  変更履歴:

    3.8.0.4 (2005/08/08) 新規追加

### setFilename

    public void setFilename(String name)

  【TAG】ファイル転送時にファイル名の別名を指定します。(初期値:null)。

  パラメータ:
    `name` - ファイル名
  TagLib:

    ファイルを転送する場合に、オープンさせるファイル名を指定します。 指定しない場合は、フォラード前に呼び出されたアドレスがそのまま使用されます。

### setNoTransition

    public void setNoTransition(String noTrnstn)

  【TAG】(通常は使いません)画面遷移を行わない形式の登録方法を使用するかを指定します。

  パラメータ:
    `noTrnstn` - 画面遷移を行わない形式の登録方法を使用するか
  TagLib:

    画面遷移なしの登録を行うかどうかを指定します。 trueが指定された場合、forwardタグでは、実際の画面遷移は行わずに、forward先の URLを [URL] の形でHTMLとして出力し、JavaScript側で 実際の画面遷移を発生させます。target属性は [TARGET] で 出力されます。 この値は、og:headタグで設定値を継承するため、通常、この属性ではセットしません。 何らかの理由でog:headタグでfalseになっているにも関わらず、trueを指定する場合のみ使用します。

  変更履歴:

    4.3.3.0 (2008/10/01) 新規追加

### setUseAjaxSubmit

    public void setUseAjaxSubmit(String ajaxSubmit)

  【TAG】(通常は使いません)ajaxを利用したsubmitを利用するかどうかを指定します。

  パラメータ:
    `ajaxSubmit` - ajaxを利用したsubmitを利用するかどうか
  TagLib:

    ajaxを利用したSubmit処理を行うかどうかを指定します。 setNoTransitionをtrueにした場合と同様の処理を行います。 （forwardせずにURLをDIVタグで出力する） この値は、前画面から送られる値を利用するため、通常セットしません。 何らかの理由で前画面のog:headタグでfalseになっているにも関わらず、trueを指定する場合のみ使用します。

  変更履歴:

    4.3.8.0 (2009/08/01) 新規追加

### toString

    public String toString()

  このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。

  オーバーライド:
    クラス `CommonTagSupport` 内の `toString`
  戻り値:
    このクラスの文字列表現

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

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