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

# クラス ViewJsonParamTag

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

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

public class ViewJsonParamTag extends ViewParamImpl
viewタグの viewFormType が JSON の場合にパラメータを設定します。 JOSN出力のViewForm_JSON クラスに対して、各種パラメータを設定します。 パラメータが設定されていない場合は、ViewJsonParam の初期値が 使用されます。 (パラメータを使用するには、viewタグのuseParam 属性をtrueに設定する必要があります。)

関連項目:
  - 直列化された形式
変更履歴:
  5.9.7.0 (2016/04/01) 新規作成
機能分類
  画面表示
形式ｻﾝﾌﾟﾙ:
  ●形式：<og:jsonParam useHead="false" /> ●body：なし ●Tag定義： <og:stackParam useHead 【TAG】ヘッダ情報を出力するかどうか(初期値:true) useInfo 【TAG】INFO情報を出力するかどうか(初期値:true) useRenderer 【TAG】データ出力でレンデラを利用するかどうか(初期値:false) useNullOmit 【TAG】nullデータの出力を行わないかどうか(初期値:false) useZeroOmit 【TAG】ゼロデータの出力を行わないかどうか(初期値:false) dataName 【TAG】データ出力時の配列オブジェクトの名称指定(初期値:DATA) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) />
導入されたバージョン:
  JDK5.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`

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

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

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `protected String`
  `getTagName()`
  タグの名称を、返します。
  `void`
  `setDataName(String name)`
  【TAG】JSON出力で、データ部の名前を指定します。
  `void`
  `setRendererColumns(String cols)`
  【TAG】JSON出力で、レンデラを利用するカラムを指定します。
  `void`
  `setUseHead(String usehead)`
  【TAG】JSON出力で、ヘッダ情報を出すかどうかを指定します。
  `void`
  `setUseInfo(String useinfo)`
  【TAG】JSON出力で、INFO情報を出すかどうかを指定します。
  `void`
  `setUseNullOmit(String nullOmit)`
  【TAG】JSON出力で、nullデータの出力を行わないかどうかを指定します(初期値:false)。
  `void`
  `setUseRenderer(String usernd)`
  【TAG】(廃止予定)JSON出力で、値出力にレンデラを利用するかどうかを指定します。
  `void`
  `setUseZeroOmit(String zeroOmit)`
  【TAG】JSON出力で、ゼロデータの出力を行わないかどうかを指定します(初期値:false)。

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

  `doEndTag, initParam, putParam, release2, toString`

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

  `add, add, addEventColumn, addEventColumn, check, commitTableObject, 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, 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`

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

  - ### ViewJsonParamTag

    public ViewJsonParamTag()
    デフォルトコンストラクター
    変更履歴:
      6.9.7.0 (2018/05/14) PMD Each class should declare at least one constructor

- ## メソッドの詳細

  - ### setUseInfo

    public void setUseInfo(String useinfo)
    【TAG】JSON出力で、INFO情報を出すかどうかを指定します。
    パラメータ:
      `useinfo` - INFO情報を出力するかどうか
    説明:
      JSON中INFO情報を出力しない場合はfalseを指定します。

  - ### setUseHead

    public void setUseHead(String usehead)
    【TAG】JSON出力で、ヘッダ情報を出すかどうかを指定します。
    パラメータ:
      `usehead` - ヘッダ情報を出力するかどうか
    説明:
      JSON中にヘッダ情報を出力しない場合はfalseを指定します。

  - ### setUseRenderer

    public void setUseRenderer(String usernd)
    【TAG】(廃止予定)JSON出力で、値出力にレンデラを利用するかどうかを指定します。
    パラメータ:
      `usernd` - レンデラーを利用するかどうか
    説明:
      JSONのデータのレンデラー変換を行うかどうか。 指定しない場合は使用しない(false)です。 true指定はrendererColumns="*"と同じため、そちらを利用してください。

  - ### setRendererColumns

    public void setRendererColumns(String cols)
    【TAG】JSON出力で、レンデラを利用するカラムを指定します。
    パラメータ:
      `cols` - データ配列の名称
    変更履歴:
      5.9.27.0 (2017/12/01) 追加
    説明:
      レンデラを利用するカラムを指定します。

  - ### setUseNullOmit

    public void setUseNullOmit(String nullOmit)
    【TAG】JSON出力で、nullデータの出力を行わないかどうかを指定します(初期値:false)。
    パラメータ:
      `nullOmit` - nullデータの出力を行わないかどうか
    変更履歴:
      6.7.7.0 (2017/03/31) 新規追加
    説明:
      JSONのデータが、nullの場合、出力するかどうかを指定します。 true を指定すると、nullデータは、出力しません。 (初期値:false)

  - ### setUseZeroOmit

    public void setUseZeroOmit(String zeroOmit)
    【TAG】JSON出力で、ゼロデータの出力を行わないかどうかを指定します(初期値:false)。
    パラメータ:
      `zeroOmit` - ゼロデータの出力を行わないかどうか
    変更履歴:
      6.7.7.0 (2017/03/31) 新規追加
    説明:
      JSONのデータが、ゼロの場合、出力するかどうかを指定します。 true を指定すると、ゼロデータとnullデータを、出力しません。 (初期値:false)

  - ### setDataName

    public void setDataName(String name)
    【TAG】JSON出力で、データ部の名前を指定します。
    パラメータ:
      `name` - データ配列の名称
    説明:
      データ配列の名称を指定します。 指定しない場合は「DATA」です。

  - ### getTagName

    protected String getTagName()
    タグの名称を、返します。 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
    オーバーライド:
      `getTagName` クラス内 `CommonTagSupport`
    戻り値:
      タグの名称
    関連項目:
      - `CommonTagSupport.getDocumentLink()`