org.opengion.hayabusa.taglib

## クラス FavoriteLinkTag

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

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

      public class FavoriteLinkTag
      extends CommonTagSupport

  お気に入りリンクを作成するタグです(通常はresult.jspに組込み)。 画面検索時の引数やユーザー情報を元にして、ダイレクトに再検索できる リンクを作成します。このリンクをお気に入り等にセーブしておき、次回検索時にも 使用できるようにします。
  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：<og:favoriteLink direct="true" target="_blank" method="GET" />
         ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)

         ●Tag定義：
           <og:favoriteLink
               target             【TAG】リンク先の文書を表示させるフレーム、またはウィンドウの名前を指定します(初期値:_blank)
               direct             【TAG】直接アクセスできる形式のリンクを作成するかどうか[true/false]を指定します(初期値:false)
               method             【TAG】リンクの作成元となるメソッド[POST/GET/ALL]を指定します(初期値:GET)
               href               【TAG】リンクを作成する時の転送先アドレスを指定します(初期値:index.jsp)
               lbl                【TAG】ラベルリソースのラベルIDを指定します
               linkCache          【TAG】リンクをキャッシュするかどうか[true/false]を指定します(初期値:false)
               lastQueryRedirect  【TAG】キャッシュされたリンク先に転送するかどうか[true/false]を指定します(初期値:false)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
               useIcon            【TAG】お気に入りアイコンリンクを作成するかどうか[true/false]を指定します(初期値:false)
           >   ... Body ...
           </og:favoriteLink>

         ●使用例：
            直接お気に入りのリンクを作成する。
            デフォルト属性を使用(direct="true" target="_blank" method="GET")
            <og:favoriteLink > Favorite Link </og:favoriteLink >

  機能分類
    画面部品
  バージョン
    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`

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `FavoriteLinkTag()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `static void` | `clear()` リンクキャッシュをクリアします。
    `int` | `doAfterBody()` Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected String` | `makeTag()` お気に入りリンクを作成します。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setDirect(String flag)` 【TAG】直接アクセスできる形式のリンクを作成するかどうか[true/false]を指定します(初期値:false)。
    `void` | `setHref(String url)` 【TAG】リンクを作成する時の転送先アドレスを指定します(初期値:index.jsp)。
    `void` | `setLastQueryRedirect(String flag)` 【TAG】キャッシュされたリンク先に転送するかどうか[true/false]を指定します(初期値:false)。
    `void` | `setLinkCache(String flag)` 【TAG】リンクをキャッシュするかどうか[true/false]を指定します(初期値:false)。
    `void` | `setMethod(String flag)` 【TAG】リンクの作成元となるメソッド[POST/GET/ALL]を指定します(初期値:GET)。
    `void` | `setTarget(String flag)` 【TAG】リンク先の文書を表示させるフレーム、またはウィンドウの名前を指定します(初期値:_blank)。
    `void` | `setUseIcon(String flag)` 【TAG】お気に入りアイコンリンクを作成するかどうか[true/false]を指定します(初期値:false)。
    `String` | `toString()` このオブジェクトの文字列表現を返します。

    - ### クラスから継承されたメソッド 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, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getTagName, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseKey, setCaseNN, setCaseNull, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, 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, 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`

- - ### コンストラクタの詳細

    - #### FavoriteLinkTag

          public FavoriteLinkTag()

  - ### メソッドの詳細

    - #### doStartTag

          public int doStartTag()

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

        3.1.1.2 (2003/04/04) Tomcat4.1 対応。ボディが存在する場合のみボディが呼ばれる対応。
        3.5.5.9 (2004/06/07) リンクキャッシュより最終画面を転送表示します。
        5.0.0.2 (2009/09/15) xss対応⇒チェックする

    - #### doAfterBody

          public int doAfterBody()

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

        3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。
        3.1.1.2 (2003/04/04) Tomcat4.1 対応。ボディが存在する場合のみボディが呼ばれる対応。

    - #### doEndTag

          public int doEndTag()

      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
        `doEndTag` インタフェース内 `Tag`
      オーバーライド:
        `doEndTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示
      変更履歴:

        3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
        4.1.1.0 (2008/0213) お気に入りアイコンリンクの作成

    - #### release2

          protected void release2()

      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
        `release2` クラス内 `CommonTagSupport`
      変更履歴:

        2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
        3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
        3.5.5.9 (2004/06/07) linkCache , redirect 属性を追加
        3.6.0.7 (2004/11/06) target 属性の初期値を _new から _blank に変更
        3.8.8.2 (2007/01/26) href 属性を追加

    - #### makeTag

          protected String makeTag()

      お気に入りリンクを作成します。
      戻り値:
        お気に入りリンクタグ文字列
      変更履歴:

        3.8.8.2 (2007/01/26) href 属性を追加

    - #### setDirect

          public void setDirect(String flag)

      【TAG】直接アクセスできる形式のリンクを作成するかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
        `flag` - ダイレクトリンクの作成可否
      説明:

             trueは、指定の画面のフレームレベルでの指定になります。false は、トップフレームを
             含む形なので、通常の登録画面と同じ形式になります。
             初期値は、false(直接リンクしない)です。

    - #### setTarget

          public void setTarget(String flag)

      【TAG】リンク先の文書を表示させるフレーム、またはウィンドウの名前を指定します(初期値:_blank)。
      パラメータ:
        `flag` - リンク先の文書のフレーム名(ターゲット属性)
      説明:

             リンク先のフレーム名(ターゲット属性)を設定します。

    - #### setHref

          public void setHref(String url)

      【TAG】リンクを作成する時の転送先アドレスを指定します(初期値:index.jsp)。
      パラメータ:
        `url` - 転送先アドレス
      説明:

             direct="false"(初期値)に使用されるリンクの転送先アドレスを指定します。
             初期値は、index.jspです。

    - #### setMethod

          public void setMethod(String flag)

      【TAG】リンクの作成元となるメソッド[POST/GET/ALL]を指定します(初期値:GET)。
      パラメータ:
        `flag` - リンクの作成元となるメソッド [POST/GET/ALL]
      説明:

             ここで指定したメソッドでリクエストされた場合のみ、リンクを作成します。
             初期値は、GET です。(つまり GET のみリンクを作成します。)
             これは、POST では、引数が付かない為です。(実際は付ける事ができますが・・・)
             ALL は、どちらの場合でもリンクを作成しますが、先に述べたように POST では
             引数がつきません。
             初期値は、GETです。

    - #### setLinkCache

          public void setLinkCache(String flag)

      【TAG】リンクをキャッシュするかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
        `flag` - リンクをキャッシュするかどうか [true:する/false:しない]
      説明:

             この、favoriteLink で指定された画面を、ユーザー毎にキャッシュします。
             キャッシュされた画面は、lastQuery を指定することで、取り出し(転送)
             することが出来ます。
             ここでのキャッシュは、direct="true" を指定した場合のアドレスです。
             direct="false" は、index.jsp からのフレーム形式の為、メール等で
             送り、後ほど再開するような使い方(または、ワークフロー的な使い方)
             を想定していますが、direct="true" により単独フレームデータを、
             リアルタイムで使用するケース(EXCELのWebクエリーなど)で使用します。
             初期値は、falseです。

      変更履歴:

        3.5.5.9 (2004/06/07) リンクキャッシュより最終画面を転送表示します。

    - #### setLastQueryRedirect

          public void setLastQueryRedirect(String flag)

      【TAG】キャッシュされたリンク先に転送するかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
        `flag` - リンクをキャッシュするかどうか [true:する/false:しない]
      説明:

             この、favoriteLink で指定された画面を、キャッシュします。
             キャッシュされた画面は、lastQuery を指定することで、取り出し(転送)
             することが出来ます。
             ここでのキャッシュは、direct="true" を指定した場合のアドレスです。
             direct="false" は、index.jsp からのフレーム形式の為、メール等で
             送り、後ほど再開するような使い方(または、ワークフロー的な使い方)
             を想定していますが、direct="true" により単独フレームデータを、
             リアルタイムで使用するケース(EXCELのWebクエリーなど)で使用します。
             初期値は、falseです。

      変更履歴:

        3.5.5.9 (2004/06/07) リンクキャッシュより最終画面を転送表示します。

    - #### setUseIcon

          public void setUseIcon(String flag)

      【TAG】お気に入りアイコンリンクを作成するかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
        `flag` - お気に入りアイコンリンクを作成するかどうか [true:する/false:しない]
      説明:

             初期値は、falseです。

      変更履歴:

        4.1.1.0 (2008/02/13) 新規追加。

    - #### clear

          public static void clear()

      リンクキャッシュをクリアします。 この時、poolされているオブジェクトは、ResourceManager#clear() メソッドを 呼び出します。
      変更履歴:

        3.5.5.9 (2004/06/07) 新規作成

    - #### toString

          public String toString()

      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
        `toString` クラス内 `CommonTagSupport`
      戻り値:
        このクラスの文字列表現

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