概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.1.3.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.opengion.hayabusa.resource
クラス LabelData

    java.lang.Object
      org.opengion.hayabusa.resource.LabelData

すべての実装されたインタフェース:
  LabelInterface

    public final class LabelData

extends Object
implements LabelInterface

systemId , lang に対応したラベルデータを作成します。 ラベルデータは、項目(CLM)に対して、各種ラベル情報を持っています。 従来のラベルは、表示名称として、一種類しか持っていませんでしたが、 ラベルデータは、３種類の名称と、１種類の概要を持っています。 label : 名称(長) 従来のラベルと同じで定義された文字そのものです。 shortLabel : 名称(HTML短) 概要説明をバルーン表示する短い名称です。 longLabel : 名称(HTML長) 概要説明をバルーン表示する長い名称です。 description : 概要説明 カラムの説明やバルーンに使用します。 名称(HTML長)は、従来の表示名称にあたります。これは、一般的なラベルとして 使用されます。名称(HTML短)は、テーブル一覧のヘッダーの様に、特殊なケースで、 簡略化された名称を使用するときに利用されます。この切り替えは、自動で判断されます。 名称(HTML短)に、なにも設定されていない場合は、名称(HTML長)が自動的に使用されますので 初期データ移行時には、そのまま、通常時もテーブルヘッダー時も同じ文字列が 使用されます。 ただし、一覧表示のうち、EXCEL出力などのデータには、名称(長)が使用されます。 これは、名称(HTML短)や名称(HTML長)は、Tips表示を行う為のHTML構文を採用している為 テキスト等に出力するには不適切だからです。また、EXCEL等のツールでは、ラベル名が 長くてもセル幅等で調整できる為、簡略化された名称よりも正式名称で出力します。 ラベルデータを作成する場合は、同一ラベルで、作成区分(KBSAKU)違いの場合は、 最も大きな作成区分を持つコードを使用します。 作成区分(KBSAKU)は、0:システム予約、1:アプリ設定、2:ユーザー設定 という具合に カスタマイズの度合いに応じて大きな数字を割り当てることで、キー情報を上書き修正 することが可能になります。（削除することは出来ません。）

機能階層
  リソース管理
変更履歴:

  4.0.0 (2004/12/31) 新規作成

バージョン
  4.0
作成者
  Kazuhiko Hasegawa
導入されたバージョン:
  JDK5.0,

フィールドの概要
`static int` | `CLM` 内部データのカラム番号 0
`static int` | `DATA_SIZE` 内部データのカラム数 4
`static int` | `DESCRIPTION` 内部データのカラム番号 3
`static int` | `FG_LOAD` リソース読み込みのために一時利用 4.3.5.7 (2009/03/22)
`static int` | `LNAME` 内部データのカラム番号 2
`static int` | `SNAME` 内部データのカラム番号 1

コンストラクタの概要
`LabelData(String inkey)` null LabelData オブジェクトを作成します。
`LabelData(String[] data)` 配列文字列のデータを元に、LabelDataオブジェクトを構築します。

メソッドの概要
`String` | `getDescription()` ラベルオブジェクトの概要説明を返します。
`String` | `getDescription(String[] vals)` ラベルオブジェクトの概要説明を返します。
`String` | `getKey()` ラベルオブジェクトのキーを返します。
`String` | `getLabel()` ラベルオブジェクトの名称を返します。
`String` | `getLongLabel()` ラベルオブジェクトの名称(長)を返します。
`String` | `getLongLabel(String title)` ラベルインターフェースの名称(長)を返します。
`String` | `getMessage(String[] vals)` ラベルインターフェースの引数付きメッセージを返します。
`String` | `getRawShortLabel()` ラベルオブジェクトの名称(短)をspanタグを付けない状態で返します。
`String` | `getShortLabel()` ラベルオブジェクトの名称(短)を返します。
`boolean` | `isOfficial()` リソースＤＢから作成されたかどうかを返します。
`String` | `toString()` オブジェクトの識別子として，詳細なユーザー情報を返します。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

フィールドの詳細

### CLM

    public static final int CLM

  内部データのカラム番号 0

  関連項目:
    定数フィールド値

### SNAME

    public static final int SNAME

  内部データのカラム番号 1

  関連項目:
    定数フィールド値

### LNAME

    public static final int LNAME

  内部データのカラム番号 2

  関連項目:
    定数フィールド値

### DESCRIPTION

    public static final int DESCRIPTION

  内部データのカラム番号 3

  関連項目:
    定数フィールド値

### DATA_SIZE

    public static final int DATA_SIZE

  内部データのカラム数 4

  関連項目:
    定数フィールド値

### FG_LOAD

    public static final int FG_LOAD

  リソース読み込みのために一時利用 4.3.5.7 (2009/03/22)

  関連項目:
    定数フィールド値

コンストラクタの詳細

### LabelData

    LabelData(String inkey)

  null LabelData オブジェクトを作成します。 このオブジェクトは、ＤＢリソース上に存在しない場合に使用される null 情報を表す、LabelData オブジェクトです。

  パラメータ:
    `inkey` - String キー情報

### LabelData

    LabelData(String[] data)

  配列文字列のデータを元に、LabelDataオブジェクトを構築します。 このコンストラクタは、他のパッケージから呼び出せないように、 パッケージプライベートにしておきます。 このコンストラクタは、ＤＢリソースファイルを想定しています。

  パラメータ:
    `data` - String[] CLM,SNAME,LNAME,DESCRIPTION

メソッドの詳細

### getKey

    public String getKey()

  ラベルオブジェクトのキーを返します。

  定義:
    インタフェース `LabelInterface` 内の `getKey`
  戻り値:
    key ラベルオブジェクトのキー

### getLabel

    public String getLabel()

  ラベルオブジェクトの名称を返します。 これは、ＤＢ上の LNAME(名称(長))に該当します。

  定義:
    インタフェース `LabelInterface` 内の `getLabel`
  戻り値:
    label ラベルオブジェクトの名称(短)

### getShortLabel

    public String getShortLabel()

  ラベルオブジェクトの名称(短)を返します。 概要説明がない場合でかつＤＢ上のSNAMEが未設定の場合は、 LNAME が返されます。SNAMEが設定されている場合は、 ツールチップにLNAME が表示されます。 概要説明が存在する場合は、ツールチップに概要説明が 表示されます。

  定義:
    インタフェース `LabelInterface` 内の `getShortLabel`
  戻り値:
    shortLabel ラベルオブジェクトの名称(短)

### getLongLabel

    public String getLongLabel()

  ラベルオブジェクトの名称(長)を返します。 概要説明が存在する場合は、ツールチップに概要説明が 表示されます。

  定義:
    インタフェース `LabelInterface` 内の `getLongLabel`
  戻り値:
    longLabel ラベルオブジェクトの名称(長)
  関連項目:
    `getLongLabel( String )`

### getLongLabel

    public String getLongLabel(String title)

  ラベルインターフェースの名称(長)を返します。 ツールチップに表示するタイトル属性(概要説明)を置き換えます。 null の場合は、既存のgetLongLabel()を返します。

  定義:
    インタフェース `LabelInterface` 内の `getLongLabel`
  パラメータ:
    `title` - String ツールチップに表示するタイトル属性
  戻り値:
    shortLabel ラベルインターフェースの名称(長)
  関連項目:
    `getLongLabel()`

### getMessage

    public String getMessage(String[] vals)

  ラベルインターフェースの引数付きメッセージを返します。 メッセージの引数部分に、文字列配列を適用して、MessageFormat で変換した結果を返します。(MessageData でのみ有効です。)

  定義:
    インタフェース `LabelInterface` 内の `getMessage`
  戻り値:
    label ラベルインターフェースの引数付きメッセージ
  変更履歴:

    4.0.0 (2007/10/17) メッセージリソース統合に伴い、MessageDataより移行
    4.3.8.0 (2009/08/01) 引数にHTMLサニタイジング処理
    5.0.0.2 (2009/09/15) サニタイジング処理をやめる

### getDescription

    public String getDescription()

  ラベルオブジェクトの概要説明を返します。 概要説明が存在する場合は、ラベルのツールチップに 概要説明が表示されます。

  定義:
    インタフェース `LabelInterface` 内の `getDescription`
  戻り値:
    description ラベルオブジェクトの概要説明

### getDescription

    public String getDescription(String[] vals)

  ラベルオブジェクトの概要説明を返します。 このメソッドでは{0},{1}...をパラメータで置換します。

  定義:
    インタフェース `LabelInterface` 内の `getDescription`
  パラメータ:
    `vals` - パラメータ
  戻り値:
    description ラベルオブジェクトの概要説明
  変更履歴:

    4.3.7.6 (2009/07/15) 新規作成
    4.3.8.0 (2009/08/01) 引数にHTMLサニタイジング処理
    5.0.0.2 (2009/09/15) サニタイジング処理をやめる

### isOfficial

    public boolean isOfficial()

  リソースＤＢから作成されたかどうかを返します。 正式な場合は、true / リソースになく、独自に作成された場合は、false になります。

  定義:
    インタフェース `LabelInterface` 内の `isOfficial`
  戻り値:
    official リソースＤＢから作成されたかどうか

### getRawShortLabel

    public String getRawShortLabel()

  ラベルオブジェクトの名称(短)をspanタグを付けない状態で返します。 SNAMEが未設定の場合は、LNAME が返されます。

  戻り値:
    rawShortLabel ラベルオブジェクトの名称(短)にspanタグを付けない状態
  変更履歴:

    4.3.8.0 (2009/08/01) 追加

### toString

    public String toString()

  オブジェクトの識別子として，詳細なユーザー情報を返します。

  オーバーライド:
    クラス `Object` 内の `toString`
  戻り値:
    詳細なユーザー情報

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.1.3.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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