KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > image > FopImage


1 /*
2  * $Id: FopImage.java,v 1.8.2.2 2003/02/25 13:38:22 jeremias Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */
51 package org.apache.fop.image;
52
53 import org.apache.fop.datatypes.ColorSpace;
54 import org.apache.fop.pdf.PDFColor;
55 import org.apache.fop.pdf.PDFFilter;
56
57 /**
58  * Class which represents an image
59  * @author Eric SCHAEFFER
60  */
61 public interface FopImage {
62     // Init the object.
63 // If href protocol isn't file://, can load the entire image
64 // and keep it in memory.
65 // Should cache the input stream, and load data when needed.
66 // public FopImage(URL href) throws FopImageException;
67
68     // Get image general properties.
69 // Methods throw exception because they can retrieve data
70 // when needed.
71
72     boolean invertImage();
73
74     // Resource location
75 String JavaDoc getURL();
76
77     // image size
78 int getWidth() throws FopImageException;
79     int getHeight() throws FopImageException;
80
81     // DeviceGray, DeviceRGB, or DeviceCMYK
82 ColorSpace getColorSpace() throws FopImageException;
83
84     // bits per pixel
85 int getBitsPerPixel() throws FopImageException;
86
87     // For transparent images
88 boolean isTransparent() throws FopImageException;
89     PDFColor getTransparentColor() throws FopImageException;
90
91     // get the image bytes, and bytes properties
92
93     // get uncompressed image bytes
94 byte[] getBitmaps() throws FopImageException;
95     // width * (bitsPerPixel / 8) * height, no ?
96 int getBitmapsSize() throws FopImageException;
97
98     // get compressed image bytes
99 // I don't know if we really need it, nor if it
100 // should be changed...
101 byte[] getRessourceBytes() throws FopImageException;
102     int getRessourceBytesSize() throws FopImageException;
103     // return null if no corresponding PDFFilter
104 PDFFilter getPDFFilter() throws FopImageException;
105
106     // release memory
107 void close();
108 }
109
Popular Tags