123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459 |
- /*
- * Copyright 1999-2004 The Apache Software Foundation.
- *
- * Licensed 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$ */
-
- package org.apache.fop.fo;
-
- import java.util.ArrayList;
- import java.util.HashMap;
- import java.util.Iterator;
- import java.util.ListIterator;
- import java.util.Map;
- import java.util.Set;
-
- import org.apache.fop.apps.FOPException;
- import org.apache.fop.fo.flow.Marker;
- import org.apache.fop.fo.properties.Property;
- import org.apache.fop.fo.properties.PropertyMaker;
- import org.xml.sax.Attributes;
- import org.xml.sax.Locator;
-
- /**
- * Base class for representation of formatting objects and their processing.
- */
- public class FObj extends FONode implements Constants {
- private static final String FO_URI = "http://www.w3.org/1999/XSL/Format";
- public static PropertyMaker[] propertyListTable = null;
-
- /**
- * Formatting properties for this fo element.
- */
- public PropertyList propertyList;
-
- /**
- * Property manager for handling 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.
- */
- public ArrayList children = null;
-
- /**
- * Markers added to this element.
- */
- protected Map markers = null;
-
- /**
- * Dynamic layout dimension. Used to resolve relative lengths.
- */
- protected Map layoutDimension = null;
-
- /**
- * Create a new formatting object.
- * All formatting object classes extend this class.
- *
- * @param parent the parent node
- */
- public FObj(FONode parent) {
- super(parent);
-
- if (propertyListTable == null) {
- propertyListTable = new PropertyMaker[Constants.PROPERTY_COUNT+1];
- PropertyMaker[] list = FOPropertyMapping.getGenericMappings();
- for (int i = 1; i < list.length; i++) {
- if (list[i] != null)
- propertyListTable[i] = list[i];
- }
- }
- }
-
- /** Marks input file containing this object **/
- public String systemId;
- /** Marks line number of this object in the input file **/
- public int line;
- /** Marks column number of this object in the input file **/
- public int column;
-
- /**
- * 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;
- }
-
- public void setLocation(Locator locator) {
- if (locator != null) {
- line = locator.getLineNumber();
- column = locator.getColumnNumber();
- systemId = locator.getSystemId();
- }
- }
-
- /**
- * Handle the attributes for this element.
- * The attributes must be used immediately as the sax attributes
- * will be altered for the next element.
- * @param attlist Collection of attributes passed to us from the parser.
- * @throws FOPException for invalid FO data
- */
- public void handleAttrs(Attributes attlist) throws FOPException {
- FObj parentFO = findNearestAncestorFObj();
- PropertyList parentPropertyList = null;
- if (parentFO != null) {
- parentPropertyList = parentFO.getPropertiesForNamespace(FO_URI);
- }
-
- propertyList = new PropertyList(this, parentPropertyList, FO_URI,
- name);
- propertyList.addAttributesToList(attlist);
- this.propMgr = makePropertyManager(propertyList);
- setWritingMode();
- }
-
- /**
- * Find the nearest parent, grandparent, etc. FONode that is also an FObj
- * @return FObj the nearest ancestor FONode that is an FObj
- */
- public FObj findNearestAncestorFObj() {
- FONode par = parent;
- while (par != null && !(par instanceof FObj)) {
- par = par.parent;
- }
- return (FObj) par;
- }
-
- /**
- * Find nearest ancestor which generates Reference Areas.
- *
- * @param includeSelf Set to true to consider the current FObj as an
- * "ancestor". Set to false to only return a true ancestor.
- * @param returnRoot Supposing a condition where no appropriate ancestor
- * FObj is found, setting returnRoot to true will return the FObj with no
- * parent (presumably the root FO). Otherwise, null will be returned.
- * Note that this will override a false setting for includeSelf, and return
- * the current node if it is the root FO. Setting returnRoot to true should
- * always return a valid FObj.
- * @return FObj of the nearest ancestor that generates Reference Areas
- * and fits the parameters.
- */
- private FObj findNearestAncestorGeneratingRAs(boolean includeSelf,
- boolean returnRoot) {
- FObj p = this;
- if (includeSelf && p.generatesReferenceAreas()) {
- return p;
- }
- FObj parent = p.findNearestAncestorFObj();
- if (parent == null && returnRoot) {
- return p;
- }
- do {
- p = parent;
- parent = p.findNearestAncestorFObj();
- } while (parent != null && !p.generatesReferenceAreas());
- if (p.generatesReferenceAreas()) {
- return p;
- }
- // if we got here, it is because parent is null
- if (returnRoot) {
- return p;
- } else {
- return null;
- }
- }
-
- /**
- * For a given namespace, determine whether the properties of this object
- * match that namespace.
- * @param nameSpaceURI the namespace URI to be tested against
- * @return this.propertyList, if the namespaces match; otherwise, null
- */
- public PropertyList getPropertiesForNamespace(String nameSpaceURI) {
- if (this.propertyList == null) {
- return null;
- }
- if (!nameSpaceURI.equals(this.propertyList.getNameSpace())) {
- return null;
- }
- return this.propertyList;
- }
-
- /**
- * @param propertyList the collection of Property objects to be managed
- * @return a PropertyManager for the Property objects
- */
- protected PropertyManager makePropertyManager(
- PropertyList propertyList) {
- return new PropertyManager(propertyList);
- }
-
- /* This section is the implemenation of the property context. */
-
- /**
- * Assign the size of a layout dimension to the key.
- * @param key the Layout dimension, from PercentBase.
- * @param dimension The layout length.
- */
- public void setLayoutDimension(Integer key, int dimension) {
- if (layoutDimension == null){
- layoutDimension = new HashMap();
- }
- layoutDimension.put(key, new Integer(dimension));
- }
-
- /**
- * Assign the size of a layout dimension to the key.
- * @param key the Layout dimension, from PercentBase.
- * @param dimension The layout length.
- */
- public void setLayoutDimension(Integer key, float dimension) {
- if (layoutDimension == null){
- layoutDimension = new HashMap();
- }
- layoutDimension.put(key, new Float(dimension));
- }
-
- /**
- * Return the size associated with the key.
- * @param key The layout dimension key.
- * @return the length.
- */
- public Number getLayoutDimension(Integer key) {
- if (layoutDimension != null) {
- Number result = (Number) layoutDimension.get(key);
- if (result != null) {
- return result;
- }
- }
- if (parent != null) {
- return ((FObj) parent).getLayoutDimension(key);
- }
- return new Integer(0);
- }
-
- /**
- * 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);
- }
- }
-
- /**
- * 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(int propId) {
- return (propertyList.get(propId));
- }
-
- /**
- * 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.
- */
- public void setupID() {
- Property prop = this.propertyList.get(PR_ID);
- if (prop != null) {
- String str = prop.getString();
- if (str != null && !str.equals("")) {
- Set idrefs = getFOTreeControl().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.
- * Use that from the nearest ancestor, including self, which generates
- * reference areas, or from root FO if no ancestor found.
- */
- protected void setWritingMode() {
- FObj p = findNearestAncestorGeneratingRAs(true, true);
- this.propertyList.setWritingMode(
- p.getProperty(PR_WRITING_MODE).getEnum());
- }
-
- /**
- * 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.
- * @param marker Marker to add.
- */
- 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);
- }
- }
-
- /**
- * @return true if there are any Markers attached to this object
- */
- public boolean hasMarkers() {
- return markers != null && !markers.isEmpty();
- }
-
- /**
- * @return th collection of Markers attached to this object
- */
- 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;
- }
-
- /**
- * This is a hook for an FOTreeVisitor subclass to be able to access
- * this object.
- * @param fotv the FOTreeVisitor subclass that can access this object.
- * @see org.apache.fop.fo.FOTreeVisitor
- */
- public void acceptVisitor(FOTreeVisitor fotv) {
- fotv.serveFObj(this);
- }
-
- /**
- * Return a string representation of the fo element.
- */
- public String toString() {
- return getName() + " at line " + line + ":" + column;
- }
-
- }
|