クラス QueryButtonTag

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

public class QueryButtonTag extends HTMLTagSupport
query.jsp での検索ボタンを表示します。 検索ボタン以外に、pageSize、maxRowCount、prevNext、timeView などの 項目も表示可能です。 また、BODY部に登録した値は、table 要素として、td 部に追記されます。
関連項目:
変更履歴:
4.0.0.0 (2005/01/31) 新規作成, 5.7.1.0 (2013/12/06) HTMLTagSupport を継承し、ボタンに付ける属性を増やします。, 7.3.2.3 (2021/04/09) システム定数のICON_DIRやIMAGE_DIRを使用します。, 8.2.0.2 (2022/06/24) HTML5廃止対応
機能分類
画面制御
形式サンプル:
●形式:<og:queryButton /> ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します) ●Tag定義: <og:queryButton command 【TAG】リクエストとして送信するコマンドを指定します(初期値:NEW) pageSize 【TAG】pageSize プルダウンメニューの初期値を指定します (初期値:HTML_PAGESIZE[=100]) maxRowCount 【TAG】maxRowCount プルダウンメニューの初期値を指定します (初期値:DB_MAX_ROW_COUNT[=1000]) type 【TAG】典型的なボタンの形状に設定します(初期値:null) scope 【TAG】リクエストとして送信するスコープを指定します(初期値:null) lbl 【TAG】ラベルリソースのラベルIDを指定します accesskey 【TAG】検索ボタンに使用するショートカットキー文字を指定します(初期値:F) clearAccesskey 【TAG】クリアボタンに使用するショートカットキー文字を指定します(初期値:C) usePrevNext 【TAG】進む/戻るのprev_next リンクを表示するかどうかを指定します(初期値:true) usePageSize 【TAG】pageSize 引数を使用するかどうかを指定します(初期値:true) useRowCount 【TAG】maxRowCount 引数を使用するかどうかを指定します(初期値:true) useTimeView 【TAG】処理時間を表示する TimeView を表示するかどうかを指定します (初期値:VIEW_USE_TIMEBAR[=])。 useDummy 【TAG】IE用ダミーinputを出力するかどうか 8.5.3.0 (2023/09/08) 廃止 useEditMenu 【TAG】編集プルダウンを出すかどうか(初期値:true) blockUIMsg 【TAG】検索中表示を画面上に表示するメッセージリソースIDを指定します (初期値:MSG0090(検索中です・・・)) 6.4.8.0 (2016/06/24) title 【HTML】要素に対する補足的情報(title)を設定します disabled 【HTML】その部品に対して、選択や変更が出来ないように(disabled)指定します(サーバーに送信されない) clazz 【HTML】要素に対して class 属性を設定します autofocus 【HTML5】指定した入力欄にカーソルが当たって自動的にフォーカスされます。 useClear 【TAG】JavaScriptによる初期化(クリア)ボタンを使用するかどうか[true/false/none]を指定します(初期値:true) 6.4.3.4 (2016/03/11) clearTarget 【TAG】useClear=true時のターゲット名(フレーム名)を指定します(初期値:QUERY) 5.9.21.1 (2017/06/16) clearHref 【TAG】useClear=true時の遷移先JSPを指定します(初期値:query.jsp) 5.9.21.1 (2017/06/16) clearCommand 【TAG】useClear=true時のcommandを指定します(初期値:NEW) 5.9.21.1 (2017/06/16) clearKeys 【TAG】useClear=true時の遷移先に渡すキーをCSV形式で複数指定します 7.0.3.0 (2019/05/13) clearVals 【TAG】useClear=true時の遷移先に渡す値をCSV形式で複数指定します 7.0.3.0 (2019/05/13) useAttStrict 【TAG】XHTMLTag に指定されている Attributes のみ使えるかどうか [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:queryButton> 【廃止】6.4.3.4 (2016/03/11) つづり間違いを訂正。useCrear → useClear。 // useCrear 【TAG】JavaScriptによる初期化(クリア)ボタンを使用するかどうか[true/false/none]を指定します(初期値:true) ●使用例 <og:queryButton command = "NEW" NEW:通常の検索(初期値)/ENTRY:エントリ登録時 type = "ENTRY" null:標準 , SELECT:検索ボタンのみ , ENTRY:登録ボタンのみ pageSize = "100" pageSize の初期値設定(初期値:HTML_PAGESIZE) maxRowCount = "100" maxRowCount の初期値設定(初期値:DB_MAX_ROW_COUNT) useClear = "true" true:JavaScriptによる初期化(クリア)/false:通常のresetボタン/none:表示しない scope = "request" null(初期値)/session:セッション登録/request:リクエスト登録 lbl = "MSG0010" 検索ボタンに表示するメッセージID(初期値:MSG0010) accesskey = "F" ショートカットキー文字(初期値:F) usePrevNext = "true" Prev-Nextリンクを使用するかどうか(初期値:true) usePageSize = "true" pageSize 引数を使用するかどうか(初期値:true) useRowCount = "true" maxRowCount 引数を使用するかどうか(初期値:true) useTimeView = "true" timeView表示(実行時間表示)を使用するかどうか(初期値:VIEW_USE_TIMEBAR) useEditMenu = "true" 編集プルダウンを出すかどうか(初期値:true) /> 標準的な検索ボタン <og:queryButton /> 標準的な登録ボタン(command="NEW" で、query.jsp で使用するボタン) <og:queryButton type="ENTRY" /> BODY 部に追加要素を表示 <og:queryButton> <td><jsp:directive.include file="/jsp/common/timeViewImage.jsp" /></td> </og:queryButton> 7.4.2.1 (2021/05/21) システム定数 USE_ACCESSKEY を false に設定すると、accesskey は使用されません。
導入されたバージョン:
JDK5.0,
  • コンストラクタの詳細

    • QueryButtonTag

      public QueryButtonTag()
      デフォルトコンストラクター
      変更履歴:
      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_BUFFERED )
      変更履歴:
      6.3.4.0 (2015/08/01) caseKey,caseVal,caseNN,caseNull,caseIf 属性対応
    • doAfterBody

      public int doAfterBody()
      Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
      定義:
      doAfterBody インタフェース内 IterationTag
      オーバーライド:
      doAfterBody クラス内 CommonTagSupport
      戻り値:
      後続処理の指示(SKIP_BODY)
      変更履歴:
      2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更, 3.0.0.0 (2002/12/25) StringUtil#changeString 廃止, 3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。
    • doEndTag

      public int doEndTag()
      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
      doEndTag インタフェース内 Tag
      オーバーライド:
      doEndTag クラス内 HTMLTagSupport
      戻り値:
      後続処理の指示
      変更履歴:
      5.3.6.0 (2011/06/01) 集計、合計などのEdit機能に対応します。, 5.6.5.1 (2013/06/14) debugプルダウンの追加。ついでに、PageSize と MaxRowCount の 表示条件を、整備します。, 5.6.9.4 (2013/10/31) editNameの初期値を外部から与えられるようにする, 5.7.1.0 (2013/12/06) HTMLTagSupportを継承する為、メソッドを、getSubmit() ⇒ makeTag() に変更, 5.7.1.2 (2013/12/20) USE_DEFAULT_EDITNAMEでeditNameの初期値変更, 5.7.5.0 (2014/04/04) useEditMenu 追加, 5.7.6.2 (2014/05/16) IEのHTML5機能が有効か無効かの判定値を飛ばす、hidden タグを作成します。, 6.3.4.0 (2015/08/01) caseKey,caseVal,caseNN,caseNull,caseIf 属性対応, 6.4.5.0 (2016/04/08) UserInfo のEditConfig関連機能を、DBEditConfigManagerに移植します。, 5.9.12.0 (2016/09/02) tableのframe属性を削除する, 6.9.2.1 (2018/03/12) DBEditConfigManagerを直接取り出す処理を、廃止します。, 8.2.0.2 (2022/06/24) HTML5廃止対応, 8.5.2.0 (2023/07/14) 一部の機能廃止による修正(問合・トラブル 0200010980), 8.5.3.0 (2023/09/08) IE用のuseDummy属性廃止(問合・トラブル 0200011488)
    • release2

      protected void release2()
      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
      release2 クラス内 HTMLTagSupport
      変更履歴:
      5.6.1.0 (2013/02/01) useDummy 追加, 5.7.5.0 (2014/04/04) useEditMenu 追加, 6.3.6.0 (2015/08/16) useTimeView の初期値を、VIEW_USE_TIMEBAR にする。, 6.4.0.5 (2016/01/09) true/false に加えて、none:表示しない を追加。, 6.4.8.0 (2016/06/24) blockUIMsg を追加。 検索中です・・・, 5.9.21.1 (2017/06/16) clearTarget , clearHref , clearCommand追加, 6.9.5.0 (2018/04/23) USE_DUMMY_INPUT 廃止(false固定), 7.0.3.0 (2019/05/13) clearKeys , clearVals属性を追加, 8.5.3.0 (2023/09/08) IE用のuseDummy属性廃止(問合・トラブル 0200011488)
    • makeTag

      protected String makeTag()
      サブミットボタンを作成します。
      定義:
      makeTag クラス内 HTMLTagSupport
      戻り値:
      サブミットボタン
      変更履歴:
      5.3.6.0 (2011/06/01) accessKeyを削除できるように対応, 5.5.7.1 (2012/10/05) 不要な括弧出力を削除, 5.6.9.3 (2013/10/25) IDを出力する, 5.7.1.0 (2013/12/06) HTMLTagSupportを継承する為、メソッドを、getSubmit() ⇒ makeTag() に変更, 6.2.2.0 (2015/03/27) 互換モード/ネイティブモード対応。検索ボタンをbutton→input に変更, 6.4.8.0 (2016/06/24) blockUIMsg を追加。 検索中です・・・, 7.4.2.1 (2021/05/21) accesskey の設定の有効(true)/無効(false)を設定, 8.0.2.0 (2021/11/30) useAccessKey → USE_ACCESSKEY 変更
      このメソッドは、nullを返しません
    • setCommand

      public void setCommand(String cmd)
      【TAG】リクエストとして送信するコマンドを指定します(初期値:NEW)。
      パラメータ:
      cmd - 送信するコマンド
      説明:
      NEW:通常の検索(初期値)/ENTRY:エントリ登録時
    • setPageSize

      public void setPageSize(String pSize)
      【TAG】pageSize プルダウンメニューの初期表示件数を指定します (初期値:HTML_PAGESIZE[=])。
      パラメータ:
      pSize - 表示件数
      関連項目:
      説明:
      プルダウンメニューを表示する場合の初期値を指定します。 (初期値:ユーザー定数のHTML_PAGESIZE[=])。
    • setMaxRowCount

      public void setMaxRowCount(String maxSize)
      【TAG】maxRowCount プルダウンメニューの初期値を指定します (初期値:DB_MAX_ROW_COUNT[=])。
      パラメータ:
      maxSize - 最大件数
      関連項目:
      説明:
      プルダウンメニューを表示する場合のmaxRowCountの初期値を指定します。 (初期値:ユーザー定数のDB_MAX_ROW_COUNT[=])。
    • setType

      public void setType(String tp)
      【TAG】典型的なボタンの形状に設定します(初期値:null)。
      パラメータ:
      tp - タイプ指定 [null/SELECT/ENTRY]
      変更履歴:
      6.4.0.5 (2016/01/09) accesskey="" が効かなかったので、対応。, 7.4.2.1 (2021/05/21) accesskey の設定の有効(true)/無効(false)を設定, 8.0.2.0 (2021/11/30) useAccessKey → USE_ACCESSKEY 変更
      説明:
      クエリーボタンでは、検索ボタン以外に、pageSize、maxRowCount、 prevNext、timeView などの項目も表示可能です。 これらを、個別に設定可能ですが、通常使用するタイプとして、3タイプを 用意します。これは、設定状態の初期値といえます。 null :通常の検索ボタンで、フル装備の指定です。 SELECT:1件のみ検索するようなケースで使用します。 検索ボタンとクリアボタンのみを表示します。 ENTRY :いきなり登録するようなケースで使用します。 登録ボタンとクリアボタンのみを表示します。(command="NEW" です。)
    • setScope

      public void setScope(String scp)
      【TAG】リクエストとして送信するスコープを指定します(初期値:null)。
      オーバーライド:
      setScope クラス内 CommonTagSupport
      パラメータ:
      scp - スコープ [session:セッション登録/request:リクエスト登録]
      関連項目:
      説明:
      リクエスト時に、付与する引数情報のうちの、スコープを指定します。 これは、検索専用画面の場合は、scope="request" にする事で、メモリの 無駄な確保を行わずに、検索結果を表示できます。 ただし、その結果に対して、NEXT-PREV や、ヘッダーソートリンクなどの 機能が使えなくなります。 通常は、何も指定しない状態(null)で、RESULT画面の設定に任せるのが良いでしょう。 初期値は、null = session(セッション登録) です。
    • setAccesskey

      public void setAccesskey(String accsKey)
      【TAG】検索ボタンに使用するショートカットキー文字を指定します(初期値:F)。
      オーバーライド:
      setAccesskey クラス内 HTMLTagSupport
      パラメータ:
      accsKey - ショートカットキー文字(初期値:F)
      変更履歴:
      5.3.6.0 (2011/06/01) accessKeyを削除できるように対応, 5.6.0.3 (2012/01/24) getRequestParameter を何度も呼んでいるので修正。, 7.4.2.1 (2021/05/21) accesskey の設定の有効(true)/無効(false)を設定, 8.0.2.0 (2021/11/30) useAccessKey → USE_ACCESSKEY 変更
      説明:
      ボタンを、Alt-XX で実行できるようにするショートカットキーを設定します。 標準では、検索ボタンは、"F" に設定していますので、Alt-F となります。 ゼロ文字列を指定すると、ショートカットキーなしに設定できます。 初期値は、Find の "F" です。 7.4.2.1 (2021/05/21) システム定数 USE_ACCESSKEY を false に設定すると、accesskey は使用されません。
    • setClearAccesskey

      public void setClearAccesskey(String accsKey)
      【TAG】クリアボタンに使用するショートカットキー文字を指定します(初期値:C)。
      パラメータ:
      accsKey - クリアボタンのショートカットキー文字(初期値:C)
      変更履歴:
      5.3.6.0 (2011/06/01) accessKeyを削除できるように対応, 5.6.0.3 (2012/01/24) getRequestParameter を何度も呼んでいるので修正。, 7.4.2.1 (2021/05/21) accesskey の設定の有効(true)/無効(false)を設定, 8.0.2.0 (2021/11/30) useAccessKey → USE_ACCESSKEY 変更
      説明:
      ボタンを、Alt-XX で実行できるようにするショートカットキーを設定します。 標準では、検索ボタンは、"C" に設定していますので、Alt-C となります。 ゼロ文字列を指定すると、ショートカットキーなしに設定できます。 初期値は、Clear の "C" です。 7.4.2.1 (2021/05/21) システム定数 USE_ACCESSKEY を false に設定すると、accesskey は使用されません。
    • setUsePrevNext

      public void setUsePrevNext(String flag)
      【TAG】進む/戻るのprev_next リンクを表示するかどうかを指定します(初期値:true)。
      パラメータ:
      flag - prev_nextリンク表示 [true:する/false:しない]
      説明:
      進む/戻るリンクは、RESULT画面にコマンド (FIRST,PREV,NEXT,LAST) という コマンドを送る事で実現している画像リンクです。 PREV_NEXT が存在しない画面では、消去しておく必要があります。 初期値は、true(表示する)です。
    • setUsePageSize

      public void setUsePageSize(String flag)
      【TAG】pageSize 引数を使用するかどうかを指定します(初期値:true)。
      パラメータ:
      flag - pageSize引数使用 [true:する/false:しない]
      関連項目:
      説明:
      pageSize 引数は、RESULT画面のviewタグで使用する 一回の表示に 何件のデータを表示させるかを指定する引数です。 この件数が多いと、多くのデータを見ることが出来ますが、その分表示が 遅くなります。逆に、少ないと、PREV_NEXT を多用することになり、 目的の行を探し出しにくくなります。 pageSize の値は、pageSizeパラメータで画面単位に指定するか、システム パラメータの HTML_PAGESIZE でシステム単位に指定できます。 初期値は、true(使用する)です。
    • setUseRowCount

      public void setUseRowCount(String flag)
      【TAG】maxRowCount 引数を使用するかどうかを指定します(初期値:true)。
      パラメータ:
      flag - maxRowCount引数使用 [true:する/false:しない]
      関連項目:
      説明:
      maxRowCount 引数は、RESULT画面のqueryタグで使用する 一回の検索時に 何件のデータを取得させるかを指定する引数です。 この件数が多いと、多くのデータを検索することが出来ますが、その分表示が 遅くなります。逆に、少ないと、目的の行まで探し出せないかもしれません。 maxRowCount の値は、rowCountパラメータで画面単位に指定するか、システム パラメータの DB_MAX_ROW_COUNT でシステム単位に指定できます。 初期値は、true(使用する)です。
    • setUseTimeView

      public void setUseTimeView(String flag)
      【TAG】処理時間を表示する TimeView を表示するかどうか[true:する/false:しない]を指定します (初期値:VIEW_USE_TIMEBAR[=])。
      パラメータ:
      flag - 処理時間を表示 [true:する/false:しない]
      変更履歴:
      6.3.6.0 (2015/08/16) useTimeView の初期値を、VIEW_USE_TIMEBAR にする。
      説明:
      true に設定すると、処理時間を表示するバーイメージが表示されます。 これは、DB検索、APサーバー処理、画面表示の各処理時間をバーイメージで 表示させる機能です。処理時間の目安になります。 (初期値:VIEW_USE_TIMEBAR[=])。
    • setUseEditMenu

      public void setUseEditMenu(String flag)
      【TAG】query画面等で編集プルダウンを出力するかどうか[true:する/false:しない]を指定します(初期値:true)。
      パラメータ:
      flag - 編集メニュー出力 [true:する/false:しない]
      関連項目:
      変更履歴:
      5.7.5.0 (2014/04/04) 新規追加
      説明:
      falseを指定すると編集プルダウンを出さない。 popup画面等、画面ID単位では編集機能は使うが、部分的に使いたくない場合に タグのパラメータとして個別に指定できるようにします。 初期値は、互換性の関係から、編集プルダウンを出力する(=true)です。
    • setBlockUIMsg

      public void setBlockUIMsg(String id)
      【TAG】検索ボタンを押下した際に表示されるメッセージリソースIDを指定します (初期値:MSG0090[検索中です・・・])。
      パラメータ:
      id - 検索中ですメッセージID
      変更履歴:
      6.4.8.0 (2016/06/24) blockUIMsg を追加。 検索中です・・・
      説明:
      headタグのuseBlockUI=true のときに、検索ボタンを押下すると、「検索中です・・・」と表示されます。 このメッセージのリソースIDを指定します。 表示させたくない場合は、blockUIMsg = "" をセットするか、headタグのuseBlockUI=false をセットしてください。
    • setUseClear

      public void setUseClear(String flag)
      【TAG】JavaScriptによる初期化(クリア)ボタンを使用するかどうか[true/false/none]を指定します(初期値:true)。
      パラメータ:
      flag - JavaScriptによる初期化ボタン使用可否 [true:JavaScript初期化ボタン/false:通常のresetボタン]
      変更履歴:
      6.4.0.5 (2016/01/09) true/false に加えて、none:表示しない を追加。, 6.4.3.4 (2016/03/11) つづり間違いを訂正。useCrear → useClear。
      説明:
      通常の初期化(クリア)ボタンでは、HTMLが作成された状態に戻すだけです。 例えば、引数付きで設定された場合、その引数が設定されている状態へ戻します。 このJavaScriptによる初期化ボタンの場合(trueの場合)は、JavaScriptにより INIT状態でもう一度QUERYフレームを呼び出しますので、指定された引数もクリアされます。 none を指定すると、クリアボタンを表示しません。 true: JavaScriptによる初期化ボタン(すべての引数がクリアされます) false: HTMLによる RESET処理(type="reset" のinputタグが出力されます。) none: クリアボタンを表示しません。 (※ 6.4.0.5 (2016/01/09) 以降 ) 初期値は、true:JavaScriptによる初期化です。
    • setClearTarget

      public void setClearTarget(String tgt)
      【TAG】useClear時のターゲットを指定します(初期値=QUERY)。
      パラメータ:
      tgt - ターゲット名
      変更履歴:
      5.9.21.1 (2017/06/16) 新規追加
      説明:
      useClearをtrueにしている場合、window.openを利用した初期化を行います。 この際に検索部分の名称がQUERY以外の場合にこの属性で指定します。 初期値はQUERYです。
    • setClearHref

      public void setClearHref(String page)
      【TAG】useClear時の遷移先を指定します(初期値=query.jsp)。
      パラメータ:
      page - 遷移先
      変更履歴:
      5.9.21.1 (2017/06/16) 新規追加
      説明:
      useClearをtrueにしている場合、window.openを利用した初期化を行います。 この際に検索画面のURLがquery.jspでない場合にこの属性で指定します。 また、query.jsp でも、特定の値を再設定したい場合、query.jsp?KEY=VALUE という 記述が可能です。指定のキーだけ、クリアしないということが出来るようになります。 初期値はquery.jspです。
    • setClearCommand

      public void setClearCommand(String cmd)
      【TAG】useClear時のcommandを指定します(初期値=NEW)。
      パラメータ:
      cmd - コマンド
      変更履歴:
      5.9.21.1 (2017/06/16) 新規追加
      説明:
      useClearをtrueにしている場合、window.openを利用した初期化を行います。 この際に読み込む画面に対してcommand=NEW以外を送信したい場合にこの属性で指定します。 初期値はNEWです。
    • setClearKeys

      public void setClearKeys(String key)
      【TAG】useClear=true時の遷移先に渡すキーをCSV形式で複数指定します。
      パラメータ:
      key - キー(CSV形式)
      変更履歴:
      7.0.3.0 (2019/05/13) clearKeys , clearVals属性を追加
      説明:
      遷移先に渡すキーを指定します。 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
    • setClearVals

      public void setClearVals(String val)
      【TAG】useClear=true時の遷移先に渡す値をCSV形式で複数指定します。
      パラメータ:
      val - 値(CSV形式)
      変更履歴:
      7.0.3.0 (2019/05/13) clearKeys , clearVals属性を追加
      説明:
      遷移先に渡す値を指定します。 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 keys,vals を使用すると、URLエンコードされます。
    • toString

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