<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!--NewPage-->
<html>
<head>
<!-- Generated by javadoc on Wed Jul 28 01:21:15 GMT 1999 -->
<title>
  Class java.awt.image.ImageFilter
</title>
</head>
<body>
<a name="_top_"></a>
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-java.awt.image.html">This Package</a>  <a href="java.awt.image.FilteredImageSource.html#_top_">Previous</a>  <a href="java.awt.image.IndexColorModel.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
<hr>
<h1>
  Class java.awt.image.ImageFilter
</h1>
<pre>
<a href="java.lang.Object.html#_top_">java.lang.Object</a>
   |
   +----java.awt.image.ImageFilter
</pre>
<hr>
<dl>
  <dt> public class <b>ImageFilter</b>
  <dt> extends <a href="java.lang.Object.html#_top_">Object</a>
  <dt> implements <a href="java.awt.image.ImageConsumer.html#_top_">ImageConsumer</a>, <a href="java.lang.Cloneable.html#_top_">Cloneable</a>
</dl>
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.
<p>
<dl>
    <dt> <b>See Also:</b>
    <dd> <a href="java.awt.image.FilteredImageSource.html#_top_">FilteredImageSource</a>, <a href="java.awt.image.ImageConsumer.html#_top_">ImageConsumer</a>
</dl>
<hr>
<a name="index"></a>
<h2>
  <img src="images/variable-index.gif" width=207 height=38 alt="Variable Index">
</h2>
<dl>
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#consumer"><b>consumer</b></a>
  <dd>  The consumer of the particular image data stream for which this
 instance of the ImageFilter is filtering data.
</dl>
<h2>
  <img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
</h2>
<dl>
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#ImageFilter()"><b>ImageFilter</b></a>()
  <dd> 
</dl>
<h2>
  <img src="images/method-index.gif" width=207 height=38 alt="Method Index">
</h2>
<dl>
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#clone()"><b>clone</b></a>()
  <dd>  Clones this object.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getFilterInstance(java.awt.image.ImageConsumer)"><b>getFilterInstance</b></a>(ImageConsumer)
  <dd>  Returns a unique instance of an ImageFilter object which will
 actually perform the filtering for the specified ImageConsumer.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#imageComplete(int)"><b>imageComplete</b></a>(int)
  <dd>  Filters the information provided in the imageComplete method of
 the ImageConsumer interface.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#resendTopDownLeftRight(java.awt.image.ImageProducer)"><b>resendTopDownLeftRight</b></a>(ImageProducer)
  <dd>  Responds to a request for a TopDownLeftRight (TDLR) ordered resend
 of the pixel data from an ImageConsumer.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#setColorModel(java.awt.image.ColorModel)"><b>setColorModel</b></a>(ColorModel)
  <dd>  Filter the information provided in the setColorModel method
 of the ImageConsumer interface.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#setDimensions(int, int)"><b>setDimensions</b></a>(int, int)
  <dd>  Filters the information provided in the setDimensions method
 of the ImageConsumer interface.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#setHints(int)"><b>setHints</b></a>(int)
  <dd>  Filters the information provided in the setHints method
 of the ImageConsumer interface.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#setPixels(int, int, int, int, java.awt.image.ColorModel, byte[], int, int)"><b>setPixels</b></a>(int, int, int, int, ColorModel, byte[], int, int)
  <dd>  Filters the information provided in the setPixels method of the
 ImageConsumer interface which takes an array of bytes.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#setPixels(int, int, int, int, java.awt.image.ColorModel, int[], int, int)"><b>setPixels</b></a>(int, int, int, int, ColorModel, int[], int, int)
  <dd>  Filters the information provided in the setPixels method of the
 ImageConsumer interface which takes an array of integers.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#setProperties(java.util.Hashtable)"><b>setProperties</b></a>(Hashtable)
  <dd>  Passes the properties from the source object along after adding a
 property indicating the stream of filters it has been run through.
</dl>
<a name="variables"></a>
<h2>
  <img src="images/variables.gif" width=153 height=38 alt="Variables">
</h2>
<a name="consumer"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
<b>consumer</b>
<pre>
 protected <a href="java.awt.image.ImageConsumer.html#_top_">ImageConsumer</a> consumer
</pre>
<dl>
  <dd> 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.<p>
  <dd><dl> 
    <dt> <b>See Also:</b>
    <dd> <a href="#getFilterInstance">getFilterInstance</a>, <a href="java.awt.image.ImageConsumer.html#_top_">ImageConsumer</a>
  </dl></dd>
</dl>
<a name="constructors"></a>
<h2>
  <img src="images/constructors.gif" width=231 height=38 alt="Constructors">
</h2>
<a name="ImageFilter"></a>
<a name="ImageFilter()"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
<b>ImageFilter</b>
<pre>
 public ImageFilter()
</pre>
<a name="methods"></a>
<h2>
  <img src="images/methods.gif" width=151 height=38 alt="Methods">
</h2>
<a name="getFilterInstance(java.awt.image.ImageConsumer)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getFilterInstance"><b>getFilterInstance</b></a>
<pre>
 public <a href="#_top_">ImageFilter</a> getFilterInstance(<a href="java.awt.image.ImageConsumer.html#_top_">ImageConsumer</a> ic)
</pre>
<dl>
  <dd> 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.
<p>
</dl>
<a name="setDimensions(int, int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="setDimensions"><b>setDimensions</b></a>
<pre>
 public void setDimensions(int width,
                           int height)
</pre>
<dl>
  <dd> Filters the information provided in the setDimensions method
 of the ImageConsumer interface.
<p>
  <dd><dl>
    <dt> <b>See Also:</b>
    <dd> <a href="java.awt.image.ImageConsumer.html#setDimensions">setDimensions</a>
  </dl></dd>
</dl>
<a name="setProperties(java.util.Hashtable)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="setProperties"><b>setProperties</b></a>
<pre>
 public void setProperties(<a href="java.util.Hashtable.html#_top_">Hashtable</a> props)
</pre>
<dl>
  <dd> Passes the properties from the source object along after adding a
 property indicating the stream of filters it has been run through.
<p>
</dl>
<a name="setColorModel(java.awt.image.ColorModel)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="setColorModel"><b>setColorModel</b></a>
<pre>
 public void setColorModel(<a href="java.awt.image.ColorModel.html#_top_">ColorModel</a> model)
</pre>
<dl>
  <dd> Filter the information provided in the setColorModel method
 of the ImageConsumer interface.
<p>
  <dd><dl>
    <dt> <b>See Also:</b>
    <dd> <a href="java.awt.image.ImageConsumer.html#setColorModel">setColorModel</a>
  </dl></dd>
</dl>
<a name="setHints(int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="setHints"><b>setHints</b></a>
<pre>
 public void setHints(int hints)
</pre>
<dl>
  <dd> Filters the information provided in the setHints method
 of the ImageConsumer interface.
<p>
  <dd><dl>
    <dt> <b>See Also:</b>
    <dd> <a href="java.awt.image.ImageConsumer.html#setHints">setHints</a>
  </dl></dd>
</dl>
<a name="setPixels(int, int, int, int, java.awt.image.ColorModel, byte[], int, int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="setPixels"><b>setPixels</b></a>
<pre>
 public void setPixels(int x,
                       int y,
                       int w,
                       int h,
                       <a href="java.awt.image.ColorModel.html#_top_">ColorModel</a> model,
                       byte pixels[],
                       int off,
                       int scansize)
</pre>
<dl>
  <dd> Filters the information provided in the setPixels method of the
 ImageConsumer interface which takes an array of bytes.
<p>
  <dd><dl>
    <dt> <b>See Also:</b>
    <dd> <a href="java.awt.image.ImageConsumer.html#setPixels">setPixels</a>
  </dl></dd>
</dl>
<a name="setPixels(int, int, int, int, java.awt.image.ColorModel, int[], int, int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="setPixels"><b>setPixels</b></a>
<pre>
 public void setPixels(int x,
                       int y,
                       int w,
                       int h,
                       <a href="java.awt.image.ColorModel.html#_top_">ColorModel</a> model,
                       int pixels[],
                       int off,
                       int scansize)
</pre>
<dl>
  <dd> Filters the information provided in the setPixels method of the
 ImageConsumer interface which takes an array of integers.
<p>
  <dd><dl>
    <dt> <b>See Also:</b>
    <dd> <a href="java.awt.image.ImageConsumer.html#setPixels">setPixels</a>
  </dl></dd>
</dl>
<a name="imageComplete(int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="imageComplete"><b>imageComplete</b></a>
<pre>
 public void imageComplete(int status)
</pre>
<dl>
  <dd> Filters the information provided in the imageComplete method of
 the ImageConsumer interface.
<p>
  <dd><dl>
    <dt> <b>See Also:</b>
    <dd> <a href="java.awt.image.ImageConsumer.html#imageComplete">imageComplete</a>
  </dl></dd>
</dl>
<a name="resendTopDownLeftRight(java.awt.image.ImageProducer)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="resendTopDownLeftRight"><b>resendTopDownLeftRight</b></a>
<pre>
 public void resendTopDownLeftRight(<a href="java.awt.image.ImageProducer.html#_top_">ImageProducer</a> ip)
</pre>
<dl>
  <dd> Responds to a request for a TopDownLeftRight (TDLR) ordered resend
 of the pixel data from an ImageConsumer.
 The ImageFilter can respond to this request in one of three ways.
 <ol>
 <li>If the filter can determine that it will forward the pixels in
 TDLR order if its upstream producer object sends them
 in TDLR order, then the request is automatically forwarded by
 default to the indicated ImageProducer using this filter as the
 requesting ImageConsumer, so no override is necessary.
 <li>If the filter can resend the pixels in the right order on its
 own (presumably because the generated pixels have been saved in
 some sort of buffer), then it can override this method and
 simply resend the pixels in TDLR order as specified in the
 ImageProducer API.  <li>If the filter simply returns from this
 method then the request will be ignored and no resend will
 occur.  </ol>
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> ip - The ImageProducer that is feeding this instance of
 the filter - also the ImageProducer that the request should be
 forwarded to if necessary.
    <dt> <b>See Also:</b>
    <dd> <a href="java.awt.image.ImageProducer.html#requestTopDownLeftRightResend">requestTopDownLeftRightResend</a>
  </dl></dd>
</dl>
<a name="clone()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="clone"><b>clone</b></a>
<pre>
 public <a href="java.lang.Object.html#_top_">Object</a> clone()
</pre>
<dl>
  <dd> Clones this object.
<p>
  <dd><dl>
    <dt> <b>Overrides:</b>
    <dd> <a href="java.lang.Object.html#clone()">clone</a> in class <a href="java.lang.Object.html#_top_">Object</a>
  </dl></dd>
</dl>
<hr>
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-java.awt.image.html">This Package</a>  <a href="java.awt.image.FilteredImageSource.html#_top_">Previous</a>  <a href="java.awt.image.IndexColorModel.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
</body>
</html>
