org.foray.area
Class AreaFixed

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BeforeFloatRA, FootnoteRA, MainRA, PageRA, RegionRA, RegionRABody

public abstract class AreaFixed
extends Area

Subclasses are block-areas that do not need to store their own size or spacing information. This includes the page itself, regions, before-float RAs, footnote RAs, and the main RA. The opposite of AreaFixed is AreaFlexible.

Nested Class Summary

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

AbstractOrderedTreeNode.PostOrderDescendantIterator

Constructor Summary

protected

AreaFixed() Constructor.

Method Summary

abstract List<AreaNode>	getChildren() Return the List of this node's children.
int	getProgressionDimension() Returns the actual total value, in millipoints, of the size of this area (not counting space-before, etc.) in its progression direction.
void	incrementProgressionDimension(int incrementAmount) Change the progression-dimension used by this Area.
boolean	isAbsolutelyPositioned() Indicates whether this Area is positioned absolutely or relatively.
int	pdAvailable()
int	pdUsedBySiblings() Returns the total amount of the progression-dimension that has been used by siblings.
void	setMinimumProgressionDimension(int minPD) Set the minimum progression dimension for this Area.
void	setProgressionDimension(int progressionDimension) Sets the progression-dimension used by this Area.

Methods inherited from class org.foray.area.Area

brBpd, brIpd, brOriginBPDOffset, brOriginIPDOffset, brOriginX, brOriginY, brPoints, contentStackingAxis, contentStackingAxisAbsolute, contentStackingDirectionAbsolute, crBpd, crIpd, crOriginBPDOffset, crOriginIPDOffset, crOriginX, crOriginY, crPoints, destinationName, generatedByExists, generatedByName, getAreaParent, getBPAxis, getFontWritingMode, getIPAxis, getNearestAncestorAreaContainer, getOverflowArea, 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, traitBorderAfterWidth, traitBorderBeforeWidth, traitBorderEndWidth, traitBorderStartWidth, traitEndIndent, traitId, traitIsFirst, traitIsLast, traitIsReferenceArea, traitPaddingAfter, traitPaddingBefore, traitPaddingEnd, traitPaddingStart, traitSpaceAfterOptimum, traitSpaceBeforeOptimum, traitSpaceEndOptimum, traitSpaceStartOptimum, traitStartIndent, 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, getLinkage, getLogger, getNextChildOfGeneratedBy, getNextSiblingArea, getNormalLinkage, getNormalLinkage, getOrderedParent, getPage, getParent, getPreviousChildOfGeneratedBy, getPreviousSiblingArea, getSiblings, hasUnresolvedRefId, heightContainingBlock, ipdAncestorBlockArea, ipdAncestorBlockOrRa, ipdContainingRefArea, ipdParentArea, isFirst, isFirstChildOfGeneratedBy, isGeneratedByBlockLevelFo, isLast, isLastChildOfGeneratedBy, iterator, linkage, nearestBeforeFloatArea, nearestFootnoteArea, nearestGeneratedByBlockLevelFo, nearestNormalBlockArea, nearestTableArea, optimize, optimizeChildren, registerWithLinkage, remove, removeChild, setParent, 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.galley.AreaNode

getAreaName, getChildAt, getGalley, render

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.axsl.area.AreaNode

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface org.axsl.fo.FoContext

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

Constructor Detail

AreaFixed

protected AreaFixed()

Constructor.

Method Detail

pdAvailable

public int pdAvailable()

Specified by:

pdAvailable in interface org.axsl.area.Area

Specified by:

pdAvailable in class Area

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.

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.

setMinimumProgressionDimension

public void setMinimumProgressionDimension(int minPD)

Description copied from class: Area

Set the minimum progression dimension for this Area. If the current progression dimension value is less than this value, it will be increased to this minimum. Otherwise, it is ignored.

Specified by:

setMinimumProgressionDimension in class Area

Parameters:

minPD - The minimum progression dimension to set.

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.

pdUsedBySiblings

public int pdUsedBySiblings()

Description copied from class: Area

Returns the total amount of the progression-dimension that has been used by siblings.

Specified by:

pdUsedBySiblings in class Area

Returns:

The total amount of the progression-dimension that has been used by siblings.

getChildren

public abstract List<AreaNode> 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.

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.