パッケージ org.opengion.fukurou.util

## クラス ColorMap

- java.lang.Object
- - org.opengion.fukurou.util.ColorMap

-     public final class ColorMap
      extends Object

  ColorMap.java は、共通的に使用される Color関連メソッドを集約した、クラスです。 StringUtil から、Color関係の部分を独立させました。 カラー文字列は、java.awt.Color static 定義色、CSS1 / HTML3–4 / VGA の色名称、 X11の色名称 が指定できます。 カラー番号は、ビビッドを、0～11 (V0～V11) , パステルを、12～23 (P0～P11) として登録します。 従来のカラー番号と異なりますので、ご注意ください。
  変更履歴:
    6.0.2.1 (2014/09/26) 新規作成, 6.4.3.3 (2016/03/04) ViewForm_ImageTimeBar#FlgColorMap 内部クラスから機能移動, 7.0.1.1 (2018/10/22) 内部色コードを文字列として管理、配列は、パステルとビビッドから作成します。
  機能分類
    ユーティリティ
  バージョン
    6.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK8.0,

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールド | 説明
    --- | --- | ---
    `static String` | `PASTEL` | 色種別ｷｰﾜｰﾄﾞ "PASTEL"
    `static String` | `VIVID` | 色種別ｷｰﾜｰﾄﾞ "VIVID"

  - ### メソッドの概要

    すべてのメソッド staticメソッド concreteメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `static Color` | `getColorInstance​(int no)` | 指定の番号に対応した、色オブジェクトを返します。
    `static Color` | `getColorInstance​(String value)` | カラーキーワードより、Colorオブジェクトを作成します。
    `static String` | `getColorKey​(int no)` | 内部で管理している ColorMap のキー配列を返します。
    `static String` | `getColorKey​(String sno)` | 内部で管理している ColorMap から、指定のキーに対する色コードを返します。
    `static String` | `getColorKey​(String sno, String defCol)` | 内部で管理している ColorMap から、指定のキーに対する色コードを返します。
    `static String[]` | `getColorKeys()` | 内部で管理している ColorMap のキー配列を返します。
    `static String[]` | `getColorKeys​(String colKey)` | 引数に応じた内部で管理している ColorMap のキー配列を返します。
    `static String[]` | `getPastelKeys()` | 内部で管理している パステルカラー のキー配列を返します。
    `static String[]` | `getVividKeys()` | 内部で管理している ビビッドカラー のキー配列を返します。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### VIVID

          public static final String VIVID

      色種別ｷｰﾜｰﾄﾞ "VIVID"
      関連項目:
        定数フィールド値

    - #### PASTEL

          public static final String PASTEL

      色種別ｷｰﾜｰﾄﾞ "PASTEL"
      関連項目:
        定数フィールド値

  - ### メソッドの詳細

    - #### getColorInstance

          public static Color getColorInstance​(String value)

      カラーキーワードより、Colorオブジェクトを作成します。 指定文字列は、java.awt.Color クラスのstatic フィールド名で指定します。 BLACK , BLUE , CYAN , DARK_GRAY , GRAY , GREEN , LIGHT_GRAY , MAGENTA , ORANGE , PINK , RED , WHITE , YELLOW , PURPLE , TRANSPARENT(透明) が指定できます。 6.0.2.1 (2014/09/26) 以降では、CSS1/HTML3–4/VGA の色名称として、 LIME , AQUA , SILVER , MAROON , OLIVE , TEAL , NAVY , FUCHSIA を追加。 それと、X11の色名称 を追加しました。 また、先頭に、# を付ける事で、#XXXXXX形式の16bitRGB表記 でも指定可能です。 static フィールド名のMapを管理していますが、存在しない場合は、エラーになります。 色番号は、ビビッドを、0～11 (V0～V11) , パステルを、11～23 (P0～P11) とします。
      パラメータ:
        `value` - java.awt.Color フィールドを示す文字列または、#XXXXXX形式の16bitRGB表記
      戻り値:
        Colorオブジェクト
      関連項目:
        `Color.BLACK`
      変更履歴:
        3.8.9.1 (2007/06/29) 新規作成, 4.1.1.0 (2008/02/04) CLR_MAP に存在しない場合はエラーにします。, 6.0.2.1 (2014/09/26) CSS1/HTML3–4/VGA の色名称 , X11の色名称 追加, 6.3.9.0 (2015/11/06) valueのnullチェックの仕方が間違っていた。, 6.4.6.1 (2016/06/03) 色番号の取得も対応しておきます。, 7.0.1.1 (2018/10/22) ビビッドとパステルの全24色を対象とします。, 7.0.6.4 (2019/11/29) 数値指定の色がMapにないとｴﾗｰになっていた個所を修正

    - #### getColorInstance

          public static Color getColorInstance​(int no)

      指定の番号に対応した、色オブジェクトを返します。 カラー番号は、ビビッドを、0～11 , パステルを、12～23 として登録しています。 従来のカラー番号と異なりますので、ご注意ください。 23を超えると、0 に戻ります。
      パラメータ:
        `no` - 内部で管理している色番号
      戻り値:
        色オブジェクト
      変更履歴:
        6.4.3.3 (2016/03/04) ViewForm_ImageTimeBar#uniqColor() メソッドから移動。, 6.9.9.2 (2018/09/18) 配列からリストに変更の対応, 7.0.1.1 (2018/10/22) ビビッドとパステルの全24色を対象とします。

    - #### getColorKey

          public static String getColorKey​(int no)

      内部で管理している ColorMap のキー配列を返します。 ここで返すのは、ビビッドを、0～11 , パステルを、12～23 として登録しています。 この、#XXXXXX形式の16bitRGB表記 を返します。
      パラメータ:
        `no` - 内部で管理している色番号
      戻り値:
        キー配列
      変更履歴:
        6.0.2.1 (2014/09/26) 新規追加, 7.0.1.1 (2018/10/22) ビビッドとパステルの全24色を対象とします。
      このメソッドは、nullを返しません

    - #### getColorKey

          public static String getColorKey​(String sno)

      内部で管理している ColorMap から、指定のキーに対する色コードを返します。 色名称でも返しますが、主に、色番号を想定しています。 引数が、文字列なのは、ビビッドを、0～11 (V0～V11) , パステルを、12～23 (P0～P11) として管理しているためです。 色コードは、、#XXXXXX形式の16bitRGB表記です。 色マップに値が存在しない場合は、null を返します。
      パラメータ:
        `sno` - 内部で管理している色番号
      戻り値:
        色コード(対象の色がMapに存在しない場合は、nullを返します)
      変更履歴:
        7.0.1.1 (2018/10/22) ビビッドとパステルの全24色を対象とします。

    - #### getColorKey

          public static String getColorKey​(String sno,
                                           String defCol)

      内部で管理している ColorMap から、指定のキーに対する色コードを返します。 色名称でも返しますが、主に、色番号を想定しています。 引数が、文字列なのは、ビビッドを、0～11 (V0～V11) , パステルを、12～23 (P0～P11) として管理しているためです。 色コードは、、#XXXXXX形式の16bitRGB表記です。
      パラメータ:
        `sno` - 内部で管理している色番号,色記号
        `defCol` - 色マップに値が存在しない場合に返す色
      戻り値:
        色コード
      変更履歴:
        7.0.1.1 (2018/10/22) ビビッドとパステルの全24色を対象とします。

    - #### getColorKeys

          public static String[] getColorKeys()

      内部で管理している ColorMap のキー配列を返します。 ここで返すのは、ビビッドを、0～11 , パステルを、12～23 として登録しています。 この、#XXXXXX形式の16bitRGB表記 を返します。
      戻り値:
        キー配列
      変更履歴:
        6.0.2.1 (2014/09/26) 新規追加, 7.0.1.1 (2018/10/22) ビビッドとパステルの全24色を対象とします。
      このメソッドは、nullを返しません

    - #### getColorKeys

          public static String[] getColorKeys​(String colKey)

      引数に応じた内部で管理している ColorMap のキー配列を返します。 colKey が null の場合は、#getColorKeys() と同じ、COLOR_KEYすべてを返します。 colKey が、VIVID の場合は、#getVividKeys() を返します。 colKey が、PASTEL の場合は、#getPastelKeys() を返します。 それ以外は、CSVで分解して、各値を、#getColorKey(String,String) で求めた色コードの 配列を返します。
      パラメータ:
        `colKey` - 内部で管理している色コード(nullの場合は、COLOR_KEYすべて。)
      戻り値:
        キー配列
      変更履歴:
        7.0.1.3 (2018/11/12) 引数に応じたColorMap のキー配列を返す。
      このメソッドは、nullを返しません

    - #### getVividKeys

          public static String[] getVividKeys()

      内部で管理している ビビッドカラー のキー配列を返します。
      戻り値:
        パステルカラーのキー配列
      変更履歴:
        7.0.1.1 (2018/10/22) ビビッドとパステルの全24色を対象とします。

    - #### getPastelKeys

          public static String[] getPastelKeys()

      内部で管理している パステルカラー のキー配列を返します。
      戻り値:
        パステルカラーのキー配列
      変更履歴:
        6.9.9.2 (2018/09/18) パステルカラーの色オブジェクト