モジュール java.desktop

パッケージ javax.swing

クラスImageIcon

java.lang.Object

javax.swing.ImageIcon

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

Serializable, Accessible, Icon

public class ImageIcon extends Object implements Icon, Serializable, Accessible

アイコンをイメージからペイントするIconインタフェースの実装です。 URL、ファイル名、またはバイト配列から生成されるイメージが、ロード状態を監視するMediaTrackerを使ってプリロードされます。

イメージ・アイコンの詳細および使用例は、「The Java Tutorial」の「How to Use Icons」を参照してください。

警告: このクラスの直列化されたオブジェクトは、今後のSwingリリースと互換ではなくなる予定です。 現在の直列化のサポートは、短期間の格納や、同じバージョンのSwingを実行するアプリケーション間のRMIに適しています。 1.4では、すべてのJavaBeansの長期ストレージのサポートがjava.beansパッケージに追加されました。 XMLEncoderを参照してください。

導入されたバージョン:

1.2

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラス	説明
protected class	ImageIcon.AccessibleImageIcon	このクラスは、ImageIconクラスのアクセシビリティ・サポートを実装しています。

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
protected static final Component	component	非推奨。 since 1.8
protected static final MediaTracker	tracker	非推奨。 since 1.8

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
ImageIcon()	初期化されていないイメージ・アイコンを生成します。
ImageIcon(byte[] imageData)	サポートされているGIF、JPEG、PNG (1.3以降)などのイメージ形式を格納しているイメージ・ファイルから読み出されたバイト配列から、イメージ・アイコンを生成します。
ImageIcon(byte[] imageData, String description)	サポートされているGIF、JPEG、PNG (1.3以降)などのイメージ形式を格納しているイメージ・ファイルから読み出されたバイト配列から、イメージ・アイコンを生成します。
ImageIcon(Image image)	イメージ・オブジェクトからイメージ・アイコンを生成します。
ImageIcon(Image image, String description)	イメージからイメージ・アイコンを生成します。
ImageIcon(String filename)	指定されたファイルからイメージ・アイコンを生成します。
ImageIcon(String filename, String description)	指定されたファイルからイメージ・アイコンを生成します。
ImageIcon(URL location)	指定されたURLからイメージ・アイコンを生成します。
ImageIcon(URL location, String description)	指定されたURLからイメージ・アイコンを生成します。

メソッドのサマリー

修飾子と型	メソッド	説明
AccessibleContext	getAccessibleContext()	このImageIconに関連付けられたAccessibleContextを取得します。
String	getDescription()	イメージの説明を取得します。
int	getIconHeight()	アイコンの高さを取得します。
int	getIconWidth()	アイコンの幅を取得します。
Image	getImage()	アイコンのImageを返します。
int	getImageLoadStatus()	イメージ・ロード操作のステータスを返します。
ImageObserver	getImageObserver()	イメージのイメージ監視オブジェクトを返します。
protected void	loadImage(Image image)	イメージをロードし、イメージがロードされたときのみ復帰します。
void	paintIcon(Component c, Graphics g, int x, int y)	アイコンをペイントします。
void	setDescription(String description)	イメージの説明を設定します。
void	setImage(Image image)	アイコンによって表示されるイメージを設定します。
void	setImageObserver(ImageObserver observer)	イメージのイメージ監視オブジェクトを設定します。
String	toString()	このイメージの文字列表現を返します。

クラスjava.lang.Objectで宣言されたメソッド

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

フィールド詳細

component

@Deprecated protected static final Component component

非推奨。

since 1.8

この共有コンポーネントを使用しないでください。これはイメージのロードを追跡するために使用されます。 下位互換性のためにのみ残されています。

tracker

@Deprecated protected static final MediaTracker tracker

非推奨。

since 1.8

この共有メディア・トラッカを使用しないでください。これはイメージをロードするために使用されます。 下位互換性のためにのみ残されています。

コンストラクタの詳細

ImageIcon

public ImageIcon(String filename, String description)

指定されたファイルからイメージ・アイコンを生成します。 イメージはロード状態を監視するMediaTrackerを使ってプリロードされます。

パラメータ:

filename - イメージが含まれているファイルの名前

description - イメージの短い説明テキスト

関連項目:

• ImageIcon(String)

ImageIcon

@ConstructorProperties("description") public ImageIcon(String filename)

指定されたファイルからイメージ・アイコンを生成します。 イメージはロード状態を監視するMediaTrackerを使ってプリロードされます。 指定する文字列はファイル名またはファイル・パスです。 パスを指定するときは、区切り文字としてインターネット標準のスラッシュ(/)を使います。 (文字列はURLに変換され、スラッシュはすべてのシステムで動作します。) たとえば、次のように指定します。

    new ImageIcon("images/myImage.gif") 

説明は、filename文字列に初期化されます。

パラメータ:

filename - ファイル名またはパスを指定する文字列

関連項目:

• getDescription()

ImageIcon

public ImageIcon(URL location, String description)

指定されたURLからイメージ・アイコンを生成します。 イメージはロード状態を監視するMediaTrackerを使ってプリロードされます。

パラメータ:

location - イメージのURL

description - イメージの短い説明テキスト

関連項目:

• ImageIcon(String)

ImageIcon

public ImageIcon(URL location)

指定されたURLからイメージ・アイコンを生成します。 イメージはロード状態を監視するMediaTrackerを使ってプリロードされます。 アイコンの説明は初期化され、URLの文字列表現となります。

パラメータ:

location - イメージのURL

関連項目:

• getDescription()

ImageIcon

public ImageIcon(Image image, String description)

イメージからイメージ・アイコンを生成します。

パラメータ:

image - イメージ

description - イメージの短い説明テキスト

ImageIcon

public ImageIcon(Image image)

イメージ・オブジェクトからイメージ・アイコンを生成します。 イメージに文字列のcommentプロパティがある場合、その文字列はアイコンの説明に使用されます。

パラメータ:

image - イメージ

関連項目:

• getDescription()
• Image.getProperty(java.lang.String, java.awt.image.ImageObserver)

ImageIcon

public ImageIcon(byte[] imageData, String description)

サポートされているGIF、JPEG、PNG (1.3以降)などのイメージ形式を格納しているイメージ・ファイルから読み出されたバイト配列から、イメージ・アイコンを生成します。 通常、このバイト配列はClass.getResourceAsStream()を使ったイメージの読出しによって生成されますが、バイト配列をクラス内に静的に格納することもできます。

パラメータ:

imageData - AWT ToolkitによってサポートされるGIF、JPEG、PNG (1.3以降)などのイメージ形式によるピクセル配列

description - イメージの短い説明テキスト

関連項目:

• Toolkit.createImage(java.lang.String)

ImageIcon

public ImageIcon(byte[] imageData)

サポートされているGIF、JPEG、PNG (1.3以降)などのイメージ形式を格納しているイメージ・ファイルから読み出されたバイト配列から、イメージ・アイコンを生成します。 通常、このバイト配列はClass.getResourceAsStream()を使ったイメージの読出しによって生成されますが、バイト配列をクラス内に静的に格納することもできます。 結果として得られるイメージに文字列のcommentプロパティがある場合、その文字列はアイコンの説明に使用されます。

パラメータ:

imageData - AWT ToolkitによってサポートされるGIF、JPEG、PNG (1.3以降)などのイメージ形式によるピクセル配列

関連項目:

• Toolkit.createImage(java.lang.String)
• getDescription()
• Image.getProperty(java.lang.String, java.awt.image.ImageObserver)

ImageIcon

public ImageIcon()

初期化されていないイメージ・アイコンを生成します。

メソッドの詳細

loadImage

protected void loadImage(Image image)

イメージをロードし、イメージがロードされたときのみ復帰します。

パラメータ:

image - イメージ

getImageLoadStatus

public int getImageLoadStatus()

イメージ・ロード操作のステータスを返します。

戻り値:

java.awt.MediaTrackerによって定義されるロード・ステータス

関連項目:

• MediaTracker.ABORTED
• MediaTracker.ERRORED
• MediaTracker.COMPLETE

getImage

public Image getImage()

アイコンのImageを返します。

戻り値:

このImageIconのImageオブジェクト

setImage

public void setImage(Image image)

アイコンによって表示されるイメージを設定します。

パラメータ:

image - イメージ

getDescription

public String getDescription()

イメージの説明を取得します。 これは、オブジェクトを説明する短いテキストです。 たとえば、目の不自由なユーザーに対して、イメージの目的を示すために使用されます。 説明はnullでもかまいません。

戻り値:

イメージの短い説明テキスト

setDescription

public void setDescription(String description)

イメージの説明を設定します。 これは、オブジェクトを説明する短いテキストです。 たとえば、目の不自由なユーザーに対して、イメージの目的を示すために使用されます。

パラメータ:

description - イメージの短い説明テキスト

paintIcon

public void paintIcon(Component c, Graphics g, int x, int y)

アイコンをペイントします。 アイコンの左上隅が、グラフィック・コンテキストgの座標空間にある点(x, y)に描画されます。 このアイコンにイメージ監視オブジェクトがない場合、このメソッドでは監視オブジェクトとしてcコンポーネントを使用します。

定義:

paintIcon、インタフェースIcon

パラメータ:

c - このアイコンにイメージ監視オブジェクトがない場合に、監視オブジェクトとして使用されるコンポーネント

g - グラフィックス・コンテキスト

x - アイコンの左上隅のX座標

y - アイコンの左上隅のY座標

getIconWidth

public int getIconWidth()

アイコンの幅を取得します。

定義:

getIconWidth、インタフェースIcon

戻り値:

このアイコンのピクセル単位の幅

getIconHeight

public int getIconHeight()

アイコンの高さを取得します。

定義:

getIconHeight、インタフェースIcon

戻り値:

このアイコンのピクセル単位の高さ

setImageObserver

public void setImageObserver(ImageObserver observer)

イメージのイメージ監視オブジェクトを設定します。 イメージ・アイコンが動画GIFを格納している場合にこのプロパティを設定すると、監視オブジェクトに対してその表示を更新するように通知されます。 たとえば:

     icon = new ImageIcon(...)
     button.setIcon(icon);
     icon.setImageObserver(button);
 

パラメータ:

observer - イメージ監視オブジェクト

getImageObserver

public ImageObserver getImageObserver()

イメージのイメージ監視オブジェクトを返します。

戻り値:

イメージ監視オブジェクト。nullの場合もある

toString

public String toString()

このイメージの文字列表現を返します。

オーバーライド:

toString、クラスObject

戻り値:

このイメージの文字列表現

getAccessibleContext

@BeanProperty(expert=true, description="The AccessibleContext associated with this ImageIcon.") public AccessibleContext getAccessibleContext()

このImageIconに関連付けられたAccessibleContextを取得します。 イメージ・アイコンの場合、AccessibleContextはAccessibleImageIconの形式を取ります。 必要に応じて新規のAccessibleImageIconインスタンスが生成されます。

定義:

getAccessibleContext、インタフェースAccessible

戻り値:

このImageIconのAccessibleContextとして機能するAccessibleImageIcon

導入されたバージョン:

1.3