org.foray.area
Class RegionRABody

java.lang.Object
  org.foray.common.AbstractOrderedTreeNode
      org.foray.area.AreaNode
          org.foray.area.Area
              org.foray.area.AreaFixed
                  org.foray.area.RegionRABody

All Implemented Interfaces:

Iterable<org.axsl.galley.AreaNode>, TreeNode, org.axsl.area.Area, org.axsl.area.AreaNode, org.axsl.area.RegionBodyRefArea, org.axsl.fo.FoContext, org.axsl.galley.BackgroundArea, org.axsl.galley.GraphicArea, org.axsl.galley.RegionArea, OrderedTreeNode

public final class RegionRABody
extends AreaFixed
implements org.axsl.galley.RegionArea, org.axsl.area.RegionBodyRefArea

Area containing a region-body.

Nested Class Summary

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

AbstractOrderedTreeNode.PostOrderDescendantIterator

Method Summary

int	brOriginX()
int	brOriginY()
org.axsl.common.value.RelativeAxis	contentStackingAxis() Returns the content stacking axis for this area.
int	crBpd()
int	crIpd()
int	crOriginBPDOffset() The difference, in millipoints, between the page-viewport-area's before-edge and this Area's content-rectangle before-edge.
int	crOriginIPDOffset() The difference, in millipoints, between the page-viewport-area's start-edge and this Area's content-rectangle start-edge.
String	getAreaName()
BeforeFloatRA	getBeforeFloatRefArea()
List<AreaNode>	getChildren() Return the List of this node's children.
int	getDimensionBeforeFloatRA() Returns the size of the before-float reference area, in millipoints.
int	getDimensionFootnoteRA() Returns the size of the footnote reference area, in millipoints.
int	getDimensionMainRA() Returns the size of the main reference area, in millipoints.
FootnoteRA	getFootnoteRefArea()
org.axsl.graphic.Graphic	getGraphic()
FOLinkage	getLinkage() Returns the raw "generated by" instance.
MainRA	getMainRefArea()
Area	getOverflowArea(Area childRequesting) This method is used by child Areas to ask the parent Area into which Area the child Area's overflow should be placed.
org.axsl.fo.fo.SimplePageMaster	getPageMaster() Returns the page master that generated this page.
AreaNode	getParent()
void	incrementBeforeFloatDimension(int incrementAmount) Increments or decrements the size of the before-float reference area.
void	incrementFootnoteDimension(int incrementAmount) Increments or decrements the size of the footnote reference area.
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)
void	setBeforeFloatDimension(int newDimension) Sets the size of the before-float reference area.
void	setFootnoteDimension(int newDimension) Sets the size of the footnote reference area.
void	setParent(AreaNode node) Sets the parent node.
Color	traitBackgroundColor()
org.axsl.graphic.Graphic	traitBackgroundImage()
org.axsl.common.value.BackgroundRepeat	traitBackgroundRepeat()
int	traitBorderAfterWidth() Returns the border-after-width trait for this area.
int	traitBorderBeforeWidth() Returns the border-before-width trait for this area.
int	traitBorderEndWidth() Returns the border-end-width trait for this area.
int	traitBorderStartWidth() Returns the border-start-width trait for this area.
int	traitColumnCount() Returns the number of columns in this body region.
int	traitColumnGap() Returns the column gap, in millipoints, of this body region.
int	traitEndIndent() Returns the end-indent trait.
int	traitExtent()
org.axsl.fo.fo.RegionBody	traitGeneratedBy()
int	traitPaddingAfter() Returns the padding-after trait for this area.
int	traitPaddingBefore() Returns the padding-before trait for this area.
int	traitPaddingEnd() Returns the padding-end trait for this area.
int	traitPaddingStart() Returns the padding-start trait for this area.
int	traitSpaceAfterOptimum() Returns the space-after optimum trait for this area.
int	traitSpaceBeforeOptimum() Returns the space-before optimum trait for this area.
int	traitSpaceEndOptimum() Returns the space-end optimum trait for this area.
int	traitSpaceStartOptimum() Returns the space-start optimum trait for this area.
int	traitStartIndent() Returns the start-indent trait.

Methods inherited from class org.foray.area.AreaFixed

getProgressionDimension, incrementProgressionDimension, isAbsolutelyPositioned, pdAvailable, pdUsedBySiblings, setMinimumProgressionDimension, setProgressionDimension

Methods inherited from class org.foray.area.Area

brBpd, brIpd, brOriginBPDOffset, brOriginIPDOffset, brPoints, contentStackingAxisAbsolute, contentStackingDirectionAbsolute, crOriginX, crOriginY, crPoints, destinationName, generatedByExists, generatedByName, getAreaParent, getBPAxis, getFontWritingMode, getIPAxis, getNearestAncestorAreaContainer, getWritingMode, hasFenceFollowing, hasFencePreceding, isBlockArea, isFirstChildOfParent, isInNormalFlow, isLastChildOfParent, isLinkRoot, larBPD, larIPD, larOriginX, larOriginY, linkDestination, linkType, narBPD, narIPD, narOriginX, narOriginY, nearestArea, parentAllocationWidth, prBpd, prIpd, prOriginBPDOffset, prOriginIPDOffset, prOriginX, prOriginY, referenceOrientationCumulative, shouldAdjustParentPD, traitAreaClass, traitId, traitIsFirst, traitIsLast, traitIsReferenceArea, traitWhiteSpaceTreatment

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, nearestBeforeFloatArea, nearestFootnoteArea, nearestGeneratedByBlockLevelFo, nearestNormalBlockArea, nearestTableArea, optimizeChildren, registerWithLinkage, remove, removeChild, tableWidth, 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.galley.BackgroundArea

prBpd, prIpd, prOriginX, prOriginY

Methods inherited from interface org.axsl.galley.Area

brBpd, brIpd, crOriginX, crOriginY, destinationName, generatedByExists, generatedByName, isLinkRoot, linkDestination, linkType, traitId

Methods inherited from interface org.axsl.galley.AreaNode

getGalley

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildCount, getIndex, isLeaf

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.axsl.area.Area

pdAvailable

Methods inherited from interface org.axsl.area.AreaNode

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

Methods inherited from interface org.axsl.fo.FoContext

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

Method Detail

getMainRefArea

public MainRA getMainRefArea()

Specified by:

getMainRefArea in interface org.axsl.area.RegionBodyRefArea

getBeforeFloatRefArea

public BeforeFloatRA getBeforeFloatRefArea()

Specified by:

getBeforeFloatRefArea in interface org.axsl.area.RegionBodyRefArea

getFootnoteRefArea

public FootnoteRA getFootnoteRefArea()

Specified by:

getFootnoteRefArea in interface org.axsl.area.RegionBodyRefArea

crBpd

public int crBpd()

Specified by:

crBpd in interface org.axsl.area.Area

Specified by:

crBpd in class Area

crIpd

public int crIpd()

Specified by:

crIpd in interface org.axsl.area.Area

Specified by:

crIpd in class Area

getDimensionFootnoteRA

public int getDimensionFootnoteRA()

Returns the size of the footnote reference area, in millipoints.

Returns:

The size of the footnote reference area.

getDimensionBeforeFloatRA

public int getDimensionBeforeFloatRA()

Returns the size of the before-float reference area, in millipoints.

Returns:

The size of the before-float reference area.

getDimensionMainRA

public int getDimensionMainRA()

Returns the size of the main reference area, in millipoints.

Returns:

The size of the main reference area.

getPageMaster

public org.axsl.fo.fo.SimplePageMaster getPageMaster()

Returns the page master that generated this page.

Returns:

The page master that generated this page.

brOriginX

public int brOriginX()

Overrides:

brOriginX in class Area

brOriginY

public int brOriginY()

Overrides:

brOriginY in class Area

crOriginIPDOffset

public int crOriginIPDOffset()

Description copied from class: Area

The difference, in millipoints, between the page-viewport-area's start-edge and this Area's content-rectangle start-edge. This assumes for now that the IP Direction is the same for all areas.

Specified by:

crOriginIPDOffset in class Area

Returns:

The IPD offset of the content rectangle.

crOriginBPDOffset

public int crOriginBPDOffset()

Description copied from class: Area

The difference, in millipoints, between the page-viewport-area's before-edge and this Area's content-rectangle before-edge. This assumes for now that the BP Direction is the same for all areas.

Specified by:

crOriginBPDOffset in class Area

Returns:

The BPD offset of the content rectangle.

getOverflowArea

public Area getOverflowArea(Area childRequesting)
                     throws org.axsl.area.AreaTreeException

Description copied from class: Area

This method is used by child Areas to ask the parent Area into which Area the child Area's overflow should be placed. Overflows start when a new LineArea cannot be create for the current BlockArea. General strategy for overflow is to recursively go up the tree until getting to any Area that knows how to solve the overflow. One general case is the page-reference-area, which should know how to create a new page.

Specified by:

getOverflowArea in class Area

Parameters:

childRequesting - Child Areas ask

Returns:

The younger sister Area that should be used to handle the overflow condition.

Throws:

org.axsl.area.AreaTreeException - If the Area is unable to find or create the overflow area.

traitColumnCount

public int traitColumnCount()

Returns the number of columns in this body region.

Returns:

The number of columns.

traitColumnGap

public int traitColumnGap()

Returns the column gap, in millipoints, of this body region.

Returns:

The column gap.

getAreaName

public String getAreaName()

Specified by:

getAreaName in interface org.axsl.area.AreaNode

setFootnoteDimension

public void setFootnoteDimension(int newDimension)

Sets the size of the footnote reference area.

Parameters:

newDimension - The new size, in millipoints, of the footnote reference area.

incrementFootnoteDimension

public void incrementFootnoteDimension(int incrementAmount)

Increments or decrements the size of the footnote reference area.

Parameters:

incrementAmount - The amount, in millipoints, by which to increment (or, for negative values, decrement) the size of the footnote reference area.

setBeforeFloatDimension

public void setBeforeFloatDimension(int newDimension)

Sets the size of the before-float reference area.

Parameters:

newDimension - The new size, in millipoints, of the before-float reference area.

incrementBeforeFloatDimension

public void incrementBeforeFloatDimension(int incrementAmount)

Increments or decrements the size of the before-float reference area.

Parameters:

incrementAmount - The amount, in millipoints, by which to increment (or, for negative values, decrement) the size of the before-float reference area.

render

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

Throws:

org.axsl.galley.GalleyVisitorException

getGraphic

public org.axsl.graphic.Graphic getGraphic()

Specified by:

getGraphic in interface org.axsl.galley.GraphicArea

contentStackingAxis

public org.axsl.common.value.RelativeAxis contentStackingAxis()

Description copied from class: Area

Returns the content stacking axis for this area.

Specified by:

contentStackingAxis in class Area

Returns:

Either RelativeAxis.BLOCK_PROGRESSION or RelativeAxis.INLINE_PROGRESSION, depending on whether the contents of this area stack in the block-progression-direction or the inline-progression-direction. The default value is that contents stack in the BPD. Classes that stack in the IPD should override this method.

getParent

public AreaNode 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<AreaNode> getChildren()

Description copied from class: AbstractOrderedTreeNode

Return the List of this node's children.

Specified by:

getChildren in class AreaFixed

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.

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.

traitGeneratedBy

public org.axsl.fo.fo.RegionBody traitGeneratedBy()

Specified by:

traitGeneratedBy in interface org.axsl.area.AreaNode

Specified by:

traitGeneratedBy in class AreaNode

traitBackgroundImage

public org.axsl.graphic.Graphic traitBackgroundImage()

Specified by:

traitBackgroundImage in interface org.axsl.galley.BackgroundArea

traitBackgroundColor

public Color traitBackgroundColor()

Specified by:

traitBackgroundColor in interface org.axsl.galley.BackgroundArea

traitBackgroundRepeat

public org.axsl.common.value.BackgroundRepeat traitBackgroundRepeat()

Specified by:

traitBackgroundRepeat in interface org.axsl.galley.BackgroundArea

traitBorderStartWidth

public int traitBorderStartWidth()

Description copied from class: Area

Returns the border-start-width trait for this area.

Specified by:

traitBorderStartWidth in class Area

Returns:

The border-start-width trait for this area.

traitBorderEndWidth

public int traitBorderEndWidth()

Description copied from class: Area

Returns the border-end-width trait for this area.

Specified by:

traitBorderEndWidth in class Area

Returns:

The border-end-width trait for this area.

traitBorderBeforeWidth

public int traitBorderBeforeWidth()

Description copied from class: Area

Returns the border-before-width trait for this area.

Specified by:

traitBorderBeforeWidth in class Area

Returns:

The border-before-width trait for this area.

traitBorderAfterWidth

public int traitBorderAfterWidth()

Description copied from class: Area

Returns the border-after-width trait for this area.

Specified by:

traitBorderAfterWidth in class Area

Returns:

The border-after-width trait for this area.

traitPaddingStart

public int traitPaddingStart()

Description copied from class: Area

Returns the padding-start trait for this area.

Specified by:

traitPaddingStart in class Area

Returns:

The padding-start trait for this area.

traitPaddingEnd

public int traitPaddingEnd()

Description copied from class: Area

Returns the padding-end trait for this area.

Specified by:

traitPaddingEnd in class Area

Returns:

The padding-end trait for this area.

traitPaddingBefore

public int traitPaddingBefore()

Description copied from class: Area

Returns the padding-before trait for this area.

Specified by:

traitPaddingBefore in class Area

Returns:

The padding-before trait for this area.

traitPaddingAfter

public int traitPaddingAfter()

Description copied from class: Area

Returns the padding-after trait for this area.

Specified by:

traitPaddingAfter in class Area

Returns:

The padding-after trait for this area.

traitSpaceBeforeOptimum

public int traitSpaceBeforeOptimum()

Description copied from class: Area

Returns the space-before optimum trait for this area.

Specified by:

traitSpaceBeforeOptimum in class Area

Returns:

The space-before optimum trait for this area.

traitSpaceAfterOptimum

public int traitSpaceAfterOptimum()

Description copied from class: Area

Returns the space-after optimum trait for this area.

Specified by:

traitSpaceAfterOptimum in class Area

Returns:

The space-after optimum trait for this area.

traitEndIndent

public int traitEndIndent()

Description copied from class: Area

Returns the end-indent trait.

Specified by:

traitEndIndent in class Area

Returns:

The end-indent trait.

traitStartIndent

public int traitStartIndent()

Description copied from class: Area

Returns the start-indent trait.

Specified by:

traitStartIndent in class Area

Returns:

The start-indent trait.

traitSpaceStartOptimum

public int traitSpaceStartOptimum()

Description copied from class: Area

Returns the space-start optimum trait for this area.

Specified by:

traitSpaceStartOptimum in class Area

Returns:

The space-start optimum trait for this area.

traitSpaceEndOptimum

public int traitSpaceEndOptimum()

Description copied from class: Area

Returns the space-end optimum trait for this area.

Specified by:

traitSpaceEndOptimum in class Area

Returns:

The space-end optimum trait for this area.

traitExtent

public int traitExtent()

Specified by:

traitExtent in interface org.axsl.galley.RegionArea