org.opengion.hayabusa.taglib

## クラス WriteCheckTag

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

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

      public class WriteCheckTag
      extends CommonTagSupport

       サブミットボタンの表示や、画面遷移先情報(forward.jsp)を制御するタグです。

       ユーザー情報と画面情報を元に、ロール/グループの権限と
       RW(読取/書込)モードを比較して、条件が成立しない場合は,そのBODY部を表示しないように
       できます。
       また、編集設定を行っている場合は、強制的に書き込み禁止に設定しています。
       (ただし、編集設定が、カラムの並べ替えのみの場合か、または、useEdit="true" に
       設定した場合は、書き込み許可されます)
       このタグは、form 内に一つだけ記述してください。

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

         ●形式：<og:writeCheck />
         ●body：あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{@XXXX} は解析しません)

         ●Tag定義：
           <og:writeCheck
               useGamenId         【TAG】GAMENID,BACK_GAMENID 属性を付加するかどうか[true/false]を設定します(初期値:true)
               roles              【TAG】画面と別にロールズを与えます
               writable           【TAG】書き込み可能かどうか[true/false]を設定します(初期値:true)
               useEdit            【TAG】EDITNAME利用時の編集を可能にするか設定します
                                           (初期値:USE_EDIT_WITH_EDITNAME[=false])。
               outputEditName     【TAG】editNameをhiddenタグで出力するか設定します
                                           (初期値:OUTPUT_EDITNAME[=false])。
               useDummy           【TAG】IE用ダミーinputを出力するかどうか
               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:writeCheck>

         ●使用例
              <og:writeCheck>
                  <og:submit  value="copy"     lbl="COPY"    accesskey="C" />
                  <og:submit  value="modify"   lbl="MODIFY"  accesskey="M" />
                  <og:submit  value="delete"   lbl="DELETE"  accesskey="D" />
                  <jsp:directive.include file="{@SYS.JSP}/common/Excel_direct.jsp"  />
                  <br />
              </og:writeCheck>

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

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

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

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setOutputEditName(String flag)` 【TAG】editNameをhiddenタグで出力するか設定します (初期値:OUTPUT_EDITNAME[=false])。
    `void` | `setRoles(String rols)` 【TAG】画面と別にロールズを与えます。
    `void` | `setUseDummy(String flag)` 【TAG】ダミーのinputタグ(display:none)を出力するか設定します (初期値:USE_DUMMY_INPUT[=false])。
    `void` | `setUseEdit(String flag)` 【TAG】EDITNAME利用時の編集を可能にするか設定します (初期値:USE_EDIT_WITH_EDITNAME[=false])。
    `void` | `setUseGamenId(String flag)` 【TAG】GAMENID,BACK_GAMENID 属性を付加するかどうか[true/false]を設定します(初期値:true)。
    `void` | `setWritable(String flag)` 【TAG】書き込み可能かどうか[true/false]を設定します(初期値:true)。
    `String` | `toString()` このオブジェクトの文字列表現を返します。

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

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doAfterBody, doCatch, doEndTag, 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`

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

    - #### WriteCheckTag

          public WriteCheckTag()

      デフォルトコンストラクター
      変更履歴:

        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`
      戻り値:
        後続処理の指示
      変更履歴:

        3.0.1.2 (2003/03/07) forward.jsp の代替用 CommonForwardTag を新規作成
        3.5.4.0 (2003/11/25) useGamenId で、BACK_GAMENID を使用する/しないを指定します。
        3.8.5.1 (2006/05/08) 書き込み許可属性 writable 追加
        5.6.1.0 (2013/02/01) display:noneのdummyインプットを出力する
        5.7.8.0 (2014/07/04) caseKey,caseVal,caseNN,caseNull 属性を追加

    - #### release2

          protected void release2()

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

        3.5.4.0 (2003/11/25) 新規追加。
        3.8.5.1 (2006/05/08) 書き込み許可属性 writable 追加
        5.5.4.2 (2012/07/13) EDITNAME利用時の編集
        5.6.1.0 (2013/02/01) useDummy 追加
        6.2.4.0 (2015/05/15) logMsg 追加

    - #### setUseGamenId

          public void setUseGamenId(String flag)

      【TAG】GAMENID,BACK_GAMENID 属性を付加するかどうか[true/false]を設定します(初期値:true)。
      パラメータ:
        `flag` - 付加するかどうか [true:付加する/false:付加しない]
      説明:

             "true"の場合は、BACK_GAMENID 、BACK_JSPID 属性を hidden で出力します。
             "false"の場合は、付加しません。
             これは、戻るリンクを作成する場合に利用されます。
             初期値は、 "true"です。
             ボタンで遷移先がポップアップ画面の場合に、戻るリンクを出しても戻れない為、
             そのようなケースでは false にします。

      変更履歴:

        3.5.4.0 (2003/11/25) useGamenId のために、新規追加。

    - #### setRoles

          public void setRoles(String rols)

      【TAG】画面と別にロールズを与えます。
      パラメータ:
        `rols` - ロールズ
      説明:

             このロールズが与えられた場合は、画面のロールズではなく、
             個別のロールズを使用して、表示の制御を行います。

      変更履歴:

        3.5.4.0 (2003/11/25) 新規追加。

    - #### setWritable

          public void setWritable(String flag)

      【TAG】書き込み可能かどうか[true/false]を設定します(初期値:true)。
      パラメータ:
        `flag` - 書き込み許可 [true:許可/false:不可]
      説明:

             書込み許可する場合は, true、許可しない場合は, true 以外を設定します。
             デフォルト値は、互換性のため、true です。
             ここで、false を設定するとBODY部の内容は表示されません。true を設定した場合、
             通常通り BODY 部は表示されます。
             これは、roles の簡易版として、外部から ON/OFF を制御するのに使用できます。

      変更履歴:

        3.8.5.1 (2006/05/08) 書き込み許可属性 writable 追加

    - #### setUseEdit

          public void setUseEdit(String flag)

      【TAG】EDITNAME利用時の編集を可能にするか設定します (初期値:USE_EDIT_WITH_EDITNAME[=false])。
      パラメータ:
        `flag` - 編集許可 [true:する/false:しない]
      関連項目:
        `SystemData.USE_EDIT_WITH_EDITNAME`
      説明:

             カラムの並び替えや表示等を設定した場合に編集可能にするかを設定します。
             (つまり、ボタンを出すかどうかをコントロールします)
             (初期値:USE_EDIT_WITH_EDITNAME[=false])。

      変更履歴:

        5.5.4.2 (2012/07/13) 新規追加

    - #### setOutputEditName

          public void setOutputEditName(String flag)

      【TAG】editNameをhiddenタグで出力するか設定します (初期値:OUTPUT_EDITNAME[=false])。
      パラメータ:
        `flag` - 編集名出力 [true:する/false:しない]
      関連項目:
        `SystemData.OUTPUT_EDITNAME`
      説明:

             選択したeditNameを次の画面に送信するためのhiddenタグを出力します。
             editNameを次の画面に送信した場合は送信先画面のviewタグのviewFormTypeが
             内部的に自動セットされるため注意が必要です。
             useEditがfalseの場合は出力しません。
             (初期値:OUTPUT_EDITNAME[=false])。

      変更履歴:

        5.5.4.2 (2012/07/13) 新規追加

    - #### setUseDummy

          public void setUseDummy(String flag)

      【TAG】ダミーのinputタグ(display:none)を出力するか設定します (初期値:USE_DUMMY_INPUT[=false])。
      パラメータ:
        `flag` - ダミー出力 [true:する/false:しない]
      関連項目:
        `SystemData.USE_DUMMY_INPUT`
      説明:

             ダミーのinputタグ(display:none)を出力するか設定します。
             IEではinputが１つだけの場合にエンターでのsubmitが上手くいかないため、ダミーを配置する必要があります。
             trueに設定するとWriteCheckタグがダミーを（常に）出力します。
             (初期値:USE_DUMMY_INPUT[=false])。

      変更履歴:

        5.6.1.0 (2013/02/01) 新規追加

    - #### toString

          public String toString()

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

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