org.apache.fop.layoutmgr

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 Summary

Fields inherited from class org.apache.fop.layoutmgr.KnuthElement

INFINITE

Constructor Summary

KnuthBlockBox(int w, LinkedList list, Position pos, boolean bAux)
Creates a new box.
KnuthBlockBox(int w, MinOptMax range, int bpdim, Position pos, boolean bAux)
Creates a new box.

Method Summary

void
addElementList(LinkedList 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.
LinkedList
getElementLists()
Returns the list of Knuth sequences registered by this box.
LinkedList
getFootnoteBodyLMs()
MinOptMax
getIPDRange()
boolean
hasAnchors()

Methods inherited from class org.apache.fop.layoutmgr.KnuthBox

isBox, toString

Methods inherited from class org.apache.fop.layoutmgr.KnuthElement

getP, getW, getY, getZ, isAuxiliary, isUnresolvedElement

Methods inherited from class org.apache.fop.layoutmgr.ListElement

getLayoutManager, getPosition, isBox, isForcedBreak, isGlue, isPenalty, isUnresolvedElement, setPosition

Constructor Details

KnuthBlockBox

public KnuthBlockBox(int w,
                     LinkedList list,
                     Position pos,
                     boolean bAux)
Creates a new box.
Parameters:
w - 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
bAux - is this box auxiliary?

KnuthBlockBox

public KnuthBlockBox(int w,
                     MinOptMax range,
                     int bpdim,
                     Position pos,
                     boolean bAux)
Creates a new box.
Parameters:
w - 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
bAux - is this box auxiliary?

Method Details

addElementList

public void addElementList(LinkedList list)
Adds the given list of Knuth elements to this box' list of elements.
Parameters:
list - elements corresponding to a footnote body

getBPD

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

getElementLists

public LinkedList getElementLists()
Returns the list of Knuth sequences registered by this box.
Returns:
a list of KnuthElement sequences corresponding to footnotes cited in this box

getFootnoteBodyLMs

public LinkedList getFootnoteBodyLMs()
Returns:
the LMs for the footnotes cited in this box.

getIPDRange

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

hasAnchors

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

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.