aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/image/AbstractFopImage.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/java/org/apache/fop/image/AbstractFopImage.java')
-rw-r--r--src/java/org/apache/fop/image/AbstractFopImage.java376
1 files changed, 0 insertions, 376 deletions
diff --git a/src/java/org/apache/fop/image/AbstractFopImage.java b/src/java/org/apache/fop/image/AbstractFopImage.java
deleted file mode 100644
index 8d5180149..000000000
--- a/src/java/org/apache/fop/image/AbstractFopImage.java
+++ /dev/null
@@ -1,376 +0,0 @@
-/*
- * 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.image;
-
-// Java
-import java.awt.color.ColorSpace;
-import java.awt.color.ICC_ColorSpace;
-import java.awt.color.ICC_Profile;
-import java.io.InputStream;
-import java.awt.Color;
-
-import org.apache.commons.io.IOUtils;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-import org.apache.fop.datatypes.Length;
-
-/**
- * Base class to implement the FopImage interface.
- *
- * @see FopImage
- */
-public abstract class AbstractFopImage implements FopImage {
-
- /**
- * logging instance
- */
- protected static Log log = LogFactory.getLog(AbstractFopImage.class);
-
- /**
- * Keeps track of what has been loaded.
- */
- protected int loaded = 0;
-
- /**
- * Image width (in pixel).
- */
- protected int width = 0;
-
- /**
- * Image height (in pixel).
- */
- protected int height = 0;
-
- /** Horizontal bitmap resolution (in dpi) */
- protected double dpiHorizontal = 72.0f;
-
- /** Vertical bitmap resolution (in dpi) */
- protected double dpiVertical = 72.0f;
-
- /**
- * Image input stream.
- */
- protected InputStream inputStream = null;
-
- /**
- * ImageReader object (to obtain image header informations).
- */
- protected FopImage.ImageInfo imageInfo = null;
-
- /**
- * Image color space (java.awt.color.ColorSpace).
- */
- protected ColorSpace colorSpace = null;
-
- /**
- * Bits per pixel.
- */
- protected int bitsPerPixel = 0;
-
- /**
- * Image data (pixels, uncompressed).
- */
- protected byte[] bitmaps = null;
-
- /**
- * Image data (undecoded, compressed, for image formats that can be embedded without decoding.
- */
- protected byte[] raw = null;
-
- /**
- * Image transparency.
- */
- protected boolean isTransparent = false;
-
- /**
- * Transparent color (java.awt.Color).
- */
- protected Color transparentColor = null;
-
- /**
- * Photoshop generated CMYK JPEGs are inverted.
- */
- protected boolean invertImage = false;
-
- /**
- * Constructor.
- * Construct a new FopImage object and initialize its default properties:
- * <UL>
- * <LI>image width
- * <LI>image height
- * </UL>
- * The image data isn't kept in memory.
- * @param info image information
- */
- public AbstractFopImage(FopImage.ImageInfo info) {
- this.inputStream = info.inputStream;
- this.imageInfo = info;
- if (this.imageInfo.width != -1) {
- width = imageInfo.width;
- height = imageInfo.height;
- dpiHorizontal = imageInfo.dpiHorizontal;
- dpiVertical = imageInfo.dpiVertical;
- loaded = loaded | DIMENSIONS;
- }
- }
-
- /**
- * Get the mime type for this image.
- *
- * @return the mime type for the image
- */
- public String getMimeType() {
- return imageInfo.mimeType;
- }
-
- /** {@inheritDoc} */
- public String getOriginalURI() {
- return this.imageInfo.originalURI;
- }
-
- /**
- * Load image data and initialize its properties.
- *
- * @param type the type of loading to do
- * @return true if the loading was successful
- */
- public synchronized boolean load(int type) {
- if ((loaded & type) != 0) {
- return true;
- }
- boolean success = true;
- if (((type & DIMENSIONS) != 0) && ((loaded & DIMENSIONS) == 0)) {
- success = success && loadDimensions();
-
- if (!success) {
- return false;
- }
- loaded = loaded | DIMENSIONS;
- }
- if (((type & BITMAP) != 0) && ((loaded & BITMAP) == 0)) {
- success = success && loadBitmap();
- if (success) {
- loaded = loaded | BITMAP;
- }
- }
- if (((type & ORIGINAL_DATA) != 0) && ((loaded & ORIGINAL_DATA) == 0)) {
- success = success && loadOriginalData();
- if (success) {
- loaded = loaded | ORIGINAL_DATA;
- }
- }
- return success;
- }
-
- /**
- * Load the dimensions of the image.
- * All implementations should override this to get and
- * return the dimensions.
- *
- * @return true if the loading was successful
- */
- protected boolean loadDimensions() {
- return false;
- }
-
- /**
- * Load a bitmap array of the image.
- * If the renderer requires a bitmap image then the
- * implementations should override this to load the bitmap.
- *
- * @return true if the loading was successful
- */
- protected boolean loadBitmap() {
- return false;
- }
-
- /**
- * Load the original image data.
- * In some cases the original data can be used by the renderer.
- * This should load the data and any other associated information.
- *
- * @return true if the loading was successful
- */
- protected boolean loadOriginalData() {
- return false;
- }
-
- /**
- * Load the original image data. This is generic code for use by any
- * subclass that wants to use this from a loadOriginalData() implementation.
- *
- * @return true if the loading was successful
- */
- protected boolean loadDefaultOriginalData() {
- if (inputStream == null) {
- throw new IllegalStateException("inputStream is already null or was never set");
- }
- try {
- this.raw = IOUtils.toByteArray(inputStream);
- } catch (java.io.IOException ex) {
- log.error("Error while reading raw image: " + ex.getMessage(), ex);
- return false;
- } finally {
- IOUtils.closeQuietly(inputStream);
- inputStream = null;
- }
- return true;
- }
-
- /**
- * @return the image width (in pixels)
- */
- public int getWidth() {
- return this.width;
- }
-
- /**
- * @return the image height (in pixels)
- */
- public int getHeight() {
- return this.height;
- }
-
- /** {@inheritDoc} */
- public int getIntrinsicWidth() {
- return (int)(getWidth() * 72000 / getHorizontalResolution());
- }
-
- /** {@inheritDoc} */
- public int getIntrinsicHeight() {
- return (int)(getHeight() * 72000 / getVerticalResolution());
- }
-
- /** {@inheritDoc} */
- public Length getIntrinsicAlignmentAdjust() {
- return this.imageInfo.alignmentAdjust;
- }
-
- /** {@inheritDoc} */
- public double getHorizontalResolution() {
- return this.dpiHorizontal;
- }
-
- /** {@inheritDoc} */
- public double getVerticalResolution() {
- return this.dpiVertical;
- }
-
- /**
- * Return the image color space.
- * @return the image color space (java.awt.color.ColorSpace)
- */
- public ColorSpace getColorSpace() {
- return this.colorSpace;
- }
-
- /**
- * Get ICC profile for this image.
- * @return the icc profile or null if not applicable
- */
- public ICC_Profile getICCProfile() {
- if (this.colorSpace != null && this.colorSpace instanceof ICC_ColorSpace) {
- return ((ICC_ColorSpace)this.colorSpace).getProfile();
- }
- return null;
- }
-
- /**
- * Return the number of bits per pixel.
- * @return number of bits per pixel
- */
- public int getBitsPerPixel() {
- return this.bitsPerPixel;
- }
-
- /**
- * Return the image transparency.
- * @return true if the image is transparent
- */
- public boolean isTransparent() {
- return this.isTransparent;
- }
-
- /**
- * Check if this image has a soft mask.
- *
- * @return true if the image also has a soft transparency mask
- */
- public boolean hasSoftMask() {
- return false;
- }
-
- /**
- * Get the soft mask.
- * The soft mask should have the same bitdepth as the image data.
- *
- * @return the data array of soft mask values
- */
- public byte[] getSoftMask() {
- return null;
- }
-
- /**
- * Return the transparent color.
- * @return the transparent color (java.awt.Color)
- */
- public Color getTransparentColor() {
- return this.transparentColor;
- }
-
- /** @return true for CMYK images generated by Adobe Photoshop */
- public boolean isInverted() {
- return this.invertImage;
- }
-
- /**
- * Return the image data (pixels, uncompressed).
- * @return the image data
- */
- public byte[] getBitmaps() {
- return this.bitmaps;
- }
-
- /**
- * Return the image data size (number of bytes taken up by the uncompressed pixels).
- * @return the image data size
- */
- public int getBitmapsSize() {
- return (bitmaps != null ? bitmaps.length : 0);
- }
-
- /**
- * Return the original image data (compressed).
- * @return the original image data
- */
- public byte[] getRessourceBytes() {
- return raw;
- }
-
- /**
- * Return the original image data size (compressed).
- * @return the original image data size
- */
- public int getRessourceBytesSize() {
- return (raw != null ? raw.length : 0);
- }
-
-}
-