org.foray.area
Class AbstractListItemContent

java.lang.Object
  org.foray.common.AbstractOrderedTreeNode
      org.foray.area.AreaNode
          org.foray.area.NonArea
              org.foray.area.AbstractListItemContent

All Implemented Interfaces:

Iterable<org.axsl.galley.AreaNode>, TreeNode, org.axsl.area.AreaNode, org.axsl.area.BlockContentFactory, org.axsl.fo.FoContext, OrderedTreeNode

Direct Known Subclasses:

ListItemBodyContainer, ListItemLabelContainer

public abstract class AbstractListItemContent
extends NonArea
implements org.axsl.area.BlockContentFactory

An AreaNode containing the areas generated by the children of a list-item-label.

Nested Class Summary

Nested classes/interfaces inherited from class org.foray.common.AbstractOrderedTreeNode

AbstractOrderedTreeNode.PostOrderDescendantIterator

Constructor Summary

protected

AbstractListItemContent(ListItemArea parentArea) Private Constructor.

Method Summary

List<Area>	getChildren() Return the List of this node's children.
FOLinkage	getLinkage() Returns the raw "generated by" instance.
ListItemArea	getParent()
int	getProgressionDimension() Computes the total BPD of the child Areas.
BlockContainerRA	makeBlockContainerArea(org.axsl.fo.fo.BlockContainer blockContainer, org.axsl.fo.fo.GraftingPoint graftingPoint)
ListBlockArea	makeListBlockArea(org.axsl.fo.fo.ListBlock listBlock, org.axsl.fo.fo.GraftingPoint graftingPoint)
NormalBlockArea	makeNormalBlockArea(org.axsl.fo.fo.Block block, org.axsl.fo.fo.GraftingPoint graftingPoint)
TableRA	makeTableArea(org.axsl.fo.fo.Table table, org.axsl.fo.fo.GraftingPoint graftingPoint)
protected boolean	optimize() This method should be run after layout is complete, allowing cleanup and adjustments that do not affect the placement of the areas to be computed before the page is rendered.
void	render(org.axsl.galley.RenderVisitor visitor)
protected void	setGeneratedBy(FOLinkage generatedBy) Sets the "generated by" for this Area.
void	setParent(AreaNode node) Sets the parent node.

Methods inherited from class org.foray.area.AreaNode

ancestorArea, ancestorBlockAreaNotALineArea, ancestorBlockContentFactory, ancestorBlockOrRa, ancestorGeneratedByBlockLevelFO, ancestorLineArea, ancestorNormalBlockArea, ancestorPageCollection, ancestorReferenceArea, ancestorSpanRA, ancestorTableArea, bpdAncestorBlockOrRa, getAllowsChildren, getAreaTree, getChildAt, getColor, getContainingReferenceArea, getFirstAreaChild, getFirstChild, getGalley, getGraftingPoint, getLastAreaChild, getLastChild, getLogger, getNextChildOfGeneratedBy, getNextSiblingArea, getNormalLinkage, getNormalLinkage, getOrderedParent, getPage, getPreviousChildOfGeneratedBy, getPreviousSiblingArea, getSiblings, hasUnresolvedRefId, heightContainingBlock, ipdAncestorBlockArea, ipdAncestorBlockOrRa, ipdContainingRefArea, ipdParentArea, isFirst, isFirstChildOfGeneratedBy, isGeneratedByBlockLevelFo, isLast, isLastChildOfGeneratedBy, iterator, linkage, nearestArea, nearestBeforeFloatArea, nearestFootnoteArea, nearestGeneratedByBlockLevelFo, nearestNormalBlockArea, nearestTableArea, optimizeChildren, registerWithLinkage, remove, removeChild, tableWidth, traitGeneratedBy, widthContainingBlock

Methods inherited from class org.foray.common.AbstractOrderedTreeNode

children, getChildCount, getFirstLeaf, getIndex, getLastLeaf, getLevel, getNextLeaf, getNextSibling, getPreviousLeaf, getPreviousSibling, getSharedAncestor, hasChildren, isLeaf, isNodeAncestor, isNodeDescendant, nextPostOrderNode, nextPreOrderNode, postOrderDescendantIterator, siblingIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.axsl.area.AreaNode

ancestorArea, ancestorBlockContentFactory, ancestorNormalBlockArea, ancestorTableArea, getAreaName, getAreaTree, getPage, isFirstChildOfGeneratedBy, nearestArea, nearestGeneratedByBlockLevelFo, removeChild, siblingIndex, traitGeneratedBy

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, isLeaf

Methods inherited from interface org.axsl.fo.FoContext

bpdAncestorBlockOrRa, getGraftingPoint, heightContainingBlock, ipdAncestorBlockArea, ipdAncestorBlockOrRa, ipdContainingRefArea, ipdParentArea, isFirst, isLast, tableWidth, widthContainingBlock

Methods inherited from interface org.axsl.galley.AreaNode

getAreaName

Constructor Detail

AbstractListItemContent

protected AbstractListItemContent(ListItemArea parentArea)

Private Constructor.

Parameters:

parentArea - The parent area.

Method Detail

render

public void render(org.axsl.galley.RenderVisitor visitor)
            throws org.axsl.galley.GalleyVisitorException

Throws:

org.axsl.galley.GalleyVisitorException

getParent

public ListItemArea getParent()

Specified by:

getParent in interface TreeNode

Specified by:

getParent in class AreaNode

setParent

public void setParent(AreaNode node)
               throws org.axsl.area.AreaTreeException

Description copied from class: AreaNode

Sets the parent node.

Specified by:

setParent in class AreaNode

Parameters:

node - The new parent node.

Throws:

org.axsl.area.AreaTreeException - If the parent node is not compatible with the implementations specification for a parent node.

getChildren

public List<Area> getChildren()

Description copied from class: AbstractOrderedTreeNode

Return the List of this node's children.

Specified by:

getChildren in class AreaNode

Returns:

The List of this node's children.

optimize

protected boolean optimize()

Description copied from class: AreaNode

This method should be run after layout is complete, allowing cleanup and adjustments that do not affect the placement of the areas to be computed before the page is rendered. For example, empty areas should be removed. Also classes like LineArea can use this to adjust word-spacing and other variables. NOTE: This method is called recursively by each node. The process starts at PageRA.layoutComplete().

Specified by:

optimize in class AreaNode

Returns:

True iff the Area node thinks it should be removed.

makeTableArea

public TableRA makeTableArea(org.axsl.fo.fo.Table table,
                             org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeTableArea in interface org.axsl.area.BlockContentFactory

makeNormalBlockArea

public NormalBlockArea makeNormalBlockArea(org.axsl.fo.fo.Block block,
                                           org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeNormalBlockArea in interface org.axsl.area.BlockContentFactory

makeBlockContainerArea

public BlockContainerRA makeBlockContainerArea(org.axsl.fo.fo.BlockContainer blockContainer,
                                               org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeBlockContainerArea in interface org.axsl.area.BlockContentFactory

makeListBlockArea

public ListBlockArea makeListBlockArea(org.axsl.fo.fo.ListBlock listBlock,
                                       org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeListBlockArea in interface org.axsl.area.BlockContentFactory

getLinkage

public FOLinkage getLinkage()

Description copied from class: AreaNode

Returns the raw "generated by" instance.

Specified by:

getLinkage in class AreaNode

Returns:

The raw linkage item.

setGeneratedBy

protected void setGeneratedBy(FOLinkage generatedBy)

Sets the "generated by" for this Area.

Parameters:

generatedBy - The new "generated by" value.

getProgressionDimension

public int getProgressionDimension()

Computes the total BPD of the child Areas.

Returns:

The total BPD of the child Areas.