123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701 |
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You 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.layoutmgr;
-
- import java.util.Collections;
- import java.util.List;
-
- import org.apache.fop.fo.Constants;
- import org.apache.fop.layoutmgr.inline.AlignmentContext;
- import org.apache.fop.layoutmgr.inline.HyphContext;
- import org.apache.fop.traits.MinOptMax;
-
-
- /**
- * This class is used to pass information to the getNextKnuthElements()
- * method. It is set up by higher level LM and used by lower level LM.
- */
- public class LayoutContext {
-
- /** linebreak at line feed only flag */
- public static final int LINEBREAK_AT_LF_ONLY = 0x01;
- /** Generated break possibility is first in a new area */
- public static final int NEW_AREA = 0x02;
- /** ipd unknown flag */
- public static final int IPD_UNKNOWN = 0x04;
- /** Signal to a Line LM that a higher level LM may provoke a change
- * in the reference area, thus ref area IPD. The LineLM should return
- * without looking for a line break.
- */
- public static final int CHECK_REF_AREA = 0x08;
-
- /**
- * If this flag is set, it indicates that any break-before values other than "auto" should
- * not cause a mandatory break as this break was already handled by a parent layout manager.
- */
- public static final int SUPPRESS_BREAK_BEFORE = 0x10;
- /** first area flag */
- public static final int FIRST_AREA = 0x20;
- /** try hypenate flag */
- public static final int TRY_HYPHENATE = 0x40;
- /** last area flag */
- public static final int LAST_AREA = 0x80;
- /** resolve leading space flag */
- public static final int RESOLVE_LEADING_SPACE = 0x100;
-
- /**
- * This flag indicates that there's a keep-with-next that hasn't
- * been processed, yet.
- */
- //public static final int KEEP_WITH_NEXT_PENDING = 0x200;
- /**
- * This flag indicates that there's a keep-with-previous that hasn't
- * been processed, yet.
- */
- //public static final int KEEP_WITH_PREVIOUS_PENDING = 0x400;
-
-
- private int flags; // Contains some set of flags defined above
- /**
- * Total available stacking dimension for a "galley-level" layout
- * manager in block-progression-direction. It is passed by the
- * parent LM.
- * These LM <b>may</b> wish to pass this information down to lower
- * level LM to allow them to optimize returned break possibilities.
- */
- private MinOptMax stackLimitBP;
-
- /** to keep track of spanning in multi-column layout */
- private int currentSpan = Constants.NOT_SET;
- private int nextSpan = Constants.NOT_SET;
-
- /** inline-progression-dimension of nearest ancestor reference area */
- private int refIPD;
- //TODO After the split of stackLimit into stackLimitBP and stackLimitIP there's now some
- //overlap with refIPD. Need to investigate how best to refactor that.
-
- /** the writing mode established by the nearest ancestor reference area */
- private int writingMode = Constants.EN_LR_TB;
-
- /** Current pending space-after or space-end from preceding area */
- private SpaceSpecifier trailingSpace;
-
- /** Current pending space-before or space-start from ancestor areas */
- private SpaceSpecifier leadingSpace;
-
- /**
- * A list of pending marks (border and padding) on the after edge when a page break occurs.
- * May be null.
- */
- private List pendingAfterMarks;
-
- /**
- * A list of pending marks (border and padding) on the before edge when a page break occurs.
- * May be null.
- */
- private List pendingBeforeMarks;
-
- /** Current hyphenation context. May be null. */
- private HyphContext hyphContext = null;
-
- /** Alignment in BP direction */
- private int bpAlignment = Constants.EN_START;
-
- /** Stretch or shrink value when making areas. */
- private double ipdAdjust = 0.0;
-
- /** Stretch or shrink value when adding spaces. */
- private double dSpaceAdjust = 0.0;
-
- private AlignmentContext alignmentContext = null;
-
- /** Amount of space before / start */
- private int spaceBefore = 0;
- /** Amount of space after / end */
- private int spaceAfter = 0;
-
- /** Amount of space to reserve at the beginning of each line */
- private int lineStartBorderAndPaddingWidth = 0;
- /** Amount of space to reserve at the end of each line */
- private int lineEndBorderAndPaddingWidth = 0;
-
- private int breakBefore;
- private int breakAfter;
-
- private Keep pendingKeepWithNext = Keep.KEEP_AUTO;
- private Keep pendingKeepWithPrevious = Keep.KEEP_AUTO;
-
- private int disableColumnBalancing;
-
- /**
- * Copy constructor for creating child layout contexts.
- * @param parentLC the parent layout context to copy from
- */
- public LayoutContext(LayoutContext parentLC) {
- this.flags = parentLC.flags;
- this.refIPD = parentLC.refIPD;
- this.writingMode = parentLC.writingMode;
- setStackLimitBP(parentLC.getStackLimitBP());
- this.leadingSpace = parentLC.leadingSpace; //???
- this.trailingSpace = parentLC.trailingSpace; //???
- this.hyphContext = parentLC.hyphContext;
- this.bpAlignment = parentLC.bpAlignment;
- this.dSpaceAdjust = parentLC.dSpaceAdjust;
- this.ipdAdjust = parentLC.ipdAdjust;
- this.alignmentContext = parentLC.alignmentContext;
- this.lineStartBorderAndPaddingWidth = parentLC.lineStartBorderAndPaddingWidth;
- this.lineEndBorderAndPaddingWidth = parentLC.lineEndBorderAndPaddingWidth;
- copyPendingMarksFrom(parentLC);
- this.pendingKeepWithNext = parentLC.pendingKeepWithNext;
- this.pendingKeepWithPrevious = parentLC.pendingKeepWithPrevious;
- // Copy other fields as necessary.
- this.disableColumnBalancing = parentLC.disableColumnBalancing;
- }
-
- /**
- * Main constructor.
- * @param flags the initial flags
- */
- public LayoutContext(int flags) {
- this.flags = flags;
- this.refIPD = 0;
- stackLimitBP = MinOptMax.ZERO;
- leadingSpace = null;
- trailingSpace = null;
- }
-
- /** @param source from which pending marks are copied */
- public void copyPendingMarksFrom(LayoutContext source) {
- if (source.pendingAfterMarks != null) {
- this.pendingAfterMarks = new java.util.ArrayList(source.pendingAfterMarks);
- }
- if (source.pendingBeforeMarks != null) {
- this.pendingBeforeMarks = new java.util.ArrayList(source.pendingBeforeMarks);
- }
- }
-
- /** @param flags to set */
- public void setFlags(int flags) {
- setFlags(flags, true);
- }
-
- /**
- * @param flags to set or clear
- * @param bSet true to set, false to clear
- */
- public void setFlags(int flags, boolean bSet) {
- if (bSet) {
- this.flags |= flags;
- } else {
- this.flags &= ~flags;
- }
- }
-
- /** @param flags to clear */
- public void unsetFlags(int flags) {
- setFlags(flags, false);
- }
-
- /** @return true if new area is set */
- public boolean isStart() {
- return ((this.flags & NEW_AREA) != 0);
- }
-
- /** @return true if new area is set and leading space is non-null */
- public boolean startsNewArea() {
- return ((this.flags & NEW_AREA) != 0 && leadingSpace != null);
- }
-
- /** @return true if first area is set */
- public boolean isFirstArea() {
- return ((this.flags & FIRST_AREA) != 0);
- }
-
- /** @return true if last area is set */
- public boolean isLastArea() {
- return ((this.flags & LAST_AREA) != 0);
- }
-
- /** @return true if suppress break before is set */
- public boolean suppressBreakBefore() {
- return ((this.flags & SUPPRESS_BREAK_BEFORE) != 0);
- }
-
- /**
- * Returns the strength of a keep-with-next currently pending.
- * @return the keep-with-next strength
- */
- public Keep getKeepWithNextPending() {
- return this.pendingKeepWithNext;
- }
-
- /**
- * Returns the strength of a keep-with-previous currently pending.
- * @return the keep-with-previous strength
- */
- public Keep getKeepWithPreviousPending() {
- return this.pendingKeepWithPrevious;
- }
-
- /**
- * Clears any pending keep-with-next strength.
- */
- public void clearKeepWithNextPending() {
- this.pendingKeepWithNext = Keep.KEEP_AUTO;
- }
-
- /**
- * Clears any pending keep-with-previous strength.
- */
- public void clearKeepWithPreviousPending() {
- this.pendingKeepWithPrevious = Keep.KEEP_AUTO;
- }
-
- /**
- * Clears both keep-with-previous and keep-with-next strengths.
- */
- public void clearKeepsPending() {
- clearKeepWithPreviousPending();
- clearKeepWithNextPending();
- }
-
- /**
- * Updates the currently pending keep-with-next strength.
- * @param keep the new strength to consider
- */
- public void updateKeepWithNextPending(Keep keep) {
- this.pendingKeepWithNext = this.pendingKeepWithNext.compare(keep);
- }
-
- /**
- * Updates the currently pending keep-with-previous strength.
- * @param keep the new strength to consider
- */
- public void updateKeepWithPreviousPending(Keep keep) {
- this.pendingKeepWithPrevious = this.pendingKeepWithPrevious.compare(keep);
- }
-
- /**
- * Indicates whether a keep-with-next constraint is pending.
- * @return true if a keep-with-next constraint is pending
- */
- public boolean isKeepWithNextPending() {
- return !getKeepWithNextPending().isAuto();
- }
-
- /**
- * Indicates whether a keep-with-previous constraint is pending.
- * @return true if a keep-with-previous constraint is pending
- */
- public boolean isKeepWithPreviousPending() {
- return !getKeepWithPreviousPending().isAuto();
- }
-
- /** @param space leading space */
- public void setLeadingSpace(SpaceSpecifier space) {
- leadingSpace = space;
- }
-
- /** @return leading space */
- public SpaceSpecifier getLeadingSpace() {
- return leadingSpace;
- }
-
- /** @return true if resolve leading space is set */
- public boolean resolveLeadingSpace() {
- return ((this.flags & RESOLVE_LEADING_SPACE) != 0);
- }
-
- /** @param space trailing space */
- public void setTrailingSpace(SpaceSpecifier space) {
- trailingSpace = space;
- }
-
- /** @return trailing space */
- public SpaceSpecifier getTrailingSpace() {
- return trailingSpace;
- }
-
- /**
- * Adds a border or padding element to the pending list which will be used to generate
- * the right element list for break possibilities. Conditionality resolution will be done
- * elsewhere.
- * @param element the border, padding or space element
- */
- public void addPendingAfterMark(UnresolvedListElementWithLength element) {
- if (this.pendingAfterMarks == null) {
- this.pendingAfterMarks = new java.util.ArrayList();
- }
- this.pendingAfterMarks.add(element);
- }
-
- /**
- * @return the pending border and padding elements at the after edge
- * @see #addPendingAfterMark(UnresolvedListElementWithLength)
- */
- public List getPendingAfterMarks() {
- if (this.pendingAfterMarks != null) {
- return Collections.unmodifiableList(this.pendingAfterMarks);
- } else {
- return null;
- }
- }
-
- /**
- * Clears all pending marks on the LayoutContext.
- */
- public void clearPendingMarks() {
- this.pendingBeforeMarks = null;
- this.pendingAfterMarks = null;
- }
-
- /**
- * Adds a border or padding element to the pending list which will be used to generate
- * the right element list for break possibilities. Conditionality resolution will be done
- * elsewhere.
- * @param element the border, padding or space element
- */
- public void addPendingBeforeMark(UnresolvedListElementWithLength element) {
- if (this.pendingBeforeMarks == null) {
- this.pendingBeforeMarks = new java.util.ArrayList();
- }
- this.pendingBeforeMarks.add(element);
- }
-
- /**
- * @return the pending border and padding elements at the before edge
- * @see #addPendingBeforeMark(UnresolvedListElementWithLength)
- */
- public List getPendingBeforeMarks() {
- if (this.pendingBeforeMarks != null) {
- return Collections.unmodifiableList(this.pendingBeforeMarks);
- } else {
- return null;
- }
- }
-
- /**
- * Sets the stack limit in block-progression-dimension.
- * @param limit the stack limit
- */
- public void setStackLimitBP(MinOptMax limit) {
- stackLimitBP = limit;
- }
-
- /**
- * Returns the stack limit in block-progression-dimension.
- * @return the stack limit
- */
- public MinOptMax getStackLimitBP() {
- return stackLimitBP;
- }
-
- /**
- * Sets the inline-progression-dimension of the nearest ancestor reference area.
- * @param ipd of nearest ancestor reference area
- */
- public void setRefIPD(int ipd) {
- refIPD = ipd;
- }
-
- /**
- * Returns the inline-progression-dimension of the nearest ancestor reference area.
- *
- * @return the inline-progression-dimension of the nearest ancestor reference area
- */
- public int getRefIPD() {
- return refIPD;
- }
-
- /** @param hyph a hyphenation context */
- public void setHyphContext(HyphContext hyph) {
- hyphContext = hyph;
- }
-
- /** @return hyphenation context */
- public HyphContext getHyphContext() {
- return hyphContext;
- }
-
- /** @return true if try hyphenate is set */
- public boolean tryHyphenate() {
- return ((this.flags & TRY_HYPHENATE) != 0);
- }
-
- /**
- * Sets the currently applicable alignment in BP direction.
- * @param alignment one of EN_START, EN_JUSTIFY etc.
- */
- public void setBPAlignment(int alignment) {
- this.bpAlignment = alignment;
- }
-
- /** @return the currently applicable alignment in BP direction (EN_START, EN_JUSTIFY...) */
- public int getBPAlignment() {
- return this.bpAlignment;
- }
-
- /** @param adjust space adjustment */
- public void setSpaceAdjust(double adjust) {
- dSpaceAdjust = adjust;
- }
-
- /** @return space adjustment */
- public double getSpaceAdjust() {
- return dSpaceAdjust;
- }
-
- /** @param ipdA ipd adjustment */
- public void setIPDAdjust(double ipdA) {
- ipdAdjust = ipdA;
- }
-
- /** @return ipd adjustment */
- public double getIPDAdjust() {
- return ipdAdjust;
- }
-
- /** @param alignmentContext alignment context */
- public void setAlignmentContext(AlignmentContext alignmentContext) {
- this.alignmentContext = alignmentContext;
- }
-
- /** @return alignment context */
- public AlignmentContext getAlignmentContext() {
- return this.alignmentContext;
- }
-
- /**
- * Reset alignment context.
- */
- public void resetAlignmentContext() {
- if (this.alignmentContext != null) {
- this.alignmentContext = this.alignmentContext.getParentAlignmentContext();
- }
- }
-
- /**
- * Get the width to be reserved for border and padding at the start of the line.
- * @return the width to be reserved
- */
- public int getLineStartBorderAndPaddingWidth() {
- return lineStartBorderAndPaddingWidth;
- }
-
- /**
- * Set the width to be reserved for border and padding at the start of the line.
- * @param lineStartBorderAndPaddingWidth the width to be reserved
- */
- public void setLineStartBorderAndPaddingWidth(int lineStartBorderAndPaddingWidth) {
- this.lineStartBorderAndPaddingWidth = lineStartBorderAndPaddingWidth;
- }
-
- /**
- * Get the width to be reserved for border and padding at the end of the line.
- * @return the width to be reserved
- */
- public int getLineEndBorderAndPaddingWidth() {
- return lineEndBorderAndPaddingWidth;
- }
-
- /**
- * Set the width to be reserved for border and padding at the end of the line.
- * @param lineEndBorderAndPaddingWidth the width to be reserved
- */
- public void setLineEndBorderAndPaddingWidth(int lineEndBorderAndPaddingWidth) {
- this.lineEndBorderAndPaddingWidth = lineEndBorderAndPaddingWidth;
- }
-
- /**
- * @return one of: {@link Constants#NOT_SET}, {@link Constants#EN_NONE}
- * {@link Constants#EN_ALL}
- */
- public int getNextSpan() {
- return nextSpan;
- }
-
- /**
- * @return one of: {@link Constants#NOT_SET}, {@link Constants#EN_NONE}
- * {@link Constants#EN_ALL}
- */
- public int getCurrentSpan() {
- return (currentSpan == Constants.NOT_SET)
- ? Constants.EN_NONE : currentSpan;
- }
-
- /**
- * Used to signal the PSLM that the element list ends early because of a span change in
- * multi-column layout.
- * @param span the new span value (legal values: NOT_SET, EN_NONE, EN_ALL)
- */
- public void signalSpanChange(int span) {
- switch (span) {
- case Constants.NOT_SET:
- case Constants.EN_NONE:
- case Constants.EN_ALL:
- this.currentSpan = this.nextSpan;
- this.nextSpan = span;
- break;
- default:
- assert false;
- throw new IllegalArgumentException("Illegal value on signalSpanChange() for span: "
- + span);
- }
- }
-
- /**
- * Get the writing mode of the relevant reference area.
- * @return the applicable writing mode
- */
- public int getWritingMode() {
- return writingMode;
- }
-
- /**
- * Set the writing mode.
- * @param writingMode the writing mode
- */
- public void setWritingMode(int writingMode) {
- this.writingMode = writingMode;
- }
-
- /**
- * Get the current amount of space before / start
- * @return the space before / start amount
- */
- public int getSpaceBefore() {
- return spaceBefore;
- }
-
- /**
- * Set the amount of space before / start
- * @param spaceBefore the amount of space before / start
- */
- public void setSpaceBefore(int spaceBefore) {
- this.spaceBefore = spaceBefore;
- }
-
- /**
- * Get the current amount of space after / end
- * @return the space after / end amount
- */
- public int getSpaceAfter() {
- return spaceAfter;
- }
-
- /**
- * Set the amount of space after / end
- * @param spaceAfter the amount of space after / end
- */
- public void setSpaceAfter(int spaceAfter) {
- this.spaceAfter = spaceAfter;
- }
-
- /**
- * Returns the value of the break before the element whose
- * {@link LayoutManager#getNextKnuthElements(LayoutContext, int)} method has just been
- * called.
- *
- * @return one of {@link Constants#EN_AUTO}, {@link Constants#EN_COLUMN},
- * {@link Constants#EN_PAGE}, {@link Constants#EN_EVEN_PAGE}, or
- * {@link Constants#EN_ODD_PAGE}
- */
- public int getBreakBefore() {
- return breakBefore;
- }
-
- /**
- * Sets the value of the break before the current element.
- *
- * @param breakBefore the value of the break-before
- * @see #getBreakBefore()
- */
- public void setBreakBefore(int breakBefore) {
- this.breakBefore = breakBefore;
- }
-
- /**
- * Returns the value of the break after the element whose
- * {@link LayoutManager#getNextKnuthElements(LayoutContext, int)} method has just been
- * called.
- *
- * @return one of {@link Constants#EN_AUTO}, {@link Constants#EN_COLUMN},
- * {@link Constants#EN_PAGE}, {@link Constants#EN_EVEN_PAGE}, or
- * {@link Constants#EN_ODD_PAGE}
- */
- public int getBreakAfter() {
- return breakAfter;
- }
-
-
- /**
- * Sets the value of the break after the current element.
- *
- * @param breakAfter the value of the break-after
- * @see #getBreakAfter()
- */
- public void setBreakAfter(int breakAfter) {
- this.breakAfter = breakAfter;
- }
-
- /** {@inheritDoc} */
- public String toString() {
- return "Layout Context:"
- + "\nStack Limit BPD: \t"
- + (getStackLimitBP() == null ? "null" : getStackLimitBP().toString())
- + "\nTrailing Space: \t"
- + (getTrailingSpace() == null ? "null" : getTrailingSpace().toString())
- + "\nLeading Space: \t"
- + (getLeadingSpace() == null ? "null" : getLeadingSpace().toString())
- + "\nReference IPD: \t" + getRefIPD()
- + "\nSpace Adjust: \t" + getSpaceAdjust()
- + "\nIPD Adjust: \t" + getIPDAdjust()
- + "\nResolve Leading Space: \t" + resolveLeadingSpace()
- + "\nSuppress Break Before: \t" + suppressBreakBefore()
- + "\nIs First Area: \t" + isFirstArea()
- + "\nStarts New Area: \t" + startsNewArea()
- + "\nIs Last Area: \t" + isLastArea()
- + "\nTry Hyphenate: \t" + tryHyphenate()
- + "\nKeeps: \t[keep-with-next=" + getKeepWithNextPending()
- + "][keep-with-previous=" + getKeepWithPreviousPending() + "] pending"
- + "\nBreaks: \tforced [" + (breakBefore != Constants.EN_AUTO ? "break-before" : "") + "]["
- + (breakAfter != Constants.EN_AUTO ? "break-after" : "") + "]";
- }
-
- /**
- * Returns whether the column balancer should be disabled before a spanning block
- *
- * @return one of {@link Constants#EN_TRUE}, {@link Constants#EN_FALSE}
- */
- public int getDisableColumnBalancing() {
- return disableColumnBalancing;
- }
-
- /**
- * Sets whether the column balancer should be disabled before a spanning block
- *
- * @param disableColumnBalancing the value of the fox:disable-column-balancing property
- * @see #getDisableColumnBalancing()
- */
- public void setDisableColumnBalancing(int disableColumnBalancing) {
- this.disableColumnBalancing = disableColumnBalancing;
- }
- }
|