/*
* $Id: RegionStart.java,v 1.3.2.6 2003/04/11 00:24:41 pietsch 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;
// FOP
import org.apache.fop.fo.*;
import org.apache.fop.layout.RegionArea;
import org.apache.fop.layout.BorderAndPadding;
import org.apache.fop.layout.BackgroundProps;
import org.apache.fop.apps.FOPException;
/**
* Class modeling the fo:region-start object.
*
* @see <a href="@XSLFO-STD@#fo_region-start"
target="_xslfostd">@XSLFO-STDID@
* ¶6.4.16</a>
*/
public class RegionStart extends Region {
public static class Maker extends FObj.Maker {
public FObj make(FObj parent, PropertyList propertyList,
String systemId, int line, int column)
throws FOPException {
return new RegionStart(parent, propertyList,
systemId, line, column);
}
}
public static FObj.Maker maker() {
return new RegionStart.Maker();
}
public static final String REGION_CLASS = "start";
protected RegionStart(FObj parent, PropertyList propertyList,
String systemId, int line, int column)
throws FOPException {
super(parent, propertyList, systemId, line, column);
}
public String getName() {
return "fo:region-start";
}
RegionArea makeRegionArea(int allocationRectangleXPosition,
int allocationRectangleYPosition,
int allocationRectangleWidth,
int allocationRectangleHeight,
boolean beforePrecedence,
boolean afterPrecedence, int beforeExtent,
int afterExtent) {
int extent = this.properties.get("extent").getLength().mvalue();
int startY = allocationRectangleYPosition;
int startH = allocationRectangleHeight;
if (beforePrecedence) {
startY -= beforeExtent;
startH -= beforeExtent;
}
if (afterPrecedence)
startH -= afterExtent;
RegionArea area = new RegionArea(allocationRectangleXPosition,
startY, extent, startH);
area.setBackground(propMgr.getBackgroundProps());
return area;
}
RegionArea makeRegionArea(int allocationRectangleXPosition,
int allocationRectangleYPosition,
int allocationRectangleWidth,
int allocationRectangleHeight) {
// Common Border, Padding, and Background Properties
BorderAndPadding bap = propMgr.getBorderAndPadding();
BackgroundProps bProps = propMgr.getBackgroundProps();
// this.properties.get("clip");
// this.properties.get("display-align");
int extent = this.properties.get("extent").getLength().mvalue();
// this.properties.get("overflow");
// this.properties.get("region-name");
// this.properties.get("reference-orientation");
// this.properties.get("writing-mode");
return makeRegionArea(allocationRectangleXPosition,
allocationRectangleYPosition,
allocationRectangleWidth, extent, false, false,
0, 0);
}
protected String getDefaultRegionName() {
return "xsl-region-start";
}
public String getRegionClass() {
return REGION_CLASS;
}
public int getExtent() {
return properties.get("extent").getLength().mvalue();
}
}