org.apache.fop.fo.expr.RGBICCColorFunction 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: RGBICCColorFunction.java 1328964 2012-04-22 20:09:49Z gadams $ */
package org.apache.fop.fo.expr;
import org.apache.fop.datatypes.PercentBase;
import org.apache.fop.datatypes.PercentBaseContext;
import org.apache.fop.fo.pagination.ColorProfile;
import org.apache.fop.fo.pagination.Declarations;
import org.apache.fop.fo.properties.ColorProperty;
import org.apache.fop.fo.properties.Property;
import org.apache.fop.util.ColorUtil;
/**
* Implements the rgb-icc() function.
*/
class RGBICCColorFunction extends FunctionBase {
/** {@inheritDoc} */
public int getRequiredArgsCount() {
return 4;
}
@Override
/** {@inheritDoc} */
public boolean hasVariableArgs() {
return true;
}
@Override
/** {@inheritDoc} */
public PercentBase getPercentBase() {
return new ICCPercentBase();
}
/** {@inheritDoc} */
public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException {
// Map color profile NCNAME to src from declarations/color-profile element
String colorProfileName = args[3].getString();
Declarations decls = (pInfo.getFO() != null
? pInfo.getFO().getRoot().getDeclarations()
: null);
ColorProfile cp = null;
if (decls == null) {
//function used in a color-specification
//on a FO occurring:
//a) before the fo:declarations,
//b) or in a document without fo:declarations?
//=> return the sRGB fallback
if (!ColorUtil.isPseudoProfile(colorProfileName)) {
Property[] rgbArgs = new Property[3];
System.arraycopy(args, 0, rgbArgs, 0, 3);
return new RGBColorFunction().eval(rgbArgs, pInfo);
}
} else {
cp = decls.getColorProfile(colorProfileName);
if (cp == null) {
if (!ColorUtil.isPseudoProfile(colorProfileName)) {
PropertyException pe = new PropertyException("The " + colorProfileName
+ " color profile was not declared");
pe.setPropertyInfo(pInfo);
throw pe;
}
}
}
String src = (cp != null ? cp.getSrc() : "");
float red = 0;
float green = 0;
float blue = 0;
red = args[0].getNumber().floatValue();
green = args[1].getNumber().floatValue();
blue = args[2].getNumber().floatValue();
/* Verify rgb replacement arguments */
if ((red < 0 || red > 255) || (green < 0 || green > 255) || (blue < 0 || blue > 255)) {
throw new PropertyException("Color values out of range. "
+ "Arguments to rgb-icc() must be [0..255] or [0%..100%]");
}
// rgb-icc is replaced with fop-rgb-icc which has an extra fifth argument containing the
// color profile src attribute as it is defined in the color-profile declarations element.
StringBuffer sb = new StringBuffer();
sb.append("fop-rgb-icc(");
sb.append(red / 255f);
sb.append(',').append(green / 255f);
sb.append(',').append(blue / 255f);
for (int ix = 3; ix < args.length; ix++) {
if (ix == 3) {
sb.append(',').append(colorProfileName);
sb.append(',').append(src);
} else {
sb.append(',').append(args[ix]);
}
}
sb.append(")");
return ColorProperty.getInstance(pInfo.getUserAgent(), sb.toString());
}
private static final class ICCPercentBase implements PercentBase {
/** {@inheritDoc} */
public int getBaseLength(PercentBaseContext context) throws PropertyException {
return 0;
}
/** {@inheritDoc} */
public double getBaseValue() {
return 255f;
}
/** {@inheritDoc} */
public int getDimension() {
return 0;
}
}
}