org.foray.fotree.fo.obj
Class Root

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

All Implemented Interfaces:

Iterable<org.axsl.fo.Fo>, TreeNode, org.axsl.fo.Fo, 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.ZIndexPa, org.axsl.fo.fo.Root, OrderedTreeNode

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

A "root" 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

Root(PropertyList propertyList)
Constructor.

Method Summary

Object	acceptProxyFactory(org.axsl.fo.ProxyFactory factory)
void	addChild(FObj child) Add a child to this object.
void	addId(FObj fobj) If fobj has a valid "id" property, map the "id" back to fobj so that fobj can be retrieved quickly later.
BasicLink	ancestorBasicLink(org.axsl.fo.FoContext context) Overrides the FObj method, because Root has no parent from which to check for a link.
FObj	ancestorGeneratingRA(org.axsl.fo.FoContext context) Returns the nearest ancestor FObj that generates reference areas.
FObj	ancestorListRelatedObject(org.axsl.fo.FoContext context) Overrides the FObj method, because Root has no parent.
Table	ancestorTable(org.axsl.fo.FoContext context) Overrides the FObj method, because there are no Tables above here.
void	checkUnmatchedReference(FObj fobj) For a given object that references an id, checks whether that id has already been registered and, if not, adds the object to a list of objects whose references have not yet been found.
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.
String	getAuthor()
org.axsl.fo.fo.BookmarkTree	getBookmarkTree()
FObj	getChildAt(int index)
List<FObj>	getChildren() Return the List of this node's children.
Block	getContainingBlock(org.axsl.fo.FoContext context) Finds the nearest self-or-ancestor that is a Block.
Declarations	getDeclarations()
FOTreeBuilder	getFoTree() Return the ancestor tree builder.
org.axsl.hyphen.HyphenationConsumer	getHyphenationConsumer() Returns the hyphenation consumer.
String	getKeywords()
LayoutMasterSet	getLayoutMasterSet() Return the child layout-master-set.
org.apache.commons.logging.Log	getLogger() Return the logger.
String	getName()
Namespace	getNamespace() Gets the Namespace instance that is associated with this object.
Leader	getNearestLeader(org.axsl.fo.FoContext context) Return the nearest ancestor Leader instance, if any.
Iterator<PageSequence>	getPageSequenceIterator() Returns an iterator over the descendant PageSequence objects.
FObj	getParent()
org.axsl.font.FontUse	getPrimaryFont(org.axsl.fo.FoContext context)
PropertyList	getPropertyList() Returns the property list for this FObj.
Root	getRoot() Return the root of this tree.
String	getSubject()
String	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.
boolean	isValid()
FObj	retrieveId(String id)
void	setFOTreeBuilder(FOTreeBuilder treeBuilder) Sets the "parent" tree builder.
protected 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, ancestorMarker, ancestorProperty, ancestorStaticContent, checkExceptionLocation, computeAutoBaseline, containsText, effectiveParent, firstLineText, firstTextSegment, getAllowsChildren, getAutoScript, getBaselineFromScript, getColumn, getContentHeight, getContentWidth, getContextMessage, getContextMessage, getCookedExternalDestination, getDescendantIterator, getDescendantText, getDestination, getFauxSmallCapFontSize, getFlowMapName, getFlowMapReference, getFlowNameReference, getFontConsumer, getFullName, getGraphicServer, getLine, getLinkType, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMessageWithContext, getNearestAncestorListBlock, 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

ancestorMarker, 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.CommonAccessibilityPa

traitRole, traitSourceDocument

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

traitMediaUsage

Constructor Detail

Root

public Root(PropertyList propertyList)

Constructor.

Parameters:

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.

setup

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

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.

getLayoutMasterSet

public LayoutMasterSet getLayoutMasterSet()

Return the child layout-master-set.

Returns:

The child layout-master-set.

getDeclarations

public Declarations getDeclarations()

Specified by:

getDeclarations in interface org.axsl.fo.fo.Root

getBookmarkTree

public org.axsl.fo.fo.BookmarkTree getBookmarkTree()

Specified by:

getBookmarkTree in interface org.axsl.fo.fo.Root

getName

public String getName()

Specified by:

getName in interface org.axsl.fo.Fo

Specified by:

getName in class FObj

getLogger

public org.apache.commons.logging.Log getLogger()

Return the logger. Overrides the FObj method, because this is the top of the tree.

Overrides:

getLogger in class FObj

Returns:

The logger.

ancestorGeneratingRA

public FObj ancestorGeneratingRA(org.axsl.fo.FoContext context)

Returns the nearest ancestor FObj that generates reference areas. Overrides the method in FObj because Root has no parent.

Overrides:

ancestorGeneratingRA in class FObj

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The nearest ancestor FObj that generates reference areas.

getRoot

public Root getRoot()

Return the root of this tree. Overrides the method in FObj because this is the root.

Overrides:

getRoot in class FObj

Returns:

The root of this tree.

getContainingBlock

public Block getContainingBlock(org.axsl.fo.FoContext context)

Finds the nearest self-or-ancestor that is a Block. Overrides the method in FObj because there is no parent for Root, and therefore no containing block.

Overrides:

getContainingBlock in class FObj

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

If this is an instance of Block, returns this, otherwise returns the nearest ancestor that is a Block, or null if there is no ancestor Block.

ancestorTable

public Table ancestorTable(org.axsl.fo.FoContext context)

Overrides the FObj method, because there are no Tables above here.

Specified by:

ancestorTable in interface org.axsl.fo.Fo

Overrides:

ancestorTable in class FObj

ancestorBasicLink

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

Overrides the FObj method, because Root has no parent from which to check for a link.

Specified by:

ancestorBasicLink in interface org.axsl.fo.Fo

Overrides:

ancestorBasicLink in class FObj

ancestorListRelatedObject

public FObj ancestorListRelatedObject(org.axsl.fo.FoContext context)

Overrides the FObj method, because Root has no parent.

Specified by:

ancestorListRelatedObject in interface org.axsl.fo.Fo

Overrides:

ancestorListRelatedObject in class FObj

getFoTree

public FOTreeBuilder getFoTree()

Return the ancestor tree builder. Overrides the method in FONode because this is the root.

Specified by:

getFoTree in interface org.axsl.fo.fo.Root

Overrides:

getFoTree in class FObj

Returns:

The ancestor tree builder.

setFOTreeBuilder

public void setFOTreeBuilder(FOTreeBuilder treeBuilder)

Sets the "parent" tree builder.

Parameters:

treeBuilder - The new "parent" tree builder.

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.

addId

public void addId(FObj fobj)
           throws org.axsl.fo.FoTreeException

If fobj has a valid "id" property, map the "id" back to fobj so that fobj can be retrieved quickly later.

Parameters:

fobj - The FObj instance that should be mapped.

Throws:

org.axsl.fo.FoTreeException - If the id already exists in the document.

retrieveId

public FObj retrieveId(String id)

Specified by:

retrieveId in interface org.axsl.fo.fo.Root

checkUnmatchedReference

public void checkUnmatchedReference(FObj fobj)

For a given object that references an id, checks whether that id has already been registered and, if not, adds the object to a list of objects whose references have not yet been found.

Parameters:

fobj - The object to be checked.

end

public void end()

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

getNearestLeader

public Leader getNearestLeader(org.axsl.fo.FoContext context)

Return the nearest ancestor Leader instance, if any. Overrides FObj method, because this has no parent.

Overrides:

getNearestLeader in class FObj

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The nearest ancestor Leader instance, or null if there is no ancestor Leader.

acceptProxyFactory

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

Specified by:

acceptProxyFactory in interface org.axsl.fo.Fo

getParent

public FObj getParent()

Specified by:

getParent in interface TreeNode

Specified by:

getParent in interface org.axsl.fo.Fo

Specified by:

getParent in class FObj

getTitle

public String getTitle()

Specified by:

getTitle in interface org.axsl.fo.fo.Root

getAuthor

public String getAuthor()

Specified by:

getAuthor in interface org.axsl.fo.fo.Root

getSubject

public String getSubject()

Specified by:

getSubject in interface org.axsl.fo.fo.Root

getKeywords

public String getKeywords()

Specified by:

getKeywords in interface org.axsl.fo.fo.Root

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.

getPageSequenceIterator

public Iterator<PageSequence> getPageSequenceIterator()

Returns an iterator over the descendant PageSequence objects.

Returns:

An iterator over the descendant page-sequence objects.

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

getHyphenationConsumer

public org.axsl.hyphen.HyphenationConsumer getHyphenationConsumer()

Description copied from class: FObj

Returns the hyphenation consumer.

Overrides:

getHyphenationConsumer in class FObj

Returns:

The hyphenation consumer.