<html> <head> <title>Interface XImageConsumer</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XImageConsumer-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">awt</a> :: </p> </td> </tr> <tr> <td class="title">interface XImageConsumer</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies a data sink for an image. </dd> <dd><p>An image consumer is a component which wants to display or just receive an image from an image producer.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XImageProducer.html">XImageProducer</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#init">init</a></td> <td class="imsum_right">initializes the consumer with image dimensions. </td> </tr> <tr> <td class="imsum_left"><a href="#setColorModel">setColorModel</a></td> <td class="imsum_right">changes color model for next pixels typically called once after initialization. </td> </tr> <tr> <td class="imsum_left"><a href="#setPixelsByBytes">setPixelsByBytes</a></td> <td class="imsum_right">delivers a chunk of pixels as <code>long</code> values. </td> </tr> <tr> <td class="imsum_left"><a href="#setPixelsByLongs">setPixelsByLongs</a></td> <td class="imsum_right">delivers a chunk of pixels as <code>byte</code> values. </td> </tr> <tr> <td class="imsum_left"><a href="#complete">complete</a></td> <td class="imsum_right">is called for the notification of the degree to which the image is delivered. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="init" class="membertitle">init</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>init</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Width,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> Height );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>initializes the consumer with image dimensions. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setColorModel" class="membertitle">setColorModel</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>setColorModel</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> BitCount,</td> </tr> <tr> <td/><td valign="top">[in] sequence< long ></td> <td valign="bottom"> RGBAPal,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> RedMask,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> GreenMask,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> BlueMask,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> AlphaMask );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>changes color model for next pixels typically called once after initialization. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setPixelsByBytes" class="membertitle">setPixelsByBytes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>setPixelsByBytes</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nX,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nY,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nWidth,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nHeight,</td> </tr> <tr> <td/><td valign="top">[in] sequence< byte ></td> <td valign="bottom"> aProducerData,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nOffset,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nScanSize );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>delivers a chunk of pixels as <code>long</code> values. </dd> <dd><p>The pixels of the image are delivered using one or more calls to this method. Each call specifies the location and size of the rectangle of source pixels that are contained in the array of pixels. The specified color model object should be used to convert the pixels into their corresponding color and alpha components. Pixel (m,n) is stored in the pixels array at index (n * <var>nScanSize</var> + m + nOffset).</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setPixelsByLongs" class="membertitle">setPixelsByLongs</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>setPixelsByLongs</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nX,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nY,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nWidth,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nHeight,</td> </tr> <tr> <td/><td valign="top">[in] sequence< long ></td> <td valign="bottom"> aProducerData,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nOffset,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nScanSize );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>delivers a chunk of pixels as <code>byte</code> values. </dd> <dd><p>The pixels of the image are delivered using one or more calls to this method. Each call specifies the location and size of the rectangle of source pixels that are contained in the array of pixels. The specified color model object should be used to convert the pixels into their corresponding color and alpha components. Pixel (m,n) is stored in the pixels array at index (n * <var>nScanSize</var> + m + nOffset).</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="complete" class="membertitle">complete</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>complete</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Status,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XImageProducer.html">XImageProducer</a></td> <td valign="bottom"> xProducer );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is called for the notification of the degree to which the image is delivered. </dd> <dd><p>The complete method is called when the image producer has finished delivering all of the pixels that the source image contains, or when a single frame of a multi-frame animation has been completed, or when an error in loading or producing the image has occurred. The image consumer should remove itself from the list of consumers registered with the image producer at this time, unless it is interested in successive frames.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
