java.awt.image

クラス ImageFilter

java.lang.Object

java.awt.image.ImageFilter

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

ImageConsumer、Cloneable

直系の既知のサブクラス:

BufferedImageFilter, CropImageFilter, ReplicateScaleFilter, RGBImageFilter

public class ImageFilter
extends Object
implements ImageConsumer, Cloneable

このクラスには、一連のインタフェースメソッド用のフィルタが実装されており、ImageProducer から ImageConsumer へデータを転送するために使われます。また、FilteredImageSource と組み合わせて、既存イメージのフィルタ処理に使われます。この基本クラスは、「空フィルタ」を実装するための呼び出しを行います。「空フィルタ」は、転送されてくるデータに何の影響も与えません。フィルタを実装するときは、このクラスをサブクラス化して、データをフィルタ処理するメソッドをオーバーライドします。また、必要に応じて修正を加えます。

関連項目:

FilteredImageSource, ImageConsumer

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected ImageConsumer	consumer 特別なイメージデータストリームのコンシューマであり、ImageFilter のこのインスタンスがデータをフィルタ処理します。

インタフェース java.awt.image.ImageConsumer から継承されたフィールド

COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT

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

コンストラクタ

コンストラクタと説明
ImageFilter()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
Object	clone() このオブジェクトを複製します。
ImageFilter	getFilterInstance(ImageConsumer ic) 指定された ImageConsumer のフィルタリングを実際に行う ImageFilter オブジェクトの一意なインスタンスを返します。
void	imageComplete(int status) ImageConsumer インタフェースの imageComplete メソッドで提供される情報にフィルタをかけます。
void	resendTopDownLeftRight(ImageProducer ip) ImageConsumer からのピクセルデータ再転送要求に応じます。上から下、左から右の順番で処理されます。
void	setColorModel(ColorModel model) ImageConsumer インタフェースの setColorModel メソッドで提供される情報をフィルタ処理します。
void	setDimensions(int width, int height) ImageConsumer インタフェースの setDimensions メソッドで提供される情報をフィルタ処理します。
void	setHints(int hints) ImageConsumer インタフェースの setHints メソッドで提供される情報をフィルタ処理します。
void	setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize) byte 配列をとる ImageConsumer インタフェースの setPixels メソッドで提供される情報にフィルタをかけます。
void	setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize) 整数値配列をとる、ImageConsumer インタフェースの setPixels メソッドで提供される情報にフィルタをかけます。
void	setProperties(Hashtable<?,?> props) フィルタのストリームを通過したことを示すプロパティーを追加したあと、ソースオブジェクトからプロパティーを渡します。

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

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

フィールドの詳細

consumer

protected ImageConsumer consumer

特別なイメージデータストリームのコンシューマであり、ImageFilter のこのインスタンスがデータをフィルタ処理します。この初期化は、コンストラクタの中ではなく、getFilterInstance() メソッドの呼び出し中に行われます。そのときに、FilteredImageSource により、特別なイメージデータストリームのためのオブジェクト固有のインスタンスが生成されます。

関連項目:

getFilterInstance(java.awt.image.ImageConsumer)、ImageConsumer

コンストラクタの詳細

ImageFilter

public ImageFilter()

メソッドの詳細

getFilterInstance

public ImageFilter getFilterInstance(ImageConsumer ic)

指定された ImageConsumer のフィルタリングを実際に行う ImageFilter オブジェクトの一意なインスタンスを返します。デフォルトの実装では、このオブジェクトを複製するだけです。

注:このメソッドは、フィルタ処理の対象となるピクセルで構成される Image の ImageProducer によって呼び出されることを想定して実装されています。このクラスを使用してイメージのピクセルをフィルタ処理する開発者は、このメソッドを直接呼び出さないでください。このメソッドを直接呼び出すと、フィルタ操作を妨げる可能性があります。

パラメータ:

ic - 指定された ImageConsumer

戻り値:

指定された ImageConsumer のフィルタ処理に使用される ImageFilter。

setDimensions

public void setDimensions(int width,
                 int height)

ImageConsumer インタフェースの setDimensions メソッドで提供される情報をフィルタ処理します。

注:このメソッドは、フィルタ処理の対象となるピクセルで構成される Image の ImageProducer によって呼び出されることを想定して実装されています。このクラスを使用してイメージのピクセルをフィルタ処理する開発者は、このメソッドを直接呼び出さないでください。このメソッドを直接呼び出すと、フィルタ操作を妨げる可能性があります。

定義:

setDimensions、インタフェース: ImageConsumer

パラメータ:

width - ソースイメージの幅

height - ソースイメージの高さ

関連項目:

ImageConsumer.setDimensions(int, int)

setProperties

public void setProperties(Hashtable<?,?> props)

フィルタのストリームを通過したことを示すプロパティーを追加したあと、ソースオブジェクトからプロパティーを渡します。

注:このメソッドは、フィルタ処理の対象となるピクセルで構成される Image の ImageProducer によって呼び出されることを想定して実装されています。このクラスを使用してイメージのピクセルをフィルタ処理する開発者は、このメソッドを直接呼び出さないでください。このメソッドを直接呼び出すと、フィルタ操作を妨げる可能性があります。

定義:

setProperties、インタフェース: ImageConsumer

パラメータ:

props - ソースオブジェクトからのプロパティー

例外:

NullPointerException - props が null である場合

setColorModel

public void setColorModel(ColorModel model)

ImageConsumer インタフェースの setColorModel メソッドで提供される情報をフィルタ処理します。

注:このメソッドは、フィルタ処理の対象となるピクセルで構成される Image の ImageProducer によって呼び出されることを想定して実装されています。このクラスを使用してイメージのピクセルをフィルタ処理する開発者は、このメソッドを直接呼び出さないでください。このメソッドを直接呼び出すと、フィルタ操作を妨げる可能性があります。

定義:

setColorModel、インタフェース: ImageConsumer

パラメータ:

model - 指定されたColorModel

関連項目:

ImageConsumer.setColorModel(java.awt.image.ColorModel)

setHints

public void setHints(int hints)

ImageConsumer インタフェースの setHints メソッドで提供される情報をフィルタ処理します。

注:このメソッドは、フィルタ処理の対象となるピクセルで構成される Image の ImageProducer によって呼び出されることを想定して実装されています。このクラスを使用してイメージのピクセルをフィルタ処理する開発者は、このメソッドを直接呼び出さないでください。このメソッドを直接呼び出すと、フィルタ操作を妨げる可能性があります。

定義:

setHints、インタフェース: ImageConsumer

パラメータ:

hints - ImageConsumer がピクセル処理に使用するヒントのセット

関連項目:

ImageConsumer.setHints(int)

setPixels

public void setPixels(int x,
             int y,
             int w,
             int h,
             ColorModel model,
             byte[] pixels,
             int off,
             int scansize)

byte 配列をとる ImageConsumer インタフェースの setPixels メソッドで提供される情報にフィルタをかけます。

注:このメソッドは、フィルタ処理の対象となるピクセルで構成される Image の ImageProducer によって呼び出されることを想定して実装されています。このクラスを使用してイメージのピクセルをフィルタ処理する開発者は、このメソッドを直接呼び出さないでください。このメソッドを直接呼び出すと、フィルタ操作を妨げる可能性があります。

定義:

setPixels、インタフェース: ImageConsumer

パラメータ:

x - 設定されるピクセルの領域の左上隅の X 座標

y - 設定されるピクセルの領域の左上隅の Y 座標

w - ピクセル領域の幅

h - ピクセル領域の高さ

model - 指定されたColorModel

pixels - ピクセルの配列

off - pixels 配列へのオフセット

scansize - pixels 配列内のあるピクセル行から次のピクセル行までの距離

関連項目:

ImageConsumer.setPixels(int, int, int, int, java.awt.image.ColorModel, byte[], int, int)

setPixels

public void setPixels(int x,
             int y,
             int w,
             int h,
             ColorModel model,
             int[] pixels,
             int off,
             int scansize)

整数値配列をとる、ImageConsumer インタフェースの setPixels メソッドで提供される情報にフィルタをかけます。

注:このメソッドは、フィルタ処理の対象となるピクセルで構成される Image の ImageProducer によって呼び出されることを想定して実装されています。このクラスを使用してイメージのピクセルをフィルタ処理する開発者は、このメソッドを直接呼び出さないでください。このメソッドを直接呼び出すと、フィルタ操作を妨げる可能性があります。

定義:

setPixels、インタフェース: ImageConsumer

パラメータ:

x - 設定されるピクセルの領域の左上隅の X 座標

y - 設定されるピクセルの領域の左上隅の Y 座標

w - ピクセル領域の幅

h - ピクセル領域の高さ

model - 指定されたColorModel

pixels - ピクセルの配列

off - pixels 配列へのオフセット

scansize - pixels 配列内のあるピクセル行から次のピクセル行までの距離

関連項目:

ImageConsumer.setPixels(int, int, int, int, java.awt.image.ColorModel, byte[], int, int)

imageComplete

public void imageComplete(int status)

ImageConsumer インタフェースの imageComplete メソッドで提供される情報にフィルタをかけます。

注:このメソッドは、フィルタ処理の対象となるピクセルで構成される Image の ImageProducer によって呼び出されることを想定して実装されています。このクラスを使用してイメージのピクセルをフィルタ処理する開発者は、このメソッドを直接呼び出さないでください。このメソッドを直接呼び出すと、フィルタ操作を妨げる可能性があります。

定義:

imageComplete、インタフェース: ImageConsumer

パラメータ:

status - イメージロードのステータス

関連項目:

ImageConsumer.imageComplete(int)

resendTopDownLeftRight

public void resendTopDownLeftRight(ImageProducer ip)

ImageConsumer からのピクセルデータ再転送要求に応じます。上から下、左から右の順番で処理されます。この ImageFilter のインスタンスによって指定された ImageConsumer が上下左右順でのデータの再送信を要求する場合、FilteredImageSource は ImageFilter のこのメソッドを呼び出します。

ImageFilter サブクラスは、上下左右順でデータを送信するかどうか、およびその方法によって、このメソッドをオーバーライドできる場合とできない場合があります。可能性は 3 つあります。

• このメソッドはオーバーライドしない。これによって、サブクラスはデフォルトの実装を使用する。デフォルトの実装は、要求している ImageConsumer としてこのフィルタを使用して、指定された ImageProducer へ要求を転送する。この動作は、上位のプロデューサオブジェクトが上下左右順でピクセルを送信する場合に、フィルタが上下左右順でピクセルを送信することを判断できる場合に適切
• データを単に送信する場合はメソッドをオーバーライドする。これはフィルタ自体が要求を処理できる場合に適切。たとえば、生成されたピクセルがバッファーなどに保存されている場合など。
• 何も実行しない場合はメソッドをオーバーライドする。これはフィルタで上下左右順にフィルタを通したデータを生成できない場合に適切

パラメータ:

ip - このフィルタのインスタンスを供給する、また必要に応じて要求を転送する ImageProducer

例外:

NullPointerException - ip が null である場合

関連項目:

ImageProducer.requestTopDownLeftRightResend(java.awt.image.ImageConsumer)

clone

public Object clone()

このオブジェクトを複製します。

オーバーライド:

clone、クラス: Object

戻り値:

このインスタンスの複製。

関連項目:

Cloneable