org.foray.area
Class LineArea

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

All Implemented Interfaces:

Iterable<org.axsl.galley.AreaNode>, TreeNode, org.axsl.area.Area, org.axsl.area.AreaNode, org.axsl.area.LineArea, org.axsl.area.LineContentFactory, org.axsl.fo.FoContext, org.axsl.text.line.LineOutput, OrderedTreeNode

public final class LineArea
extends BlockArea
implements org.axsl.galley.LineArea, org.axsl.area.LineArea

Area containing a line of content on the page.

Nested Class Summary

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

AbstractOrderedTreeNode.PostOrderDescendantIterator

Method Summary

protected int	alignmentAdjustment() Computes the amount that the start-edge of the line-area's content-rectangle should be adjusted when rendering.
int	alignmentPointOffset() Provides the number which would, when added to the before-edge of the line-area in the block-progression-dimension, produce the alignment-point for text on this line.
int	alignmentPointY() Computes the y axis of the alignment point for this line.
LineArea	ancestorLineArea() Returns the ancestor LineArea, if any.
int	capacityRemaining()
int	capacityTotal()
int	capacityUsed()
void	cleanup() This method should be called before a LineArea is discarded to clean up dependencies between nodes in the tree.
int	computeInitialPD() Initialize the progression dimension for this Area.
org.axsl.common.value.RelativeAxis	contentStackingAxis() Returns the content stacking axis for this area.
int	crBpd()
String	getAreaName()
List<AbstractInlineArea>	getChildren() Return the List of this node's children.
FOLinkage	getLinkage() Returns the raw "generated by" instance.
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.
NormalBlockArea	getParent()
org.axsl.font.FontUse	getPrimaryFont() Returns the primary font.
int	getProgressionDimension() Returns the actual total value, in millipoints, of the size of this area (not counting space-before, etc.) in its progression direction.
boolean	hasAnyContent()
void	incrementProgressionDimension(int incrementAmount) Change the progression-dimension used by this Area.
void	initializeAnteriorSpace() Computes the initial value of anteriorSpace for this Area.
boolean	isFirstLineAreaInBlock() Indicates whether this is the first line-area generated by the parent block.
boolean	isLastLineAreaInBlock() Indicates whether this is the last line-area generated by the parent block.
void	lineContentChanged() Tell the LineArea that its content has changed, so that it can make any adjustments it thinks are necessary.
int	lineContentLengthUsed() Computes the total IPD used by the children on this line.
BasicLinkArea	makeBasicLinkArea(org.axsl.fo.fo.BasicLink basicLink, org.axsl.fo.fo.GraftingPoint graftingPoint)
BidiOverrideArea	makeBidiOverrideArea(org.axsl.fo.fo.BidiOverride bidiOverride, org.axsl.fo.fo.GraftingPoint graftingPoint)
ExternalGraphicArea	makeExternalGraphicArea(org.axsl.fo.fo.ExternalGraphic ifo, int ipd, org.axsl.fo.fo.GraftingPoint graftingPoint)
ForeignObjectArea	makeForeignObjectArea(org.axsl.fo.fo.InstreamForeignObject ifo, int ipd, org.axsl.fo.fo.GraftingPoint graftingPoint)
TextArea	makeGlyphAreaSequence(org.axsl.fo.fo.CharacterSequence foText, int startOffset, int sizeInChars, int ipd, boolean hasDiscretionaryHyphen, boolean hasFauxSmallCaps, boolean isLastItemOnLine, org.axsl.fo.fo.GraftingPoint graftingPoint)
IndexPageCitationListArea	makeIndexPageCitationListArea(org.axsl.fo.fo.IndexPageCitationList indexPcl, org.axsl.fo.fo.GraftingPoint graftingPoint)
InlineArea	makeInlineArea(org.axsl.fo.fo.Inline inline, org.axsl.fo.fo.GraftingPoint graftingPoint)
InlineContainerArea	makeInlineContainerArea(org.axsl.fo.fo.InlineContainer inlineContainer, org.axsl.fo.fo.GraftingPoint graftingPoint)
LeaderArea	makeLeaderArea(org.axsl.fo.fo.Leader leader, int ipd, org.axsl.fo.fo.GraftingPoint graftingPoint)
PageNumberArea	makePageNumberArea(org.axsl.fo.fo.PageNumber pageNumber, int ipd, org.axsl.fo.fo.GraftingPoint graftingPoint)
PageNumberCitationArea	makePageNumberCitationArea(org.axsl.fo.fo.PageNumberCitation citation, int ipd, org.axsl.fo.fo.GraftingPoint graftingPoint)
PageNumberCitationLastArea	makePageNumberCitationLastArea(org.axsl.fo.fo.PageNumberCitationLast citation, int ipd, org.axsl.fo.fo.GraftingPoint graftingPoint)
ScalingValueCitationArea	makeScalingValueCitationArea(org.axsl.fo.fo.ScalingValueCitation citation, int ipd, org.axsl.fo.fo.GraftingPoint graftingPoint)
int	offsetFromStart() Returns the offset from the start of this area at which the line content should actually be rendered.
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.
int	pdAvailable() LineArea uses this method uniquely.
void	render(org.axsl.galley.RenderVisitor visitor)
protected void	resetChildren() Removes the references to the child nodes from this Area.
void	setParent(AreaNode node) Sets the parent node.
void	setProgressionDimension(int progressionDimension) Sets the progression-dimension used by this Area.
int	startAlignmentAdjustment() Computes the adjustment to the starting offset that results from alignment.
boolean	textAlignLastApplies() Tests for the specialized case of a line qualifying for text-align-last to apply to it.
int	totalAlignmentAdjustment() Computes the difference between the space available on the line and the amount of space actually used.
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	traitEndIndent() Returns the end-indent trait.
int	traitFontSize() Returns the font-size trait.
org.axsl.fo.fo.Block	traitGeneratedBy()
int	traitIPDimensionOpt() Return the optimum IP dimension for this area.
int	traitLastLineEndIndent() Returns the last-line end-indent value for this line.
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.
org.axsl.common.value.Conditionality	traitSpaceAfterConditionality() Returns the space-after conditionality for this area.
int	traitSpaceAfterMaximum() Returns the space-after maximum trait for this area.
int	traitSpaceAfterMinumum() Returns the space-after minimum trait for this area.
int	traitSpaceAfterOptimum() Returns the space-after optimum trait for this area.
int	traitSpaceAfterPrecedence() Returns the space-after precedence for this area.
org.axsl.common.value.Conditionality	traitSpaceBeforeConditionality() Returns the space-before conditionality for this area.
int	traitSpaceBeforeMaximum() Returns the space-before maximum trait for this area.
int	traitSpaceBeforeMinimum() Returns the space-before minimum trait for this area.
int	traitSpaceBeforeOptimum() Returns the space-before optimum trait for this area.
int	traitSpaceBeforePrecedence() Returns the space-before precedence 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.
org.axsl.common.value.TextAlign	traitTextAlign() Returns the effective text alignment value for this line.
int	traitTextIndent() Returns the text-indent value for this line.
org.axsl.common.value.WhiteSpaceTreatment	traitWhiteSpaceTreatment() Returns the whitespace-treatment trait for this area.
void	verticalAlign() Balance (vertically) the inline areas within this line.

Methods inherited from class org.foray.area.BlockArea

crIpd, crOriginIPDOffset, isAbsolutelyPositioned, traitHalfLeadingMax, traitHalfLeadingMin, traitHalfLeadingOpt, traitLineStackingStrategy

Methods inherited from class org.foray.area.AreaFlexible

crIPDBlockArea, crOriginBPDOffset, getAnteriorSpace, incrementAnteriorSpace, incrementParentPD, 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

Methods inherited from class org.foray.area.AreaNode

ancestorArea, ancestorBlockAreaNotALineArea, ancestorBlockContentFactory, ancestorBlockOrRa, ancestorGeneratedByBlockLevelFO, 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.Area

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

Methods inherited from interface org.axsl.galley.AreaNode

getChildAt, getGalley

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.axsl.area.Area

crIpd

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, getChildCount, getIndex, isLeaf

Methods inherited from interface org.axsl.fo.FoContext

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

Method Detail

alignmentAdjustment

protected int alignmentAdjustment()

Computes the amount that the start-edge of the line-area's content-rectangle should be adjusted when rendering.

Returns:

The alignment adjustment, in millipoints.

optimize

public 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. 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(). Resolves and optimizes the line. Specifically, this method resolves any page-number citations, and then adjusts leaders, letter-spacing, and word-spacing to justify the line if that is neeeded.

Specified by:

optimize in class AreaNode

Returns:

True iff the Area node thinks it should be removed.

verticalAlign

public void verticalAlign()

Balance (vertically) the inline areas within this line.

isFirstLineAreaInBlock

public boolean isFirstLineAreaInBlock()

Indicates whether this is the first line-area generated by the parent block.

Returns:

True iff this is the first LineArea instance generated by the parent Block.

isLastLineAreaInBlock

public boolean isLastLineAreaInBlock()

Indicates whether this is the last line-area generated by the parent block.

Returns:

True iff this is the last LineArea instance generated by the parent Block.

textAlignLastApplies

public boolean textAlignLastApplies()

Tests for the specialized case of a line qualifying for text-align-last to apply to it. The requirements are outlined in XSL-FO Recommendation 1.1, Section 7.16.10: "Specifies the alignment of the last line-area child of the last block-area generated and returned by the formatting object, and to any line-area generated by the formatting object whose following sibling is a block-area that is not a line-area, and any lines in the block ending in U+000A."

Returns:

True iff the text-align-last trait should be used as the alignment for this LineArea.

offsetFromStart

public int offsetFromStart()

Returns the offset from the start of this area at which the line content should actually be rendered.

Returns:

The offset, in millipoints.

totalAlignmentAdjustment

public int totalAlignmentAdjustment()

Computes the difference between the space available on the line and the amount of space actually used. This amount is used in alignment computations.

Returns:

The amount of unused space on the line.

startAlignmentAdjustment

public int startAlignmentAdjustment()

Computes the adjustment to the starting offset that results from alignment.

Returns:

Additional offset from the start edge of the content rectangle that results from aligning the line.

contentStackingAxis

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

Returns the content stacking axis for this area. Overrides superclass method because LineArea contents stack in the IPD.

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.

pdAvailable

public int pdAvailable()

LineArea uses this method uniquely. It never really cares about how much of its own progression dimension is available: BlockArea manages that. (Don't forget that LineArea is a block-area.) What LineArea needs to report here is its own content rectangle IPD less the amount used by its children.

Specified by:

pdAvailable in interface org.axsl.area.Area

Overrides:

pdAvailable in class AreaFlexible

lineContentLengthUsed

public int lineContentLengthUsed()

Computes the total IPD used by the children on this line.

Returns:

The total IPD, in millipoints, of the children on this line.

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.

alignmentPointOffset

public int alignmentPointOffset()

Provides the number which would, when added to the before-edge of the line-area in the block-progression-dimension, produce the alignment-point for text on this line. We believe the alignment point, which is defined in XSL-FO Standard 1.0, Section 7.8.1, to be the same point which is described in the PDF Reference, Second Edition, Section 5.1.3, as the "glyph origin". Renderers should rely on this behavior.

Returns:

The distance, in millipoints, between the before-edge of this line-area and a line parallel to it that runs through the alignment-point.

alignmentPointY

public int alignmentPointY()

Computes the y axis of the alignment point for this line.

Returns:

The y axis of the alignment point for this line.

traitBorderBeforeWidth

public int traitBorderBeforeWidth()

Returns the border-before-width trait for this area. Overrides Area because line-areas have no borders or padding. See XSL-FO Standard 1.0, Section 4.5.

Specified by:

traitBorderBeforeWidth in class Area

Returns:

The border-before-width trait for this area.

traitBorderAfterWidth

public int traitBorderAfterWidth()

Returns the border-after-width trait for this area. Overrides Area because line-areas have no borders or padding. See XSL-FO Standard 1.0, Section 4.5.

Specified by:

traitBorderAfterWidth in class Area

Returns:

The border-after-width trait for this area.

traitBorderStartWidth

public int traitBorderStartWidth()

Returns the border-start-width trait for this area. Overrides Area because line-areas have no borders or padding. See XSL-FO Standard 1.0, Section 4.5.

Specified by:

traitBorderStartWidth in class Area

Returns:

The border-start-width trait for this area.

traitBorderEndWidth

public int traitBorderEndWidth()

Returns the border-end-width trait for this area. Overrides Area because line-areas have no borders or padding. See XSL-FO Standard 1.0, Section 4.5.

Specified by:

traitBorderEndWidth in class Area

Returns:

The border-end-width trait for this area.

traitPaddingBefore

public int traitPaddingBefore()

Returns the padding-before trait for this area. Overrides Area because line-areas have no borders or padding. See XSL-FO Standard 1.0, Section 4.5.

Specified by:

traitPaddingBefore in class Area

Returns:

The padding-before trait for this area.

traitPaddingAfter

public int traitPaddingAfter()

Returns the padding-after trait for this area. Overrides Area because line-areas have no borders or padding. See XSL-FO Standard 1.0, Section 4.5.

Specified by:

traitPaddingAfter in class Area

Returns:

The padding-after trait for this area.

traitPaddingStart

public int traitPaddingStart()

Returns the padding-start trait for this area. Overrides Area because line-areas have no borders or padding. See XSL-FO Standard 1.0, Section 4.5.

Specified by:

traitPaddingStart in class Area

Returns:

The padding-start trait for this area.

traitPaddingEnd

public int traitPaddingEnd()

Returns the padding-end trait for this area. Overrides Area because line-areas have no borders or padding. See XSL-FO Standard 1.0, Section 4.5.

Specified by:

traitPaddingEnd in class Area

Returns:

The padding-end trait for this area.

cleanup

public void cleanup()

This method should be called before a LineArea is discarded to clean up dependencies between nodes in the tree.

traitTextAlign

public org.axsl.common.value.TextAlign traitTextAlign()

Returns the effective text alignment value for this line. This method uses either the text-align or text-align-last properties, as appropriate. It also resolves the values of TextAlign.INSIDE and TextAlign.OUTSIDE, converting them, as appropriate, to the one of the cardinal values (START, END, CENTER, JUSTIFY).

Returns:

One of the following TraitEnumeration constants: START, END, CENTER, JUSTIFY.

traitTextIndent

public int traitTextIndent()

Returns the text-indent value for this line.

Returns:

The text-indent value for this line.

traitLastLineEndIndent

public int traitLastLineEndIndent()

Returns the last-line end-indent value for this line.

Returns:

The last-line end-indent value for this line.

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.

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.

ancestorLineArea

public LineArea ancestorLineArea()

Returns the ancestor LineArea, if any. Overrides the AreaNode method, because this is the LineArea being sought.

Overrides:

ancestorLineArea in class AreaNode

Returns:

The ancestor LineArea, or null if there is none.

capacityTotal

public int capacityTotal()

Specified by:

capacityTotal in interface org.axsl.text.line.LineOutput

capacityUsed

public int capacityUsed()

Specified by:

capacityUsed in interface org.axsl.text.line.LineOutput

capacityRemaining

public int capacityRemaining()

Specified by:

capacityRemaining in interface org.axsl.text.line.LineOutput

hasAnyContent

public boolean hasAnyContent()

Specified by:

hasAnyContent in interface org.axsl.text.line.LineOutput

makeBidiOverrideArea

public BidiOverrideArea makeBidiOverrideArea(org.axsl.fo.fo.BidiOverride bidiOverride,
                                             org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeBidiOverrideArea in interface org.axsl.area.LineContentFactory

makeGlyphAreaSequence

public TextArea makeGlyphAreaSequence(org.axsl.fo.fo.CharacterSequence foText,
                                      int startOffset,
                                      int sizeInChars,
                                      int ipd,
                                      boolean hasDiscretionaryHyphen,
                                      boolean hasFauxSmallCaps,
                                      boolean isLastItemOnLine,
                                      org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeGlyphAreaSequence in interface org.axsl.area.LineContentFactory

makeExternalGraphicArea

public ExternalGraphicArea makeExternalGraphicArea(org.axsl.fo.fo.ExternalGraphic ifo,
                                                   int ipd,
                                                   org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeExternalGraphicArea in interface org.axsl.area.LineContentFactory

makeForeignObjectArea

public ForeignObjectArea makeForeignObjectArea(org.axsl.fo.fo.InstreamForeignObject ifo,
                                               int ipd,
                                               org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeForeignObjectArea in interface org.axsl.area.LineContentFactory

makeInlineArea

public InlineArea makeInlineArea(org.axsl.fo.fo.Inline inline,
                                 org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeInlineArea in interface org.axsl.area.LineContentFactory

makeInlineContainerArea

public InlineContainerArea makeInlineContainerArea(org.axsl.fo.fo.InlineContainer inlineContainer,
                                                   org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeInlineContainerArea in interface org.axsl.area.LineContentFactory

makeLeaderArea

public LeaderArea makeLeaderArea(org.axsl.fo.fo.Leader leader,
                                 int ipd,
                                 org.axsl.fo.fo.GraftingPoint graftingPoint)
                          throws org.axsl.area.AreaTreeException

Specified by:

makeLeaderArea in interface org.axsl.area.LineContentFactory

Throws:

org.axsl.area.AreaTreeException

makePageNumberArea

public PageNumberArea makePageNumberArea(org.axsl.fo.fo.PageNumber pageNumber,
                                         int ipd,
                                         org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makePageNumberArea in interface org.axsl.area.LineContentFactory

makePageNumberCitationArea

public PageNumberCitationArea makePageNumberCitationArea(org.axsl.fo.fo.PageNumberCitation citation,
                                                         int ipd,
                                                         org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makePageNumberCitationArea in interface org.axsl.area.LineContentFactory

makePageNumberCitationLastArea

public PageNumberCitationLastArea makePageNumberCitationLastArea(org.axsl.fo.fo.PageNumberCitationLast citation,
                                                                 int ipd,
                                                                 org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makePageNumberCitationLastArea in interface org.axsl.area.LineContentFactory

makeScalingValueCitationArea

public ScalingValueCitationArea makeScalingValueCitationArea(org.axsl.fo.fo.ScalingValueCitation citation,
                                                             int ipd,
                                                             org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeScalingValueCitationArea in interface org.axsl.area.LineContentFactory

makeBasicLinkArea

public BasicLinkArea makeBasicLinkArea(org.axsl.fo.fo.BasicLink basicLink,
                                       org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeBasicLinkArea in interface org.axsl.area.LineContentFactory

makeIndexPageCitationListArea

public IndexPageCitationListArea makeIndexPageCitationListArea(org.axsl.fo.fo.IndexPageCitationList indexPcl,
                                                               org.axsl.fo.fo.GraftingPoint graftingPoint)

Specified by:

makeIndexPageCitationListArea in interface org.axsl.area.LineContentFactory

traitSpaceBeforeMinimum

public int traitSpaceBeforeMinimum()

Returns the space-before minimum trait for this area.

Returns:

The space-before minimum 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.

traitSpaceBeforeMaximum

public int traitSpaceBeforeMaximum()

Returns the space-before maximum trait for this area.

Returns:

The space-before maximum trait for this area.

traitSpaceBeforeConditionality

public org.axsl.common.value.Conditionality traitSpaceBeforeConditionality()

Returns the space-before conditionality for this area.

Returns:

The space-before conditionality for this area.

traitSpaceBeforePrecedence

public int traitSpaceBeforePrecedence()

Returns the space-before precedence for this area.

Returns:

The space-before precedence for this area.

traitSpaceAfterMinumum

public int traitSpaceAfterMinumum()

Returns the space-after minimum trait for this area.

Returns:

The space-after minimum 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.

traitSpaceAfterMaximum

public int traitSpaceAfterMaximum()

Returns the space-after maximum trait for this area.

Returns:

The space-after maximum trait for this area.

traitSpaceAfterConditionality

public org.axsl.common.value.Conditionality traitSpaceAfterConditionality()

Returns the space-after conditionality for this area.

Returns:

The space-after conditionality for this area.

traitSpaceAfterPrecedence

public int traitSpaceAfterPrecedence()

Returns the space-after precedence for this area.

Returns:

The space-after precedence for this area.

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

lineContentChanged

public void lineContentChanged()

Tell the LineArea that its content has changed, so that it can make any adjustments it thinks are necessary.

crBpd

public int crBpd()

Specified by:

crBpd in interface org.axsl.area.Area

Specified by:

crBpd in class Area

getParent

public NormalBlockArea 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<AbstractInlineArea> 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.

resetChildren

protected void resetChildren()

Removes the references to the child nodes from this Area.

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.

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.Block traitGeneratedBy()

Specified by:

traitGeneratedBy in interface org.axsl.area.AreaNode

Overrides:

traitGeneratedBy in class BlockArea

computeInitialPD

public int computeInitialPD()

Description copied from class: AreaFlexible

Initialize the progression dimension for this Area.

Overrides:

computeInitialPD in class AreaFlexible

Returns:

The initial progression dimension for this Area.

initializeAnteriorSpace

public void initializeAnteriorSpace()

Description copied from class: AreaFlexible

Computes the initial value of anteriorSpace for this Area.

Overrides:

initializeAnteriorSpace in class AreaFlexible

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

traitWhiteSpaceTreatment

public org.axsl.common.value.WhiteSpaceTreatment traitWhiteSpaceTreatment()

Returns the whitespace-treatment trait for this area.

Overrides:

traitWhiteSpaceTreatment in class Area

Returns:

The whitespace-treatment trait for this area.

traitFontSize

public int traitFontSize()

Returns the font-size trait.

Returns:

The font-size trait.

getPrimaryFont

public org.axsl.font.FontUse getPrimaryFont()

Returns the primary font.

Returns:

The primary font.