Moved sources from src/org/** to src/java/org/**

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196061 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 289 insertions, 0 deletions

diff --git a/src/java/org/apache/fop/fo/pagination/Region.java b/src/java/org/apache/fop/fo/pagination/Region.java
new file mode 100644
index 000000000..682595a47
--- /dev/null
+++ b/src/java/org/apache/fop/fo/pagination/Region.java
@@ -0,0 +1,289 @@
+/*
+ * $Id: Region.java,v 1.18 2003/03/06 13:42:41 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.pagination;
+
+// Java
+import java.awt.Rectangle;
+import java.awt.geom.Rectangle2D;
+
+// FOP
+import org.apache.fop.datatypes.FODimension;
+import org.apache.fop.fo.FObj;
+import org.apache.fop.fo.FONode;
+import org.apache.fop.layout.BorderAndPadding;
+import org.apache.fop.layout.BackgroundProps;
+import org.apache.fop.apps.FOPException;
+import org.apache.fop.area.CTM;
+import org.apache.fop.area.RegionViewport;
+import org.apache.fop.area.RegionReference;
+import org.apache.fop.layoutmgr.TraitSetter;
+
+// SAX
+import org.xml.sax.Attributes;
+
+/**
+ * This is an abstract base class for pagination regions
+ */
+public abstract class Region extends FObj {
+
+    private static final String PROP_REGION_NAME = "region-name";
+
+    /** Key for before regions */
+    public static final String BEFORE = "before";
+    /** Key for start regions */
+    public static final String START =  "start";
+    /** Key for end regions */
+    public static final String END =    "end";
+    /** Key for after regions */
+    public static final String AFTER =  "after";
+    /** Key for body regions */
+    public static final String BODY =   "body";
+
+    private SimplePageMaster layoutMaster;
+    private String regionName;
+
+    /** Holds the overflow attribute */
+    protected int overflow;
+    /** Holds the writing mode */
+    protected int wm;
+
+    /**
+     * @see org.apache.fop.fo.FONode#FONode(FONode)
+     */
+    protected Region(FONode parent) {
+        super(parent);
+    }
+
+    /**
+     * @see org.apache.fop.fo.FONode#handleAttrs(Attributes)
+     */
+    public void handleAttrs(Attributes attlist) throws FOPException {
+        super.handleAttrs(attlist);
+
+        // regions may have name, or default
+        if (null == this.properties.get(PROP_REGION_NAME)) {
+            setRegionName(getDefaultRegionName());
+        } else if (this.properties.get(PROP_REGION_NAME).getString().equals("")) {
+            setRegionName(getDefaultRegionName());
+        } else {
+            setRegionName(this.properties.get(PROP_REGION_NAME).getString());
+            // check that name is OK. Not very pretty.
+            if (isReserved(getRegionName())
+                    && !getRegionName().equals(getDefaultRegionName())) {
+                throw new FOPException(PROP_REGION_NAME + " '" + regionName
+                        + "' for " + this.name
+                        + " not permitted.");
+            }
+        }
+
+        if (parent instanceof SimplePageMaster) {
+            layoutMaster = (SimplePageMaster)parent;
+        } else {
+            throw new FOPException(this.name + " must be child "
+                    + "of simple-page-master, not "
+                    + parent.getName());
+        }
+        this.wm = this.properties.get("writing-mode").getEnum();
+    }
+
+    /**
+     * Creates a RegionViewport Area object for this pagination Region.
+     * @param reldims relative dimensions
+     * @param pageCTM page coordinate transformation matrix
+     * @return the new region viewport
+     */
+    public RegionViewport makeRegionViewport(FODimension reldims, CTM pageCTM) {
+        Rectangle2D relRegionRect = getViewportRectangle(reldims);
+        Rectangle2D absRegionRect = pageCTM.transform(relRegionRect);
+        // Get the region viewport rectangle in absolute coords by
+        // transforming it using the page CTM
+        RegionViewport rv = new RegionViewport(absRegionRect);
+        setRegionViewportTraits(rv);
+        return rv;
+    }
+
+    /**
+     * Set the region viewport traits.
+     * The viewport has the border, background and
+     * clipping overflow traits.
+     *
+     * @param r the region viewport
+     */
+    protected void setRegionViewportTraits(RegionViewport r) {
+        // Common Border, Padding, and Background Properties
+        BorderAndPadding bap = propMgr.getBorderAndPadding();
+        BackgroundProps bProps = propMgr.getBackgroundProps();
+        TraitSetter.addBorders(r, bap);
+        TraitSetter.addBackground(r, bProps);
+
+        // this.properties.get("clip");
+        // this.properties.get("display-align");
+        this.overflow = this.properties.get("overflow").getEnum();
+    }
+
+    protected abstract Rectangle getViewportRectangle(FODimension pageRefRect);
+
+    /**
+     * Create the region reference area for this region master.
+     * @param absRegVPRect The region viewport rectangle is "absolute" coordinates
+     * where x=distance from left, y=distance from bottom, width=right-left
+     * height=top-bottom
+     * @return a new region reference area
+     */
+    public RegionReference makeRegionReferenceArea(Rectangle2D absRegVPRect) {
+        RegionReference r = new RegionReference(getRegionAreaClass());
+        setRegionPosition(r, absRegVPRect);
+        return r;
+    }
+
+    /**
+     * Set the region position inside the region viewport.
+     * This sets the trasnform that is used to place the contents of
+     * the region.
+     *
+     * @param r the region reference area
+     * @param absRegVPRect the rectangle to place the region contents
+     */
+    protected void setRegionPosition(RegionReference r, Rectangle2D absRegVPRect) {
+        FODimension reldims = new FODimension(0, 0);
+        r.setCTM(propMgr.getCTMandRelDims(absRegVPRect, reldims));
+    }
+
+    /**
+     * Return the enumerated value designating this type of region in the
+     * Area tree.
+     * @return the region area class
+     */
+    protected abstract int getRegionAreaClass();
+
+    /**
+     * Returns the default region name (xsl-region-before, xsl-region-start,
+     * etc.)
+     * @return the default region name
+     */
+    protected abstract String getDefaultRegionName();
+
+
+    /**
+     * Returns the region class name.
+     * @return the region class name
+     */
+    public abstract String getRegionClass();
+
+
+    /**
+     * Returns the name of this region.
+     * @return the region name
+     */
+    public String getRegionName() {
+        return this.regionName;
+    }
+
+    /**
+     * Sets the name of the region.
+     * @param name the name
+     */
+    private void setRegionName(String name) {
+        this.regionName = name;
+    }
+
+    /**
+     * Returns the page master associated with this region.
+     * @return a simple-page-master
+     */
+    protected SimplePageMaster getPageMaster() {
+        return this.layoutMaster;
+    }
+
+    /**
+     * Checks to see if a given region name is one of the reserved names
+     *
+     * @param name a region name to check
+     * @return true if the name parameter is a reserved region name
+     */
+    protected boolean isReserved(String name) /*throws FOPException*/ {
+        return (name.equals("xsl-region-before")
+                || name.equals("xsl-region-start")
+                || name.equals("xsl-region-end")
+                || name.equals("xsl-region-after")
+                || name.equals("xsl-before-float-separator")
+                || name.equals("xsl-footnote-separator"));
+    }
+
+    /**
+     * @see org.apache.fop.fo.FObj#generatesReferenceAreas()
+     */
+    public boolean generatesReferenceAreas() {
+        return true;
+    }
+
+    /**
+     * Returns a sibling region for this region.
+     * @param regionClass the class of the requested region
+     * @return the requested region
+     */
+    protected Region getSiblingRegion(String regionClass) {
+        // Ask parent for region
+        return  layoutMaster.getRegion(regionClass);
+    }
+
+    /**
+     * Indicates if this region gets precedence.
+     * @return True if it gets precedence
+     */
+    public boolean getPrecedence() {
+        return false;
+    }
+
+    public int getExtent() {
+        return 0;
+    }
+}