- java.lang.Object
-
- java.awt.image.ImageFilter
-
- All Implemented Interfaces:
- ImageConsumer, Cloneable
- Direct Known Subclasses:
- BufferedImageFilter, CropImageFilter, ReplicateScaleFilter, RGBImageFilter
public class ImageFilter extends Object implements ImageConsumer, Cloneable
This class implements a filter for the set of interface methods that are used to deliver data from an ImageProducer to an ImageConsumer. It is meant to be used in conjunction with a FilteredImageSource object to produce filtered versions of existing images. It is a base class that provides the calls needed to implement a "Null filter" which has no effect on the data being passed through. Filters should subclass this class and override the methods which deal with the data that needs to be filtered and modify it as necessary.- See Also:
FilteredImageSource
,ImageConsumer
-
-
Field Summary
Fields 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.-
Fields inherited from interface java.awt.image.ImageConsumer
COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT
-
-
Constructor Summary
Constructors Constructor and Description ImageFilter()
-
Method Summary
Methods Modifier and Type Method and Description Object
clone()
Clones this object.ImageFilter
getFilterInstance(ImageConsumer ic)
Returns a unique instance of an ImageFilter object which will actually perform the filtering for the specified ImageConsumer.void
imageComplete(int status)
Filters the information provided in the imageComplete method of the ImageConsumer interface.void
resendTopDownLeftRight(ImageProducer ip)
Responds to a request for a TopDownLeftRight (TDLR) ordered resend of the pixel data from anImageConsumer
.void
setColorModel(ColorModel model)
Filter the information provided in the setColorModel method of the ImageConsumer interface.void
setDimensions(int width, int height)
Filters the information provided in the setDimensions method of the ImageConsumer interface.void
setHints(int hints)
Filters the information provided in the setHints method of the ImageConsumer interface.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.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.void
setProperties(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 Detail
-
consumer
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.
-
-
Method Detail
-
getFilterInstance
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
- the specifiedImageConsumer
- Returns:
- an
ImageFilter
used to perform the filtering for the specifiedImageConsumer
.
-
setDimensions
public 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:
setDimensions
in interfaceImageConsumer
- Parameters:
width
- the width of the source imageheight
- the height of the source image- See Also:
ImageConsumer.setDimensions(int, int)
-
setProperties
public void setProperties(Hashtable<?,?> props)
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.
- Specified by:
setProperties
in interfaceImageConsumer
- Parameters:
props
- the properties from the source object- Throws:
NullPointerException
- ifprops
is null
-
setColorModel
public void setColorModel(ColorModel model)
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.
- Specified by:
setColorModel
in interfaceImageConsumer
- Parameters:
model
- the specifiedColorModel
- See Also:
ImageConsumer.setColorModel(java.awt.image.ColorModel)
-
setHints
public 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:
setHints
in interfaceImageConsumer
- Parameters:
hints
- a set of hints that the ImageConsumer uses to process the pixels- See Also:
ImageConsumer.setHints(int)
-
setPixels
public 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:
setPixels
in interfaceImageConsumer
- Parameters:
x
- the X coordinate of the upper-left corner of the area of pixels to be sety
- the Y coordinate of the upper-left corner of the area of pixels to be setw
- the width of the area of pixelsh
- the height of the area of pixelsmodel
- the specifiedColorModel
pixels
- the array of pixelsoff
- the offset into thepixels
arrayscansize
- the distance from one row of pixels to the next in thepixels
array- See Also:
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)
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:
setPixels
in interfaceImageConsumer
- Parameters:
x
- the X coordinate of the upper-left corner of the area of pixels to be sety
- the Y coordinate of the upper-left corner of the area of pixels to be setw
- the width of the area of pixelsh
- the height of the area of pixelsmodel
- the specifiedColorModel
pixels
- the array of pixelsoff
- the offset into thepixels
arrayscansize
- the distance from one row of pixels to the next in thepixels
array- See Also:
ImageConsumer.setPixels(int, int, int, int, java.awt.image.ColorModel, byte[], int, int)
-
imageComplete
public 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:
imageComplete
in interfaceImageConsumer
- Parameters:
status
- the status of image loading- See Also:
ImageConsumer.imageComplete(int)
-
resendTopDownLeftRight
public void resendTopDownLeftRight(ImageProducer ip)
Responds to a request for a TopDownLeftRight (TDLR) ordered resend of the pixel data from anImageConsumer
. When anImageConsumer
being fed by an instance of thisImageFilter
requests a resend of the data in TDLR order, theFilteredImageSource
invokes this method of theImageFilter
.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 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
- ifip
is null- See Also:
ImageProducer.requestTopDownLeftRightResend(java.awt.image.ImageConsumer)
-
Do not override this method.
This makes the subclass use the default implementation,
which is to
forward the request
to the indicated
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/awt/image/imagefilter.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.