- All Implemented Interfaces:
- ImageConsumer,- Cloneable
- Direct Known Subclasses:
- BufferedImageFilter,- CropImageFilter,- ReplicateScaleFilter,- RGBImageFilter
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected ImageConsumerThe consumer of the particular image data stream for which this instance of the ImageFilter is filtering data.Fields declared in interface java.awt.image.ImageConsumerCOMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionclone()Clones this object.Returns a unique instance of an ImageFilter object which will actually perform the filtering for the specified ImageConsumer.voidimageComplete(int status) Filters the information provided in the imageComplete method of the ImageConsumer interface.voidResponds to a request for a TopDownLeftRight (TDLR) ordered resend of the pixel data from anImageConsumer.voidsetColorModel(ColorModel model) Filter the information provided in the setColorModel method of the ImageConsumer interface.voidsetDimensions(int width, int height) Filters the information provided in the setDimensions method of the ImageConsumer interface.voidsetHints(int hints) Filters the information provided in the setHints method of the ImageConsumer interface.voidsetPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize) Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of bytes.voidsetPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize) Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of integers.voidsetProperties(Hashtable<?, ?> props) Passes the properties from the source object along after adding a property indicating the stream of filters it has been run through.
- 
Field Details- 
consumerThe 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:
 
 
- 
- 
Constructor Details- 
ImageFilterpublic ImageFilter()Constructs anImageFilter.
 
- 
- 
Method Details- 
getFilterInstanceReturns 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- the specified- ImageConsumer
- Returns:
- an ImageFilterused to perform the filtering for the specifiedImageConsumer.
 
- 
setDimensionspublic void setDimensions(int width, int height) 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. - Specified by:
- setDimensionsin interface- ImageConsumer
- Parameters:
- width- the width of the source image
- height- the height of the source image
- See Also:
 
- 
setPropertiesPasses 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. - Specified by:
- setPropertiesin interface- ImageConsumer
- Parameters:
- props- the properties from the source object
- Throws:
- NullPointerException- if- propsis null
 
- 
setColorModelFilter 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. - Specified by:
- setColorModelin interface- ImageConsumer
- Parameters:
- model- the specified- ColorModel
- See Also:
 
- 
setHintspublic void setHints(int hints) 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. - Specified by:
- setHintsin interface- ImageConsumer
- Parameters:
- hints- a set of hints that the ImageConsumer uses to process the pixels
- See Also:
 
- 
setPixelspublic void setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize) 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. - Specified by:
- setPixelsin interface- ImageConsumer
- Parameters:
- x- the X coordinate of the upper-left corner of the area of pixels to be set
- y- the Y coordinate of the upper-left corner of the area of pixels to be set
- w- the width of the area of pixels
- h- the height of the area of pixels
- model- the specified- ColorModel
- pixels- the array of pixels
- off- the offset into the- pixelsarray
- scansize- the distance from one row of pixels to the next in the- pixelsarray
- See Also:
 
- 
setPixelspublic void setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize) 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. - Specified by:
- setPixelsin interface- ImageConsumer
- Parameters:
- x- the X coordinate of the upper-left corner of the area of pixels to be set
- y- the Y coordinate of the upper-left corner of the area of pixels to be set
- w- the width of the area of pixels
- h- the height of the area of pixels
- model- the specified- ColorModel
- pixels- the array of pixels
- off- the offset into the- pixelsarray
- scansize- the distance from one row of pixels to the next in the- pixelsarray
- See Also:
 
- 
imageCompletepublic void imageComplete(int status) 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. - Specified by:
- imageCompletein interface- ImageConsumer
- Parameters:
- status- the status of image loading
- See Also:
 
- 
resendTopDownLeftRightResponds to a request for a TopDownLeftRight (TDLR) ordered resend of the pixel data from anImageConsumer. When anImageConsumerbeing fed by an instance of thisImageFilterrequests a resend of the data in TDLR order, theFilteredImageSourceinvokes this method of theImageFilter.An ImageFiltersubclass 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 ImageProducerusing this filter as the requestingImageConsumer. 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- the ImageProducer that is feeding this instance of the filter - also the ImageProducer that the request should be forwarded to if necessary
- Throws:
- NullPointerException- if- ipis null
- See Also:
 
- 
 Do not override this method.
 This makes the subclass use the default implementation,
 which is to
 forward the request
 to the indicated 
- 
cloneClones this object.
 
-