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

# クラス OrderByTag

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

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

public class OrderByTag extends CommonTagSupport
ラジオボタンで表示順(Order By 句)を指定するタグです。 name 属性値は、 "ORDER_BY" 固定です。 columns 属性は、CSV形式のカラム属性を設定します。 ロケールは、ユーザー情報の lang 属性を初期値で使用し、 セットされていない場合は、 リクエスト情報のロケールから取得します。

関連項目:
  - 直列化された形式
変更履歴:
  3.1.4.0 (2003/04/18) 継承元を、CommonTagSupport に変更。
機能分類
  画面部品
形式ｻﾝﾌﾟﾙ:
  ●形式：<og:orderBy columns="…" /> ●body：なし ●Tag定義： <og:orderBy columns ○【TAG】表示順対象のカラムをCSV形式で複数指定します(必須)。 checked 【TAG】初めからチェックされた状態(checked)で表示します(初期値:null) lbls 【TAG】ラベルをCSV形式で複数指定します checkedValue 【TAG】初めからチェックされた状態にする値を指定します(初期値:null) caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) caseIf 【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) /> ●使用例 <og:orderBy columns="PN,YOBI" checked="checked" /> <og:orderBy columns="YOBI,PN" /> <og:orderBy columns="MKNM,YOBI" />
導入されたバージョン:
  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`

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

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

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `int`
  `doEndTag()`
  Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
  `protected String`
  `makeTag()`
  検索条件の入力用のテキストフィールドを作成します。
  `protected void`
  `release2()`
  タグリブオブジェクトをリリースします。
  `void`
  `setChecked(String ch)`
  【TAG】初めからチェックされた状態(checked)で表示します(初期値:null)。
  `void`
  `setCheckedValue(String ch)`
  【TAG】初めからチェックされた状態にする値を指定します(初期値:null)。
  `void`
  `setColumns(String columns)`
  【TAG】表示順対象のカラムをCSV形式で複数指定します。
  `void`
  `setLbls(String lbls)`
  【TAG】ラベルをCSV形式で複数指定します。
  `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`

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

  - ### OrderByTag

    public OrderByTag()
    デフォルトコンストラクター
    変更履歴:
      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`
    戻り値:
      後続処理の指示
    変更履歴:
      3.1.4.1 (2003/04/21) HTMLTagSupport の継承を廃止した為、doEndTag() を追加。, 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応

  - ### release2

    protected void release2()
    タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
    オーバーライド:
      `release2` クラス内 `CommonTagSupport`
    変更履歴:
      2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加, 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。

  - ### makeTag

    protected String makeTag()
    検索条件の入力用のテキストフィールドを作成します。 テーブルタグによりフィールドは分割されます。 使用時は、テーブルタグを前後に使用して下さい。
    戻り値:
      入力用のテキストフィールドタグ
    変更履歴:
      3.1.1.0 (2003/03/28) radio ボタン等で、ラベルをクリックしても値をセットできるようにする。, 7.0.1.2 (2018/11/04) StringBuilder で、若干の見直し
    このﾒｿｯﾄﾞは、nullを返しません

  - ### setColumns

    public void setColumns(String columns)
    【TAG】表示順対象のカラムをCSV形式で複数指定します。
    パラメータ:
      `columns` - カラム(CSV形式)
    説明:
      表示順対象のカラムを指定します。

  - ### setChecked

    public void setChecked(String ch)
    【TAG】初めからチェックされた状態(checked)で表示します(初期値:null)。
    パラメータ:
      `ch` - チェック指定 [checked:チェックされた状態で表示/その他:なにもしない]
    説明:
      check 値が "checked" の場合のみ、実行されます。

  - ### setCheckedValue

    public void setCheckedValue(String ch)
    【TAG】初めからチェックされた状態にする値を指定します(初期値:null)。
    パラメータ:
      `ch` - チェックされた状態にする値
    説明:
      チェックバリューが、自分自身のカラム名と同じであれば、チェックがつきます。 通常、checkedValue = "{@ORDER_BY}" で、自動的にチェックされます。

  - ### setLbls

    public void setLbls(String lbls)
    【TAG】ラベルをCSV形式で複数指定します。
    パラメータ:
      `lbls` - 複数ラベルID(CSV形式)
    変更履歴:
      3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得, 5.2.2.0 (2010/11/01) setMsglbl 廃止 ⇒ setLbl に置換え, 6.4.3.4 (2016/03/11) CSV形式の文字連結を、stream 経由で行います。
    説明:
      ラベル(複数)を変更するときに、lbls属性を使います。 シングルラベルの lbl 属性との違いは,ここではラベルを複数 CSV形式で 渡すことが可能であることです。これにより、"A,B,C" という値に対して、 "Aのラベル表示,Bのラベル表示,Cのラベル表示" という具合に文字列を 再合成します。 これは、SQL文のOrder By 句で、ソート順を指定する場合などに便利です。

  - ### toString

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