Package org.apache.fop.layoutmgr
Class KnuthBlockBox
- java.lang.Object
-
- org.apache.fop.layoutmgr.ListElement
-
- org.apache.fop.layoutmgr.KnuthElement
-
- org.apache.fop.layoutmgr.KnuthBox
-
- org.apache.fop.layoutmgr.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 Summary
Fields Modifier and Type Field Description private int
bpd
Natural width of the line represented by this box.private java.util.List
elementLists
List of Knuth elements.private java.util.List<FloatContentLayoutManager>
floatContentLMs
private java.util.List<FootnoteBodyLayoutManager>
footnoteList
private MinOptMax
ipdRange
-
Fields inherited from class org.apache.fop.layoutmgr.KnuthElement
INFINITE
-
-
Constructor Summary
Constructors Constructor Description KnuthBlockBox(int width, java.util.List list, Position pos, boolean auxiliary)
Creates a new box.KnuthBlockBox(int width, java.util.List list, Position pos, boolean auxiliary, java.util.List<FloatContentLayoutManager> fclms)
KnuthBlockBox(int width, MinOptMax range, int bpdim, Position pos, boolean auxiliary)
Creates a new box.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addElementList(java.util.List list)
Adds the given list of Knuth elements to this box' list of elements.int
getBPD()
Returns the natural width (without stretching nor shrinking) of the line represented by this box.java.util.List
getElementLists()
Returns the list of Knuth sequences registered by this box.java.util.List<FloatContentLayoutManager>
getFloatContentLMs()
java.util.List<FootnoteBodyLayoutManager>
getFootnoteBodyLMs()
MinOptMax
getIPDRange()
boolean
hasAnchors()
boolean
hasFloatAnchors()
-
Methods inherited from class org.apache.fop.layoutmgr.KnuthElement
getPenalty, getShrink, getStretch, getWidth, isAuxiliary, isUnresolvedElement
-
Methods inherited from class org.apache.fop.layoutmgr.ListElement
getLayoutManager, getPosition, isForcedBreak, isGlue, isPenalty, setPosition
-
-
-
-
Field Detail
-
ipdRange
private MinOptMax ipdRange
-
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.
-
footnoteList
private java.util.List<FootnoteBodyLayoutManager> footnoteList
-
floatContentLMs
private java.util.List<FloatContentLayoutManager> floatContentLMs
-
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 boxrange
- min, opt, max inline progression dimension of this boxbpdim
- natural width of the line represented by this box.pos
- the Position stored in this boxauxiliary
- 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 boxlist
- footnotes cited by elements in this box. The list contains the corresponding FootnoteBodyLayoutManagerspos
- the Position stored in this boxauxiliary
- is this box auxiliary?
-
KnuthBlockBox
public KnuthBlockBox(int width, java.util.List list, Position pos, boolean auxiliary, java.util.List<FloatContentLayoutManager> fclms)
-
-
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
-
getFloatContentLMs
public java.util.List<FloatContentLayoutManager> getFloatContentLMs()
-
hasFloatAnchors
public boolean hasFloatAnchors()
-
-