diff options
Diffstat (limited to 'src/java/org/apache/fop/fo/FObj.java')
| -rw-r--r-- | src/java/org/apache/fop/fo/FObj.java | 376 |
1 files changed, 376 insertions, 0 deletions
diff --git a/src/java/org/apache/fop/fo/FObj.java b/src/java/org/apache/fop/fo/FObj.java new file mode 100644 index 000000000..c9a840d54 --- /dev/null +++ b/src/java/org/apache/fop/fo/FObj.java @@ -0,0 +1,376 @@ +/* + * $Id: FObj.java,v 1.40 2003/03/05 21:48:02 jeremias Exp $ + * ============================================================================ + * The Apache Software License, Version 1.1 + * ============================================================================ + * + * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modifica- + * tion, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. The end-user documentation included with the redistribution, if any, must + * include the following acknowledgment: "This product includes software + * developed by the Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, if + * and wherever such third-party acknowledgments normally appear. + * + * 4. The names "FOP" and "Apache Software Foundation" must not be used to + * endorse or promote products derived from this software without prior + * written permission. For written permission, please contact + * apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", nor may + * "Apache" appear in their name, without prior written permission of the + * Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND + * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU- + * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * ============================================================================ + * + * This software consists of voluntary contributions made by many individuals + * on behalf of the Apache Software Foundation and was originally created by + * James Tauber <jtauber@jtauber.com>. For more information on the Apache + * Software Foundation, please see <http://www.apache.org/>. + */ +package org.apache.fop.fo; + +// Java +import java.util.Iterator; +import java.util.ListIterator; +import java.util.ArrayList; +import java.util.List; +import java.util.HashMap; +import java.util.Set; +import java.util.Map; +import org.xml.sax.Attributes; + +// FOP +import org.apache.fop.apps.FOPException; +import org.apache.fop.apps.StructureHandler; +import org.apache.fop.fo.properties.FOPropertyMapping; +import org.apache.fop.fo.flow.Marker; + +/** + * base class for representation of formatting objects and their processing + */ +public class FObj extends FONode { + private static final String FO_URI = "http://www.w3.org/1999/XSL/Format"; + + /** + * Static property list builder that converts xml attributes + * into fo properties. This is static since the underlying + * property mappings for fo are also static. + */ + protected static PropertyListBuilder plb = null; + + /** + * Structure handler used to notify structure events + * such as start end element. + */ + protected StructureHandler structHandler; + + /** + * Formatting properties for this fo element. + */ + public PropertyList properties; + + /** + * Property manager for handler some common properties. + */ + protected PropertyManager propMgr; + + /** + * Id of this fo element of null if no id. + */ + protected String id = null; + + /** + * The children of this node. + */ + protected ArrayList children = null; + + /** + * Markers added to this element. + */ + protected Map markers = null; + + /** + * Create a new formatting object. + * All formatting object classes extend this class. + * + * @param parent the parent node + */ + public FObj(FONode parent) { + super(parent); + } + + /** + * Set the name of this element. + * The prepends "fo:" to the name to indicate it is in the fo namespace. + * + * @param str the xml element name + */ + public void setName(String str) { + name = "fo:" + str; + } + + protected PropertyListBuilder getListBuilder() { + if (plb == null) { + plb = new PropertyListBuilder(); + plb.addList(FOPropertyMapping.getGenericMappings()); + + for (Iterator iter = + FOPropertyMapping.getElementMappings().iterator(); + iter.hasNext();) { + String elem = (String) iter.next(); + plb.addElementList(elem, + FOPropertyMapping.getElementMapping(elem)); + } + } + return plb; + } + + /** + * Handle the attributes for this element. + * The attributes must be used immediately as the sax attributes + * will be altered for the next element. + */ + public void handleAttrs(Attributes attlist) throws FOPException { + FONode par = parent; + while (par != null && !(par instanceof FObj)) { + par = par.parent; + } + PropertyList props = null; + if (par != null) { + props = ((FObj) par).properties; + } + properties = getListBuilder().makeList(FO_URI, name, attlist, props, + (FObj) par); + properties.setFObj(this); + this.propMgr = makePropertyManager(properties); + setWritingMode(); + } + + protected PropertyManager makePropertyManager( + PropertyList propertyList) { + return new PropertyManager(propertyList); + } + + /** + * Add the child to this object. + * + * @param child the child node to add + */ + protected void addChild(FONode child) { + if (containsMarkers() && child.isMarker()) { + addMarker((Marker)child); + } else { + if (children == null) { + children = new ArrayList(); + } + children.add(child); + } + } + + /** + * Set the structure handler for handling structure events. + * + * @param st the structure handler + */ + public void setStructHandler(StructureHandler st) { + structHandler = st; + } + + /** + * lets outside sources access the property list + * first used by PageNumberCitation to find the "id" property + * @param name - the name of the desired property to obtain + * @return the property + */ + public Property getProperty(String name) { + return (properties.get(name)); + } + + /** + * Setup the id for this formatting object. + * Most formatting objects can have an id that can be referenced. + * This methods checks that the id isn't already used by another + * fo and sets the id attribute of this object. + */ + protected void setupID() { + Property prop = this.properties.get("id"); + if (prop != null) { + String str = prop.getString(); + if (str != null && !str.equals("")) { + Set idrefs = structHandler.getIDReferences(); + if (!idrefs.contains(str)) { + id = str; + idrefs.add(id); + } else { + getLogger().warn("duplicate id:" + str + " ignored"); + } + } + } + } + + /** + * Get the id string for this formatting object. + * This will be unique for the fo document. + * + * @return the id string or null if not set + */ + public String getID() { + return id; + } + + /** + * Check if this formatting object generates reference areas. + * + * @return true if generates reference areas + */ + public boolean generatesReferenceAreas() { + return false; + } + + /** + * Check if this formatting object generates inline areas. + * + * @return true if generates inline areas + */ + public boolean generatesInlineAreas() { + return true; + } + + /** + * Check if this formatting object may contain markers. + * + * @return true if this can contian markers + */ + protected boolean containsMarkers() { + return false; + } + + /** + * Set writing mode for this FO. + * Find nearest ancestor, including self, which generates + * reference areas and use the value of its writing-mode property. + * If no such ancestor is found, use the value on the root FO. + */ + protected void setWritingMode() { + FObj p; + FONode parent; + for (p = this; !p.generatesReferenceAreas() + && (parent = p.getParent()) != null + && (parent instanceof FObj); p = (FObj) parent) { + } + this.properties.setWritingMode( + p.getProperty("writing-mode").getEnum()); + } + + /** + * Return a LayoutManager responsible for laying out this FObj's content. + * Must override in subclasses if their content can be laid out. + * @param list the list to add the layout manager(s) to + */ + public void addLayoutManager(List list) { + } + + /** + * Return an iterator over all the children of this FObj. + * @return A ListIterator. + */ + public ListIterator getChildren() { + if (children != null) { + return children.listIterator(); + } + return null; + } + + /** + * Return an iterator over the object's children starting + * at the pased node. + * @param childNode First node in the iterator + * @return A ListIterator or null if childNode isn't a child of + * this FObj. + */ + public ListIterator getChildren(FONode childNode) { + if (children != null) { + int i = children.indexOf(childNode); + if (i >= 0) { + return children.listIterator(i); + } + } + return null; + } + + /** + * Add the marker to this formatting object. + * If this object can contain markers it checks that the marker + * has a unique class-name for this object and that it is + * the first child. + */ + public void addMarker(Marker marker) { + String mcname = marker.getMarkerClassName(); + if (children != null) { + // check for empty children + for (Iterator iter = children.iterator(); iter.hasNext();) { + FONode node = (FONode)iter.next(); + if (node instanceof FOText) { + FOText text = (FOText)node; + if (text.willCreateArea()) { + getLogger().error("fo:marker must be an initial child: " + mcname); + return; + } else { + iter.remove(); + } + } else { + getLogger().error("fo:marker must be an initial child: " + mcname); + return; + } + } + } + if (markers == null) { + markers = new HashMap(); + } + if (!markers.containsKey(mcname)) { + markers.put(mcname, marker); + } else { + getLogger().error("fo:marker 'marker-class-name' " + + "must be unique for same parent: " + mcname); + } + } + + public boolean hasMarkers() { + return markers != null && !markers.isEmpty(); + } + + public Map getMarkers() { + return markers; + } + + /** + * lets layout managers access FO properties via PropertyManager + * @return the property manager for this FO + */ + public PropertyManager getPropertyManager() { + return this.propMgr; + } + +} + |