org.foray.fotree.fo.obj
Class PageSequence

java.lang.Object
  org.foray.common.AbstractOrderedTreeNode
      org.foray.fotree.FObj
          org.foray.fotree.fo.obj.PageSequence

All Implemented Interfaces:

Iterable<org.axsl.fo.Fo>, TreeNode, org.axsl.fo.Fo, org.axsl.fo.fo.PageSequence, org.axsl.fo.fo.proforma.CommonFontExcludedPa, org.axsl.fo.fo.proforma.LinefeedTreatmentPa, org.axsl.fo.fo.proforma.WhiteSpaceCollapsePa, org.axsl.fo.fo.prop.ActiveStatePa, org.axsl.fo.fo.prop.AlignmentAdjustPa, org.axsl.fo.fo.prop.AlignmentBaselinePa, org.axsl.fo.fo.prop.AllowedHeightScalePa, org.axsl.fo.fo.prop.AllowedWidthScalePa, org.axsl.fo.fo.prop.AutoRestorePa, org.axsl.fo.fo.prop.BaselineShiftPa, org.axsl.fo.fo.prop.BlockProgressionDimensionPa, org.axsl.fo.fo.prop.BorderAfterPrecedencePa, org.axsl.fo.fo.prop.BorderBeforePrecedencePa, org.axsl.fo.fo.prop.BorderCollapsePa, org.axsl.fo.fo.prop.BorderEndPrecedencePa, org.axsl.fo.fo.prop.BorderSeparationPa, org.axsl.fo.fo.prop.BorderStartPrecedencePa, org.axsl.fo.fo.prop.BreakAfterPa, org.axsl.fo.fo.prop.BreakBeforePa, org.axsl.fo.fo.prop.CaptionSidePa, org.axsl.fo.fo.prop.CaseNamePa, org.axsl.fo.fo.prop.CaseTitlePa, org.axsl.fo.fo.prop.ChangeBarClassPa, org.axsl.fo.fo.prop.ChangeBarColorPa, org.axsl.fo.fo.prop.ChangeBarOffsetPa, org.axsl.fo.fo.prop.ChangeBarPlacementPa, org.axsl.fo.fo.prop.ChangeBarStylePa, org.axsl.fo.fo.prop.ChangeBarWidthPa, org.axsl.fo.fo.prop.ClearPa, org.axsl.fo.fo.prop.ClipPa, org.axsl.fo.fo.prop.ColorPa, org.axsl.fo.fo.prop.ColorProfileNamePa, org.axsl.fo.fo.prop.ColumnCountPa, org.axsl.fo.fo.prop.ColumnGapPa, org.axsl.fo.fo.prop.CommonAbsolutePositionPa, org.axsl.fo.fo.prop.CommonAccessibilityPa, org.axsl.fo.fo.prop.CommonAuralPa, org.axsl.fo.fo.prop.CommonBorderPaddingBgPa, org.axsl.fo.fo.prop.CommonFontPa, org.axsl.fo.fo.prop.CommonHyphenationPa, org.axsl.fo.fo.prop.CommonMarginBlockPa, org.axsl.fo.fo.prop.CommonMarginInlineOptimumPa, org.axsl.fo.fo.prop.CommonMarginInlinePa, org.axsl.fo.fo.prop.CommonPositionPa, org.axsl.fo.fo.prop.CommonRelativePositionPa, org.axsl.fo.fo.prop.ContentTypePa, org.axsl.fo.fo.prop.DestinationPa, org.axsl.fo.fo.prop.DestinationPlacementOffsetPa, org.axsl.fo.fo.prop.DirectionPa, org.axsl.fo.fo.prop.DisplayAlignPa, org.axsl.fo.fo.prop.DominantBaselinePa, org.axsl.fo.fo.prop.EmptyCellsPa, org.axsl.fo.fo.prop.ExtentPa, org.axsl.fo.fo.prop.FloatPa, org.axsl.fo.fo.prop.FlowNamePa, org.axsl.fo.fo.prop.FontStylePa, org.axsl.fo.fo.prop.FontWeightPa, org.axsl.fo.fo.prop.ForcePageCountPa, org.axsl.fo.fo.prop.FormatPa, org.axsl.fo.fo.prop.GlyphOrientationHorizontalPa, org.axsl.fo.fo.prop.GlyphOrientationVerticalPa, org.axsl.fo.fo.prop.HyphenationKeepPa, org.axsl.fo.fo.prop.HyphenationLadderCountPa, org.axsl.fo.fo.prop.IdPa, org.axsl.fo.fo.prop.IndexClassPa, org.axsl.fo.fo.prop.IndexKeyPa, org.axsl.fo.fo.prop.IndicateDestinationPa, org.axsl.fo.fo.prop.InitialPageNumberPa, org.axsl.fo.fo.prop.InlineProgressionDimensionPa, org.axsl.fo.fo.prop.IntrusionDisplacePa, org.axsl.fo.fo.prop.KeepTogetherPa, org.axsl.fo.fo.prop.KeepWithNextPa, org.axsl.fo.fo.prop.KeepWithPreviousPa, org.axsl.fo.fo.prop.LastLineEndIndentPa, org.axsl.fo.fo.prop.LeaderAlignmentPa, org.axsl.fo.fo.prop.LeaderLengthPa, org.axsl.fo.fo.prop.LeaderPatternPa, org.axsl.fo.fo.prop.LeaderPatternWidthPa, org.axsl.fo.fo.prop.LetterSpacingPa, org.axsl.fo.fo.prop.LineHeightPa, org.axsl.fo.fo.prop.LineHeightShiftAdjustmentPa, org.axsl.fo.fo.prop.LineStackingStrategyPa, org.axsl.fo.fo.prop.MediaUsagePa, org.axsl.fo.fo.prop.MergePagesAcrossIndexKeyReferencesPa, org.axsl.fo.fo.prop.MergeRangesAcrossIndexKeyReferencesPa, org.axsl.fo.fo.prop.MergeSequentialPageNumbersPa, org.axsl.fo.fo.prop.NumberColumnsRepeatedPa, org.axsl.fo.fo.prop.OrphansPa, org.axsl.fo.fo.prop.OverflowPa, org.axsl.fo.fo.prop.PageCitationStrategyPa, org.axsl.fo.fo.prop.PageHeightPa, org.axsl.fo.fo.prop.PageNumberTreatmentPa, org.axsl.fo.fo.prop.PageWidthPa, org.axsl.fo.fo.prop.ProvisionalDistanceBetweenStartsPa, org.axsl.fo.fo.prop.ProvisionalLabelSeparationPa, org.axsl.fo.fo.prop.ReferenceOrientationPa, org.axsl.fo.fo.prop.RefIdPa, org.axsl.fo.fo.prop.RefIndexKeyPa, org.axsl.fo.fo.prop.RelativeAlignPa, org.axsl.fo.fo.prop.RenderingIntentPa, org.axsl.fo.fo.prop.RetrieveBoundaryWithinTablePa, org.axsl.fo.fo.prop.RetrievePositionWithinTablePa, org.axsl.fo.fo.prop.RuleStylePa, org.axsl.fo.fo.prop.RuleThicknessPa, org.axsl.fo.fo.prop.ScalingMethodPa, org.axsl.fo.fo.prop.ScoreSpacesPa, org.axsl.fo.fo.prop.ShowDestinationPa, org.axsl.fo.fo.prop.SpanPa, org.axsl.fo.fo.prop.SrcPa, org.axsl.fo.fo.prop.StartingStatePa, org.axsl.fo.fo.prop.SuppressAtLineBreakPa, org.axsl.fo.fo.prop.SwitchToPa, org.axsl.fo.fo.prop.TableLayoutPa, org.axsl.fo.fo.prop.TableOmitFooterAtBreakPa, org.axsl.fo.fo.prop.TableOmitHeaderAtBreakPa, org.axsl.fo.fo.prop.TargetPresentationContextPa, org.axsl.fo.fo.prop.TargetProcessingContextPa, org.axsl.fo.fo.prop.TargetStylesheetPa, org.axsl.fo.fo.prop.TextAlignLastPa, org.axsl.fo.fo.prop.TextAlignPa, org.axsl.fo.fo.prop.TextAltitudePa, org.axsl.fo.fo.prop.TextDecorationPa, org.axsl.fo.fo.prop.TextDepthPa, org.axsl.fo.fo.prop.TextIndentPa, org.axsl.fo.fo.prop.TextShadowPa, org.axsl.fo.fo.prop.TextTransformPa, org.axsl.fo.fo.prop.TreatAsWordSpacePa, org.axsl.fo.fo.prop.UnicodeBidiPa, org.axsl.fo.fo.prop.VisibilityPa, org.axsl.fo.fo.prop.WhiteSpaceTreatmentPa, org.axsl.fo.fo.prop.WidowsPa, org.axsl.fo.fo.prop.WordSpacingPa, org.axsl.fo.fo.prop.WrapOptionPa, org.axsl.fo.fo.prop.WritingModePa, org.axsl.fo.fo.prop.ZIndexPa, OrderedTreeNode

public class PageSequence
extends FObj
implements org.axsl.fo.fo.PageSequence

A "page-sequence" object in XSL-FO.

Nested Class Summary

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

AbstractOrderedTreeNode.PostOrderDescendantIterator

Field Summary

Fields inherited from class org.foray.fotree.FObj

EMPTY_CHILD_LIST, PAGE_CITATION_TEXT_SEGMENT

Fields inherited from interface org.axsl.fo.Fo

DIMENSION_AUTO

Fields inherited from interface org.axsl.fo.fo.prop.CommonPositionPa

ABSOLUTE_POSITION_AUTO

Constructor Summary

PageSequence(Root parent, PropertyList propertyList)
Constructor.

Method Summary

Object	acceptProxyFactory(org.axsl.fo.ProxyFactory factory)
void	addChild(FObj child) Add a child to this object.
void	addFlow(org.axsl.fo.fo.Flow flow) Register a descendant flow.
void	addStaticContent(StaticContent staticContent) Register a descendant static-content.
BasicLink	ancestorBasicLink(org.axsl.fo.FoContext context) Override the FONode method, because there will be no BasicLink objects above this one.
void	end() This method is a hook into the parsing process, primarily to allow the subclass to do some validation or setup work after the object and all of its properties have been parsed and all of its children processed.
protected boolean	flowValid(AbstractFlow flow) Indicates whether a given flow can be laid out on at least one page in this page-sequence.
String	formatPageNumber(int pageNumber)
org.axsl.fo.fo.StaticContent	getBeforeFloatSeparator()
FObj	getChildAt(int index)
List<FObj>	getChildren() Return the List of this node's children.
FlowMap	getFlowMap() Returns the flow-map associated with this page-sequence.
List<org.axsl.fo.fo.Flow>	getFlows()
FolioPrefix	getFolioPrefix()
FolioSuffix	getFolioSuffix()
org.axsl.fo.fo.StaticContent	getFootnoteSeparator()
LayoutMasterSet	getLayoutMasterSet() Convenience method returning the layout-master-set for this document.
String	getName()
Namespace	getNamespace() Gets the Namespace instance that is associated with this object.
org.axsl.common.PositiveIntegerFormatter	getPageNumberFormatter()
PageSequenceTemplate	getPageSequenceTemplate() Returns the page sequence template for this page sequence.
Root	getParent()
org.axsl.font.FontUse	getPrimaryFont(org.axsl.fo.FoContext context)
PropertyList	getPropertyList() Returns the property list for this FObj.
Root	getRoot() Override the default method, because this object knows how to find the Root directly.
StaticContent	getStaticContent(org.axsl.fo.fo.Region region)
StaticContent	getStaticContent(String regionName) Returns the static-content for a specified region.
Title	getTitle()
boolean	isContentBlock() Reports whether the object fits the %block parameter entity described in XSL-FO Std 1.0, Section 6.2.
boolean	isContentInline() Reports whether the object fits the %inline parameter entity described in XSL-FO Std 1.0, Section 6.2.
boolean	isContentPcdata() Reports whether the object fits the #PCDATA content type in XSL-FO Std 1.0, Section 6.2.
protected boolean	isInFlowMap(AbstractFlow flow) Indicates whether a given flow is found in one of the flow-source-list instances in this page-sequence's flow-map.
boolean	isValid()
PageMasterResolver	makePageMasterResolver(int lastPageNumber)
void	setup() A hook into the parsing process which allows the subclass instance to do some initialization-type work after all of the properties have been parsed, but before any of the children have been parsed.
protected void	validateAncestry() A hook into the parsing process which allows the subclass instance to validate its ancestry.
protected void	validateDescendants() A hook into the parsing process which allows the subclass instance to validate its descendants.
protected void	validateProperties() A hook into the parsing process which allows the subclass instance to validate its properties.

Methods inherited from class org.foray.fotree.FObj

addCharacters, addChildToEmptyContentModel, ancestorFlow, ancestorGeneratingRA, ancestorListRelatedObject, ancestorMarker, ancestorProperty, ancestorStaticContent, ancestorTable, checkExceptionLocation, computeAutoBaseline, containsText, effectiveParent, firstLineText, firstTextSegment, getAllowsChildren, getAutoScript, getBaselineFromScript, getColumn, getContainingBlock, getContentHeight, getContentWidth, getContextMessage, getContextMessage, getCookedExternalDestination, getDescendantIterator, getDescendantText, getDestination, getFauxSmallCapFontSize, getFlowMapName, getFlowMapReference, getFlowNameReference, getFontConsumer, getFoTree, getFullName, getGraphicServer, getHyphenationConsumer, getLine, getLinkType, getLogger, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMessageWithContext, getNearestAncestorListBlock, getNearestLeader, getNearestListItem, getNextContiguousTextInBlock, getOrderedParent, getParsedParent, getPreviousContiguousTextInBlock, getRegionNameReference, getSecondaryFont, getSequentialIndex, getSiblings, getSpeechServer, getSystemId, getTextServer, getVoice, initialPageNumberSetExplicitly, invalidPageReference, isBlockLevelFo, isContentHeightDependentOnPd, isContentWidthDependentOnPd, iterator, logWarning, nearestGeneratingRA, qtyMarkerChildren, relativeAlignApplies, resolvePrimaryFont, scalingUniform, setLocation, throwException, throwException, throwExceptionContentModelViolation, throwExceptionInvalidLocation, traitAbsolutePosition, traitActiveState, traitAlignmentAdjust, traitAlignmentBaseline, traitAllowedHeightScale, traitAllowedHeightScale, traitAllowedWidthScale, traitAllowedWidthScale, traitAutoRestore, traitAzimuth, traitBackgroundAttachment, traitBackgroundColor, traitBackgroundImage, traitBackgroundPositionHorizontal, traitBackgroundPositionVertical, traitBackgroundRepeat, traitBaselineShift, traitBlankOrNotBlank, traitBlink, traitBorderAfterColor, traitBorderAfterPrecedence, traitBorderAfterStyle, traitBorderAfterWidth, traitBorderBeforeColor, traitBorderBeforePrecedence, traitBorderBeforeStyle, traitBorderBeforeWidth, traitBorderCollapse, traitBorderEndColor, traitBorderEndPrecedence, traitBorderEndStyle, traitBorderEndWidth, traitBorderSeparationBpd, traitBorderSeparationIpd, traitBorderStartColor, traitBorderStartPrecedence, traitBorderStartStyle, traitBorderStartWidth, traitBottom, traitBpDimensionMax, traitBpDimensionMin, traitBpDimensionOpt, traitBreakAfter, traitBreakBefore, traitCaptionSide, traitCaseName, traitCaseTitle, traitChangeBarClass, traitChangeBarColor, traitChangeBarOffset, traitChangeBarPlacement, traitChangeBarStyle, traitChangeBarWidth, traitCharacter, traitClear, traitClip, traitClipIsAuto, traitColor, traitColorProfileName, traitColumnCount, traitColumnGap, traitColumnNumber, traitContentType, traitCountry, traitCueAfter, traitCueBefore, traitDestinationPlacementOffset, traitDirection, traitDisplayAlign, traitDominantBaseline, traitElevation, traitEmptyCells, traitEndIndent, traitEndsRow, traitExtent, traitExternalDestination, traitFloat, traitFlowName, traitFontFamily, traitFontSelectionStrategy, traitFontSize, traitFontSizeActual, traitFontSizeAdjust, traitFontStretch, traitFontStyle, traitFontVariant, traitFontWeight, traitForcePageCount, traitFormat, traitGlyphOrientationHorizontal, traitGlyphOrientationVertical, traitGroupingSeparator, traitGroupingSize, traitHalfLeadingConditionality, traitHalfLeadingMax, traitHalfLeadingMin, traitHalfLeadingOpt, traitHalfLeadingPrecedence, traitHyphenate, traitHyphenationCharacter, traitHyphenationKeep, traitHyphenationLadderCount, traitHyphenationPushCharacterCount, traitHyphenationRemainCharacterCount, traitId, traitIndexClass, traitIndexKey, traitIndicateDestination, traitInitialPageNumber, traitInternalDestination, traitIntrusionDisplace, traitIpDimensionMax, traitIpDimensionMin, traitIpDimensionOpt, traitIsReferenceArea, traitKeepTogetherWithinColumn, traitKeepTogetherWithinLine, traitKeepTogetherWithinPage, traitKeepWithNextWithinColumn, traitKeepWithNextWithinLine, traitKeepWithNextWithinPage, traitKeepWithPreviousWithinColumn, traitKeepWithPreviousWithinLine, traitKeepWithPreviousWithinPage, traitLanguage, traitLastLineEndIndent, traitLeaderAlignment, traitLeaderLengthMax, traitLeaderLengthMin, traitLeaderLengthOpt, traitLeaderPattern, traitLeaderPatternWidth, traitLeft, traitLetterSpacingConditionality, traitLetterSpacingMax, traitLetterSpacingMin, traitLetterSpacingOpt, traitLetterSpacingPrecedence, traitLetterValue, traitLinefeedTreatment, traitLineHeightShiftAdjustment, traitLineStackingStrategy, traitMarkerClassName, traitMasterName, traitMasterReference, traitMaximumRepeats, traitMediaUsage, traitMergePagesAcrossIndexKeyReferences, traitMergeRangesAcrossIndexKeyReferences, traitMergeSequentialPageNumbers, traitNumberColumnsRepeated, traitNumberColumnsSpanned, traitNumberRowsSpanned, traitOddOrEven, traitOrphans, traitOverflow, traitOverlineScore, traitOverlineScoreColor, traitPaddingAfter, traitPaddingBefore, traitPaddingEnd, traitPaddingStart, traitPageCitationStrategy, traitPageHeight, traitPageNumberTreatment, traitPagePosition, traitPageWidth, traitPauseAfter, traitPauseBefore, traitPitch, traitPitchRange, traitPlayDuring, traitPlayDuringMix, traitPlayDuringRepeat, traitPrecedence, traitProvisionalDistanceBetweenStarts, traitProvisionalLabelSeparation, traitReferenceOrientation, traitRefId, traitRefIndexKey, traitRelativeAlign, traitRelativePosition, traitRenderingIntent, traitRetrieveBoundaryWithinTable, traitRetrieveClassName, traitRetrievePositionWithinTable, traitRichness, traitRight, traitRole, traitRuleStyle, traitRuleThickness, traitScaling, traitScalingMethod, traitScalingMethod, traitScoreSpaces, traitScript, traitShowDestination, traitSourceDocument, traitSpaceAfterConditionality, traitSpaceAfterMaximum, traitSpaceAfterMinimum, traitSpaceAfterOptimum, traitSpaceAfterPrecedence, traitSpaceBeforeConditionality, traitSpaceBeforeMaximum, traitSpaceBeforeMinimum, traitSpaceBeforeOptimum, traitSpaceBeforePrecedence, traitSpaceEndConditionality, traitSpaceEndMaximum, traitSpaceEndMinimum, traitSpaceEndOptimum, traitSpaceEndPrecedence, traitSpaceStartConditionality, traitSpaceStartMaximum, traitSpaceStartMinimum, traitSpaceStartOptimum, traitSpaceStartPrecedence, traitSpan, traitSpeak, traitSpeakHeader, traitSpeakNumeral, traitSpeakPunctuation, traitSpeechRate, traitSrc, traitStartIndent, traitStartingState, traitStartsRow, traitStress, traitSuppressAtLineBreak, traitSwitchTo, traitSwitchToNames, traitTableLayout, traitTableOmitFooterAtBreak, traitTableOmitHeaderAtBreak, traitTargetPresentationContext, traitTargetProcessingContext, traitTargetStylesheet, traitTextAlign, traitTextAlignLast, traitTextAlignString, traitTextAltitude, traitTextDepth, traitTextIndent, traitTextShadow, traitTextTransform, traitThroughScore, traitThroughScoreColor, traitTop, traitTreatAsWordSpace, traitUnderlineScore, traitUnderlineScoreColor, traitUnicodeBidi, traitVisibility, traitVoiceFamily, traitVolume, traitWhiteSpaceCollapse, traitWhiteSpaceTreatment, traitWidows, traitWordSpacingConditionality, traitWordSpacingMax, traitWordSpacingMin, traitWordSpacingOpt, traitWordSpacingPrecedence, traitWrapOption, traitWritingMode, traitZIndex, traitZIndexIsAuto, validateAtLeastOneChild, validateEmptyContent

Methods inherited from class org.foray.common.AbstractOrderedTreeNode

children, getChildCount, getFirstChild, getFirstLeaf, getIndex, getLastChild, 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.fo.Fo

ancestorListRelatedObject, ancestorMarker, ancestorTable, getColumn, getContextMessage, getLine, getSequentialIndex, getSystemId, isBlockLevelFo, qtyMarkerChildren, traitIsReferenceArea

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.fo.fo.prop.FormatPa

traitFormat

Methods inherited from interface org.axsl.fo.fo.prop.IdPa

traitId

Methods inherited from interface org.axsl.fo.fo.prop.IndexClassPa

traitIndexClass

Methods inherited from interface org.axsl.fo.fo.prop.IndexKeyPa

traitIndexKey

Methods inherited from interface org.axsl.fo.fo.prop.InitialPageNumberPa

initialPageNumberSetExplicitly, traitInitialPageNumber

Methods inherited from interface org.axsl.fo.fo.prop.ForcePageCountPa

traitForcePageCount

Methods inherited from interface org.axsl.fo.fo.prop.ReferenceOrientationPa

traitReferenceOrientation

Methods inherited from interface org.axsl.fo.fo.prop.WritingModePa

traitWritingMode

Constructor Detail

PageSequence

public PageSequence(Root parent,
                    PropertyList propertyList)

Constructor.

Parameters:

parent - The parent FObj.

propertyList - The property list for this FObj.

Method Detail

validateAncestry

protected void validateAncestry()
                         throws org.axsl.fo.FoTreeException

Description copied from class: FObj

A hook into the parsing process which allows the subclass instance to validate its ancestry. This method is called after object construction, but before any properties are parsed.

Specified by:

validateAncestry in class FObj

Throws:

org.axsl.fo.FoTreeException - For invalid ancestry.

validateProperties

protected void validateProperties()
                           throws org.axsl.fo.FoTreeException

Description copied from class: FObj

A hook into the parsing process which allows the subclass instance to validate its properties. This method is called after all properties have been parsed, but before any children have been read.

Specified by:

validateProperties in class FObj

Throws:

org.axsl.fo.FoTreeException - For invalid properties.

validateDescendants

protected void validateDescendants()
                            throws org.axsl.fo.FoTreeException

Description copied from class: FObj

A hook into the parsing process which allows the subclass instance to validate its descendants. This method is called after all children have been parsed.

Specified by:

validateDescendants in class FObj

Throws:

org.axsl.fo.FoTreeException - For invalid descendants.

setup

public void setup()
           throws org.axsl.fo.FoTreeException

Description copied from class: FObj

A hook into the parsing process which allows the subclass instance to do some initialization-type work after all of the properties have been parsed, but before any of the children have been parsed.

Specified by:

setup in class FObj

Throws:

org.axsl.fo.FoTreeException - For errors during initialization.

end

public void end()
         throws org.axsl.fo.FoTreeException

Description copied from class: FObj

This method is a hook into the parsing process, primarily to allow the subclass to do some validation or setup work after the object and all of its properties have been parsed and all of its children processed.

Specified by:

end in class FObj

Throws:

org.axsl.fo.FoTreeException - For errors during validation or setup.

getName

public String getName()

Specified by:

getName in interface org.axsl.fo.Fo

Specified by:

getName in class FObj

addFlow

public void addFlow(org.axsl.fo.fo.Flow flow)
             throws org.axsl.fo.FoTreeException

Register a descendant flow.

Parameters:

flow - The flow to be registered.

Throws:

org.axsl.fo.FoTreeException - If a flow already exists or if the new flow-name is not unique.

addStaticContent

public void addStaticContent(StaticContent staticContent)
                      throws org.axsl.fo.FoTreeException

Register a descendant static-content.

Parameters:

staticContent - The static-content to be registered.

Throws:

org.axsl.fo.FoTreeException - If the static-content appears after the flow or if the flow-name of the static-content has already been registered.

getStaticContent

public StaticContent getStaticContent(String regionName)

Returns the static-content for a specified region.

Parameters:

regionName - The name of the region whose static content should be returned.

Returns:

The static-content for the specified region.

getStaticContent

public StaticContent getStaticContent(org.axsl.fo.fo.Region region)

Specified by:

getStaticContent in interface org.axsl.fo.fo.PageSequence

getBeforeFloatSeparator

public org.axsl.fo.fo.StaticContent getBeforeFloatSeparator()

Specified by:

getBeforeFloatSeparator in interface org.axsl.fo.fo.PageSequence

getFootnoteSeparator

public org.axsl.fo.fo.StaticContent getFootnoteSeparator()

Specified by:

getFootnoteSeparator in interface org.axsl.fo.fo.PageSequence

ancestorBasicLink

public BasicLink ancestorBasicLink(org.axsl.fo.FoContext context)

Override the FONode method, because there will be no BasicLink objects above this one.

Specified by:

ancestorBasicLink in interface org.axsl.fo.Fo

Overrides:

ancestorBasicLink in class FObj

getNamespace

public Namespace getNamespace()

Description copied from class: FObj

Gets the Namespace instance that is associated with this object.

Specified by:

getNamespace in class FObj

Returns:

The Namespace instance that is associated with this object.

getRoot

public Root getRoot()

Override the default method, because this object knows how to find the Root directly. Return the root of this tree.

Overrides:

getRoot in class FObj

Returns:

The root of this tree.

getLayoutMasterSet

public LayoutMasterSet getLayoutMasterSet()

Convenience method returning the layout-master-set for this document.

Returns:

The layout-master-set.

formatPageNumber

public String formatPageNumber(int pageNumber)

Specified by:

formatPageNumber in interface org.axsl.fo.fo.PageSequence

getFlows

public List<org.axsl.fo.fo.Flow> getFlows()

Specified by:

getFlows in interface org.axsl.fo.fo.PageSequence

makePageMasterResolver

public PageMasterResolver makePageMasterResolver(int lastPageNumber)

Specified by:

makePageMasterResolver in interface org.axsl.fo.fo.PageSequence

acceptProxyFactory

public Object acceptProxyFactory(org.axsl.fo.ProxyFactory factory)

Specified by:

acceptProxyFactory in interface org.axsl.fo.Fo

getTitle

public Title getTitle()

Specified by:

getTitle in interface org.axsl.fo.fo.PageSequence

flowValid

protected boolean flowValid(AbstractFlow flow)

Indicates whether a given flow can be laid out on at least one page in this page-sequence.

Parameters:

flow - The abstract flow to be tested.

Returns:

True iff the flow can be laid out on at least one page in this page-sequence.

isInFlowMap

protected boolean isInFlowMap(AbstractFlow flow)

Indicates whether a given flow is found in one of the flow-source-list instances in this page-sequence's flow-map.

Parameters:

flow - The abstract flow to be tested.

Returns:

True iff the flow is found in one of the flow-source-list instances in this page-sequence's flow-map.

getPageSequenceTemplate

public PageSequenceTemplate getPageSequenceTemplate()

Returns the page sequence template for this page sequence.

Returns:

Returns the pageSequenceTemplate.

getParent

public Root getParent()

Specified by:

getParent in interface TreeNode

Specified by:

getParent in interface org.axsl.fo.Fo

Specified by:

getParent in class FObj

getChildren

public List<FObj> getChildren()

Description copied from class: AbstractOrderedTreeNode

Return the List of this node's children.

Specified by:

getChildren in class FObj

Returns:

The List of this node's children.

addChild

public void addChild(FObj child)
              throws org.axsl.fo.FoTreeException

Description copied from class: FObj

Add a child to this object.

Specified by:

addChild in class FObj

Parameters:

child - The child to be added.

Throws:

org.axsl.fo.FoTreeException - If the child cannot be added as a child for any reason, either because it an invalid type or is in the wrong order.

isContentInline

public boolean isContentInline()

Description copied from class: FObj

Reports whether the object fits the %inline parameter entity described in XSL-FO Std 1.0, Section 6.2. This includes not just the %inline definition, but also all other objects, such as the neutral containers that can be used where %inline can.

Specified by:

isContentInline in class FObj

Returns:

Returns true iff the object fits the %inline content model.

isContentBlock

public boolean isContentBlock()

Description copied from class: FObj

Reports whether the object fits the %block parameter entity described in XSL-FO Std 1.0, Section 6.2. This includes not just the %block definition, but also all other objects, such as the neutral containers that can be used where %block can.

Specified by:

isContentBlock in class FObj

Returns:

Returns true iff the object fits the %block content model.

isContentPcdata

public boolean isContentPcdata()

Description copied from class: FObj

Reports whether the object fits the #PCDATA content type in XSL-FO Std 1.0, Section 6.2. This includes objects such as the neutral containers that can be used where #PCDATA can.

Specified by:

isContentPcdata in class FObj

Returns:

Returns true iff the object fits the #PCDATA content model.

getFlowMap

public FlowMap getFlowMap()

Returns the flow-map associated with this page-sequence.

Returns:

The flow-map for this page-sequence.

getPropertyList

public PropertyList getPropertyList()

Description copied from class: FObj

Returns the property list for this FObj.

Specified by:

getPropertyList in class FObj

Returns:

Returns the propertyList.

getPrimaryFont

public org.axsl.font.FontUse getPrimaryFont(org.axsl.fo.FoContext context)

Specified by:

getPrimaryFont in interface org.axsl.fo.fo.prop.CommonFontPa

getChildAt

public FObj getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Specified by:

getChildAt in interface org.axsl.fo.Fo

isValid

public boolean isValid()

Specified by:

isValid in interface org.axsl.fo.Fo

getPageNumberFormatter

public org.axsl.common.PositiveIntegerFormatter getPageNumberFormatter()

Specified by:

getPageNumberFormatter in interface org.axsl.fo.fo.PageSequence

getFolioPrefix

public FolioPrefix getFolioPrefix()

Specified by:

getFolioPrefix in interface org.axsl.fo.fo.PageSequence

getFolioSuffix

public FolioSuffix getFolioSuffix()

Specified by:

getFolioSuffix in interface org.axsl.fo.fo.PageSequence