Constructor Detail

• ListBlockLayoutManager

  public ListBlockLayoutManager​(ListBlock node)

  Create a new list block layout manager.

  Parameters:

  node - list-block to create the layout manager for

Method Detail

• getCommonBorderPaddingBackground

  protected CommonBorderPaddingBackground getCommonBorderPaddingBackground()

  Description copied from class: SpacedBorderedPaddedBlockLayoutManager
  Returns the CommonBorderPaddingBackground instance from the FO handled by this layout manager.

  Specified by:

  getCommonBorderPaddingBackground in class SpacedBorderedPaddedBlockLayoutManager

• getListBlockFO

  protected ListBlock getListBlockFO()

  Convenience method.

  Returns:

  the ListBlock node

• initialize

  public void initialize()

  initialize the layout manager. Allows each layout manager to calculate often used values.

  Specified by:

  initialize in interface LayoutManager

  Overrides:

  initialize in class AbstractLayoutManager

• getNextKnuthElements

  public java.util.List getNextKnuthElements​(LayoutContext context,
                                             int alignment,
                                             java.util.Stack lmStack,
                                             Position restartPosition,
                                             LayoutManager restartAtLM)

  Returns an updated list of Knuth elements corresponding to this layout manager, after a change of IPD has been detected.

  Specified by:

  getNextKnuthElements in interface LayoutManager

  Overrides:

  getNextKnuthElements in class BlockStackingLayoutManager

  Parameters:

  context - the layout context

  alignment - the alignment

  lmStack - the stack of LMs that are active at the IPD change

  restartPosition - the position corresponding to the element finishing the page before the IPD change

  restartAtLM - if not null, the layout manager from which to restart. That is, the IPD change occurs between two block elements and not inside a paragraph

  Returns:

  an updated list of elements, taking the new IPD into account

• addAreas

  public void addAreas​(PositionIterator parentIter,
                       LayoutContext layoutContext)

  A list block generates one or more normal block areas whose child areas are normal block areas returned by the children of fo:list-block. See XSL-FO 1.1 6.8.2.

  Specified by:

  addAreas in interface LayoutManager

  Overrides:

  addAreas in class AbstractLayoutManager

  Parameters:

  parentIter - the position iterator

  layoutContext - the layout context for adding areas

• getParentArea

  public Area getParentArea​(Area childArea)

  Return an Area which can contain the passed childArea. The childArea may not yet have any content, but it has essential traits set. In general, if the LayoutManager already has an Area it simply returns it. Otherwise, it makes a new Area of the appropriate class. It gets a parent area for its area by calling its parent LM. Finally, based on the dimensions of the parent area, it initializes its own area. This includes setting the content IPD and the maximum BPD.

  Specified by:

  getParentArea in interface LayoutManager

  Overrides:

  getParentArea in class AbstractLayoutManager

  Parameters:

  childArea - the child area

  Returns:

  the parent area of the child

• addChildArea

  public void addChildArea​(Area childArea)

  Add the child area to this layout manager.

  Specified by:

  addChildArea in interface LayoutManager

  Overrides:

  addChildArea in class BlockStackingLayoutManager

  Parameters:

  childArea - the child area to add

• getKeepTogetherProperty

  public KeepProperty getKeepTogetherProperty()

  Returns the keep-together property specified on the FObj. Default implementation throws a IllegalStateException. Must be implemented by the subclass, if applicable.

  Specified by:

  getKeepTogetherProperty in interface BlockLevelLayoutManager

  Overrides:

  getKeepTogetherProperty in class BlockStackingLayoutManager

  Returns:

  the keep-together property

• getKeepWithPreviousProperty

  public KeepProperty getKeepWithPreviousProperty()

  Returns the keep-with-previous property specified on the FObj. Default implementation throws a IllegalStateException. Must be implemented by the subclass, if applicable.

  Specified by:

  getKeepWithPreviousProperty in interface BlockLevelLayoutManager

  Overrides:

  getKeepWithPreviousProperty in class BlockStackingLayoutManager

  Returns:

  the keep-together property

• getKeepWithNextProperty

  public KeepProperty getKeepWithNextProperty()

  Returns the keep-with-next property specified on the FObj. Default implementation throws a IllegalStateException. Must be implemented by the subclass, if applicable.

  Specified by:

  getKeepWithNextProperty in interface BlockLevelLayoutManager

  Overrides:

  getKeepWithNextProperty in class BlockStackingLayoutManager

  Returns:

  the keep-together property

• isRestartable

  public boolean isRestartable()

  Returns true if this layout manager is able to re-generate its Knuth elements after an IPD change.

  Specified by:

  isRestartable in interface LayoutManager

  Overrides:

  isRestartable in class AbstractBaseLayoutManager

  Returns:

  true if this layout manager can be restarted after an IPD change