org.apache.fop.fo.expr.InheritedPropFunction 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: InheritedPropFunction.java 679326 2008-07-24 09:35:34Z vhennebert $ */
package org.apache.fop.fo.expr;
import org.apache.fop.fo.FOPropertyMapping;
import org.apache.fop.fo.properties.Property;
/**
* Class modelling the inherited-property-value Property Value function. See
* Sec. 5.10.4 of the XSL-FO standard.
*/
public class InheritedPropFunction extends FunctionBase {
/**
* @return 1 (maximum number of arguments for the inherited-property-value
* function)
*/
public int nbArgs() {
return 1;
}
/**
* @return true (allow padding of arglist with property name)
*/
public boolean padArgsWithPropertyName() {
return true;
}
/**
*
* @param args arguments to be evaluated
* @param pInfo PropertyInfo object to be evaluated
* @return Property satisfying the inherited-property-value
* @throws PropertyException for invalid parameter
*/
public Property eval(Property[] args,
PropertyInfo pInfo) throws PropertyException {
String propName = args[0].getString();
if (propName == null) {
throw new PropertyException("Incorrect parameter to inherited-property-value function");
}
int propId = FOPropertyMapping.getPropertyId(propName);
if (propId < 0) {
throw new PropertyException(
"Unknown property name used with inherited-property-value function: "
+ propName);
}
return pInfo.getPropertyList().getInherited(propId);
}
}