123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170 |
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
- /* $Id$ */
-
- package org.apache.fop.pdf;
-
- import java.io.IOException;
- import java.io.OutputStream;
-
- /**
- * Interface for a PDF image.
- * This is used for inserting an image into PDF.
- */
- public interface PDFImage {
-
- /**
- * Key to look up XObject.
- * This should be a unique key to refer to the image.
- *
- * @return the key for this image
- */
- String getKey();
-
- /**
- * Setup the PDF image for the current document.
- * Some image formats may need to access the document (for example to
- * add an ICC profile to the document).
- *
- * @param doc the PDF parent document
- * (todo) Remove this and delegate to the XObject
- */
- void setup(PDFDocument doc);
-
- /**
- * Get the image width in pixels.
- *
- * @return the image width
- */
- int getWidth();
-
- /**
- * Get the image height in pixels.
- *
- * @return the image height
- */
- int getHeight();
-
- /**
- * Get the color space for this image.
- * Possible results are: DeviceGray, DeviceRGB, or DeviceCMYK
- *
- * @return the color space
- */
- PDFDeviceColorSpace getColorSpace();
-
- /**
- * Get the bits per color component for this image.
- *
- * @return the bits per component
- */
- int getBitsPerComponent();
-
- /**
- * Check if this image is a PostScript image.
- *
- * @return true if this is a PostScript image
- */
- boolean isPS();
-
- /**
- * Check if this image has a transparent color transparency.
- *
- * Classes such as {@link PDFImageXObject} rely on this simple
- * binary model of transparency (e.g. compare to
- * {@link java.awt.Transparency}) in order to render
- * color key masking (see PDF Spec 1.7 Chapter 8.9.6.4).
- * Therefore only return true if image has fully transparent
- * colors.
- *
- * @return true if it has at least one fully transparent color
- */
- boolean isTransparent();
-
- /**
- * Get the transparent color.
- *
- * @return the transparent color for this image
- */
- PDFColor getTransparentColor();
-
- /**
- * Get the PDF reference for a bitmap mask.
- *
- * @return the PDF reference for the mask image
- */
- String getMask();
-
- /**
- * Get the PDF reference for a soft mask.
- * @return the PDF reference for a soft mask image (or null if there's no soft mask)
- */
- PDFReference getSoftMaskReference();
-
- /** @return true for CMYK images generated by Adobe Photoshop */
- boolean isInverted();
-
- /**
- * Get the PDF Filter to be applied to the image.
- *
- * @return the PDF Filter or null
- */
- PDFFilter getPDFFilter();
-
- // get the image bytes, and bytes properties
-
- /**
- * Writes the raw, unencoded contents of the image to a given output stream.
- *
- * @param out OutputStream to write to
- * @throws IOException if there creating stream
- */
- void outputContents(OutputStream out) throws IOException;
-
- /**
- * Populates the XObject's dictionary with additional values. The values are added to the
- * dictionary after all the values obtained from other methods from this interface have
- * been put into the dictionary. That allows to override certain values.
- * @param dict the dictionary to fill
- */
- void populateXObjectDictionary(PDFDictionary dict);
-
- /**
- * Get the ICC stream for this image.
- *
- * @return the ICC stream for this image if any
- */
- PDFICCStream getICCStream();
-
- /**
- * Returns a hint in form of a String (Possible values from PDFFilterList)
- * indicating which filter setup should be used to encode the object.
- * @return the filter setup hint
- */
- String getFilterHint();
-
- /**
- * Indicates whether multiple image filters are allowed; this is implemented because Adobe
- * Reader does not like multiple FlateDecode filters applied to an image even though that
- * allowed by the PDF spec; this is probable due to security concerns since many PDF malware
- * exploits, like zip bombs, make use of a chain of FlateDecode filters.
- */
- boolean multipleFiltersAllowed();
-
- }
|