org.opengion.hayabusa.taglib

## クラス ViewCalendarParamTag

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - javax.servlet.jsp.tagext.BodyTagSupport
    - - org.opengion.hayabusa.taglib.CommonTagSupport
      - - org.opengion.hayabusa.taglib.ViewParamImpl
        - - org.opengion.hayabusa.taglib.ViewCalendarParamTag

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

      public class ViewCalendarParamTag
      extends ViewParamImpl

       viewタグの viewFormType が HTMLCalendar の場合にパラメータを設定します。

       カレンダーを表示する、ViewForm_HTMLCalendar クラスに対して、各種パラメータを
       設定します。
       パラメータが設定されていない場合は、ViewCalendarParam の初期値が使用されます。
       (パラメータを使用するには、viewタグのuseParam 属性をtrueに設定する必要があります。)

  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：<og:calendarParam ymKey="YYYYMM" dayKey="DY" firstWeek="0" />
         ●body：なし

         ●Tag定義：
           <og:calendarParam
               viewKeys           【TAG】行のキーとなるカラム名を複数指定します(事業所やWCなど)
               ymKey              【TAG】行のキーとなる年月を表すカラム名を指定します
               dayKey             【TAG】日付け(休日フラグ)のキーとなるカラム名の英字部分を指定します(DY1 ～ DY31)
               valueKey           【TAG】データの値となるカラム名の英字部分を指定します(初期値は使用しません)
               valueBRFlag        【TAG】データの値を使用する場合に、日付けとの関係で、BR を入れるかどうか指定します
               firstWeek          【TAG】カレンダ表示の週の初めを指定します( 0は、日曜日から、1は月曜日から)
               headerLocale       【TAG】週表示ヘッダーを表示する時の、Locale(language のみ) を指定します
               columnSize         【TAG】カレンダを横に並べる場合の数量を指定します(初期値: 3)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例
             ViewFormTag の viewFormType が、ViewCalendarParam の場合に使用します。
             useParam 属性を設定しておかないと、使用されません。
             <og:view
                 viewFormType = "HTMLCalendar"
                 command      = "{@command}"
                 startNo      = "0"
                 pageSize     = "20"
                 useParam     = "true"
             >
                 <og:calendarParam
                      viewKeys     = "CDJGS"
                      ymKey        = "YYYYMM"
                      dayKey       = "DY"
                      valueKey     = ""
                      valueBRFlag  = "true"
                      firstWeek    = "0"
                      headerLocale = "en"
                      columnSize   = "3"
                 />
             </og:view >

  変更履歴:

    3.5.6.0 (2004/06/18) 新規作成

  機能分類
    画面表示
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドのサマリー

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

      `BR, BUFFER_MIDDLE, CR`

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

      `bodyContent`

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

      `id, pageContext`

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

      `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

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

      `EVAL_BODY_AGAIN`

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

      `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

  - ### コンストラクタのサマリー

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

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `protected java.lang.String` | `getTagName()` タグの名称を、返します。
    `void` | `setColumnSize(java.lang.String columnSize)` 【TAG】カレンダを横に並べる場合の数量を指定します(初期値: 3)。
    `void` | `setDayKey(java.lang.String dayKey)` 【TAG】日付け(休日フラグ)のキーとなるカラム名の英字部分を指定します(DY1 ～ DY31)。
    `void` | `setFirstWeek(java.lang.String firstWeek)` 【TAG】カレンダ表示の週の初めを指定します( 0は、日曜日から、1は月曜日から)。
    `void` | `setHeaderLocale(java.lang.String headerLocale)` 【TAG】週表示ヘッダーを表示する時の、Locale(language のみ) を指定します。
    `void` | `setValueBRFlag(java.lang.String valueBRFlag)` 【TAG】データの値を使用する場合に、日付けとの関係で、BR を入れるかどうか指定します。
    `void` | `setValueKey(java.lang.String valueKey)` 【TAG】データの値となるカラム名の英字部分を指定します(初期値は使用しません)。
    `void` | `setViewKeys(java.lang.String viewKeys)` 【TAG】行のキーとなるカラム名を複数指定(CSV形式)します(事業所やWCなど)。
    `void` | `setYmKey(java.lang.String ymKey)` 【TAG】行のキーとなる年月を表すカラム名を指定します。

    - ### クラスから継承されたメソッド 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, getCommonTagThrowable, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsg, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getSumRequestValue, 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`

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

      `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

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

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

      `getParent, setPageContext, setParent`

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

    - #### ViewCalendarParamTag

          public ViewCalendarParamTag()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### setViewKeys

          public void setViewKeys(java.lang.String viewKeys)

      【TAG】行のキーとなるカラム名を複数指定(CSV形式)します(事業所やWCなど)。
      パラメータ:
        `viewKeys` - 行カラム名 (CSV形式)
      説明:

             エンジン標準カレンダ(GE13)では、年月(YYYYMM)と事業所コード(CDJGS)
             でユニークキーになります。また、能力カレンダなどでは、事業所、ワークセンタ
             で、ユニークになります。
             それらのキー項目を編集できるように、カラムをCSV形式で指定します。

      変更履歴:

        3.5.6.0 (2004/06/18) 新規作成

    - #### setYmKey

          public void setYmKey(java.lang.String ymKey)

      【TAG】行のキーとなる年月を表すカラム名を指定します。
      パラメータ:
        `ymKey` - 行年月カラム
      説明:

             現カレンダーは、年月毎に、３１個の日付けフィールドを持ったデータを
             前提としています。工場や事業所などの区分は、取得時には確定させておく必要があります。
             初期値は、ViewCalendarParam に依存します。(例：YYYYMM)

    - #### setDayKey

          public void setDayKey(java.lang.String dayKey)

      【TAG】日付け(休日フラグ)のキーとなるカラム名の英字部分を指定します(DY1 ～ DY31)。
      パラメータ:
        `dayKey` - 日付カラム(英字)
      説明:

             カレンダーを表示する場合の、各日付け欄のカラム名の英字部分を指定します。
             現カレンダーは、年月毎に、３１個の日付けフィールドを持ったデータを
             前提としています。よって、このカラム名(英字部分)＋日付け(１～３１)を
             動的に作成して、日付けカラムとして取得します。
             例えば、"DY" という文字を指定した場合、DY1 ～ DY31 のカラム名を
             使用して、検索結果の DBTableModel より値を取得します。
             初期値は、ViewCalendarParam に依存します。(例：DY)

    - #### setValueKey

          public void setValueKey(java.lang.String valueKey)

      【TAG】データの値となるカラム名の英字部分を指定します(初期値は使用しません)。
      パラメータ:
        `valueKey` - 値カラム(英字) (初期値は使用しません)
      説明:

             カレンダーを表示する場合の、各日付け欄の値のカラム名の英字部分を指定します。
             現カレンダーは、年月毎に、３１個の値フィールドを持ったデータを
             前提としています。よって、このカラム名(英字部分)＋日付け(１～３１)を
             動的に作成して、値カラムとして取得します。
             例えば、"VAL" という文字を指定した場合、VAL1 ～ VAL31 のカラム名を
             使用して、検索結果の DBTableModel より値を取得します。
             初期値は、ViewCalendarParam に依存します。(例：使用していません)

    - #### setValueBRFlag

          public void setValueBRFlag(java.lang.String valueBRFlag)

      【TAG】データの値を使用する場合に、日付けとの関係で、BR を入れるかどうか指定します。
      パラメータ:
        `valueBRFlag` - 日付BRデータ制御 [true:BRを入れる/false:入れない]
      説明:

             データを表示する場合、日付けの横につけるか、日付けの下に付けるかを指定します。
             ただし、valueKey で、値カラムを指定した場合のみ、有効になります。
             初期値は、ViewCalendarParam に依存します。(例：true)

    - #### setFirstWeek

          public void setFirstWeek(java.lang.String firstWeek)

      【TAG】カレンダ表示の週の初めを指定します( 0は、日曜日から、1は月曜日から)。
      パラメータ:
        `firstWeek` - 開始週指定 [0:日曜/1:月曜…]
      説明:

             カレンダの週表示で、どの曜日から表示を始めるかを指定します。
             0は、日曜日から、1は月曜日から表示を開始します。
             初期値は、ViewCalendarParam に依存します。(例：0 日曜日から)

    - #### setHeaderLocale

          public void setHeaderLocale(java.lang.String headerLocale)

      【TAG】週表示ヘッダーを表示する時の、Locale(language のみ) を指定します。
      パラメータ:
        `headerLocale` - ヘッダー言語 [ja/en]
      説明:

             現実装では、"ja" と "en" のみ指定可能です。
             将来的には、SimpleDateFormat を使用し、多言語対応しますが、現段階では、
             (日、月、火、水、木、金、土)と、(SUN,MON,TUE,WED,THU,FRI,SAT)の
             ２種類を切り替えているだけです。
             どの曜日から表示を始めるかは、firstWeek 属性で設定します。
             初期値は、ViewCalendarParam に依存します。(例："en")

    - #### setColumnSize

          public void setColumnSize(java.lang.String columnSize)

      【TAG】カレンダを横に並べる場合の数量を指定します(初期値: 3)。
      パラメータ:
        `columnSize` - 横並び個数 (初期値:3)
      説明:

             カレンダを複数並べる場合の横方向の件数を指定します。
             １年を表す場合、３＊４ や ２＊６ のカレンダが一般的です。
             ここでは、横方向(３や２)の件数を指定することで、レイアウトを
             指定します。

      変更履歴:

        3.5.6.0 (2004/06/18) 新規作成

    - #### getTagName

          protected java.lang.String getTagName()

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

        4.0.0.0 (2005/01/31) 新規追加

      このメソッドは、nullを返しません

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.