blob: 3b30885b94d2221803f56641ccc9ee9de14c9ec0 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
CompositeRable (Apache Batik Javadoc)
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CompositeRable (Apache Batik Javadoc)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CompositeRable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/ComponentTransferRable8Bit.html" title="class in org.apache.batik.ext.awt.image.renderable"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/CompositeRable8Bit.html" title="class in org.apache.batik.ext.awt.image.renderable"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/apache/batik/ext/awt/image/renderable/CompositeRable.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="CompositeRable.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.batik.ext.awt.image.renderable</FONT>
<BR>
Interface CompositeRable</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/Filter.html" title="interface in org.apache.batik.ext.awt.image.renderable">Filter</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/FilterColorInterpolation.html" title="interface in org.apache.batik.ext.awt.image.renderable">FilterColorInterpolation</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true" title="class or interface in java.awt.image.renderable">RenderableImage</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/CompositeRable8Bit.html" title="class in org.apache.batik.ext.awt.image.renderable">CompositeRable8Bit</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>CompositeRable</B><DT>extends <A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/FilterColorInterpolation.html" title="interface in org.apache.batik.ext.awt.image.renderable">FilterColorInterpolation</A></DL>
</PRE>
<P>
Composites a list of images according to a single composite rule.
the image are applied in the order they are in the List given.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_java.awt.image.renderable.RenderableImage"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface java.awt.image.renderable.<A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true" title="class or interface in java.awt.image.renderable">RenderableImage</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#HINTS_OBSERVED" title="class or interface in java.awt.image.renderable">HINTS_OBSERVED</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../org/apache/batik/ext/awt/image/CompositeRule.html" title="class in org.apache.batik.ext.awt.image">CompositeRule</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/CompositeRable.html#getCompositeRule()">getCompositeRule</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the composite rule in use for combining the sources.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/CompositeRable.html#setCompositeRule(org.apache.batik.ext.awt.image.CompositeRule)">setCompositeRule</A></B>(<A HREF="../../../../../../../org/apache/batik/ext/awt/image/CompositeRule.html" title="class in org.apache.batik.ext.awt.image">CompositeRule</A>&nbsp;cr)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the composite rule to use for combining the sources.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/CompositeRable.html#setSources(java.util.List)">setSources</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&nbsp;srcs)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The sources to be composited togeather.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.batik.ext.awt.image.renderable.FilterColorInterpolation"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.batik.ext.awt.image.renderable.<A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/FilterColorInterpolation.html" title="interface in org.apache.batik.ext.awt.image.renderable">FilterColorInterpolation</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/FilterColorInterpolation.html#getOperationColorSpace()">getOperationColorSpace</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/FilterColorInterpolation.html#isColorSpaceLinear()">isColorSpaceLinear</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/FilterColorInterpolation.html#setColorSpaceLinear(boolean)">setColorSpaceLinear</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.batik.ext.awt.image.renderable.Filter"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.batik.ext.awt.image.renderable.<A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/Filter.html" title="interface in org.apache.batik.ext.awt.image.renderable">Filter</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/Filter.html#getBounds2D()">getBounds2D</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/Filter.html#getDependencyRegion(int, java.awt.geom.Rectangle2D)">getDependencyRegion</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/Filter.html#getDirtyRegion(int, java.awt.geom.Rectangle2D)">getDirtyRegion</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/Filter.html#getTimeStamp()">getTimeStamp</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.awt.image.renderable.RenderableImage"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface java.awt.image.renderable.<A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true" title="class or interface in java.awt.image.renderable">RenderableImage</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#createDefaultRendering()" title="class or interface in java.awt.image.renderable">createDefaultRendering</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#createRendering(java.awt.image.renderable.RenderContext)" title="class or interface in java.awt.image.renderable">createRendering</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#createScaledRendering(int, int, java.awt.RenderingHints)" title="class or interface in java.awt.image.renderable">createScaledRendering</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#getHeight()" title="class or interface in java.awt.image.renderable">getHeight</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#getMinX()" title="class or interface in java.awt.image.renderable">getMinX</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#getMinY()" title="class or interface in java.awt.image.renderable">getMinY</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#getProperty(java.lang.String)" title="class or interface in java.awt.image.renderable">getProperty</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#getPropertyNames()" title="class or interface in java.awt.image.renderable">getPropertyNames</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#getSources()" title="class or interface in java.awt.image.renderable">getSources</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#getWidth()" title="class or interface in java.awt.image.renderable">getWidth</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/awt/image/renderable/RenderableImage.html?is-external=true#isDynamic()" title="class or interface in java.awt.image.renderable">isDynamic</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="setSources(java.util.List)"><!-- --></A><H3>
setSources</H3>
<PRE>
void <B>setSources</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&nbsp;srcs)</PRE>
<DL>
<DD>The sources to be composited togeather.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>srcs</CODE> - The list of images to be composited by the composite rule.</DL>
</DD>
</DL>
<HR>
<A NAME="setCompositeRule(org.apache.batik.ext.awt.image.CompositeRule)"><!-- --></A><H3>
setCompositeRule</H3>
<PRE>
void <B>setCompositeRule</B>(<A HREF="../../../../../../../org/apache/batik/ext/awt/image/CompositeRule.html" title="class in org.apache.batik.ext.awt.image">CompositeRule</A>&nbsp;cr)</PRE>
<DL>
<DD>Set the composite rule to use for combining the sources.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cr</CODE> - Composite rule to use.</DL>
</DD>
</DL>
<HR>
<A NAME="getCompositeRule()"><!-- --></A><H3>
getCompositeRule</H3>
<PRE>
<A HREF="../../../../../../../org/apache/batik/ext/awt/image/CompositeRule.html" title="class in org.apache.batik.ext.awt.image">CompositeRule</A> <B>getCompositeRule</B>()</PRE>
<DL>
<DD>Get the composite rule in use for combining the sources.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Composite rule currently in use.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CompositeRable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/ComponentTransferRable8Bit.html" title="class in org.apache.batik.ext.awt.image.renderable"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/CompositeRable8Bit.html" title="class in org.apache.batik.ext.awt.image.renderable"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/apache/batik/ext/awt/image/renderable/CompositeRable.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="CompositeRable.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2017 <a href='http://www.apache.org/'>Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>