org.opengion.hayabusa.taglib

## クラス ViewMarkerTag

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

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

      public class ViewMarkerTag
      extends CommonTagSupport

       複数のcolumnMarker を統合して、検索結果に対して様々な属性を付加するタグです。(参照:columnMarker)

       DBTableModelオブジェクトの表示にHTMLタグをマークします。
       子タグとして、ColumnMarkerTag のBODY要素をパースして、タグを作成します。

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

         ●形式：<og:viewMarker > ･･･ </og:viewMarker >
         ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)

         ●Tag定義：
           <og:viewMarker
               command          ○【TAG】コマンド (NEW,RENEW,RESET,REVIEW)をセットします(必須)。
               viewMarkerId       【TAG】(通常は使いません)requestから取得する ViewMarker に対応する Attributes オブジェクトの ID
               isRenderer         【TAG】マーカーのタイプが renderer かどうか[true/false]を指定します(初期値:true)
               caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
               caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
               caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない)
               caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない)
               caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           >   ... Body ...
           </og:viewMarker>

         ●使用例
             商品CD２(CDSYHN02)は赤字で表示する。
             商品CD３(CDSYHN03)は-----と表示する。
                 <og:viewMarker command="{@command}">
                     <og:columnMarker column="CDSYHN02" onMark="true" >
                         <font color='red'>[VCDSYHN02]</font>
                     </og:columnMarker>
                     <og:columnMarker column="CDSYHN03" onMark="true" >
                         <CENTER>-----</CENTER>
                     </og:columnMarker>
                 </og:viewMarker>

  機能分類
    画面表示
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドのサマリー

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `static java.lang.String` | `CMD_NEW` command 引数に渡す事の出来る コマンド 新規 "NEW"
    `static java.lang.String` | `CMD_RENEW` command 引数に渡す事の出来る コマンド 再検索 "RENEW"
    `static java.lang.String` | `CMD_RESET` command 引数に渡す事の出来る コマンド リセット "RESET"
    `static java.lang.String` | `CMD_REVIEW` command 引数に渡す事の出来る コマンド 再表示 "REVIEW"

    - ### クラスから継承されたフィールド org.opengion.hayabusa.taglib.CommonTagSupport

      `BR, BUFFER_MIDDLE, CR`

    - ### クラスから継承されたフィールド 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`

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `ViewMarkerTag()` デフォルトコンストラクター

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `protected void` | `addAttribute(Attributes attri)` 内部タグの ColumnMarkerTag より、個々のカラムの値を書き換える 為の マーカー文字列を受け取る。
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setCommand(java.lang.String cmd)` 【TAG】コマンド (NEW,RENEW,RESET,REVIEW)をセットします。
    `void` | `setIsRenderer(java.lang.String flag)` 【TAG】マーカーのタイプが renderer かどうか[true/false]を指定します(初期値:true)。
    `void` | `setViewMarkerId(java.lang.String id)` 【TAG】(通常は使いません)requestから取得する ViewMarker に対応する Attributes オブジェクトの ID。
    `java.lang.String` | `toString()` このオブジェクトの文字列表現を返します。

    - ### クラスから継承されたメソッド org.opengion.hayabusa.taglib.CommonTagSupport

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsg, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getSumRequestValue, getTagName, getTransaction, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, makeUrl, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseIf, 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`

- - ### フィールドの詳細

    - #### CMD_NEW

          public static final java.lang.String CMD_NEW

      command 引数に渡す事の出来る コマンド 新規 "NEW"
      関連項目:
        定数フィールド値

    - #### CMD_RENEW

          public static final java.lang.String CMD_RENEW

      command 引数に渡す事の出来る コマンド 再検索 "RENEW"
      関連項目:
        定数フィールド値

    - #### CMD_RESET

          public static final java.lang.String CMD_RESET

      command 引数に渡す事の出来る コマンド リセット "RESET"
      関連項目:
        定数フィールド値

    - #### CMD_REVIEW

          public static final java.lang.String CMD_REVIEW

      command 引数に渡す事の出来る コマンド 再表示 "REVIEW"
      関連項目:
        定数フィールド値

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

    - #### ViewMarkerTag

          public ViewMarkerTag()

      デフォルトコンストラクター
      変更履歴:
        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`
      戻り値:
        後続処理の指示
      変更履歴:
        5.1.9.0 (2010/08/01) 戻り値を、EVAL_BODY_INCLUDE → EVAL_BODY_BUFFERED に変更, 6.3.4.0 (2015/08/01) caseKey,caseVal,caseNN,caseNull,caseIf 属性対応, 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。

    - #### doEndTag

          public int doEndTag()

      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
        `doEndTag` インタフェース内 `Tag`
      オーバーライド:
        `doEndTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示
      変更履歴:
        3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 3.8.6.1 (2006/10/20) isRenderer 属性でマーカーの種類を指定, 6.3.4.0 (2015/08/01) caseKey,caseVal,caseNN,caseNull,caseIf 属性対応, 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。, 6.7.2.0 (2017/01/16) ColumnMarkerTagなどが、caseKey,caseVal等で未使用のときの対応。

    - #### 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.8.6.1 (2006/10/20) isRenderer属性追加、viewMarkerId属性初期値変更

    - #### addAttribute

          protected void addAttribute(Attributes attri)

      内部タグの ColumnMarkerTag より、個々のカラムの値を書き換える 為の マーカー文字列を受け取る。 複数の値を受け取って、後ほど、すべてのカラムに対して処理を行います。
      パラメータ:
        `attri` - マーク処理属性
      変更履歴:
        3.1.2.0 (2003/04/07) taglib パッケージ内部で使用している箇所を protected 化する。, 4.0.0.0 (2005/08/31) 同一カラムの複数登録を許可します。

    - #### setCommand

          public void setCommand(java.lang.String cmd)

      【TAG】コマンド (NEW,RENEW,RESET,REVIEW)をセットします。
      パラメータ:
        `cmd` - コマンド (public static final 宣言されている文字列)
      関連項目:
        コマンド定数
      説明:
        コマンドは,HTMLから(get/post)指定されますので,CMD_xxx で設定される フィールド定数値のいづれかを、指定できます。

    - #### setViewMarkerId

          public void setViewMarkerId(java.lang.String id)

      【TAG】(通常は使いません)requestから取得する ViewMarker に対応する Attributes オブジェクトの ID。
      パラメータ:
        `id` - マーカーID
      説明:
        ViewForm オブジェクトに、ViewMarker オブジェクトをこのキーより取得することにより、 カラムに対して、マーカー情報を付加して表示させる。 初期値は、HybsSystem.VIEW_MARK_KEY です。
      変更履歴:
        3.1.4.0 (2003/04/18) 新規追加, 3.5.6.3 (2004/07/12) {@XXXX} 変数を使用できるように変更。, 3.5.6.4 (2004/07/16) MARK_ID を付加して、他のid と混同しないようにします。, 3.8.6.1 (2006/10/20) 初期値:null (editMarker を考慮), 7.0.4.3 (2019/06/24) MARK_ID を付加して、他のid と混同しないようにします。

    - #### setIsRenderer

          public void setIsRenderer(java.lang.String flag)

      【TAG】マーカーのタイプが renderer かどうか[true/false]を指定します(初期値:true)。
      パラメータ:
        `flag` - マーカータイプ [true:renderer/false:editor]
      説明:
        このMarker オブジェクトが、ViewMarker か、EditMarker かを指定します。 内部的には、ViewMarker オブジェクトを構築しており、viewForm で、どちらにセット するかを決めているだけです。 true にセットすると、従来からある、viewMarker(renderer) を指定します。 false は、editMarker として作用し、オブジェクトが書き込み可能な場合に表示されます。 初期値は、true:renderer です。
      変更履歴:
        3.8.6.1 (2006/10/20) 新規追加

    - #### toString

          public java.lang.String toString()

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

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