org.apache.fop.pdf.PDFICCBasedColorSpace Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fop Show documentation
Show all versions of fop Show documentation
Apache FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting objects (XSL-FO) and the world's first output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PCL, PS, AFP, TIFF, PNG, SVG, XML (area tree representation), Print, AWT and TXT. The primary output target is PDF.
/*
* 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: PDFICCBasedColorSpace.java 1771002 2016-11-23 16:45:53Z ssteiner $ */
package org.apache.fop.pdf;
import java.awt.color.ColorSpace;
import java.awt.color.ICC_Profile;
import java.io.IOException;
import java.io.InputStream;
import java.util.Set;
import org.apache.commons.io.IOUtils;
import org.apache.xmlgraphics.java2d.color.profile.ColorProfileUtil;
/**
* Represents an ICCBased color space in PDF.
*/
public class PDFICCBasedColorSpace extends PDFObject implements PDFColorSpace {
private PDFICCStream iccStream;
private String explicitName;
private int numComponents;
/**
* Constructs a the ICCBased color space with an explicit name (ex. "DefaultRGB").
* @param explicitName an explicit name or null if a name should be generated
* @param iccStream the ICC stream to associate with this color space
*/
public PDFICCBasedColorSpace(String explicitName, PDFICCStream iccStream) {
this.explicitName = explicitName;
this.iccStream = iccStream;
this.numComponents = iccStream.getICCProfile().getNumComponents();
}
/**
* Constructs a the ICCBased color space.
* @param iccStream the ICC stream to associate with this color space
*/
public PDFICCBasedColorSpace(PDFICCStream iccStream) {
this(null, iccStream);
}
/** @return the ICC stream associated with this color space */
public PDFICCStream getICCStream() {
return this.iccStream;
}
/** {@inheritDoc} */
public int getNumComponents() {
return this.numComponents;
}
/** {@inheritDoc} */
public String getName() {
if (explicitName != null) {
return explicitName;
} else {
return "ICC" + iccStream.getObjectNumber();
}
}
/** {@inheritDoc} */
public boolean isDeviceColorSpace() {
return false;
}
/** {@inheritDoc} */
public boolean isRGBColorSpace() {
return getNumComponents() == 3;
}
/** {@inheritDoc} */
public boolean isCMYKColorSpace() {
return getNumComponents() == 4;
}
/** {@inheritDoc} */
public boolean isGrayColorSpace() {
return getNumComponents() == 1;
}
/** {@inheritDoc} */
@Override
protected String toPDFString() {
StringBuffer sb = new StringBuffer(64);
sb.append("[/ICCBased ").append(getICCStream().referencePDF()).append("]");
return sb.toString();
}
/**
* Sets sRGB as the DefaultRGB color space in the PDF document.
* @param pdfDoc the PDF document
* @return the newly installed color space object
*/
public static PDFICCBasedColorSpace setupsRGBAsDefaultRGBColorSpace(PDFDocument pdfDoc) {
PDFICCStream sRGBProfile = setupsRGBColorProfile(pdfDoc);
//Map sRGB as default RGB profile for DeviceRGB
return pdfDoc.getFactory().makeICCBasedColorSpace(null, "DefaultRGB", sRGBProfile);
}
/**
* Installs the sRGB color space in the PDF document.
* @param pdfDoc the PDF document
* @return the newly installed color space object
*/
public static PDFICCBasedColorSpace setupsRGBColorSpace(PDFDocument pdfDoc) {
PDFICCStream sRGBProfile = setupsRGBColorProfile(pdfDoc);
//Map sRGB as default RGB profile for DeviceRGB
return pdfDoc.getFactory().makeICCBasedColorSpace(null, null, sRGBProfile);
}
/**
* Sets up the sRGB color profile in the PDF document. It does so by trying to
* install a very small ICC profile (~4KB) instead of the very big one (~140KB)
* the Sun JVM uses.
* @param pdfDoc the PDF document
* @return the ICC stream with the sRGB profile
*/
public static PDFICCStream setupsRGBColorProfile(PDFDocument pdfDoc) {
ICC_Profile profile;
PDFICCStream sRGBProfile = pdfDoc.getFactory().makePDFICCStream();
InputStream in = PDFDocument.class.getResourceAsStream("sRGB.icc");
if (in != null) {
try {
profile = ColorProfileUtil.getICC_Profile(in);
} catch (IOException ioe) {
throw new RuntimeException(
"Unexpected IOException loading the sRGB profile: " + ioe.getMessage());
} finally {
IOUtils.closeQuietly(in);
}
} else {
// Fallback: Use the sRGB profile from the JRE (about 140KB)
profile = ColorProfileUtil.getICC_Profile(ColorSpace.CS_sRGB);
}
sRGBProfile.setColorSpace(profile, null);
return sRGBProfile;
}
@Override
public void getChildren(Set children) {
super.getChildren(children);
children.add(iccStream);
iccStream.getChildren(children);
}
}