Class TextLayoutManager

    • Constructor Detail

      • TextLayoutManager

        public TextLayoutManager​(FOText node)
        Create a Text layout manager.
        Parameters:
        node - The FOText object to be rendered
    • Method Detail

      • addAreas

        public void addAreas​(PositionIterator posIter,
                             LayoutContext context)
        Generate and add areas to parent area. This can either generate an area for each TextArea and each space, or an area containing all text with a parameter controlling the size of the word space. The latter is most efficient for PDF generation. Set size of each area.
        Specified by:
        addAreas in interface LayoutManager
        Overrides:
        addAreas in class LeafNodeLayoutManager
        Parameters:
        posIter - Iterator over Position information returned by this LayoutManager.
        context - LayoutContext for adjustments
      • getNextKnuthElements

        public java.util.List getNextKnuthElements​(LayoutContext context,
                                                   int alignment)
        Get a sequence of KnuthElements representing the content of the node assigned to the LM.
        Specified by:
        getNextKnuthElements in interface LayoutManager
        Overrides:
        getNextKnuthElements in class LeafNodeLayoutManager
        Parameters:
        context - the LayoutContext used to store layout information
        alignment - the desired text alignment
        Returns:
        the list of KnuthElements
      • addALetterSpaceTo

        public java.util.List addALetterSpaceTo​(java.util.List oldList)
        Tell the LM to modify its data, adding a letter space to the word fragment represented by the given elements, and returning the corrected elements
        Specified by:
        addALetterSpaceTo in interface InlineLevelLayoutManager
        Overrides:
        addALetterSpaceTo in class LeafNodeLayoutManager
        Parameters:
        oldList - the elements which must be given one more letter space
        Returns:
        the new elements replacing the old ones
      • addALetterSpaceTo

        public java.util.List addALetterSpaceTo​(java.util.List oldList,
                                                int depth)
        Tell the LM to modify its data, adding a letter space to the word fragment represented by the given elements, and returning the corrected elements Only TextLM has a meaningful implementation of this method
        Specified by:
        addALetterSpaceTo in interface InlineLevelLayoutManager
        Overrides:
        addALetterSpaceTo in class LeafNodeLayoutManager
        Parameters:
        oldList - the elements which must be given one more letter space
        depth - the depth at which the Positions for this LM in oldList are found
        Returns:
        the new elements replacing the old ones
      • applyChanges

        public boolean applyChanges​(java.util.List oldList)
        Tell the LM to apply the changes due to hyphenation
        Specified by:
        applyChanges in interface InlineLevelLayoutManager
        Overrides:
        applyChanges in class LeafNodeLayoutManager
        Parameters:
        oldList - the list of the old elements the changes refer to
        Returns:
        true if the LM had to change its data, false otherwise
      • applyChanges

        public boolean applyChanges​(java.util.List oldList,
                                    int depth)
        Tell the LM to apply the changes due to hyphenation Only TextLM has a meaningful implementation of this method
        Specified by:
        applyChanges in interface InlineLevelLayoutManager
        Overrides:
        applyChanges in class LeafNodeLayoutManager
        Parameters:
        oldList - the list of the old elements the changes refer to
        depth - the depth at which the Positions for this LM in oldList are found
        Returns:
        true if the LM had to change its data, false otherwise
      • getChangedKnuthElements

        public java.util.List getChangedKnuthElements​(java.util.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. 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 interface LayoutManager
        Overrides:
        getChangedKnuthElements in class LeafNodeLayoutManager
        Parameters:
        oldList - the elements to replace
        alignment - the desired text alignment
        Returns:
        the updated list of KnuthElements