123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441 |
- /*
- * $Id$
- * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
- * For details on use and redistribution please refer to the
- * LICENSE file included with these sources.
- */
-
- package org.apache.fop.fo;
-
- import org.apache.fop.datatypes.*;
- import org.apache.fop.fo.expr.Numeric;
- import org.apache.fop.fo.expr.PropertyParser;
- import org.apache.fop.fo.expr.PropertyInfo;
- import org.apache.fop.fo.expr.PropertyException;
- import org.apache.fop.apps.FOPException;
- import java.util.Vector;
-
- public class Property {
-
- public static class Maker {
- private static final String UNKNOWN = "UNKNOWN";
- private String propName;
-
- /**
- * Return the name of the property whose value is being set.
- */
- protected String getPropName() {
- return propName;
- }
-
- /**
- * Construct an instance of a Property.Maker for the given property.
- * @param propName The name of the property to be made.
- */
- protected Maker(String propName) {
- this.propName = propName;
- }
-
- /**
- * Construct an instance of a Property.Maker.
- * Note: the property name is set to "UNKNOWN".
- */
- protected Maker() {
- this.propName = UNKNOWN;
- }
-
-
- /**
- * Default implementation of isInherited.
- * @return A boolean indicating whether this property is inherited.
- */
- public boolean isInherited() {
- return false;
- }
-
- /**
- * Return a boolean indicating whether this property inherits the
- * "specified" value rather than the "computed" value. The default is
- * to inherit the "computed" value.
- * @return If true, property inherits the value specified.
- */
- public boolean inheritsSpecified() {
- return false;
- }
-
-
- /**
- * Return an object implementing the PercentBase interface.
- * This is used to handle properties specified as a percentage of
- * some "base length", such as the content width of their containing
- * box.
- * Overridden by subclasses which allow percent specifications. See
- * the documentation on properties.xsl for details.
- */
- public PercentBase getPercentBase(FObj fo, PropertyList pl) {
- return null;
- }
-
- /**
- * Return a Maker object which is used to set the values on components
- * of compound property types, such as "space".
- * Overridden by property maker subclasses which handle
- * compound properties.
- * @param subprop The name of the component for which a Maker is to
- * returned, for example "optimum", if the FO attribute is
- * space.optimum='10pt'.
- */
- protected Maker getSubpropMaker(String subprop) {
- return null;
- }
-
- /**
- * Return a property value for the given component of a compound
- * property.
- * @param p A property value for a compound property type such as
- * SpaceProperty.
- * @param subprop The name of the component whose value is to be
- * returned.
- * NOTE: this is only to ease porting when calls are made to
- * PropertyList.get() using a component name of a compound property,
- * such as get("space.optimum"). The recommended technique is:
- * get("space").getOptimum().
- * Overridden by property maker subclasses which handle
- * compound properties.
- */
- public Property getSubpropValue(Property p, String subprop) {
- return null;
- }
-
- /**
- * Return a property value for a compound property. If the property
- * value is already partially initialized, this method will modify it.
- * @param baseProp The Property object representing the compound property,
- * such as SpaceProperty.
- * @param partName The name of the component whose value is specified.
- * @param propertyList The propertyList being built.
- * @param fo The FO whose properties are being set.
- * @return A compound property object.
- */
- public Property make(Property baseProp, String partName,
- PropertyList propertyList, String value,
- FObj fo) throws FOPException {
- if (baseProp == null) {
- baseProp = makeCompound(propertyList, fo);
- }
- Maker spMaker = getSubpropMaker(partName);
- if (spMaker != null) {
- Property p = spMaker.make(propertyList, value, fo);
- if (p != null) {
- return setSubprop(baseProp, partName, p);
- }
- } else {
- //getLogger().error("compound property component "
- // + partName + " unknown.");
- }
- return baseProp;
- }
-
- /**
- * Set a component in a compound property and return the modified
- * compound property object.
- * This default implementation returns the original base property
- * without modifying it.
- * It is overridden by property maker subclasses which handle
- * compound properties.
- * @param baseProp The Property object representing the compound property,
- * such as SpaceProperty.
- * @param partName The name of the component whose value is specified.
- * @param subProp A Property object holding the specified value of the
- * component to be set.
- * @return The modified compound property object.
- */
- protected Property setSubprop(Property baseProp, String partName,
- Property subProp) {
- return baseProp;
- }
-
- /**
- * Create a Property object from an attribute specification.
- * @param propertyList The PropertyList object being built for this FO.
- * @param value The attribute value.
- * @param fo The current FO whose properties are being set.
- * @return The initialized Property object.
- */
- public Property make(PropertyList propertyList, String value,
- FObj fo) throws FOPException {
- try {
- Property pret = null;
- String pvalue = value;
- pret = checkEnumValues(value);
- if (pret == null) {
- /* Check for keyword shorthand values to be substituted. */
- pvalue = checkValueKeywords(value);
- // Override parsePropertyValue in each subclass of Property.Maker
- Property p = PropertyParser.parse(pvalue,
- new PropertyInfo(this,
- propertyList, fo));
- pret = convertProperty(p, propertyList, fo);
- } else if (isCompoundMaker()) {
- pret = convertProperty(pret, propertyList, fo);
- }
- if (pret == null) {
- throw new org.apache.fop.fo.expr.PropertyException("No conversion defined");
- } else if (inheritsSpecified()) {
- pret.setSpecifiedValue(pvalue);
- }
- return pret;
- } catch (org.apache.fop.fo.expr.PropertyException propEx) {
- throw new FOPException("Error in " + propName +
- " property value '" + value + "': " +
- propEx);
- }
- }
-
- public Property convertShorthandProperty(PropertyList propertyList,
- Property prop, FObj fo) {
- Property pret = null;
- try {
- pret = convertProperty(prop, propertyList, fo);
- if (pret == null) {
- // If value is a name token, may be keyword or Enum
- String sval = prop.getNCname();
- if (sval != null) {
- // System.err.println("Convert shorthand ncname " + sval);
- pret = checkEnumValues(sval);
- if (pret == null) {
- /* Check for keyword shorthand values to be substituted. */
- String pvalue = checkValueKeywords(sval);
- if (!pvalue.equals(sval)) {
- // System.err.println("Convert shorthand keyword" + pvalue);
- // Substituted a value: must parse it
- Property p =
- PropertyParser.parse(pvalue,
- new PropertyInfo(this,
- propertyList,
- fo));
- pret = convertProperty(p, propertyList, fo);
- }
- }
- }
- }
- } catch (FOPException e) {
-
- //getLogger().error("convertShorthandProperty caught FOPException "
- // + e);
- } catch (org.apache.fop.fo.expr.PropertyException propEx) {
- //getLogger().error("convertShorthandProperty caught PropertyException "
- // + propEx);
- }
- if (pret != null) {
- /*
- * System.err.println("Return shorthand value " + pret.getString() +
- * " for " + getPropName());
- */
- }
- return pret;
- }
-
- protected boolean isCompoundMaker() {
- return false;
- }
-
- public Property checkEnumValues(String value) {
- return null;
- }
-
- /**
- * Return a String to be parsed if the passed value corresponds to
- * a keyword which can be parsed and used to initialize the property.
- * For example, the border-width family of properties can have the
- * initializers "thin", "medium", or "thick". The foproperties.xml
- * file specifies a length value equivalent for these keywords,
- * such as "0.5pt" for "thin". These values are considered parseable,
- * since the Length object is no longer responsible for parsing
- * unit expresssions.
- * @param value The string value of property attribute.
- * @return A String containging a parseable equivalent or null if
- * the passed value isn't a keyword initializer for this Property.
- */
- protected String checkValueKeywords(String value) {
- return value;
- }
-
- /**
- * Return a Property object based on the passed Property object.
- * This method is called if the Property object built by the parser
- * isn't the right type for this property.
- * It is overridden by subclasses when the property specification in
- * foproperties.xml specifies conversion rules.
- * @param p The Property object return by the expression parser
- * @param propertyList The PropertyList object being built for this FO.
- * @param fo The current FO whose properties are being set.
- * @return A Property of the correct type or null if the parsed value
- * can't be converted to the correct type.
- */
- public Property convertProperty(Property p,
- PropertyList propertyList,
- FObj fo) throws FOPException {
- return null;
- }
-
- protected Property convertPropertyDatatype(Property p,
- PropertyList propertyList,
- FObj fo) {
- return null;
- }
-
- /**
- * Return a Property object representing the initial value.
- * @param propertyList The PropertyList object being built for this FO.
- */
- public Property make(PropertyList propertyList) throws FOPException {
- return null;
- }
-
- /**
- * Return a Property object representing the initial value.
- * @param propertyList The PropertyList object being built for this FO.
- * @param parentFO The parent FO for the FO whose property is being made.
- * @return a Property subclass object holding a "compound" property object
- * initialized to the default values for each component.
- */
- protected Property makeCompound(PropertyList propertyList,
- FObj parentFO) throws FOPException {
- return null;
- }
-
- /**
- * Return a Property object representing the value of this property,
- * based on other property values for this FO.
- * A special case is properties which inherit the specified value,
- * rather than the computed value.
- * @param propertyList The PropertyList for the FO.
- * @return Property A computed Property value or null if no rules
- * are specified (in foproperties.xml) to compute the value.
- */
- public Property compute(PropertyList propertyList)
- throws FOPException {
- if (inheritsSpecified()) {
- // recalculate based on last specified value
- // Climb up propertylist and find last spec'd value
- // NEED PROPNAME!!! get from Maker
- Property specProp =
- propertyList.getNearestSpecified(propName);
- if (specProp != null) {
- // Only need to do this if the value is relative!!!
- String specVal = specProp.getSpecifiedValue();
- if (specVal != null) {
- try {
- return make(propertyList, specVal,
- propertyList.getParentFObj());
- } catch (FOPException e) {
- //getLogger()error("Error computing property value for "
- // + propName + " from "
- // + specVal);
- return null;
- }
- }
- }
- }
- return null; // standard
- }
-
- public boolean isCorrespondingForced(PropertyList propertyList) {
- return false;
- }
-
- public Property getShorthand(PropertyList propertyList) {
- return null;
- }
-
- } // end of nested Maker class
-
- /**
- * The original specified value for properties which inherit
- * specified values.
- */
- private String specVal;
-
- /**
- * Set the original value specified for the property attribute.
- * @param specVal The specified value.
- */
- public void setSpecifiedValue(String specVal) {
- this.specVal = specVal;
- }
-
- /**
- * Return the original value specified for the property attribute.
- * @return The specified value as a String.
- */
- public String getSpecifiedValue() {
- return specVal;
- }
-
- /**
- * Accessor functions for all possible Property datatypes
- */
- public Length getLength() {
- return null;
- }
-
- public ColorType getColorType() {
- return null;
- }
-
- public CondLength getCondLength() {
- return null;
- }
-
- public LengthRange getLengthRange() {
- return null;
- }
-
- public LengthPair getLengthPair() {
- return null;
- }
-
- public Space getSpace() {
- return null;
- }
-
- public Keep getKeep() {
- return null;
- }
-
- public int getEnum() {
- return 0;
- }
-
- public char getCharacter() {
- return 0;
- }
-
- public Vector getList() {
- return null;
- } // List of Property objects
-
- public Number getNumber() {
- return null;
- }
-
- // Classes used when evaluating property expressions
- public Numeric getNumeric() {
- return null;
- }
-
- public String getNCname() {
- return null;
- }
-
- public Object getObject() {
- return null;
- }
-
- public String getString() {
- Object o = getObject();
- return (o == null) ? null : o.toString();
- }
-
- }
|