kinugasa.ui
クラス CharSet

java.lang.Object
  上位を拡張 kinugasa.ui.CharSet
すべての実装されたインタフェース:
java.io.Serializable, Nameable

public final class CharSet
extends java.lang.Object
implements Nameable, java.io.Serializable

Kinugasa : CharSet : 入力ウインドウで入力可能な文字のセットと大まかな描画位置を定義するクラスです.
文字セットは一つの文字列を1文字ずつ分解することで選択可能な文字のセットを定義するクラスです。
ただし、1つの文字セットに含まれる文字は重複が許容されます。
文字セットに使用する文字列はその描画位置を指定するために改行"\n"およびスペース" "を使用できます。
改行は

バージョン:
1.0.0 - 2012/11/24_17:23:37.
作成者:
Dra0211

関連項目:
直列化された形式

フィールドの概要
private  float drawSizeMag
          文字セットの描画サイズのフォントサイズに対する係数です.
private  java.lang.String name
          この文字セットの名前です.
private static long serialVersionUID
           
private  java.lang.String values
          この文字セットが使用するすべての文字です.
 
コンストラクタの概要
CharSet(java.lang.String name, float charSize, java.lang.String allData)
          新しい文字セットを定義します.
 
メソッドの概要
 boolean contains(java.lang.String c)
          文字cがこの文字セットに含まれているか検査します.
 float convertSize(float fontSize)
          フォントサイズを補正し、この文字セットに含まれる文字の等幅の適切なサイズを返します.
 boolean cotnains(char c)
          文字cがこの文字セットに含まれているか検査します.
 float getDrawSizeMag()
          この文字セットのフォントサイズに適用する補正値を取得します.
 java.lang.String getName()
          このインスタンスの一意的な名前を取得します.
 java.lang.String getValues()
          この文字セットで使用されるすべての文字が含まれた文字列を返します.
 TextLabel[][] parse(float startX, float startY, LabelModel labelModel)
          文字セット内の文字を分解し、1文字ごとにテキストラベルに発行します.
 int rowNum()
          この文字セットの行数を返します.
 java.lang.String toString()
           
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

serialVersionUID

private static final long serialVersionUID
関連項目:
定数フィールド値

name

private java.lang.String name
この文字セットの名前です.


values

private java.lang.String values
この文字セットが使用するすべての文字です.


drawSizeMag

private float drawSizeMag
文字セットの描画サイズのフォントサイズに対する係数です.

コンストラクタの詳細

CharSet

public CharSet(java.lang.String name,
               float charSize,
               java.lang.String allData)
        throws java.lang.IllegalArgumentException
新しい文字セットを定義します. 文字セットをグローバルに扱えるようにするには CharSetHostに追加する必要があります。

パラメータ:
name - この文字セットの名前を指定します。
charSize - 文字の描画サイズを補正する係数です。 文字セット中の文字はフォントサイズ*charSizeの幅が「文字の幅」として扱われます。
allData - 文字データを送信します。スペース" "や改行"\n"を使用できます。
例外:
java.lang.IllegalArgumentException - データ中に全角のアンダースコア"_"が含まれている場合に投げられます。 "_"は未入力データを示すために使用されるため、文字セットとしては使用できません。
メソッドの詳細

contains

public boolean contains(java.lang.String c)
文字cがこの文字セットに含まれているか検査します.

パラメータ:
c - 検査する文字を送信します。
戻り値:
文字cがこの文字セットに含まれている場合はtrueを返します。

cotnains

public boolean cotnains(char c)
文字cがこの文字セットに含まれているか検査します.

パラメータ:
c - 検査する文字を送信します。
戻り値:
文字cがこの文字セットに含まれている場合はtrueを返します。

getDrawSizeMag

public float getDrawSizeMag()
この文字セットのフォントサイズに適用する補正値を取得します.

戻り値:
フォントサイズに適用する補正値を返します。

convertSize

public float convertSize(float fontSize)
フォントサイズを補正し、この文字セットに含まれる文字の等幅の適切なサイズを返します.

パラメータ:
fontSize - 補正するフォントサイズを送信します。
戻り値:
fontSIze * getDrawSizeMag()を返します。

getValues

public java.lang.String getValues()
この文字セットで使用されるすべての文字が含まれた文字列を返します.

戻り値:
コンストラクタで指定された使用する文字を返します。

parse

public TextLabel[][] parse(float startX,
                           float startY,
                           LabelModel labelModel)
文字セット内の文字を分解し、1文字ごとにテキストラベルに発行します.

パラメータ:
startX - 最も左上のラベルを配置するX座標を指定します。
startY - 最も左上のラベルを配置するY座標を指定します。
labelModel - 使用するラベルモデルを指定します。クローンされません。
戻り値:
指定した条件で作成したこの文字セットの表示用ラベルを2次元に配置して返します。

rowNum

public int rowNum()
この文字セットの行数を返します.

戻り値:
この文字セットを構築した際の行数を返します。

getName

public java.lang.String getName()
インタフェース Nameable の記述:
このインスタンスの一意的な名前を取得します. 名前はゲームの実行中変更されてはなりません。

定義:
インタフェース Nameable 内の getName
戻り値:
このインスタンスを識別できる一意的な名前を返します。名前はユーザやプレイヤーが指定する可能性があるため 意味のある文字列を推奨します。

toString

public java.lang.String toString()
オーバーライド:
クラス java.lang.Object 内の toString