OpenJDK 27 · java.awt.image.ImageFilter · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected ImageConsumer	consumer The consumer of the particular image data stream for which this instance of the ImageFilter is filtering data.

Access	Constructor and Description
public	ImageFilter() Constructs an `ImageFilter`.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Clones this object.
public ImageFilter	Returns: an `ImageFilter` used to perform the filtering for the specified `ImageConsumer`. getFilterInstance(ImageConsumer the specified `ImageConsumer` ic) Returns a unique instance of an ImageFilter object which will actually perform the filtering for the specified ImageConsumer.
public void	imageComplete(int status) Implements java.awt.image.ImageConsumer.imageComplete. Filters the information provided in the imageComplete method of the ImageConsumer interface.
public void	resendTopDownLeftRight(ImageProducer the ImageProducer that is feeding this instance of the filter - also the ImageProducer that the request should be forwarded to if necessary ip) Responds to a request for a TopDownLeftRight (TDLR) ordered resend of the pixel data from an `ImageConsumer`.
public void	setColorModel(ColorModel model) Implements java.awt.image.ImageConsumer.setColorModel. Filter the information provided in the setColorModel method of the ImageConsumer interface.
public void	setDimensions(int width, int height) Implements java.awt.image.ImageConsumer.setDimensions. Filters the information provided in the setDimensions method of the ImageConsumer interface.
public void	setHints(int hints) Implements java.awt.image.ImageConsumer.setHints. Filters the information provided in the setHints method of the ImageConsumer interface.
public void	setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize) Implements java.awt.image.ImageConsumer.setPixels. Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of bytes.
public void	setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize) Implements java.awt.image.ImageConsumer.setPixels. Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of integers.
public void	setProperties(Hashtable<?, ?> the properties from the source object props) Implements java.awt.image.ImageConsumer.setProperties. Passes the properties from the source object along after adding a property indicating the stream of filters it has been run through.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

consumer	back to summary
protected ImageConsumer consumer The consumer of the particular image data stream for which this instance of the ImageFilter is filtering data. It is not initialized during the constructor, but rather during the getFilterInstance() method call when the FilteredImageSource is creating a unique instance of this object for a particular image data stream. See Also `getFilterInstance`, `ImageConsumer`

ImageFilter	back to summary
public ImageFilter() Constructs an `ImageFilter`.

Method Detail

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Clones this object.

clone

back to summary

public Object clone()

Overrides java.lang.Object.clone.

Clones this object.

getFilterInstance back to summary

getFilterInstance	back to summary
public ImageFilter getFilterInstance(ImageConsumer ic) Returns a unique instance of an ImageFilter object which will actually perform the filtering for the specified ImageConsumer. The default implementation just clones this object. Note This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation. Parameters ic:ImageConsumer the specified `ImageConsumer` Returns:ImageFilter an `ImageFilter` used to perform the filtering for the specified `ImageConsumer`.

public ImageFilter getFilterInstance(ImageConsumer ic)

Returns a unique instance of an ImageFilter object which will actually perform the filtering for the specified ImageConsumer. The default implementation just clones this object.

Note

This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation.

Parameters

ic:ImageConsumer: the specified ImageConsumer

Returns:ImageFilter

an ImageFilter used to perform the filtering for the specified ImageConsumer.

imageComplete back to summary

imageComplete	back to summary
public void imageComplete(int status) Implements java.awt.image.ImageConsumer.imageComplete. Filters the information provided in the imageComplete method of the ImageConsumer interface. Note This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation. See Also `ImageConsumer#imageComplete`

public void imageComplete(int status)

Implements java.awt.image.ImageConsumer.imageComplete.

Filters the information provided in the imageComplete method of the ImageConsumer interface.

Note

See Also: ImageConsumer#imageComplete

resendTopDownLeftRight back to summary

resendTopDownLeftRight	back to summary
public void resendTopDownLeftRight(ImageProducer ip) Responds to a request for a TopDownLeftRight (TDLR) ordered resend of the pixel data from an `ImageConsumer`. When an `ImageConsumer` being fed by an instance of this `ImageFilter` requests a resend of the data in TDLR order, the `FilteredImageSource` invokes this method of the `ImageFilter`. An `ImageFilter` subclass might override this method or not, depending on if and how it can send data in TDLR order. Three possibilities exist: Do not override this method. This makes the subclass use the default implementation, which is to forward the request to the indicated `ImageProducer` using this filter as the requesting `ImageConsumer`. This behavior is appropriate if the filter can determine that it will forward the pixels in TDLR order if its upstream producer object sends them in TDLR order. Override the method to simply send the data. This is appropriate if the filter can handle the request itself — for example, if the generated pixels have been saved in some sort of buffer. Override the method to do nothing. This is appropriate if the filter cannot produce filtered data in TDLR order. Parameters ip:ImageProducer the ImageProducer that is feeding this instance of the filter - also the ImageProducer that the request should be forwarded to if necessary Exceptions NullPointerException: if `ip` is null See Also `ImageProducer#requestTopDownLeftRightResend`

public void resendTopDownLeftRight(ImageProducer ip)

Responds to a request for a TopDownLeftRight (TDLR) ordered resend of the pixel data from an ImageConsumer. When an ImageConsumer being fed by an instance of this ImageFilter requests a resend of the data in TDLR order, the FilteredImageSource invokes this method of the ImageFilter.

An ImageFilter subclass might override this method or not, depending on if and how it can send data in TDLR order. Three possibilities exist:

Do not override this method. This makes the subclass use the default implementation, which is to forward the request to the indicated ImageProducer using this filter as the requesting ImageConsumer. This behavior is appropriate if the filter can determine that it will forward the pixels in TDLR order if its upstream producer object sends them in TDLR order.
Override the method to simply send the data. This is appropriate if the filter can handle the request itself — for example, if the generated pixels have been saved in some sort of buffer.
Override the method to do nothing. This is appropriate if the filter cannot produce filtered data in TDLR order.

Parameters

ip:ImageProducer: the ImageProducer that is feeding this instance of the filter - also the ImageProducer that the request should be forwarded to if necessary

Exceptions

NullPointerException:: if ip is null

setColorModel back to summary

setColorModel	back to summary
public void setColorModel(ColorModel model) Implements java.awt.image.ImageConsumer.setColorModel. Filter the information provided in the setColorModel method of the ImageConsumer interface. Note This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation. See Also `ImageConsumer#setColorModel`

public void setColorModel(ColorModel model)

Implements java.awt.image.ImageConsumer.setColorModel.

Filter the information provided in the setColorModel method of the ImageConsumer interface.

Note

See Also: ImageConsumer#setColorModel

setDimensions back to summary

setDimensions	back to summary
public void setDimensions(int width, int height) Implements java.awt.image.ImageConsumer.setDimensions. Filters the information provided in the setDimensions method of the ImageConsumer interface. Note This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation. See Also `ImageConsumer#setDimensions`

public void setDimensions(int width, int height)

Implements java.awt.image.ImageConsumer.setDimensions.

Filters the information provided in the setDimensions method of the ImageConsumer interface.

Note

See Also: ImageConsumer#setDimensions

setHints back to summary

setHints	back to summary
public void setHints(int hints) Implements java.awt.image.ImageConsumer.setHints. Filters the information provided in the setHints method of the ImageConsumer interface. Note This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation. See Also `ImageConsumer#setHints`

public void setHints(int hints)

Implements java.awt.image.ImageConsumer.setHints.

Filters the information provided in the setHints method of the ImageConsumer interface.

Note

See Also: ImageConsumer#setHints

setPixels back to summary

setPixels	back to summary
public void setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize) Implements java.awt.image.ImageConsumer.setPixels. Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of bytes. Note This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation. See Also `ImageConsumer#setPixels`

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

Implements java.awt.image.ImageConsumer.setPixels.

Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of bytes.

Note

See Also: ImageConsumer#setPixels

setPixels back to summary

setPixels	back to summary
public void setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize) Implements java.awt.image.ImageConsumer.setPixels. Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of integers. Note This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation. See Also `ImageConsumer#setPixels`

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

Implements java.awt.image.ImageConsumer.setPixels.

Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of integers.

Note

See Also: ImageConsumer#setPixels

setProperties back to summary

setProperties	back to summary
public void setProperties(Hashtable<?, ?> props) Implements java.awt.image.ImageConsumer.setProperties. Passes the properties from the source object along after adding a property indicating the stream of filters it has been run through. Note This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation. Parameters props:Hashtable<?, ?> the properties from the source object Exceptions NullPointerException: if `props` is null

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

Implements java.awt.image.ImageConsumer.setProperties.

Passes the properties from the source object along after adding a property indicating the stream of filters it has been run through.

Note

Parameters

props:Hashtable<?, ?>: the properties from the source object

Exceptions

NullPointerException:: if props is null

public Class ImageFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail