Class KnuthBlockBox


  • public class KnuthBlockBox
    extends KnuthBox
    Knuth box used to represent a line in block-progression-dimension (i.e. the width is its height).
    • Field Detail

      • bpd

        private int bpd
        Natural width of the line represented by this box. In addition to ipdRange because it isn't possible to get the opt value stored in a MinOptMax object.
      • elementLists

        private java.util.List elementLists
        List of Knuth elements. This is a list of LinkedList elements.
    • Constructor Detail

      • KnuthBlockBox

        public KnuthBlockBox​(int width,
                             MinOptMax range,
                             int bpdim,
                             Position pos,
                             boolean auxiliary)
        Creates a new box.
        Parameters:
        width - block progression dimension of this box
        range - min, opt, max inline progression dimension of this box
        bpdim - natural width of the line represented by this box.
        pos - the Position stored in this box
        auxiliary - is this box auxiliary?
      • KnuthBlockBox

        public KnuthBlockBox​(int width,
                             java.util.List list,
                             Position pos,
                             boolean auxiliary)
        Creates a new box.
        Parameters:
        width - block progression dimension of this box
        list - footnotes cited by elements in this box. The list contains the corresponding FootnoteBodyLayoutManagers
        pos - the Position stored in this box
        auxiliary - is this box auxiliary?
    • Method Detail

      • getFootnoteBodyLMs

        public java.util.List<FootnoteBodyLayoutManager> getFootnoteBodyLMs()
        Returns:
        the LMs for the footnotes cited in this box.
      • hasAnchors

        public boolean hasAnchors()
        Returns:
        true if this box contains footnote citations.
      • addElementList

        public void addElementList​(java.util.List list)
        Adds the given list of Knuth elements to this box' list of elements.
        Parameters:
        list - elements corresponding to a footnote body
      • getElementLists

        public java.util.List getElementLists()
        Returns the list of Knuth sequences registered by this box.
        Returns:
        a list of KnuthElement sequences corresponding to footnotes cited in this box
      • getIPDRange

        public MinOptMax getIPDRange()
        Returns:
        the inline progression dimension of this box.
      • getBPD

        public int getBPD()
        Returns the natural width (without stretching nor shrinking) of the line represented by this box.
        Returns:
        the line width
      • hasFloatAnchors

        public boolean hasFloatAnchors()