org.foray.fotree.fo.obj
Class SimplePageMaster

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

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.WritingModePa, org.axsl.fo.fo.prop.ZIndexPa, org.axsl.fo.fo.SimplePageMaster, OrderedTreeNode, PageSequenceTemplate

public class SimplePageMaster
extends AbstractPageMaster
implements org.axsl.fo.fo.SimplePageMaster, PageSequenceTemplate

A "simple-page-master" object in XSL-FO.

Nested Class Summary

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

AbstractOrderedTreeNode.PostOrderDescendantIterator

Field Summary

static int	FALLBACK_PAGE_HEIGHT Constant indicating the fallback page height of 11 inches.
static int	FALLBACK_PAGE_WIDTH Constant indicating the fallback page widht of 8.5 inches.

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

SimplePageMaster(LayoutMasterSet parent, PropertyList propertyList)
Constructor.

Method Summary

Object	acceptProxyFactory(org.axsl.fo.ProxyFactory factory)
protected void	addRegionAfter(RegionAfter regionAfter) Registers the child region-after.
protected void	addRegionBefore(RegionBefore regionBefore) Registers the child region-before.
protected void	addRegionBody(RegionBody regionBody) Registers the child region-body.
protected void	addRegionEnd(RegionEnd regionEnd) Registers the child region-end.
protected void	addRegionStart(RegionStart regionStart) Registers the child region-start.
protected 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.
boolean	flowValid(AbstractFlow flow) Make sure that a given flow can be laid out on at least one page in this page-sequence template.
int	getAfterExtent()
boolean	getAfterPrecedence() Convenience method.
int	getBeforeExtent()
boolean	getBeforePrecedence() Convenience method.
int	getEndExtent()
int	getHeightRAContent() Returns the height of the page.
String	getName()
Namespace	getNamespace() Gets the Namespace instance that is associated with this object.
RegionAfter	getRegionAfter()
RegionBefore	getRegionBefore()
Collection<RegionBody>	getRegionBodies()
RegionBody	getRegionBody(String regionName)
RegionEnd	getRegionEnd()
RegionStart	getRegionStart()
int	getStartExtent()
int	getWidthRAContent() Returns the width of the page.
int	getXPositionRAContent() Returns the X position of the upper-left corner of the page.
int	getYPositionRAContent() Returns the Y position of the upper-left corner of the page.
boolean	hasRegion(String flowName) Indicates whether this page has a region matching a given flow name.
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.
boolean	traitIsReferenceArea()
protected void	validateDescendants() A hook into the parsing process which allows the subclass instance to validate its descendants.

Methods inherited from class org.foray.fotree.fo.obj.AbstractPageMaster

addChild, getChildAt, getChildren, getParent, getPrimaryFont, getPropertyList, isContentBlock, isContentInline, isContentPcdata, isValid, validateAncestry, validateProperties

Methods inherited from class org.foray.fotree.FObj

addCharacters, addChildToEmptyContentModel, ancestorBasicLink, 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, getRoot, 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, 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

ancestorBasicLink, ancestorListRelatedObject, ancestorMarker, ancestorTable, getChildAt, getColumn, getContextMessage, getLine, getParent, getSequentialIndex, getSystemId, isBlockLevelFo, isValid, qtyMarkerChildren

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

traitEndIndent, traitSpaceAfterConditionality, traitSpaceAfterMaximum, traitSpaceAfterMinimum, traitSpaceAfterOptimum, traitSpaceAfterPrecedence, traitSpaceBeforeConditionality, traitSpaceBeforeMaximum, traitSpaceBeforeMinimum, traitSpaceBeforeOptimum, traitSpaceBeforePrecedence, traitStartIndent

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

traitSpaceEndOptimum, traitSpaceStartOptimum

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

traitPageHeight

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

traitPageWidth

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

traitReferenceOrientation

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

traitWritingMode

Field Detail

FALLBACK_PAGE_WIDTH

public static final int FALLBACK_PAGE_WIDTH

Constant indicating the fallback page widht of 8.5 inches.

See Also:

Constant Field Values

FALLBACK_PAGE_HEIGHT

public static final int FALLBACK_PAGE_HEIGHT

Constant indicating the fallback page height of 11 inches.

See Also:

Constant Field Values

Constructor Detail

SimplePageMaster

public SimplePageMaster(LayoutMasterSet parent,
                        PropertyList propertyList)

Constructor.

Parameters:

parent - The parent FObj.

propertyList - The property list for this FObj.

Method Detail

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.

end

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

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.

getName

public String getName()

Specified by:

getName in interface org.axsl.fo.Fo

Specified by:

getName in class FObj

addRegionBefore

protected void addRegionBefore(RegionBefore regionBefore)
                        throws org.axsl.fo.FoTreeException

Registers the child region-before.

Parameters:

regionBefore - The child region-before to register.

Throws:

org.axsl.fo.FoTreeException - If a region-before has already been registered.

addRegionAfter

protected void addRegionAfter(RegionAfter regionAfter)
                       throws org.axsl.fo.FoTreeException

Registers the child region-after.

Parameters:

regionAfter - The child region-after to register.

Throws:

org.axsl.fo.FoTreeException - If a region-after has already been registered.

addRegionStart

protected void addRegionStart(RegionStart regionStart)
                       throws org.axsl.fo.FoTreeException

Registers the child region-start.

Parameters:

regionStart - The child region-start to register.

Throws:

org.axsl.fo.FoTreeException - If a region-start has already been registered.

addRegionEnd

protected void addRegionEnd(RegionEnd regionEnd)
                     throws org.axsl.fo.FoTreeException

Registers the child region-end.

Parameters:

regionEnd - The child region-end to register.

Throws:

org.axsl.fo.FoTreeException - If a region-end has already been registered.

addRegionBody

protected void addRegionBody(RegionBody regionBody)
                      throws org.axsl.fo.FoTreeException

Registers the child region-body.

Parameters:

regionBody - The child region-body to register.

Throws:

org.axsl.fo.FoTreeException - If a region-body has already been registered.

getRegionBodies

public Collection<RegionBody> getRegionBodies()

Specified by:

getRegionBodies in interface org.axsl.fo.fo.SimplePageMaster

getRegionBody

public RegionBody getRegionBody(String regionName)

Specified by:

getRegionBody in interface org.axsl.fo.fo.SimplePageMaster

getRegionBefore

public RegionBefore getRegionBefore()

Specified by:

getRegionBefore in interface org.axsl.fo.fo.SimplePageMaster

getRegionAfter

public RegionAfter getRegionAfter()

Specified by:

getRegionAfter in interface org.axsl.fo.fo.SimplePageMaster

getRegionStart

public RegionStart getRegionStart()

Specified by:

getRegionStart in interface org.axsl.fo.fo.SimplePageMaster

getRegionEnd

public RegionEnd getRegionEnd()

Specified by:

getRegionEnd in interface org.axsl.fo.fo.SimplePageMaster

getBeforePrecedence

public boolean getBeforePrecedence()

Convenience method.

Returns:

True iff the region-before has Precedence.

getAfterPrecedence

public boolean getAfterPrecedence()

Convenience method.

Returns:

True iff the region-after has Precedence.

getBeforeExtent

public int getBeforeExtent()

Specified by:

getBeforeExtent in interface org.axsl.fo.fo.SimplePageMaster

getAfterExtent

public int getAfterExtent()

Specified by:

getAfterExtent in interface org.axsl.fo.fo.SimplePageMaster

getStartExtent

public int getStartExtent()

Specified by:

getStartExtent in interface org.axsl.fo.fo.SimplePageMaster

getEndExtent

public int getEndExtent()

Specified by:

getEndExtent in interface org.axsl.fo.fo.SimplePageMaster

getXPositionRAContent

public int getXPositionRAContent()

Returns the X position of the upper-left corner of the page.

Returns:

The X Position of the upper left corner of the page's reference area's content rectangle, in millipoints.

getYPositionRAContent

public int getYPositionRAContent()

Returns the Y position of the upper-left corner of the page.

Returns:

The Y Position of the upper left corner of the page's reference area's content rectangle, in millipoints.

getWidthRAContent

public int getWidthRAContent()

Returns the width of the page.

Returns:

The width of the page's reference area's content rectangle, in millipoints.

getHeightRAContent

public int getHeightRAContent()

Returns the height of the page.

Returns:

The height of the page's reference area's content rectangle, in millipoints.

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.

traitIsReferenceArea

public boolean traitIsReferenceArea()

Specified by:

traitIsReferenceArea in interface org.axsl.fo.Fo

Overrides:

traitIsReferenceArea in class FObj

acceptProxyFactory

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

Specified by:

acceptProxyFactory in interface org.axsl.fo.Fo

hasRegion

public boolean hasRegion(String flowName)

Description copied from class: AbstractPageMaster

Indicates whether this page has a region matching a given flow name.

Specified by:

hasRegion in class AbstractPageMaster

Parameters:

flowName - The flow name sought.

Returns:

True iff this page has a region whose name matches flowName.

flowValid

public boolean flowValid(AbstractFlow flow)

Description copied from interface: PageSequenceTemplate

Make sure that a given flow can be laid out on at least one page in this page-sequence template.

Specified by:

flowValid in interface PageSequenceTemplate

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