org.foray.area
Class BlockArea

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

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:

LineArea, NormalBlockArea

public abstract class BlockArea
extends AreaFlexible

Superclass for normal block-areas (NormalBlockArea) and line-areas (LineArea).

Nested Class Summary

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

AbstractOrderedTreeNode.PostOrderDescendantIterator

Constructor Summary

protected

BlockArea() Constructor.

Method Summary

int	crIpd()
int	crOriginIPDOffset() The difference, in millipoints, between the page-viewport-area's start-edge and this Area's content-rectangle start-edge.
boolean	isAbsolutelyPositioned() Indicates whether this Area is positioned absolutely or relatively.
org.axsl.fo.fo.Block	traitGeneratedBy()
int	traitHalfLeadingMax() Returns the half-leading maximum trait for this area.
int	traitHalfLeadingMin() Returns the half-leading minimum trait for this area.
int	traitHalfLeadingOpt() Returns the half-leading optimum trait for this area.
org.axsl.common.value.LineStackingStrategy	traitLineStackingStrategy() Returns the line-stacking-strategy trait for this Area.

Methods inherited from class org.foray.area.AreaFlexible

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

Methods inherited from class org.foray.area.Area

brBpd, brIpd, brOriginBPDOffset, brOriginIPDOffset, brOriginX, brOriginY, brPoints, contentStackingAxis, contentStackingAxisAbsolute, contentStackingDirectionAbsolute, crBpd, crOriginX, crOriginY, crPoints, destinationName, generatedByExists, generatedByName, getAreaParent, getBPAxis, getFontWritingMode, getIPAxis, getNearestAncestorAreaContainer, getOverflowArea, getProgressionDimension, getWritingMode, hasFenceFollowing, hasFencePreceding, incrementProgressionDimension, isBlockArea, isFirstChildOfParent, isInNormalFlow, isLastChildOfParent, isLinkRoot, larBPD, larIPD, larOriginX, larOriginY, linkDestination, linkType, narBPD, narIPD, narOriginX, narOriginY, nearestArea, parentAllocationWidth, prBpd, prIpd, prOriginBPDOffset, prOriginIPDOffset, prOriginX, prOriginY, referenceOrientationCumulative, setProgressionDimension, 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, getChildren, 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, 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

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

BlockArea

protected BlockArea()

Constructor.

Method Detail

crIpd

public int crIpd()

Specified by:

crIpd in interface org.axsl.area.Area

Specified by:

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

Overrides:

crOriginIPDOffset in class AreaFlexible

Returns:

The IPD offset of the content rectangle.

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.

traitLineStackingStrategy

public org.axsl.common.value.LineStackingStrategy traitLineStackingStrategy()

Returns the line-stacking-strategy trait for this Area.

Returns:

The line-stacking-strategy trait.

traitGeneratedBy

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

Specified by:

traitGeneratedBy in interface org.axsl.area.AreaNode

Specified by:

traitGeneratedBy in class AreaNode

traitHalfLeadingMin

public int traitHalfLeadingMin()

Returns the half-leading minimum trait for this area.

Returns:

The half-leading minimum trait for this area.

traitHalfLeadingOpt

public int traitHalfLeadingOpt()

Returns the half-leading optimum trait for this area.

Returns:

The half-leading optimum trait for this area.

traitHalfLeadingMax

public int traitHalfLeadingMax()

Returns the half-leading maximum trait for this area.

Returns:

The half-leading maximum trait for this area.