Constructor Detail

• BlockContainerLayoutManager

  public BlockContainerLayoutManager​(BlockContainer node)

  Create a new block container layout manager.

  Parameters:

  node - block-container node to create the layout manager for.

Method Detail

• 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

• 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

• getRotatedIPD

  protected int getRotatedIPD()

  Returns:

  the content IPD

• isAbsoluteOrFixed

  protected boolean isAbsoluteOrFixed()

• getContentAreaBPD

  public int getContentAreaBPD()

  Returns the BPD of the content area

  Specified by:

  getContentAreaBPD in interface LayoutManager

  Overrides:

  getContentAreaBPD in class BlockStackingLayoutManager

  Returns:

  the BPD of the content area

• 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 BlockStackingLayoutManager

  Parameters:

  context - the LayoutContext used to store layout information

  alignment - the desired text alignment

  Returns:

  the list of KnuthElements

• makeChildLayoutContext

  protected LayoutContext makeChildLayoutContext​(LayoutContext context)

  Overridden to handle writing-mode, and different stack limit setup. Creates and initializes a LayoutContext to pass to the child LM

  Overrides:

  makeChildLayoutContext in class BlockStackingLayoutManager

  Parameters:

  context - the parent LayoutContext

  Returns:

  a new child layout context

• 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

• 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

• addAreas

  public void addAreas​(PositionIterator parentIter,
                       LayoutContext layoutContext)

  Tell the layout manager to add all the child areas implied by Position objects which will be returned by the Iterator.

  Specified by:

  addAreas in interface LayoutManager

  Overrides:

  addAreas in class AbstractLayoutManager

  Parameters:

  parentIter - the position iterator

  layoutContext - the context

• getParentArea

  public Area getParentArea​(Area childArea)

  Get the parent area for children of this block container. This returns the current block container area and creates it if required. 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 for which the parent area is wanted

  Returns:

  the parent area for the given child

• addChildArea

  public void addChildArea​(Area childArea)

  Add the child to the block container. Add the childArea to the current area. Called by child LayoutManager when it has filled one of its areas. The LM should already have an Area in which to put the child. See if the area will fit in the current area. If so, add it. Otherwise initiate breaking.

  Specified by:

  addChildArea in interface LayoutManager

  Overrides:

  addChildArea in class BlockStackingLayoutManager

  Parameters:

  childArea - the area to add: will be some block-stacked Area.

• flush

  protected void flush()

  Force current area to be added to parent area. Force current area to be added to parent area.

  Overrides:

  flush in class BlockStackingLayoutManager

• negotiateBPDAdjustment

  public int negotiateBPDAdjustment​(int adj,
                                    KnuthElement lastElement)

  Negotiate BPD adjustment.

  Specified by:

  negotiateBPDAdjustment in interface BlockLevelLayoutManager

  Overrides:

  negotiateBPDAdjustment in class BlockStackingLayoutManager

  Parameters:

  adj - amount to adjust

  lastElement - the last knuth element

  Returns:

  the resulting adjusted BPD

• discardSpace

  public void discardSpace​(KnuthGlue spaceGlue)

  Discard space.

  Specified by:

  discardSpace in interface BlockLevelLayoutManager

  Overrides:

  discardSpace in class BlockStackingLayoutManager

  Parameters:

  spaceGlue - the space

• 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

• getBlockContainerFO

  protected BlockContainer getBlockContainerFO()

  Returns:

  the BlockContainer node

• getGeneratesReferenceArea

  public boolean getGeneratesReferenceArea()

  Returns an indication if the layout manager generates a reference area.

  Specified by:

  getGeneratesReferenceArea in interface LayoutManager

  Overrides:

  getGeneratesReferenceArea in class AbstractBaseLayoutManager

  Returns:

  True if the layout manager generates a reference area

• getGeneratesBlockArea

  public boolean getGeneratesBlockArea()

  Returns an indication if the layout manager generates a block area.

  Specified by:

  getGeneratesBlockArea in interface LayoutManager

  Overrides:

  getGeneratesBlockArea in class AbstractBaseLayoutManager

  Returns:

  True if the layout manager generates a block area

• handleOverflow

  public boolean handleOverflow​(int milliPoints)

  Whether this LM can handle horizontal overflow error messages (only a BlockContainerLayoutManager can).

  Overrides:

  handleOverflow in class BlockStackingLayoutManager

  Parameters:

  milliPoints - horizontal overflow

  Returns:

  true if handled by a BlockContainerLayoutManager