Package org.apache.fop.layoutmgr.inline
Class LineLayoutManager
java.lang.Object
org.apache.fop.layoutmgr.AbstractBaseLayoutManager
org.apache.fop.layoutmgr.AbstractLayoutManager
org.apache.fop.layoutmgr.inline.InlineStackingLayoutManager
org.apache.fop.layoutmgr.inline.LineLayoutManager
- All Implemented Interfaces:
PercentBaseContext
,Constants
,BlockLevelLayoutManager
,BreakOpportunity
,InlineLevelLayoutManager
,LayoutManager
public class LineLayoutManager
extends InlineStackingLayoutManager
implements BlockLevelLayoutManager
LayoutManager for lines. It builds one or more lines containing
inline areas generated by its sub layout managers.
A break is found for each line which may contain one of more
breaks from the child layout managers.
Once a break is found then it is return for the parent layout
manager to handle.
When the areas are being added to the page this manager
creates a line area to contain the inline areas added by the
child layout managers.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
(package private) static class
Private class to store information about inline breaks.private static class
private final class
This class is used to remember which was the first element in the paragraph returned by each LM. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate AlignmentContext
private int
private int
private int
static final int
this constant is used to create elements when text-align is center: every TextLM descendant of LineLM must use the same value, otherwise the line breaking algorithm does not find the right break pointprivate int
private final Block
private final int
private Numeric
private boolean
When layout must be re-started due to a change of IPD, there is no need to perform hyphenation on the remaining Knuth sequence once again.private CommonHyphenation
private int
private boolean
private List<KnuthSequence>
private Length
private final int
private final Length
private LineLayoutPossibilities
private LineLayoutPossibilities[]
private static org.apache.commons.logging.Log
logging instanceprivate int
private int
private Length
private int
private int
Fields inherited from class org.apache.fop.layoutmgr.inline.InlineStackingLayoutManager
childLC, extraBPD
Fields inherited from class org.apache.fop.layoutmgr.AbstractLayoutManager
childLMiter, childLMs, curChildLM, fobjIter, parentLayoutManager
Fields inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager
generatesBlockArea, generatesReferenceArea
Fields inherited from interface org.apache.fop.fo.Constants
COMPOUND_COUNT, COMPOUND_MASK, COMPOUND_SHIFT, CP_BLOCK_PROGRESSION_DIRECTION, CP_CONDITIONALITY, CP_INLINE_PROGRESSION_DIRECTION, CP_LENGTH, CP_MAXIMUM, CP_MINIMUM, CP_OPTIMUM, CP_PRECEDENCE, CP_WITHIN_COLUMN, CP_WITHIN_LINE, CP_WITHIN_PAGE, EN_100, EN_200, EN_300, EN_400, EN_500, EN_600, EN_700, EN_800, EN_900, EN_ABSOLUTE, EN_ABSOLUTE_COLORMETRIC, EN_AFTER, EN_AFTER_EDGE, EN_ALL, EN_ALPHABETIC, EN_ALTERNATE, EN_ALWAYS, EN_ANY, EN_AUTO, EN_AUTO_EVEN, EN_AUTO_ODD, EN_AVOID, EN_BACKSLANT, EN_BASELINE, EN_BEFORE, EN_BEFORE_EDGE, EN_BIDI_OVERRIDE, EN_BLANK, EN_BLINK, EN_BLOCK, EN_BOLDER, EN_BOTH, EN_BOTTOM, EN_BOUNDED_IN_ONE_DIMENSION, EN_BT, EN_CAPITALIZE, EN_CAPTION, EN_CENTER, EN_CENTRAL, EN_CHARACTER_BY_CHARACTER, EN_COLLAPSE, EN_COLLAPSE_WITH_PRECEDENCE, EN_COLUMN, EN_CONDENSED, EN_CONSIDER_SHIFTS, EN_DASHED, EN_DISCARD, EN_DISREGARD_SHIFTS, EN_DOCUMENT, EN_DOTS, EN_DOTTED, EN_DOUBLE, EN_EMBED, EN_END, EN_END_ON_EVEN, EN_END_ON_ODD, EN_ERROR_IF_OVERFLOW, EN_EVEN, EN_EVEN_PAGE, EN_EXPANDED, EN_EXTRA_CONDENSED, EN_EXTRA_EXPANDED, EN_FALSE, EN_FIC, EN_FIRST, EN_FIRST_INCLUDING_CARRYOVER, EN_FIRST_STARTING, EN_FIXED, EN_FONT_HEIGHT, EN_FORCE, EN_FSWP, EN_GROOVE, EN_HANGING, EN_HIDDEN, EN_HIDE, EN_ICON, EN_IDEOGRAPHIC, EN_IGNORE, EN_IGNORE_IF_AFTER_LINEFEED, EN_IGNORE_IF_BEFORE_LINEFEED, EN_IGNORE_IF_SURROUNDING_LINEFEED, EN_INDEFINITE, EN_INDENT, EN_INHERIT, EN_INSET, EN_INSIDE, EN_INTEGER_PIXELS, EN_ITALIC, EN_JUSTIFY, EN_LARGER, EN_LAST, EN_LAST_ENDING, EN_LAST_STARTING, EN_LEAVE_SEPARATE, EN_LEFT, EN_LEWP, EN_LIGHTER, EN_LINE, EN_LINE_HEIGHT, EN_LINE_THROUGH, EN_LINK, EN_LOWERCASE, EN_LR, EN_LR_TB, EN_LSWP, EN_LTR, EN_MATHEMATICAL, EN_MAX_HEIGHT, EN_MENU, EN_MERGE, EN_MESSAGE_BOX, EN_MIDDLE, EN_NARROWER, EN_NEW, EN_NO_BLINK, EN_NO_CHANGE, EN_NO_FORCE, EN_NO_LIMIT, EN_NO_LINE_THROUGH, EN_NO_LINK, EN_NO_OVERLINE, EN_NO_UNDERLINE, EN_NO_WRAP, EN_NON_UNIFORM, EN_NONE, EN_NOREPEAT, EN_NORMAL, EN_NOT_BLANK, EN_OBLIQUE, EN_ODD, EN_ODD_PAGE, EN_ONLY, EN_OUTSET, EN_OUTSIDE, EN_OVERLINE, EN_PAGE, EN_PAGE_SEQUENCE, EN_PAGINATE, EN_PERCEPTUAL, EN_PRE, EN_PRESERVE, EN_REFERENCE_AREA, EN_RELATIVE, EN_RELATIVE_COLOMETRIC, EN_REPEAT, EN_REPEATX, EN_REPEATY, EN_REPLACE, EN_RESAMPLE_ANY_METHOD, EN_RESET_SIZE, EN_REST, EN_RETAIN, EN_RIDGE, EN_RIGHT, EN_RL, EN_RL_TB, EN_RTL, EN_RULE, EN_SATURATION, EN_SCALE_DOWN_TO_FIT, EN_SCALE_TO_FIT, EN_SCALE_UP_TO_FIT, EN_SCROLL, EN_SELECT_FIRST_FITTING, EN_SEMI_CONDENSED, EN_SEMI_EXPANDED, EN_SEPARATE, EN_SHOW, EN_SMALL_CAPS, EN_SMALL_CAPTION, EN_SMALLER, EN_SOLID, EN_SPACE, EN_START, EN_STATIC, EN_STATUS_BAR, EN_SUB, EN_SUPER, EN_SUPPRESS, EN_TABLE, EN_TABLE_FRAGMENT, EN_TB, EN_TB_LR, EN_TB_RL, EN_TEXT_AFTER_EDGE, EN_TEXT_BEFORE_EDGE, EN_TEXT_BOTTOM, EN_TEXT_TOP, EN_TOP, EN_TRADITIONAL, EN_TREAT_AS_SPACE, EN_TREAT_AS_ZERO_WIDTH_SPACE, EN_TRUE, EN_ULTRA_CONDENSED, EN_ULTRA_EXPANDED, EN_UNBOUNDED, EN_UNDERLINE, EN_UNIFORM, EN_UPPERCASE, EN_USE_FONT_METRICS, EN_USE_SCRIPT, EN_USECONTENT, EN_VISIBLE, EN_WIDER, EN_WRAP, ENUM_COUNT, FO_BASIC_LINK, FO_BIDI_OVERRIDE, FO_BLOCK, FO_BLOCK_CONTAINER, FO_BOOKMARK, FO_BOOKMARK_TITLE, FO_BOOKMARK_TREE, FO_CHANGE_BAR_BEGIN, FO_CHANGE_BAR_END, FO_CHARACTER, FO_COLOR_PROFILE, FO_CONDITIONAL_PAGE_MASTER_REFERENCE, FO_DECLARATIONS, FO_EXTERNAL_GRAPHIC, FO_FLOAT, FO_FLOW, FO_FLOW_ASSIGNMENT, FO_FLOW_MAP, FO_FLOW_NAME_SPECIFIER, FO_FLOW_SOURCE_LIST, FO_FLOW_TARGET_LIST, FO_FOLIO_PREFIX, FO_FOLIO_SUFFIX, FO_FOOTNOTE, FO_FOOTNOTE_BODY, FO_INDEX_KEY_REFERENCE, FO_INDEX_PAGE_CITATION_LIST, FO_INDEX_PAGE_CITATION_LIST_SEPARATOR, FO_INDEX_PAGE_CITATION_RANGE_SEPARATOR, FO_INDEX_PAGE_NUMBER_PREFIX, FO_INDEX_PAGE_NUMBER_SUFFIX, FO_INDEX_RANGE_BEGIN, FO_INDEX_RANGE_END, FO_INITIAL_PROPERTY_SET, FO_INLINE, FO_INLINE_CONTAINER, FO_INSTREAM_FOREIGN_OBJECT, FO_LAYOUT_MASTER_SET, FO_LEADER, FO_LIST_BLOCK, FO_LIST_ITEM, FO_LIST_ITEM_BODY, FO_LIST_ITEM_LABEL, FO_MARKER, FO_MULTI_CASE, FO_MULTI_PROPERTIES, FO_MULTI_PROPERTY_SET, FO_MULTI_SWITCH, FO_MULTI_TOGGLE, FO_PAGE_NUMBER, FO_PAGE_NUMBER_CITATION, FO_PAGE_NUMBER_CITATION_LAST, FO_PAGE_SEQUENCE, FO_PAGE_SEQUENCE_MASTER, FO_PAGE_SEQUENCE_WRAPPER, FO_REGION_AFTER, FO_REGION_BEFORE, FO_REGION_BODY, FO_REGION_END, FO_REGION_NAME_SPECIFIER, FO_REGION_START, FO_REPEATABLE_PAGE_MASTER_ALTERNATIVES, FO_REPEATABLE_PAGE_MASTER_REFERENCE, FO_RETRIEVE_MARKER, FO_RETRIEVE_TABLE_MARKER, FO_ROOT, FO_SCALING_VALUE_CITATION, FO_SIMPLE_PAGE_MASTER, FO_SINGLE_PAGE_MASTER_REFERENCE, FO_STATIC_CONTENT, FO_TABLE, FO_TABLE_AND_CAPTION, FO_TABLE_BODY, FO_TABLE_CAPTION, FO_TABLE_CELL, FO_TABLE_COLUMN, FO_TABLE_FOOTER, FO_TABLE_HEADER, FO_TABLE_ROW, FO_TITLE, FO_UNKNOWN_NODE, FO_WRAPPER, FRM_OBJ_COUNT, NOT_SET, PR_ABSOLUTE_POSITION, PR_ACTIVE_STATE, PR_ALIGNMENT_ADJUST, PR_ALIGNMENT_BASELINE, PR_AUTO_RESTORE, PR_AZIMUTH, PR_BACKGROUND, PR_BACKGROUND_ATTACHMENT, PR_BACKGROUND_COLOR, PR_BACKGROUND_IMAGE, PR_BACKGROUND_POSITION, PR_BACKGROUND_POSITION_HORIZONTAL, PR_BACKGROUND_POSITION_VERTICAL, PR_BACKGROUND_REPEAT, PR_BASELINE_SHIFT, PR_BLANK_OR_NOT_BLANK, PR_BLOCK_PROGRESSION_DIMENSION, PR_BORDER, PR_BORDER_AFTER_COLOR, PR_BORDER_AFTER_PRECEDENCE, PR_BORDER_AFTER_STYLE, PR_BORDER_AFTER_WIDTH, PR_BORDER_BEFORE_COLOR, PR_BORDER_BEFORE_PRECEDENCE, PR_BORDER_BEFORE_STYLE, PR_BORDER_BEFORE_WIDTH, PR_BORDER_BOTTOM, PR_BORDER_BOTTOM_COLOR, PR_BORDER_BOTTOM_STYLE, PR_BORDER_BOTTOM_WIDTH, PR_BORDER_COLLAPSE, PR_BORDER_COLOR, PR_BORDER_END_COLOR, PR_BORDER_END_PRECEDENCE, PR_BORDER_END_STYLE, PR_BORDER_END_WIDTH, PR_BORDER_LEFT, PR_BORDER_LEFT_COLOR, PR_BORDER_LEFT_STYLE, PR_BORDER_LEFT_WIDTH, PR_BORDER_RIGHT, PR_BORDER_RIGHT_COLOR, PR_BORDER_RIGHT_STYLE, PR_BORDER_RIGHT_WIDTH, PR_BORDER_SEPARATION, PR_BORDER_SPACING, PR_BORDER_START_COLOR, PR_BORDER_START_PRECEDENCE, PR_BORDER_START_STYLE, PR_BORDER_START_WIDTH, PR_BORDER_STYLE, PR_BORDER_TOP, PR_BORDER_TOP_COLOR, PR_BORDER_TOP_STYLE, PR_BORDER_TOP_WIDTH, PR_BORDER_WIDTH, PR_BOTTOM, PR_BREAK_AFTER, PR_BREAK_BEFORE, PR_CAPTION_SIDE, PR_CASE_NAME, PR_CASE_TITLE, PR_CHANGE_BAR_CLASS, PR_CHANGE_BAR_COLOR, PR_CHANGE_BAR_OFFSET, PR_CHANGE_BAR_PLACEMENT, PR_CHANGE_BAR_STYLE, PR_CHANGE_BAR_WIDTH, PR_CHARACTER, PR_CLEAR, PR_CLIP, PR_COLOR, PR_COLOR_PROFILE_NAME, PR_COLUMN_COUNT, PR_COLUMN_GAP, PR_COLUMN_NUMBER, PR_COLUMN_WIDTH, PR_CONTENT_HEIGHT, PR_CONTENT_TYPE, PR_CONTENT_WIDTH, PR_COUNTRY, PR_CUE, PR_CUE_AFTER, PR_CUE_BEFORE, PR_DESTINATION_PLACEMENT_OFFSET, PR_DIRECTION, PR_DISPLAY_ALIGN, PR_DOMINANT_BASELINE, PR_ELEVATION, PR_EMPTY_CELLS, PR_END_INDENT, PR_ENDS_ROW, PR_EXTENT, PR_EXTERNAL_DESTINATION, PR_FLOAT, PR_FLOW_MAP_NAME, PR_FLOW_MAP_REFERENCE, PR_FLOW_NAME, PR_FLOW_NAME_REFERENCE, PR_FONT, PR_FONT_FAMILY, PR_FONT_SELECTION_STRATEGY, PR_FONT_SIZE, PR_FONT_SIZE_ADJUST, PR_FONT_STRETCH, PR_FONT_STYLE, PR_FONT_VARIANT, PR_FONT_WEIGHT, PR_FORCE_PAGE_COUNT, PR_FORMAT, PR_GLYPH_ORIENTATION_HORIZONTAL, PR_GLYPH_ORIENTATION_VERTICAL, PR_GROUPING_SEPARATOR, PR_GROUPING_SIZE, PR_HEIGHT, PR_HYPHENATE, PR_HYPHENATION_CHARACTER, PR_HYPHENATION_KEEP, PR_HYPHENATION_LADDER_COUNT, PR_HYPHENATION_PUSH_CHARACTER_COUNT, PR_HYPHENATION_REMAIN_CHARACTER_COUNT, PR_ID, PR_INDEX_CLASS, PR_INDEX_KEY, PR_INDICATE_DESTINATION, PR_INITIAL_PAGE_NUMBER, PR_INLINE_PROGRESSION_DIMENSION, PR_INTERNAL_DESTINATION, PR_INTRINSIC_SCALE_VALUE, PR_INTRUSION_DISPLACE, PR_KEEP_TOGETHER, PR_KEEP_WITH_NEXT, PR_KEEP_WITH_PREVIOUS, PR_LANGUAGE, PR_LAST_LINE_END_INDENT, PR_LEADER_ALIGNMENT, PR_LEADER_LENGTH, PR_LEADER_PATTERN, PR_LEADER_PATTERN_WIDTH, PR_LEFT, PR_LETTER_SPACING, PR_LETTER_VALUE, PR_LINE_HEIGHT, PR_LINE_HEIGHT_SHIFT_ADJUSTMENT, PR_LINE_STACKING_STRATEGY, PR_LINEFEED_TREATMENT, PR_MARGIN, PR_MARGIN_BOTTOM, PR_MARGIN_LEFT, PR_MARGIN_RIGHT, PR_MARGIN_TOP, PR_MARKER_CLASS_NAME, PR_MASTER_NAME, PR_MASTER_REFERENCE, PR_MAX_HEIGHT, PR_MAX_WIDTH, PR_MAXIMUM_REPEATS, PR_MEDIA_USAGE, PR_MERGE_PAGES_ACROSS_INDEX_KEY_REFERENCES, PR_MERGE_RANGES_ACROSS_INDEX_KEY_REFERENCES, PR_MERGE_SEQUENTIAL_PAGE_NUMBERS, PR_MIN_HEIGHT, PR_MIN_WIDTH, PR_NUMBER_COLUMNS_REPEATED, PR_NUMBER_COLUMNS_SPANNED, PR_NUMBER_ROWS_SPANNED, PR_ODD_OR_EVEN, PR_ORPHANS, PR_OVERFLOW, PR_PADDING, PR_PADDING_AFTER, PR_PADDING_BEFORE, PR_PADDING_BOTTOM, PR_PADDING_END, PR_PADDING_LEFT, PR_PADDING_RIGHT, PR_PADDING_START, PR_PADDING_TOP, PR_PAGE_BREAK_AFTER, PR_PAGE_BREAK_BEFORE, PR_PAGE_BREAK_INSIDE, PR_PAGE_CITATION_STRATEGY, PR_PAGE_HEIGHT, PR_PAGE_NUMBER_TREATMENT, PR_PAGE_POSITION, PR_PAGE_WIDTH, PR_PAUSE, PR_PAUSE_AFTER, PR_PAUSE_BEFORE, PR_PITCH, PR_PITCH_RANGE, PR_PLAY_DURING, PR_POSITION, PR_PRECEDENCE, PR_PROVISIONAL_DISTANCE_BETWEEN_STARTS, PR_PROVISIONAL_LABEL_SEPARATION, PR_REF_ID, PR_REF_INDEX_KEY, PR_REFERENCE_ORIENTATION, PR_REGION_NAME, PR_REGION_NAME_REFERENCE, PR_RELATIVE_ALIGN, PR_RELATIVE_POSITION, PR_RENDERING_INTENT, PR_RETRIEVE_BOUNDARY, PR_RETRIEVE_BOUNDARY_WITHIN_TABLE, PR_RETRIEVE_CLASS_NAME, PR_RETRIEVE_POSITION, PR_RETRIEVE_POSITION_WITHIN_TABLE, PR_RICHNESS, PR_RIGHT, PR_ROLE, PR_RULE_STYLE, PR_RULE_THICKNESS, PR_SCALING, PR_SCALING_METHOD, PR_SCORE_SPACES, PR_SCRIPT, PR_SHOW_DESTINATION, PR_SIZE, PR_SOURCE_DOCUMENT, PR_SPACE_AFTER, PR_SPACE_BEFORE, PR_SPACE_END, PR_SPACE_START, PR_SPAN, PR_SPEAK, PR_SPEAK_HEADER, PR_SPEAK_NUMERAL, PR_SPEAK_PUNCTUATION, PR_SPEECH_RATE, PR_SRC, PR_START_INDENT, PR_STARTING_STATE, PR_STARTS_ROW, PR_STRESS, PR_SUPPRESS_AT_LINE_BREAK, PR_SWITCH_TO, PR_TABLE_LAYOUT, PR_TABLE_OMIT_FOOTER_AT_BREAK, PR_TABLE_OMIT_HEADER_AT_BREAK, PR_TARGET_PRESENTATION_CONTEXT, PR_TARGET_PROCESSING_CONTEXT, PR_TARGET_STYLESHEET, PR_TEXT_ALIGN, PR_TEXT_ALIGN_LAST, PR_TEXT_ALTITUDE, PR_TEXT_DECORATION, PR_TEXT_DEPTH, PR_TEXT_INDENT, PR_TEXT_SHADOW, PR_TEXT_TRANSFORM, PR_TOP, PR_TREAT_AS_WORD_SPACE, PR_UNICODE_BIDI, PR_VERTICAL_ALIGN, PR_VISIBILITY, PR_VOICE_FAMILY, PR_VOLUME, PR_WHITE_SPACE, PR_WHITE_SPACE_COLLAPSE, PR_WHITE_SPACE_TREATMENT, PR_WIDOWS, PR_WIDTH, PR_WORD_SPACING, PR_WRAP_OPTION, PR_WRITING_MODE, PR_X_ABBREVIATION, PR_X_ALT_TEXT, PR_X_AUTO_TOGGLE, PR_X_BACKGROUND_IMAGE_HEIGHT, PR_X_BACKGROUND_IMAGE_WIDTH, PR_X_BORDER_AFTER_END_RADIUS, PR_X_BORDER_AFTER_RADIUS_END, PR_X_BORDER_AFTER_RADIUS_START, PR_X_BORDER_AFTER_START_RADIUS, PR_X_BORDER_BEFORE_END_RADIUS, PR_X_BORDER_BEFORE_RADIUS_END, PR_X_BORDER_BEFORE_RADIUS_START, PR_X_BORDER_BEFORE_START_RADIUS, PR_X_BORDER_END_RADIUS_AFTER, PR_X_BORDER_END_RADIUS_BEFORE, PR_X_BORDER_RADIUS, PR_X_BORDER_START_RADIUS_AFTER, PR_X_BORDER_START_RADIUS_BEFORE, PR_X_DISABLE_COLUMN_BALANCING, PR_X_HEADER_COLUMN, PR_X_LAYER, PR_X_NUMBER_CONVERSION_FEATURES, PR_X_ORPHAN_CONTENT_LIMIT, PR_X_WIDOW_CONTENT_LIMIT, PR_X_XML_BASE, PR_XML_LANG, PR_Z_INDEX, PROPERTY_COUNT, PROPERTY_MASK
-
Constructor Summary
ConstructorsConstructorDescriptionLineLayoutManager
(Block block, Length lh, int l, int f) Create a new Line Layout Manager. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAreas
(PositionIterator parentIter, LayoutContext context) Add the areas with the break points.private void
addBlockArea
(LayoutContext context, Position pos, boolean isLastPosition) Add a line with block contentvoid
addChildArea
(Area childArea) Add a child area to the current area.private void
addInlineArea
(LayoutContext context, LineLayoutManager.LineBreakPosition lbp, boolean isLastPosition) Add a line with inline contentprivate void
collectInlineKnuthElements
(LayoutContext context) Phase 1 of Knuth algorithm: Collect all inline Knuth elements before determining line breaks.private void
createElements
(List<ListElement> list, LineLayoutPossibilities llPoss, Position elementPosition) private List<ListElement>
createLineBreaks
(int alignment, LayoutContext context) Phase 2 of Knuth algorithm: find optimal break points.void
discardSpace
(KnuthGlue spaceGlue) Discard space.private void
Find hyphenation points for every word in the current paragraph.private LineLayoutPossibilities
findOptimalBreakingPoints
(int alignment, LineLayoutManager.Paragraph currPar, boolean isLastPar) Find the optimal linebreaks for a paragraphint
Returns the position of the dominant-baseline of this FO's first descendant line-area.getChangedKnuthElements
(List oldList, int alignment) Get a sequence of KnuthElements representing the content of the node assigned to the LM, after changes have been applied In the context of line breaking, this method is called after hyphenation has been performed, in order to receive the sequence of elements representing the text together with all possible hyphenation points.getChangedKnuthElements
(List oldList, int alignment, int depth) Get a sequence of KnuthElements representing the content of the node assigned to the LM, after changes have been appliedprivate int
getEffectiveAlignment
(int alignment, int alignmentLast) boolean
Returns an indication if the layout manager generates a block area.boolean
Returns an indication if the layout manager generates a line area.private HyphContext
getHyphenContext
(StringBuffer sbChars) Returns the keep-together strength for this element.Returns the keep-together property specified on the FObj.Returns the keep-with-next strength for this element.Returns the keep-with-next property specified on the FObj.Returns the keep-with-previous strength for this element.Returns the keep-with-previous property specified on the FObj.getNextKnuthElements
(LayoutContext context, int alignment) Get a sequence of KnuthElements representing the content of the node assigned to the LM.getNextKnuthElements
(LayoutContext context, int alignment, LeafPosition restartPosition) Get a sequence of KnuthElements representing the content of the node assigned to the LM.boolean
handleOverflow
(int milliPoints) Whether this LM can handle horizontal overflow error messages (only a BlockContainerLayoutManager can).protected boolean
hasLeadingFence
(boolean isNotFirst) Line area is always considered to act as a fence.boolean
Whether the FO handled by this layout manager has a descendant (including itself) that will generate a line-area.protected boolean
hasTrailingFence
(boolean isNotLast) Line area is always considered to act as a fence.void
initialize the layout manager.boolean
Returnstrue
if this layout manager is able to re-generate its Knuth elements after an IPD change.boolean
boolean
boolean
int
negotiateBPDAdjustment
(int adj, KnuthElement lastElement) Negotiate BPD adjustment.private List<ListElement>
postProcessLineBreaks
(int alignment, LayoutContext context) Creates the element list in BP direction for the broken lines.private void
processUpdates
(LineLayoutManager.Paragraph par, List updateList) Methods inherited from class org.apache.fop.layoutmgr.inline.InlineStackingLayoutManager
addALetterSpaceTo, addALetterSpaceTo, addSpace, applyChanges, applyChanges, getBreakBefore, getContext, getCurrentArea, getExtraIPD, getSpaceEnd, getSpaceStart, getWordChars, hyphenate, setChildContext, setCurrentArea, setLMiter, setTraits
Methods inherited from class org.apache.fop.layoutmgr.AbstractLayoutManager
addChildLM, addChildLMs, addId, checkEndOfLayout, createChildLMs, createNextChildLMs, getChildLM, getChildLMs, getCurrentPage, getCurrentPV, getParent, getParentArea, getPSLM, handlingFloat, hasNextChildLM, isFinished, isFirst, isLast, newNoLineAreaDescendantException, notifyEndOfLayout, notifyPos, possiblyRegisterMarkersForTables, preserveChildrenAtEndOfLayout, recreateChildrenLMs, registerMarkers, reset, setCurrentChildLM, setFinished, setParent, toString, transferExtensionAttachments, transferExtensions, transferForeignAttributes
Methods inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager
getAncestorBlockAreaBPD, getAncestorBlockAreaIPD, getBaseLength, getChangeBarList, getContentAreaBPD, getContentAreaIPD, getFObj, getGeneratesReferenceArea, getNextKnuthElements, getParentAreaBPD, getParentAreaIPD, getReferenceAreaBPD, getReferenceAreaIPD, setGeneratesBlockArea, setGeneratesReferenceArea
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.fop.layoutmgr.LayoutManager
addChildLM, addChildLMs, createNextChildLMs, getChildLMs, getContentAreaBPD, getContentAreaIPD, getFObj, getGeneratesReferenceArea, getNextKnuthElements, getParent, getParentArea, getPSLM, isFinished, notifyPos, reset, setFinished, setParent
Methods inherited from interface org.apache.fop.datatypes.PercentBaseContext
getBaseLength
-
Field Details
-
DEFAULT_SPACE_WIDTH
public static final int DEFAULT_SPACE_WIDTHthis constant is used to create elements when text-align is center: every TextLM descendant of LineLM must use the same value, otherwise the line breaking algorithm does not find the right break point- See Also:
-
log
private static org.apache.commons.logging.Log loglogging instance -
fobj
-
isFirstInBlock
private boolean isFirstInBlock -
bidiLevel
private int bidiLevel -
textAlignment
private int textAlignment -
textAlignmentLast
private int textAlignmentLast -
effectiveAlignment
private int effectiveAlignment -
textIndent
-
lastLineEndIndent
-
hyphenationProperties
-
hyphenationLadderCount
-
wrapOption
private int wrapOption -
whiteSpaceTreament
private int whiteSpaceTreament -
lineHeight
-
lead
private final int lead -
follow
private final int follow -
alignmentContext
-
baselineOffset
private int baselineOffset -
knuthParagraphs
-
lineLayouts
-
lineLayoutsList
-
ipd
private int ipd -
hyphenationPerformed
private boolean hyphenationPerformedWhen layout must be re-started due to a change of IPD, there is no need to perform hyphenation on the remaining Knuth sequence once again. -
constantLineHeight
private int constantLineHeight
-
-
Constructor Details
-
LineLayoutManager
Create a new Line Layout Manager. This is used by the block layout manager to create line managers for handling inline areas flowing into line areas.- Parameters:
block
- the block formatting objectlh
- the default line heightl
- the default lead, from top to baselinef
- the default follow, from baseline to bottom
-
-
Method Details
-
initialize
public void initialize()initialize the layout manager. Allows each layout manager to calculate often used values.- Specified by:
initialize
in interfaceLayoutManager
- Overrides:
initialize
in classAbstractLayoutManager
-
getEffectiveAlignment
private int getEffectiveAlignment(int alignment, int alignmentLast) -
getNextKnuthElements
Get a sequence of KnuthElements representing the content of the node assigned to the LM.- Specified by:
getNextKnuthElements
in interfaceLayoutManager
- Overrides:
getNextKnuthElements
in classAbstractLayoutManager
- Parameters:
context
- the LayoutContext used to store layout informationalignment
- the desired text alignment- Returns:
- the list of KnuthElements
-
getNextKnuthElements
public List getNextKnuthElements(LayoutContext context, int alignment, LeafPosition restartPosition) Get a sequence of KnuthElements representing the content of the node assigned to the LM.- Parameters:
context
- the LayoutContext used to store layout informationalignment
- the desired text alignmentrestartPosition
- position at restart- Returns:
- the list of KnuthElements
- See Also:
-
collectInlineKnuthElements
Phase 1 of Knuth algorithm: Collect all inline Knuth elements before determining line breaks.- Parameters:
context
- the LayoutContext
-
createLineBreaks
Phase 2 of Knuth algorithm: find optimal break points.- Parameters:
alignment
- alignment in BP direction of the paragraphcontext
- the layout context- Returns:
- a list of Knuth elements representing broken lines
-
findOptimalBreakingPoints
private LineLayoutPossibilities findOptimalBreakingPoints(int alignment, LineLayoutManager.Paragraph currPar, boolean isLastPar) Find the optimal linebreaks for a paragraph- Parameters:
alignment
- alignment of the paragraphcurrPar
- the Paragraph for which the linebreaks are foundisLastPar
- flag indicating whether currPar is the last paragraph- Returns:
- the line layout possibilities for the paragraph
-
postProcessLineBreaks
Creates the element list in BP direction for the broken lines.- Parameters:
alignment
- the currently applicable vertical alignmentcontext
- the layout context- Returns:
- the newly built element list
-
createElements
private void createElements(List<ListElement> list, LineLayoutPossibilities llPoss, Position elementPosition) -
mustKeepTogether
public boolean mustKeepTogether()- Specified by:
mustKeepTogether
in interfaceBlockLevelLayoutManager
- Returns:
- true if this element must be kept together
-
getKeepTogetherProperty
Returns the keep-together property specified on the FObj.- Specified by:
getKeepTogetherProperty
in interfaceBlockLevelLayoutManager
- Returns:
- the keep-together property
-
getKeepWithPreviousProperty
Returns the keep-with-previous property specified on the FObj.- Specified by:
getKeepWithPreviousProperty
in interfaceBlockLevelLayoutManager
- Returns:
- the keep-together property
-
getKeepWithNextProperty
Returns the keep-with-next property specified on the FObj.- Specified by:
getKeepWithNextProperty
in interfaceBlockLevelLayoutManager
- Returns:
- the keep-together property
-
getKeepTogether
Returns the keep-together strength for this element.- Specified by:
getKeepTogether
in interfaceBlockLevelLayoutManager
- Returns:
- the keep-together strength
-
mustKeepWithPrevious
public boolean mustKeepWithPrevious()- Specified by:
mustKeepWithPrevious
in interfaceBlockLevelLayoutManager
- Returns:
- true if this element must be kept with the previous element.
-
mustKeepWithNext
public boolean mustKeepWithNext()- Specified by:
mustKeepWithNext
in interfaceBlockLevelLayoutManager
- Returns:
- true if this element must be kept with the next element.
-
getKeepWithNext
Returns the keep-with-next strength for this element.- Specified by:
getKeepWithNext
in interfaceBlockLevelLayoutManager
- Returns:
- the keep-with-next strength
-
getKeepWithPrevious
Returns the keep-with-previous strength for this element.- Specified by:
getKeepWithPrevious
in interfaceBlockLevelLayoutManager
- Returns:
- the keep-with-previous strength
-
negotiateBPDAdjustment
Negotiate BPD adjustment.- Specified by:
negotiateBPDAdjustment
in interfaceBlockLevelLayoutManager
- Parameters:
adj
- amount to adjustlastElement
- the last knuth element- Returns:
- the resulting adjusted BPD
-
discardSpace
Discard space.- Specified by:
discardSpace
in interfaceBlockLevelLayoutManager
- Parameters:
spaceGlue
- the space
-
getChangedKnuthElements
Get a sequence of KnuthElements representing the content of the node assigned to the LM, after changes have been applied- Specified by:
getChangedKnuthElements
in interfaceInlineLevelLayoutManager
- Overrides:
getChangedKnuthElements
in classInlineStackingLayoutManager
- Parameters:
oldList
- the elements to replacealignment
- the desired text alignmentdepth
- the depth at which the Positions for this LM in oldList are found- Returns:
- the updated list of KnuthElements
-
getChangedKnuthElements
Get a sequence of KnuthElements representing the content of the node assigned to the LM, after changes have been applied In the context of line breaking, this method is called after hyphenation has been performed, in order to receive the sequence of elements representing the text together with all possible hyphenation points. For example, if the text "representation" originates a single box element when getNextKnuthElements() is called, it will be now split in syllables (rep-re-sen-ta-tion) each one originating a box and divided by additional elements allowing a line break. In the context of page breaking, this method is called only if the pages need to be "vertically justified" modifying (also) the quantity of lines created by the paragraphs, and after a first page breaking has been performed. According to the result of the first page breaking, each paragraph now knows how many lines it must create (among the existing layout possibilities) and has to create a sequence of elements representing this layout; in particular, each box, representing a line, will contain a LineBreakPositions that will be used in the addAreas() phase. LMs having children look at the old list of elements in order to know which ones they must get the new elements from, as break conditions of preserved linefeeds can divide children into smaller groups (page sequences or paragraphs). LMs having no children can simply return the old elements if they have nothing to change. Inline LMs need to know the text alignment because it affects the elements representing feasible breaks between syllables.- Specified by:
getChangedKnuthElements
in interfaceLayoutManager
- Overrides:
getChangedKnuthElements
in classInlineStackingLayoutManager
- Parameters:
oldList
- the elements to replacealignment
- the desired text alignment- Returns:
- the updated list of KnuthElements
-
findHyphenationPoints
Find hyphenation points for every word in the current paragraph.- Parameters:
currPar
- the paragraph whose words will be hyphenated
-
processUpdates
-
hasLeadingFence
protected boolean hasLeadingFence(boolean isNotFirst) Line area is always considered to act as a fence.- Overrides:
hasLeadingFence
in classInlineStackingLayoutManager
- Parameters:
isNotFirst
- ignored- Returns:
- always true
-
hasTrailingFence
protected boolean hasTrailingFence(boolean isNotLast) Line area is always considered to act as a fence.- Overrides:
hasTrailingFence
in classInlineStackingLayoutManager
- Parameters:
isNotLast
- ignored- Returns:
- always true
-
getHyphenContext
-
hasLineAreaDescendant
public boolean hasLineAreaDescendant()Description copied from interface:LayoutManager
Whether the FO handled by this layout manager has a descendant (including itself) that will generate a line-area.- Specified by:
hasLineAreaDescendant
in interfaceLayoutManager
- Overrides:
hasLineAreaDescendant
in classAbstractLayoutManager
- Returns:
true
if a descendant line-area will be generated,false
otherwise
-
getBaselineOffset
public int getBaselineOffset()Description copied from interface:LayoutManager
Returns the position of the dominant-baseline of this FO's first descendant line-area.The behavior of this method is undefined if this FO has no descendant line-area, and an exception may be thrown. See
LayoutManager.hasLineAreaDescendant()
- Specified by:
getBaselineOffset
in interfaceLayoutManager
- Overrides:
getBaselineOffset
in classAbstractLayoutManager
- Returns:
- this FO's space-before plus the distance from the before-edge of its allocation-rectangle to the dominant-baseline of the first line-area descendant
- See Also:
-
addAreas
Add the areas with the break points.- Specified by:
addAreas
in interfaceLayoutManager
- Overrides:
addAreas
in classAbstractLayoutManager
- Parameters:
parentIter
- the iterator of break positionscontext
- the context for adding areas
-
addInlineArea
private void addInlineArea(LayoutContext context, LineLayoutManager.LineBreakPosition lbp, boolean isLastPosition) Add a line with inline content- Parameters:
context
- the context for adding areaslbp
- the position for which the line is generatedisLastPosition
- true if this is the last position of this LM
-
addBlockArea
Add a line with block content- Parameters:
context
- the context for adding areaspos
- the position for which the line is generatedisLastPosition
- true if this is the last position of this LM
-
addChildArea
Add a child area to the current area. If this causes the maximum dimension of the current area to be exceeded, the parent LM is called to add it.- Specified by:
addChildArea
in interfaceLayoutManager
- Overrides:
addChildArea
in classAbstractLayoutManager
- Parameters:
childArea
- the child area to be added
-
getGeneratesBlockArea
public boolean getGeneratesBlockArea()Returns an indication if the layout manager generates a block area.- Specified by:
getGeneratesBlockArea
in interfaceLayoutManager
- Overrides:
getGeneratesBlockArea
in classAbstractBaseLayoutManager
- Returns:
- True if the layout manager generates a block area
-
getGeneratesLineArea
public boolean getGeneratesLineArea()Returns an indication if the layout manager generates a line area.- Specified by:
getGeneratesLineArea
in interfaceLayoutManager
- Overrides:
getGeneratesLineArea
in classAbstractBaseLayoutManager
- Returns:
- True if the layout manager generates a line area
-
isRestartable
public boolean isRestartable()Returnstrue
if this layout manager is able to re-generate its Knuth elements after an IPD change.- Specified by:
isRestartable
in interfaceLayoutManager
- Overrides:
isRestartable
in classAbstractBaseLayoutManager
- Returns:
true
if this layout manager can be restarted after an IPD change
-
handleOverflow
public boolean handleOverflow(int milliPoints) Whether this LM can handle horizontal overflow error messages (only a BlockContainerLayoutManager can).- Parameters:
milliPoints
- horizontal overflow- Returns:
- true if handled by a BlockContainerLayoutManager
-