org.foray.area
Class SpanRA

java.lang.Object
  org.foray.common.AbstractOrderedTreeNode
      org.foray.area.AreaNode
          org.foray.area.Area
              org.foray.area.AreaFlexible
                  org.foray.area.ContainerRA
                      org.foray.area.SpanRA

All Implemented Interfaces:

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

public final class SpanRA
extends ContainerRA
implements org.axsl.area.SpanRefArea

Represents a span-reference-area. The standard does not seem to tell us what if any FO generates a span-reference-area. The best guess is that it is generated by the region-body fo.

Nested Class Summary

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

AbstractOrderedTreeNode.PostOrderDescendantIterator

Method Summary

SpanRA	ancestorSpanRA() Returns the ancestor Span area.
void	balanceColumns() Balances the size of the columns.
boolean	canAddLineArea(NormalBlockArea blockArea) Indicates whether a new line can be added to a given block area.
org.axsl.common.value.RelativeAxis	contentStackingAxis() Returns the content stacking axis for this area.
int	crBpd()
int	crIpd()
String	getAreaName()
List<NormalFlowRA>	getChildren() Return the List of this node's children.
int	getColumnWidth() Returns the width of the columns in this span.
NormalFlowRA	getCurrentColumnArea() Returns the current column area.
FOLinkage	getLinkage() Returns the raw "generated by" instance.
int	getMaxContentHeight() Returns the height of the largest child normal flow reference area.
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.
AreaNode	getParent()
int	getProgressionDimension() Returns the actual total value, in millipoints, of the size of this area (not counting space-before, etc.) in its progression direction.
int	getTotalContentHeight() Returns the total height of the content in this span area.
void	incrementProgressionDimension(int incrementAmount) Change the progression-dimension used by this Area.
boolean	isAbsolutelyPositioned() Indicates whether this Area is positioned absolutely or relatively.
boolean	isBalanced() Indicates whether this span area has been balanced.
boolean	isLastColumn() Indicates whether the current column is the last column in this span area.
void	moveChildBackward(AreaNode child, NormalFlowRA oldParent, NormalFlowRA newParent) Moves a child from one parent to the last child of another parent.
void	moveChildForward(AreaNode child, NormalFlowRA oldParent, NormalFlowRA newParent) Moves a child from one parent to the first child of another parent.
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	setIsBalanced() Sets the "isBalanced" value to true.
void	setParent(AreaNode node) Sets the parent node.
void	setProgressionDimension(int progressionDimension) Sets the progression-dimension used by this Area.
SpanRA	spanForNextFO(org.axsl.fo.fo.prop.SpanPa fo) Returns a span area that conforms to the requirements of fo, either itself or a newly-created younger sibling span area that does have traits that match fo.
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 span area.
int	traitColumnGap() Returns the column gap, in millipoints, of this span area.
int	traitEndIndent() Returns the end-indent trait.
org.axsl.fo.fo.RegionBody	traitGeneratedBy()
int	traitIPDimensionOpt() Return the optimum IP dimension for this area.
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.AreaFlexible

computeInitialPD, crIPDBlockArea, crOriginBPDOffset, crOriginIPDOffset, getAnteriorSpace, incrementAnteriorSpace, incrementParentPD, initializeAnteriorSpace, pdAvailable, pdUsedBySiblings, removeChild, setAnteriorSpace, setMinimumProgressionDimension, setParentPD, usedProgressionDimension, usedProgressionDimensionNormalFlow

Methods inherited from class org.foray.area.Area

brBpd, brIpd, brOriginBPDOffset, brOriginIPDOffset, brOriginX, brOriginY, 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, 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.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 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

getChildAt, getGalley

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getColumnWidth

public int getColumnWidth()

Returns the width of the columns in this span.

Returns:

The width of each column in this span.

getCurrentColumnArea

public NormalFlowRA getCurrentColumnArea()

Returns the current column area.

Returns:

The current column area.

isBalanced

public boolean isBalanced()

Indicates whether this span area has been balanced.

Returns:

True iff this span area has been balanced.

setIsBalanced

public void setIsBalanced()

Sets the "isBalanced" value to true.

getTotalContentHeight

public int getTotalContentHeight()

Returns the total height of the content in this span area.

Returns:

The total height, in millipoints, of the content of this span area.

getMaxContentHeight

public int getMaxContentHeight()

Returns the height of the largest child normal flow reference area.

Returns:

The height, in millipoints, of the largest child normal flow reference area.

isLastColumn

public boolean isLastColumn()

Indicates whether the current column is the last column in this span area.

Returns:

True iff the current column is the last column in this span area.

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 span area.

Returns:

The number of columns in this span area.

traitColumnGap

public int traitColumnGap()

Returns the column gap, in millipoints, of this span area.

Returns:

The column gap.

ancestorSpanRA

public SpanRA ancestorSpanRA()

Returns the ancestor Span area. Overrides AreaNode method, because this is the SpanRA instance being sought.

Overrides:

ancestorSpanRA in class AreaNode

Returns:

The ancestor SpanRA, or null if there is none.

spanForNextFO

public SpanRA spanForNextFO(org.axsl.fo.fo.prop.SpanPa fo)

Returns a span area that conforms to the requirements of fo, either itself or a newly-created younger sibling span area that does have traits that match fo.

Parameters:

fo - The FObj instance whose span characteristics govern the new SpanRA creation. Note that this method is not responsible to test whether fo is in fact properly ordered, that is, should be placed in this location in the AreaTree.

Returns:

SpanRA The SpanRA instance into which fo should be placed.

canAddLineArea

public boolean canAddLineArea(NormalBlockArea blockArea)

Indicates whether a new line can be added to a given block area.

Parameters:

blockArea - The block area to be tested.

Returns:

True iff there is enough room to add a new line to blockArea.

balanceColumns

public void balanceColumns()
                    throws org.axsl.area.AreaTreeException

Balances the size of the columns.

Throws:

org.axsl.area.AreaTreeException - For errors reparenting areas.

getAreaName

public String getAreaName()

Specified by:

getAreaName in interface org.axsl.area.AreaNode

render

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

Throws:

org.axsl.galley.GalleyVisitorException

crIpd

public int crIpd()

Specified by:

crIpd in interface org.axsl.area.Area

Specified by:

crIpd in class Area

crBpd

public int crBpd()

Specified by:

crBpd in interface org.axsl.area.Area

Specified by:

crBpd in class Area

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<NormalFlowRA> 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.

moveChildBackward

public void moveChildBackward(AreaNode child,
                              NormalFlowRA oldParent,
                              NormalFlowRA newParent)
                       throws org.axsl.area.AreaTreeException

Moves a child from one parent to the last child of another parent.

Parameters:

child - The child to be moved.

oldParent - The existing parent.

newParent - The new parent.

Throws:

org.axsl.area.AreaTreeException - If the new node is not compatible.

moveChildForward

public void moveChildForward(AreaNode child,
                             NormalFlowRA oldParent,
                             NormalFlowRA newParent)
                      throws org.axsl.area.AreaTreeException

Moves a child from one parent to the first child of another parent.

Parameters:

child - The child to be moved.

oldParent - The existing parent.

newParent - The new parent.

Throws:

org.axsl.area.AreaTreeException - If the new node is not compatible.

setProgressionDimension

public void setProgressionDimension(int progressionDimension)

Description copied from class: Area

Sets the progression-dimension used by this Area.

Specified by:

setProgressionDimension in class Area

Parameters:

progressionDimension - The new progression-dimension value for this Area.

incrementProgressionDimension

public void incrementProgressionDimension(int incrementAmount)

Description copied from class: Area

Change the progression-dimension used by this Area.

Specified by:

incrementProgressionDimension in class Area

Parameters:

incrementAmount - The amount by which the progression-dimension should be changed for this area. Positive values increase the progression-dimension, negative values decrease it.

getProgressionDimension

public int getProgressionDimension()

Description copied from class: Area

Returns the actual total value, in millipoints, of the size of this area (not counting space-before, etc.) in its progression direction. This value does not include space-before, etc., but does include borders and padding. For block areas, the progression dimension is the block-progression-dimension. For inline areas, it is the inline-progression-dimension.

Specified by:

getProgressionDimension in class Area

Returns:

The progressionDimension.

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

isAbsolutelyPositioned

public boolean isAbsolutelyPositioned()

Description copied from class: Area

Indicates whether this Area is positioned absolutely or relatively.

Specified by:

isAbsolutelyPositioned in class Area

Returns:

True iff this Area is absolutely positioned.

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.

traitIPDimensionOpt

public int traitIPDimensionOpt()

Description copied from class: AreaFlexible

Return the optimum IP dimension for this area.

Specified by:

traitIPDimensionOpt in class AreaFlexible

Returns:

The optimum IP dimension for this area, or -1 for "auto".