パッケージ org.opengion.hayabusa.taglib

# クラス EditConfigTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.EditConfigTag

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

public class EditConfigTag extends CommonTagSupport
画面表示、集計に関する設定情報の表示、登録を行うためのタグです。 (このタグは標準の設定編集画面に組み込んで使用され、各画面JSPから呼び出すことはありません) このタグは、ユーザー単位に管理される編集設定オブジェクトに対するI/Fの機能を 提供しています。この編集設定オブジェクトについては、画面毎に設定を行うため、 タグの呼び出しには、画面IDが必須となっています。 具体的な機能としては、3つの機能を提供します。 (1)設定画面表示(command="GET") ユーザー単位に管理される編集設定オブジェクトをHTMLに変換して表示 また、表示カラムの一覧(CSV形式)については、画面側のJavaScriptで再設定を行うため、 その値を"viewClms"という名前のhiddenタグで出力します。 (2)編集名一覧(command="LIST") 指定の画面IDに対して、設定されている編集名の一覧をプルダウン(selectタグ)に 変換して表示します。(name="editName") (3)設定情報登録/削除(command="SET"/"DELETE") (1)で設定された内容に対して、編集名を指定してその内容を保存/削除します。 情報の保存は、command="GET"で表示される項目名と連動していますので、単独での使用は できません。

関連項目:
  - 直列化された形式
変更履歴:
  5.3.6.0 (2011/06/01)
機能分類
  編集設定
形式ｻﾝﾌﾟﾙ:
  ●形式：一般ユーザーが直接組み込むことはありません。 ●body：なし ●Tag定義： <og:editConfig command ○【TAG】command を指定します(必須) gamenId ○【TAG】画面ID を指定します(必須) editName 【TAG】編集名 を指定します orderOnly 【TAG】チェックボックスのリードオンリー化を行います(初期値:false) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) /> ●使用例 <og:editConfig command="{@command}" gamenId="{@GAMENID}" editName="{@editName}" /> <og:editConfig command = command設定 (GET/LIST/SET/REMOVE) gamenId = "GE0000" 画面ID [ editName ] = "EDITNAME" 編集名 />
導入されたバージョン:
  JDK6.0,

- ## フィールドの概要

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

  `BR, BUFFER_MIDDLE, CR`

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

  `bodyContent`

  ### クラスから継承されたフィールド jakarta.servlet.jsp.tagext.TagSupport

  `id, pageContext`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.BodyTag

  `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

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

  `EVAL_BODY_AGAIN`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.Tag

  `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

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

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

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `int`
  `doEndTag()`
  Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
  `protected void`
  `release2()`
  タグリブオブジェクトをリリースします。
  `void`
  `setCommand(String cmd)`
  【TAG】command を指定します。
  `void`
  `setEditName(String name)`
  【TAG】編集名を指定します。
  `void`
  `setGamenId(String key)`
  【TAG】画面ID を指定します。
  `void`
  `setOrderOnly(String flag)`
  【TAG】順番の入れ替えと、表示順の設定のみを行う場合にtrueにします(初期値:false)。
  `String`
  `toString()`
  このオブジェクトの文字列表現を返します。

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

  `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsg, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, 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`

  ### クラスから継承されたメソッド jakarta.servlet.jsp.tagext.BodyTagSupport

  `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

  ### クラスから継承されたメソッド jakarta.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`

  ### インタフェースから継承されたメソッド jakarta.servlet.jsp.tagext.Tag

  `getParent, setPageContext, setParent`

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

  - ### EditConfigTag

    public EditConfigTag()
    デフォルトコンストラクター
    変更履歴:
      6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

- ## メソッドの詳細

  - ### doEndTag

    public int doEndTag()
    Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    定義:
      `doEndTag` インタフェース内 `Tag`
    オーバーライド:
      `doEndTag` クラス内 `CommonTagSupport`
    戻り値:
      後続処理の指示
    変更履歴:
      5.7.1.2 (2013/12/20) msg ⇒ errMsg 変更, 6.0.2.4 (2014/10/17) JSP修正時の追加カラム対応, 6.4.5.0 (2016/04/08) DBEditConfigのローカル化。, 5.9.18.1 (2017/03/24) ADD 編集名の共通判別対応, 6.9.2.1 (2018/03/12) DBEditConfigManagerを直接取り出す処理を、廃止します

  - ### release2

    protected void release2()
    タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
    オーバーライド:
      `release2` クラス内 `CommonTagSupport`
    変更履歴:
      5.5.5.2 (2012/08/10) orderOnly対応, 6.4.5.0 (2016/04/08) DBEditConfigのローカル化。

  - ### setCommand

    public void setCommand(String cmd)
    【TAG】command を指定します。
    パラメータ:
      `cmd` - コマンド [GET/LIST/SET/DELETE]
    説明:
      command を指定します。 [GET/LIST/SET/DELETE]のみが設定可能です。それ以外の場合、何も処理されません。

  - ### setGamenId

    public void setGamenId(String key)
    【TAG】画面ID を指定します。
    パラメータ:
      `key` - 画面ID
    説明:
      画面ID を指定します。

  - ### setEditName

    public void setEditName(String name)
    【TAG】編集名を指定します。
    パラメータ:
      `name` - 編集名
    説明:
      編集名 を指定します。 commandがSETまたはDELETEの場合は必須です。 commandがGETまたはLISTの場合は無効です。

  - ### setOrderOnly

    public void setOrderOnly(String flag)
    【TAG】順番の入れ替えと、表示順の設定のみを行う場合にtrueにします(初期値:false)。
    パラメータ:
      `flag` - 順番入替のみ [true:入替のみ/false:通常]
    変更履歴:
      5.5.5.2 (2012/08/10) 新規追加
    説明:
      順番の入れ替えと、表示順の設定のみを行う場合にtrueにします。 表示/非表示切替や、集計機能は利用できなくなります。 （チェックボックスのリードオンリーはできないため、実際にはdisable+hiddenで出力しています） 初期値は、false:通常 です。

  - ### toString

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