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

# クラス HideMenuTag

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

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

public class HideMenuTag extends CommonTagSupport
Query画面の拡張検索領域を指定用のタグです。 通常は属性を何もセットせずにQuery画面の隠しメニューに利用します。 queryButtonタグが存在しない場合はボタンを出力したい場所にIDをセットしたspanタグを 配置し、そのIDをこのタグのbuttonId属性で指定して下さい。 タグの動きとしてはにはbody内に書いた内容をbuttonIdで指定した領域に動的に作成した ボタン(初期値はシステムパラメータの画像)でON/OFF制御可能とします。 なお、body部分にはog:firldsetタグも利用可能です。

関連項目:
  - 直列化された形式
変更履歴:
  4.3.6.0 (2009/04/01) 新規作成, 7.3.2.3 (2021/04/09) ｼｽﾃﾑ定数のICON_DIRやIMAGE_DIRを使用します。
機能分類
  画面部品
形式ｻﾝﾌﾟﾙ:
  ●形式： ・<og:hideMenu [ id = "uniqHideId" ] タグで囲われた部分に付けるID [ buttonId = "targetId" ] ボタンを出力する場所のIDを指定 [ defaultNone = "[true|false]" ] 初期状態の開閉指定 [ openButton = "open.png" ] 開く(＋)ボタンの画像 [ closeButton = "close.png" ] 閉じる(－)ボタンの画像 [ lbl = "MSG0076" ] 画像のalt属性に付けるメッセージ(初期値:MSG0076) > ●body：あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{@XXXX} は解析しません) ●Tag定義： <og:hideMenu id 【TAG】このタグのBODY部分にIDを指定します buttonId 【TAG】画像ボタン出力先のIDを指定します defaultNone 【TAG】初期状態の開閉指定[[true:閉じている/false:開いている]を指定します(初期値:true) openButton 【TAG】開くボタンの画像を指定します(初期値:"jsp/image/" + SystemData#HIDE_OPEN_BUTTON[=]) closeButton 【TAG】閉じるボタンの画像を指定します(初期値:"jsp/image/" + SystemData#HIDE_CLOSE_BUTTON[=]) lbl 【TAG】ラベルリソースのラベルIDを指定します debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) > ... Body ... </og:hideMenu> ●使用例 例１:通常のQUERY画面での利用 <og:hideMenu> <table><tr> <og:column name="CLM"/> </tr></table> </og:hideMenu> 例２:queryButtonタグが存在しない状況での利用(buttonIdの明示的な指定) <span id="hideButtonSet"> </span> <og:hideMenu> ...... </og:hideMenu>
導入されたバージョン:
  JDK5.0,

- ## フィールドの概要

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

  `BR, BUFFER_MIDDLE, CR`

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

  `bodyContent`

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

  `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`

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

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

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `int`
  `doEndTag()`
  Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
  `int`
  `doStartTag()`
  Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
  `protected void`
  `release2()`
  タグリブオブジェクトをリリースします。
  `void`
  `setButtonId(String input)`
  【TAG】画像ボタン出力先のIDを指定します。
  `void`
  `setCloseButton(String name)`
  【TAG】閉じるボタンの画像を指定します (初期値:"jsp/image/" + SystemData#HIDE_CLOSE_BUTTON[=])。
  `void`
  `setDefaultNone(String flag)`
  【TAG】初期状態の開閉指定[[true:閉じている/false:開いている]を指定します(初期値:true)。
  `void`
  `setHideClass(String name)`
  【TAG】開閉するclassを指定します。
  `void`
  `setId(String input)`
  【HTML】要素に対して固有の名前(id)をつける場合に設定します。
  `void`
  `setOpenButton(String name)`
  【TAG】開くボタンの画像を指定します (初期値:"jsp/image/" + SystemData#HIDE_OPEN_BUTTON[=])。
  `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, 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, setPageContext, setParent, setValue`

  ### クラスから継承されたメソッド java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

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

  `getParent, setPageContext, setParent`

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

  - ### HideMenuTag

    public HideMenuTag()
    デフォルトコンストラクター
    変更履歴:
      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`
    戻り値:
      後続処理の指示( EVAL_BODY_INCLUDE )
    変更履歴:
      5.5.2.6 (2012/05/25) findbugs対応。staticフィールドへの書き込みに、AtomicInteger を利用します。, 5.5.3.2 (2012/06/08) 画像にalt属性を追加します。, 5.5.4.4 (2012/07/20) hideClassを外部から指定可能にします, 5.7.1.2 (2013/12/20) msg ⇒ msglbl 変更, 6.0.2.4 (2014/10/17) img タグに、title 属性追記, 6.2.2.0 (2015/03/27) BRと\nを相互に変換する処理を追加, 6.2.2.3 (2015/04/10) htmlフィルターに、BR→改行処理機能を追加。, 5.9.2.1 (2015/11/12) , 6.3.9.0 (2015/11/06) id修正, 6.4.4.1 (2016/03/18) StringBuilderの代わりに、OgBuilderを使用する。, 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"／＞" 止めを、"＞" に変更します)。

  - ### doEndTag

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

  - ### release2

    protected void release2()
    タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
    オーバーライド:
      `release2` クラス内 `CommonTagSupport`
    変更履歴:
      5.5.4.4 (2012/07/20) hideClass対応, 7.3.2.3 (2021/04/09) ｼｽﾃﾑ定数のICON_DIRやIMAGE_DIRを使用します。

  - ### setId

    public void setId(String input)
    【HTML】要素に対して固有の名前(id)をつける場合に設定します。
    オーバーライド:
      `setId` クラス内 `TagSupport`
    パラメータ:
      `input` - BODY部分のID
    説明:
      開閉される部分を囲っているDIVタグのBODY部分にIDを指定します。 特定のhideMenuにスタイルを指定したい場合等に利用して下さい。

  - ### setButtonId

    public void setButtonId(String input)
    【TAG】画像ボタン出力先のIDを指定します。
    パラメータ:
      `input` - 出力先のID
    説明:
      初期値は"query-button-append"です。 queryButtonタグが存在する画面では通常指定する必要はありません。 queryButtonタグが存在しない場合は、別途用意したspanタグの IDを指定する事でボタンが表示されます。

  - ### setDefaultNone

    public void setDefaultNone(String flag)
    【TAG】初期状態の開閉指定[[true:閉じている/false:開いている]を指定します(初期値:true)。
    パラメータ:
      `flag` - 開閉指定 [true:閉じている/false:開いている]
    説明:
      初期状態が開いているか、閉じているかを指定します。 初期値は閉じる(true)です。

  - ### setOpenButton

    public void setOpenButton(String name)
    【TAG】開くボタンの画像を指定します (初期値:"jsp/image/" + SystemData#HIDE_OPEN_BUTTON[=])。
    パラメータ:
      `name` - 画像ファイル名
    説明:
      ボタンの画像を指定します。 絶対パスの場合は、システムの先頭から、相対パスの場合、基底は各画面のフォルダとなります。 初期値はjsp/imageフォルダ内のシステムパラメータHIDE_OPEN_BUTTONのファイルです。 (/システムID/jsp/image/expand_u.png)

  - ### setCloseButton

    public void setCloseButton(String name)
    【TAG】閉じるボタンの画像を指定します (初期値:"jsp/image/" + SystemData#HIDE_CLOSE_BUTTON[=])。
    パラメータ:
      `name` - 画像ファイル名
    説明:
      ボタンの画像を指定します。 絶対パスの場合は、システムの先頭から、相対パスの場合、基底は各画面のフォルダとなります。 初期値はjsp/imageフォルダ内のシステムパラメータHIDE_CLOSE_BUTTONのファイルです。 (/システムID/jsp/image/shrink_u.png)

  - ### setHideClass

    public void setHideClass(String name)
    【TAG】開閉するclassを指定します。
    パラメータ:
      `name` - クラス
    変更履歴:
      5.5.4.4 (2012/07/20) 新規追加
    説明:
      開閉を制御するためのclass属性を外部から指定します。 指定しない場合は自動でユニークなClassがセットされます。

  - ### toString

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