aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/layoutmgr/BreakPoss.java
diff options
context:
space:
mode:
authorJeremias Maerki <jeremias@apache.org>2003-03-11 13:05:43 +0000
committerJeremias Maerki <jeremias@apache.org>2003-03-11 13:05:43 +0000
commit1e5d512c216d329effa693b91ef64652945def6a (patch)
tree5bd3521ee8121eade7bf1909ceaf29cfc0263fd1 /src/java/org/apache/fop/layoutmgr/BreakPoss.java
parent73c824d39411bf11ad0c2f4e1c57cd9c484665f9 (diff)
downloadxmlgraphics-fop-1e5d512c216d329effa693b91ef64652945def6a.tar.gz
xmlgraphics-fop-1e5d512c216d329effa693b91ef64652945def6a.zip
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
Diffstat (limited to 'src/java/org/apache/fop/layoutmgr/BreakPoss.java')
-rw-r--r--src/java/org/apache/fop/layoutmgr/BreakPoss.java293
1 files changed, 293 insertions, 0 deletions
diff --git a/src/java/org/apache/fop/layoutmgr/BreakPoss.java b/src/java/org/apache/fop/layoutmgr/BreakPoss.java
new file mode 100644
index 000000000..61184cbf8
--- /dev/null
+++ b/src/java/org/apache/fop/layoutmgr/BreakPoss.java
@@ -0,0 +1,293 @@
+/*
+ * $Id: BreakPoss.java,v 1.13 2003/03/07 07:58:51 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.layoutmgr;
+
+import org.apache.fop.traits.LayoutProps;
+
+/**
+ * Represents a break possibility for the layout manager.
+ * Used to pass information between different levels of layout manager concerning
+ * the break positions. In an inline context, before and after are interpreted as
+ * start and end.
+ * The position field is opaque represents where the break occurs. It is a
+ * nested structure with one level for each layout manager involved in generating
+ * the BreakPoss..
+ * @author Karen Lease
+ */
+public class BreakPoss {
+
+ // --- Values for flags returned from lower level LM. ---
+ /** May break after */
+ public static final int CAN_BREAK_AFTER = 0x01;
+ /** Last area generated by FO */
+ public static final int ISLAST = 0x02;
+ /** First area generated by FO */
+ public static final int ISFIRST = 0x04;
+ /** Forced break (ie LF) */
+ public static final int FORCE = 0x08;
+ /** May break before */
+ public static final int CAN_BREAK_BEFORE = 0x10;
+ /** has anchors */
+ public static final int HAS_ANCHORS = 0x40;
+ /**
+ * Set this flag if all fo:character generated Areas would
+ * suppressed at the end or beginning of a line */
+ public static final int ALL_ARE_SUPPRESS_AT_LB = 0x80;
+ /** This break possibility is a hyphenation */
+ public static final int HYPHENATED = 0x100;
+ /**
+ * If this break possibility ends the line, all remaining characters
+ * in the lowest level text LM will be suppressed.
+ */
+ public static final int REST_ARE_SUPPRESS_AT_LB = 0x200;
+ /** Next area for LM overflows */
+ public static final int NEXT_OVERFLOWS = 0x400;
+
+ /** The opaque position object used by m_lm to record its
+ * break position.
+ */
+ private Position position;
+
+ /**
+ * The size range in the stacking direction of the area which would be
+ * generated if this BreakPoss were used.
+ */
+ private MinOptMax stackSize;
+
+ /**
+ * Max height above and below the baseline. These are cumulative.
+ */
+ private int lead;
+ // the max height of before and after alignment
+ private int total;
+ // middle alignment height for after
+ private int middle;
+
+ /** Size in the non-stacking direction (perpendicular). */
+ private MinOptMax nonStackSize;
+
+ private long flags = 0;
+ private LayoutProps layoutProps = new LayoutProps();
+
+ /** Store space-after (or end) and space-before (or start) to be
+ * added if this break position is used.
+ */
+ private SpaceSpecifier spaceSpecTrailing;
+ private SpaceSpecifier spaceSpecLeading;
+
+ public BreakPoss(Position position) {
+ this(position, 0);
+ }
+
+ public BreakPoss(Position position, long flags) {
+ this.position = position;
+ this.flags = flags;
+ }
+
+ /**
+ * The top-level layout manager responsible for this break
+ */
+ public LayoutProcessor getLayoutManager() {
+ return position.getLM();
+ }
+
+ // public void setLayoutManager(LayoutManager lm) {
+ // m_lm = lm;
+ // }
+
+ /**
+ * An object representing the break position in this layout manager.
+ */
+ public Position getPosition() {
+ return position;
+ }
+
+ public void setPosition(Position pos) {
+ position = pos;
+ }
+
+ public void setStackingSize(MinOptMax size) {
+ this.stackSize = size;
+ }
+
+ public MinOptMax getStackingSize() {
+ return this.stackSize ;
+ }
+
+ public void setNonStackingSize(MinOptMax size) {
+ this.nonStackSize = size;
+ }
+
+ public MinOptMax getNonStackingSize() {
+ return this.nonStackSize ;
+ }
+
+ public long getFlags() {
+ return flags;
+ }
+
+ public void setFlag(int flagBit) {
+ setFlag(flagBit, true);
+ }
+
+ public void setFlag(int flagBit, boolean bSet) {
+ if (bSet) {
+ flags |= flagBit;
+ } else {
+ flags &= ~flagBit;
+ }
+ }
+
+ public boolean isLastArea() {
+ return ((flags & ISLAST) != 0);
+ }
+
+ public boolean isFirstArea() {
+ return ((flags & ISFIRST) != 0);
+ }
+
+ public boolean canBreakAfter() {
+ return ((flags & CAN_BREAK_AFTER) != 0);
+ }
+
+ public boolean canBreakBefore() {
+ return ((flags & CAN_BREAK_BEFORE) != 0);
+ }
+
+ public boolean couldEndLine() {
+ return ((flags & REST_ARE_SUPPRESS_AT_LB) != 0);
+ }
+
+ public boolean isForcedBreak() {
+ return ((flags & FORCE) != 0);
+ }
+
+ public boolean nextBreakOverflows() {
+ return ((flags & NEXT_OVERFLOWS) != 0);
+ }
+
+ public boolean isSuppressible() {
+ return ((flags & ALL_ARE_SUPPRESS_AT_LB) != 0);
+ }
+
+ public SpaceSpecifier getLeadingSpace() {
+ return spaceSpecLeading;
+ }
+
+ public MinOptMax resolveLeadingSpace() {
+ if (spaceSpecLeading != null) {
+ return spaceSpecLeading.resolve(false);
+ } else {
+ return new MinOptMax(0);
+ }
+ }
+
+ public SpaceSpecifier getTrailingSpace() {
+ return spaceSpecTrailing;
+ }
+
+ public MinOptMax resolveTrailingSpace(boolean bEndsRefArea) {
+ if (spaceSpecTrailing != null) {
+ return spaceSpecTrailing.resolve(bEndsRefArea);
+ } else {
+ return new MinOptMax(0);
+ }
+ }
+
+
+ public void setLeadingSpace(SpaceSpecifier spaceSpecLeading) {
+ this.spaceSpecLeading = spaceSpecLeading;
+ }
+
+ public void setTrailingSpace(SpaceSpecifier spaceSpecTrailing) {
+ this.spaceSpecTrailing = spaceSpecTrailing;
+ }
+
+ public LayoutProps getLayoutProps() {
+ return layoutProps;
+ }
+
+ public int getLead() {
+ return lead;
+ }
+
+ public int getTotal() {
+ return total;
+ }
+
+ public int getMiddle() {
+ return middle;
+ }
+
+ /**
+ * set lead height of baseline positioned element
+ * @param ld new lead value
+ */
+ public void setLead(int ld) {
+ lead = ld;
+ }
+
+ /**
+ * Set total height of top or bottom aligned element
+ * @param t new total height
+ */
+ public void setTotal(int t) {
+ total = t;
+ }
+
+ /**
+ * Set distance below baseline of middle aligned element
+ * @param t new value
+ */
+ public void setMiddle(int t) {
+ middle = t;
+ }
+}