2.1.55. コード値表示項目ウィジェット¶
コード値表示項目ウィジェット は Nablarchのコード管理機能から取得したラベルや値を他の入力項目と 並べて表示するウィジェットである。
なお、通常の変数に格納された値を表示する場合は 表示項目ウィジェット を使用すること。
2.1.55.1. コードサンプル¶
設計成果物(ローカル動作)
<field:label_code title = "ユーザIDロック"> </field:label_code>
実装成果物(サーバ動作)
<field:label_code title = "ユーザIDロック" name = "11AC_W11AC01.userIdLocked" codeId = "C0000001" pattern = "PATTERN01" optionColumnName = "OPTION01" labelPattern = "$OPTIONALNAME$" listFormat = "ul"> </field:code_label>
2.1.55.2. 仕様¶
- サーバ動作時の挙動
- codeId属性に指定したコード値の内容を表示する。 詳細は Nablarch標準タグライブラリの <n:code> タグの仕様を参照すること。
- ローカル動作時の挙動
sample に値を指定した場合はその内容を表示する。 ただし、codeId 属性にコードIDを指定した場合、下記のファイル内のエントリーから、 該当するコードの名称を取得し、表示する。 pattern 属性によるパターン指定や optionColumnName 属性によるオプション名称指定も利用できる。 (codeId と sample を両方指定した場合は sample の値を優先する。)
- パス
- /js/devtool/resource/コード値定義.js (ツールによってコード設計書から自動生成する。)
属性値一覧 [◎ 必須属性 ○ 任意属性 × 無効(指定しても効果なし)]
名称 | 内容 | タイプ | サーバ | ローカル | 備考 |
---|---|---|---|---|---|
title | 項目名 | 文字列 | ◎ | ◎ | |
name | 出力対象の値を変数スコープ から取得するための名前 | 文字列 | ◎ | × | |
sample | ローカル動作時に表示する文字列 | 文字列 | × | ○ | “|” 区切りで複数指定する。 “[]” で囲われた項目は選択状態 で表示される。 |
codeId | コード定義ID | 文字列 | ◎ | ○ | |
pattern | 使用するコードパターンの カラム名 | 文字列 | ○ | ○ | デフォルトは ‘PATTERN01’ |
optionColumnName | 取得するオプション名称の カラム名 | 文字列 | ○ | ○ | デフォルトは ‘OPTION01’ |
labelPattern | ラベル表示書式 | 文字列 | ○ | ○ | ラベルを整形するパターン。 プレースホルダを下記に示す。 $NAME$: コード値に対応するコード名称 $SHORTNAME$: コード値に対応するコードの略称 $OPTIONALNAME$: コード値に対応するコードのオプション名称 $OPTIONALNAME$を使用する場合は optionColumnName属性の指定が必須となる。 $VALUE$: コード値 デフォルトは”$NAME$”。 |
listFormat | リスト表示時に使用する フォーマット | 文字列 | ○ | ○ | デフォルトは ‘sp’ |
dataFrom | 表示するデータの取得元 | 文字列 | × | × | 画面項目定義に記載する、 「表示情報取得元」.「表示項目名」 の形式で設定する。 |
comment | コード値表示についての備考 | 文字列 | × | × | 設計書の表示時に、 画面項目定義の項目定義一覧で、 「備考」に表示される。 |
initialValueDesc | 初期表示内容に関する説明 | 文字列 | × | × | 設計書の表示時に、 画面項目定義の項目定義一覧で、 「備考」に表示される。 |
2.1.55.3. 内部構造・改修時の留意点¶
部品一覧
パス | 内容 |
---|---|
/WEB-INF/tags/widget/field/label_code.tag | コード値表示項目ウィジェット の実体となるタグファイル |
/js/jsp/taglib/nablarch.js | <n:code> のエミュレーション機能を実装する タグライブラリスタブJS |