com.nttdocomo.ui
クラス Graphics

java.lang.Object
  |
  +--com.nttdocomo.ui.Graphics

public class Graphics

extends java.lang.Object

グラフィクス クラスです。 キャンバスに対応するグラフィクスコンテキストを表します。 lock メソッド, unlock メソッドは、かならず組で使用してください。Canvas.paint メソッド内で lock メソッドを 発行した場合、必ずそのメソッド内で unlock メソッドを発行してください。 バッファがフラッシュされてい ない状態でフレームが切り替わり、再び表示されたときの状態は機種依存になります。なお、典型的な 実装では、Canvas.paint メソッドが呼ばれた直後にバッファが フラッシュされます。

ミニマムスペック
• ミニマムスペックでは、fillPolygon は、16 頂点以下の多角形を塗りつぶすことができます。

フィールドの概要

static int	AQUA 水色を表す色の名前です (=3)。
static int	BLACK 黒色を表す色の名前です (=0)。
static int	BLUE 青色を表す色の名前です (=1)。
static int	FUCHSIA 紫色を表す色の名前です (=5)。
static int	GRAY 灰色を表す色の名前です (=8)。
static int	GREEN 暗い緑色を表す色の名前です (=10)。
static int	LIME 緑色を表す色の名前です (=2)。
static int	MAROON 暗い赤色を表す色の名前です (=12)。
static int	NAVY 暗い青色を表す色の名前です (=9)。
static int	OLIVE 暗い黄色を表す色の名前です (=14)。
static int	PURPLE 暗い紫色を表す色の名前です (=13)。
static int	RED 赤色を表す色の名前です (=4)。
static int	SILVER 銀色を表す色の名前です (=15)。
static int	TEAL 暗い水色を表す色の名前です (=11)。
static int	WHITE 白色を表す色の名前です (=7)。
static int	YELLOW 黄色を表す色の名前です (=6)。

コンストラクタの概要

protected

Graphics() コンストラクタ。

メソッドの概要

void	clearRect(int x, int y, int width, int height) 矩形領域を背景色で塗りつぶします。
Graphics	copy() グラフィクスオブジェクトのコピーを生成します。
void	dispose() グラフィクスコンテキストを破棄します。
void	drawChars(char[] data, int x, int y, int off, int len) 文字列の一部を描画します。
void	drawImage(Image img, int x, int y) イメージを描画します。
void	drawLine(int x1, int y1, int x2, int y2) 直線を描画します。
void	drawPolyline(int[] xPoints, int[] yPoints, int nPoints) 指定された点を結ぶ線分を描画します。
void	drawRect(int x, int y, int width, int height) 矩形を描画します。
void	drawString(java.lang.String str, int x, int y) 文字列を描画します。
void	fillPolygon(int[] xPoints, int[] yPoints, int nPoints) 多角形を塗りつぶします。
void	fillRect(int x, int y, int width, int height) 矩形領域を塗りつぶします。
static int	getColorOfName(int name) 名前を指定してその名前に対応するカラーを表す整数値を取得します。
static int	getColorOfRGB(int r, int g, int b) RGB 値を指定してそのRGB 値に対応するカラーを表す整数値を取得します。
void	lock() 描画デバイスに対して、ダブルバッファリングの開始を宣言します。
void	setColor(int c) 描画に使用する色を設定します。
void	setFont(Font f) 描画に使用するフォントを設定します。
void	setOrigin(int x, int y) 描画の際の座標原点を設定します。
void	unlock(boolean forced) 描画デバイスに対して、ダブルバッファリングの終了を宣言します。

クラス java.lang.Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

BLACK

public static final int BLACK

黒色を表す色の名前です (=0)。 この色に対応するRGB 値は、(R, G, B)=(0x00, 0x00, 0x00) です。

BLUE

public static final int BLUE

青色を表す色の名前です (=1)。この色に対応するRGB 値は、(R, G, B)=(0x00, 0x00, 0xff) です。

LIME

public static final int LIME

緑色を表す色の名前です (=2)。この色に対応するRGB 値は、(R, G, B)=(0x00, 0xff, 0x00) です。

AQUA

public static final int AQUA

水色を表す色の名前です (=3)。この色に対応するRGB 値は、(R, G, B)=(0x00, 0xff, 0xff) です。

RED

public static final int RED

赤色を表す色の名前です (=4)。この色に対応するRGB 値は、(R, G, B)=(0xff, 0x00, 0x00) です。

FUCHSIA

public static final int FUCHSIA

紫色を表す色の名前です (=5)。この色に対応するRGB 値は、(R, G, B)=(0xff, 0x00, 0x00) です。

YELLOW

public static final int YELLOW

黄色を表す色の名前です (=6)。この色に対応するRGB 値は、(R, G, B)=(0xff, 0xff, 0x00) です。

WHITE

public static final int WHITE

白色を表す色の名前です (=7)。この色に対応するRGB 値は、(R, G, B)=(0xff, 0xff, 0xff) です。

GRAY

public static final int GRAY

灰色を表す色の名前です (=8)。この色に対応するRGB 値は、(R, G, B)=(0x80, 0x80, 0x80) です。

NAVY

public static final int NAVY

暗い青色を表す色の名前です (=9)。この色に対応するRGB 値は、(R, G, B)=(0x00, 0x00, 0x80) です。

GREEN

public static final int GREEN

暗い緑色を表す色の名前です (=10)。この色に対応するRGB 値は、(R, G, B)=(0x00, 0x80, 0x00) です。

TEAL

public static final int TEAL

暗い水色を表す色の名前です (=11)。この色に対応するRGB 値は、(R, G, B)=(0x00, 0x80, 0x80) です。

MAROON

public static final int MAROON

暗い赤色を表す色の名前です (=12)。この色に対応するRGB 値は、(R, G, B)=(0x80, 0x00, 0x00) です。

PURPLE

public static final int PURPLE

暗い紫色を表す色の名前です (=13)。この色に対応するRGB 値は、(R, G, B)=(0x80, 0x00, 0x80) です。

OLIVE

public static final int OLIVE

暗い黄色を表す色の名前です (=14)。この色に対応するRGB 値は、(R, G, B)=(0x80, 0x80, 0x00) です。

SILVER

public static final int SILVER

銀色を表す色の名前です (=15)。この色に対応するRGB 値は、(R, G, B)=(0xC0, 0xC0, 0xC0) です。

コンストラクタの詳細

Graphics

protected Graphics()

コンストラクタ。アプリケーションはこのコンストラクタを直接呼んではなりません。

メソッドの詳細

copy

public Graphics copy()

グラフィクスオブジェクトのコピーを生成します。設定されている属性はそのまま コピーされま す。

戻り値:

グラフィクスオブジェクトのコピーを返します。コピーが作成できない場合は、 null を返しま す。

dispose

public void dispose()

グラフィクスコンテキストを破棄します。 このメソッド発行後に、このオブジェクトにアクセスして はいけません。

lock

public void lock()

描画デバイスに対して、ダブルバッファリングの開始を宣言します。 ダブルバッファリングをサ ポートしている場合は、ロックカウントに1 を加えて、以後の描画処理をバッファリングします。 ダブルバッファリングをサポートしていない場合は何も行いません。このメソッドは１ つのグラフ ィクスオブジェクトに対して複数回実行することができます。lock()はunlock()と組で使用し、 バッファリングされた描画データはunlock()によってフラッシュされます。

関連項目:

unlock(boolean)

unlock

public void unlock(boolean forced)

描画デバイスに対して、ダブルバッファリングの終了を宣言します。 ダブルバッファリングをサ ポートしている場合は、ロックカウントが0 より大きい場合は ロックカウントから1 を引いて、次 のような動作を行います。

• forced に true が渡された場合はバッファをフラッシュして、ロックカウントを0 に設定します。
• forced に false が渡された場合は、ロックカウントが0 の場合のみ バッファをフラッシュします。

ロックカウントが0 のときにこのメソッドが呼ばれた場合は、このメソッドはなにもしません。 ダ ブルバッファリングをサポートしていない場合は何も行いません。

パラメータ:

forced - ダブルバッファリングがサポートされている場合に強制的にフラッシュするかどうか を 指定します。

関連項目:

lock()

setOrigin

public void setOrigin(int x,
                      int y)

描画の際の座標原点を設定します。 drawLine() などの描画メソッドを呼び出した場合は、 実際には引数に渡した座標値に このメソッドで指定されたオフセット値が加算された座標に 描画されます。座標原点をデフォルトに戻すには、x と y の両方に 0 を指定してこのメソッ ドを呼び出します。 デフォルトでは (0, 0) が設定されます。

パラメータ:

x - X 方向のオフセット値を指定します。

y - Y 方向のオフセット値を指定します。

getColorOfRGB

public static int getColorOfRGB(int r,
                                int g,
                                int b)

RGB 値を指定してそのRGB 値に対応するカラーを表す整数値を取得します。 各引数が、0 より小さい場合場合や255 より大きい場合は、例外が発生します。

パラメータ:

r - 赤要素の輝度を指定します（0 〜255 ）。

g - 緑要素の輝度を指定します（0 〜255 ）。

b - 青要素の輝度を指定します（0 〜255 ）。

戻り値:

カラーを表す整数値を返します。 返される値は機種依存ですが、負数以外です。

例外:

java.lang.IllegalArgumentException - 引数の値が範囲外の場合に発生します。

getColorOfName

public static int getColorOfName(int name)

名前を指定してその名前に対応するカラーを表す整数値を取得します。

パラメータ:

name - このクラスで定義される色の名前を示す値を指定します。

戻り値:

カラーを表す整数値を返します。返される値は機種依存ですが、負数以外です。引数に不正 な値を指定した場合は、例外が発生します。

例外:

java.lang.IllegalArgumentException - 引数の値が不正な場合に発生します。具体的には、 このク ラスで定義された色に対応する値(Grahics.BLACK, Graphics.BLUE など)以外の値を 指 定した場合にこの例外が発生します。

setColor

public void setColor(int c)

描画に使用する色を設定します。デフォルトでは、getGraphics メソッドでGraphic オブジェ クトを生成したときにキャンパスが保持している背景色とコントラストのある機種依存の色が設 定されます。

パラメータ:

c - 描画に使用する色を指定します。

例外:

java.lang.IllegalArgumentException - 引数の値が不正な場合に発生します。

setFont

public void setFont(Font f)

描画に使用するフォントを設定します。 Graphics オブジェクトには、デフォルトでは、Font ク ラスの getDefaultFont メソッドが 返すフォントが設定されています。 引数に, null が指定 された場合は、例外が発生します。

パラメータ:

f - 描画に使用するフォントを指定します。

例外:

NullPointerException - 引数f にnull が指定された場合に発生します。

関連項目:

Font.getDefaultFont()

clearRect

public void clearRect(int x,
                      int y,
                      int width,
                      int height)

矩形領域を背景色で塗りつぶします。 このメソッドは、 左上(x, y), 右下(x+width-1, y+height-1)で、構成された領域(幅 width, 高さ height)を 背景色で塗りつぶします。 width 、height のどちらか一方が正で他方が0 の場合または両方が0 の場合は、 描画しま せん。width 、height のどちらかまたは両方が0 未満の場合は、例外が発生します。

パラメータ:

x - 矩形の左上のX 座標を指定します。

y - 矩形の左上のY 座標を指定します。

width - 矩形の幅を指定します。

height - 矩形の高さを指定します。

例外:

java.lang.IllegalArgumentException - width 、height のどちらかまたは両方が0 未満の場合に発生 します。

関連項目:

Frame.setBackground(int)

drawLine

public void drawLine(int x1,
                     int y1,
                     int x2,
                     int y2)

直線を描画します。 線分(x1,y1)-(x2,y2)を、setColor メソッドで指定された色で描画します。

パラメータ:

x1 - 直線の描画開始点のX 座標を指定します。

y1 - 直線の描画開始点のY 座標を指定します。

x2 - 直線の描画終了点のX 座標を指定します。

y2 - 直線の描画終了点のY 座標を指定します。

drawRect

public void drawRect(int x,
                     int y,
                     int width,
                     int height)

矩形を描画します。 このメソッドは、左上(x, y) 右下(x+width, y+height)で指定される矩 形(幅 width+1, 高さ height+1)を setColor メソッドで設定された色で描画します。 width 、 height のどちらかまたは両方が0 未満の場合は、例外が発生します。

パラメータ:

x - 矩形の左上のX 座標を指定します。

y - 矩形の左上のY 座標を指定します。

width - 矩形の幅を指定します。

height - 矩形の高さを指定します。

例外:

java.lang.IllegalArgumentException - width 、height のどちらかまたは両方が0 未満の場合に発生 します。

fillRect

public void fillRect(int x,
                     int y,
                     int width,
                     int height)

矩形領域を塗りつぶします。 このメソッドは、 左上(x, y), 右下(x+width-1, y+height-1)で、 構成された領域(幅 width, 高さ height)を setColor メソッドで設定された色で塗りつぶしま す。 width 、height のどちらか一方が正で他方が0 の場合または両方が0 の場合は、描画 しません。 width 、height のどちらかまたは両方が0 未満の場合は、例外が発生します。

パラメータ:

x - 矩形の左上のX 座標を指定します。

y - 矩形の左上のY 座標を指定します。

width - 矩形の幅を指定します。

height - 矩形の高さを指定します。

例外:

java.lang.IllegalArgumentException - width 、height のどちらかまたは両方が0 未満の場合に発生 します。

drawImage

public void drawImage(Image img,
                      int x,
                      int y)

イメージを描画します。img が null の場合は、例外が発生します。

パラメータ:

img - 描画するイメージオブジェクトを指定します。

x - X 座標を指定します。

y - Y 座標を指定します。

例外:

NullPointerException - img がnull の場合に発生します。

fillPolygon

public void fillPolygon(int[] xPoints,
                        int[] yPoints,
                        int nPoints)

多角形を塗りつぶします。引数で指定した頂点で構成される多角形をsetColor メソッドで指 定された色で塗りつぶします。ミニマムスペックでは、頂点の数が16 点以下の多角形を塗り つぶすことができることとします。 引数で指定された配列のサイズより、引数で指定された頂 点の総数が小さい場合、配列の最初から頂点の総数個だけの要素が利用されます。 nPoints が3 未満の場合は、なにも描画しません。 頂点数が16 より多く多角形の塗りつぶし ができない場合の振舞は機種依存です。

パラメータ:

xPoints - x 座標の配列

yPoints - y 座標の配列

nPoints - 頂点の総数

例外:

java.lang.IllegalArgumentException - 配列のサイズが頂点の総数より小さい場合 またはnPoints が負の場合に発生します。

drawPolyline

public void drawPolyline(int[] xPoints,
                         int[] yPoints,
                         int nPoints)

指定された点を結ぶ線分を描画します。引数で指定された点を結ぶ線分をsetColor メソッド で指定した色で、描画します。ただし、最初に指定された点と最後に指定された点が異なる 場合、その区間は描画しません。引数で指定された配列のサイズより、引数で指定された点 の総数が小さい場合、配列の最初から点の総数個だけの要素が使用されます。nPoints が 0 の場合は、なにも描画しません。 なお、点の数が1 の場合、点を描画します。

パラメータ:

xPoints - 点のx 座標の配列。

yPoints - 点のy 座標の配列。

nPoints - 点の総数。

例外:

java.lang.IllegalArgumentException - 配列のサイズが点の総数より小さい場合 またはnPoints が 負の場合に発生します。

drawString

public void drawString(java.lang.String str,
                       int x,
                       int y)

文字列を描画します。文字列を、setColor メソッドで指定した色で描画します。str がnull の 場合は例外が発生します。 描画位置は、ベースラインの座標を指定します。

パラメータ:

str - 描画する文字列を指定します。

x - X 座標を指定します。

y - Y 座標を指定します。

例外:

NullPointerException - 引数str にnull が指定された場合に発生します。

drawChars

public void drawChars(char[] data,
                      int x,
                      int y,
                      int off,
                      int len)

文字列の一部を描画します。引数 data がnull の場合、例外が発生します。 描画は、 setColor メソッドで指定された色で行われます。描画位置は、ベースラインの座標を指定しま す。

パラメータ:

data - 描画するchar 型の配列を指定します。

x - X 座標を指定します。

y - Y 座標を指定します。

off - 描画する文字列のオフセットを指定します。

len - 描画する文字列の長さを指定します。

例外:

NullPointerException - 引数data にnull が指定された場合に発生します。

java.lang.IllegalArgumentException - 引数の値が不正な場合に発生します。例えば、 引数data の 配列の範囲外をアクセスすることになる引数の組合せの場合、この例外が 発生します。