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.
CHECK_REF_AREA
public static final int CHECK_REF_AREA
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.
FIRST_AREA
public static final int FIRST_AREA
IPD_UNKNOWN
public static final int IPD_UNKNOWN
KEEP_WITH_NEXT_PENDING
public static final int KEEP_WITH_NEXT_PENDING
This flag indicates that there's a keep-with-next that hasn't
been processed, yet.
KEEP_WITH_PREVIOUS_PENDING
public static final int KEEP_WITH_PREVIOUS_PENDING
This flag indicates that there's a keep-with-previous that hasn't
been processed, yet.
LAST_AREA
public static final int LAST_AREA
LINEBREAK_AT_LF_ONLY
public static final int LINEBREAK_AT_LF_ONLY
Values for flags.
NEW_AREA
public static final int NEW_AREA
Generated break possibility is first in a new area
RESOLVE_LEADING_SPACE
public static final int RESOLVE_LEADING_SPACE
SUPPRESS_LEADING_SPACE
public static final int SUPPRESS_LEADING_SPACE
If this flag is set, it indicates that any leading fo:character
objects with suppress-at-line-break="suppress" should not generate
areas. This is the case at the beginning of each new LineArea
except the first.
TRY_HYPHENATE
public static final int TRY_HYPHENATE
addPendingAfterMark
public void addPendingAfterMark(UnresolvedListElementWithLength element)
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.
element
- the border, padding or space element
addPendingBeforeMark
public void addPendingBeforeMark(UnresolvedListElementWithLength element)
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.
element
- the border, padding or space element
clearPendingMarks
public void clearPendingMarks()
Clears all pending marks on the LayoutContext.
copyPendingMarksFrom
public void copyPendingMarksFrom(LayoutContext source)
getBPAlignment
public int getBPAlignment()
- the currently applicable alignment in BP direction (EN_START, EN_JUSTIFY...)
getBreakAfter
public int getBreakAfter()
getBreakBefore
public int getBreakBefore()
getIPDAdjust
public double getIPDAdjust()
getLineEndBorderAndPaddingWidth
public int getLineEndBorderAndPaddingWidth()
Get the width to be reserved for border and padding at the end of the line.
getLineStartBorderAndPaddingWidth
public int getLineStartBorderAndPaddingWidth()
Get the width to be reserved for border and padding at the start of the line.
getNextSpan
public int getNextSpan()
- true if the current element list ends early because of a span change
in multi-column layout.
getPendingAfterMarks
public List getPendingAfterMarks()
- the pending border and padding elements at the after edge
getPendingBeforeMarks
public List getPendingBeforeMarks()
- the pending border and padding elements at the before edge
getRefIPD
public int getRefIPD()
Returns the inline-progression-dimension of the nearest ancestor reference area.
- the inline-progression-dimension of the nearest ancestor reference area
getSpaceAdjust
public double getSpaceAdjust()
getSpaceAfter
public int getSpaceAfter()
Get the current amount of space after / end
- the space after / end amount
getSpaceBefore
public int getSpaceBefore()
Get the current amount of space before / start
- the space before / start amount
getStackLimitBP
public MinOptMax getStackLimitBP()
Returns the stack limit in block-progression-dimension.
getStackLimitIP
public MinOptMax getStackLimitIP()
Returns the stack limit in inline-progression-dimension.
getWritingMode
public int getWritingMode()
Get the writing mode of the relevant reference area.
- the applicable writing mode
isFirstArea
public boolean isFirstArea()
isKeepWithNextPending
public boolean isKeepWithNextPending()
isKeepWithPreviousPending
public boolean isKeepWithPreviousPending()
isLastArea
public boolean isLastArea()
isStart
public boolean isStart()
resetAlignmentContext
public void resetAlignmentContext()
resolveLeadingSpace
public boolean resolveLeadingSpace()
setAlignmentContext
public void setAlignmentContext(AlignmentContext alignmentContext)
setBPAlignment
public void setBPAlignment(int alignment)
Sets the currently applicable alignment in BP direction.
alignment
- one of EN_START, EN_JUSTIFY etc.
setBreakAfter
public void setBreakAfter(int breakAfter)
Sets the value of the break after the current element.
breakAfter
- the value of the break-after
setBreakBefore
public void setBreakBefore(int breakBefore)
Sets the value of the break before the current element.
breakBefore
- the value of the break-before
setFlags
public void setFlags(int flags)
setFlags
public void setFlags(int flags,
boolean bSet)
setHyphContext
public void setHyphContext(HyphContext hyph)
setIPDAdjust
public void setIPDAdjust(double ipdA)
setLineEndBorderAndPaddingWidth
public void setLineEndBorderAndPaddingWidth(int lineEndBorderAndPaddingWidth)
Set the width to be reserved for border and padding at the end of the line.
lineEndBorderAndPaddingWidth
- the width to be reserved
setLineStartBorderAndPaddingWidth
public void setLineStartBorderAndPaddingWidth(int lineStartBorderAndPaddingWidth)
Set the width to be reserved for border and padding at the start of the line.
lineStartBorderAndPaddingWidth
- the width to be reserved
setRefIPD
public void setRefIPD(int ipd)
Sets the inline-progression-dimension of the nearest ancestor reference area.
setSpaceAdjust
public void setSpaceAdjust(double adjust)
setSpaceAfter
public void setSpaceAfter(int spaceAfter)
Set the amount of space after / end
spaceAfter
- the amount of space after / end
setSpaceBefore
public void setSpaceBefore(int spaceBefore)
Set the amount of space before / start
spaceBefore
- the amount of space before / start
setStackLimitBP
public void setStackLimitBP(MinOptMax limit)
Sets the stack limit in block-progression-dimension.
setStackLimitIP
public void setStackLimitIP(MinOptMax limit)
Sets the stack limit in inline-progression-dimension.
setStackLimitsFrom
public void setStackLimitsFrom(LayoutContext context)
Sets (Copies) the stack limits in both directions from another layout context.
context
- the layout context to taje the values from
setWritingMode
public void setWritingMode(int writingMode)
Set the writing mode.
writingMode
- the writing mode
signalSpanChange
public void signalSpanChange(int span)
Used to signal the PSLM that the element list ends early because of a span change in
multi-column layout.
span
- the new span value (legal values: NOT_SET, EN_NONE, EN_ALL)
startsNewArea
public boolean startsNewArea()
suppressLeadingSpace
public boolean suppressLeadingSpace()
toString
public String toString()
tryHyphenate
public boolean tryHyphenate()
unsetFlags
public void unsetFlags(int flags)