TransparentImage (DoJa 3.5 (オプションAPIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.nttdocomo.opt.ui
クラス TransparentImage

Object
  |
  +--com.nttdocomo.ui.Image
        |
        +--com.nttdocomo.opt.ui.TransparentImage

public class TransparentImage
extends com.nttdocomo.ui.Image

透明色を持つイメージを定義します。ユーザは、イメージ中のどの色を透明色とみなすのかを自由に設定することができます。また、透明色設定を無効化することにより、非透明イメージとして扱うこともできます。 TransparentImageがどの描画メソッドで使用できるのかは機種依存です。 TransparentImageに対応していないメソッドの引数にTransparentImageオブジェクトを指定した場合には、UIException(UNSUPPORTED_FORMAT)となります。

端末によってサポートされていない場合があります。未サポートの場合、メソッドが呼び出された時点でUnsupportedOperationExceptionを発生します。

[DoJa-3.0]
基本 API の中で Image オブジェクトを引数に取るメソッドが TransparentImage に対応しているかどうかは機種依存です。 TransparentImage に対応していないメソッドの引数に TransparentImage オブジェクトを指定して呼び出した場合、特に例外は発生しませんが、描画内容については機種依存となります。

導入されたバージョン:: DoJa-2.0

コンストラクタの概要

protected TransparentImage()
           アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの概要

static TransparentImage createTransparentImage(com.nttdocomo.ui.Image image)
           通常のイメージから透明色を持つイメージを生成します。

com.nttdocomo.ui.Graphics getGraphics()
           このクラスのインスタンスに対して呼び出すことはできません。

void setTransparentColor(int color)
           透明色を設定します。

void setTransparentEnabled(boolean b)
           透明色を使用するかどうかを設定します。

クラス com.nttdocomo.ui.Image から継承したメソッド

createImage, createImage, dispose, getHeight, getWidth

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

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

コンストラクタの詳細

TransparentImage

protected TransparentImage()

アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの詳細

createTransparentImage

public static TransparentImage createTransparentImage(com.nttdocomo.ui.Image image)

通常のイメージから透明色を持つイメージを生成します。デフォルトでは透明色を使用しません。なお、本メソッドに通常のイメージを継承した拡張イメージ(TransparentImage, PalettedImage など)を指定することはできません。

パラメータ:: image - イメージを指定します。
戻り値:: 透明色を持つイメージを生成して返します。
例外:: NullPointerException - 引数 image に null が指定された場合に発生します。; com.nttdocomo.ui.UIException - 引数 image に拡張イメージが指定された場合に発生します(UNSUPPORTED_FORMAT)。; com.nttdocomo.ui.UIException - 引数 image に既に dispose されているイメージが指定された場合に発生します(ILLEGAL_STATE)。

setTransparentEnabled

public void setTransparentEnabled(boolean b)

透明色を使用するかどうかを設定します。

パラメータ:: b - 透明色を使用する場合は true を、使用しない場合は false を指定します。

setTransparentColor

public void setTransparentColor(int color)

透明色を設定します。 TransparentImage#createTransparentImage(Image)メソッドを用いてTransparentImageオブジェクトを取得した直後の、デフォルトの透明色設定は機種依存です。
なお、透明色はGraphics#getColorOfRGB(int, int, int)メソッド等で返される端末内部表現で指定されます。したがって、端末のサポートする色数がオリジナルのイメージの色数よりも少ない場合には、減色処理によって似た色が同じ色に書換えられている場合があります。この場合、ユーザの意図よりも広い領域が透明色と見なされる可能性があります。

パラメータ:: color - 透明色を指定します。透明色には Graphics.getColorOfRGB メソッド等で返される値を指定します。端末によってはこのメソッドの処理に時間がかかる場合があります。
例外:: IllegalArgumentException - 引数 color に不正な値が指定された場合に発生します。

getGraphics

public final com.nttdocomo.ui.Graphics getGraphics()

このクラスのインスタンスに対して呼び出すことはできません。

オーバーライド:: クラス com.nttdocomo.ui.Image 内の getGraphics

戻り値:: イメージに描画するためのグラフィックスオブジェクトを返します。
例外:: com.nttdocomo.lang.UnsupportedOperationException - このメソッドが呼ばれた場合に発生します。

概要