org.axsl.foR.fo
Interface PageSequence

All Superinterfaces:

FObj, FONode, OrderedTreeNode, javax.swing.tree.TreeNode

public interface PageSequence

extends FObj

An fo:page-sequence object in XSL-FO. See XSL-FO 1.0 Section 6.4.5.

Method Summary

java.lang.String	formatPageNumber(int pageNumber) For a given page-number in the page-sequence, provides a formatted String representation of that page-number, suitable for placement in the output document.
StaticContent	getBeforeFloatSeparator() Convenience method to obtain the static content for the before-float-separator.
Flow	getFlow() The fo:flow item for this fo:page-sequence.
StaticContent	getFootnoteSeparator() Convenience method to obtain the static content for the footnote-separator.
StaticContent	getStaticContent(Region region) Returns the static-content for a given region in this page-sequence.
Title	getTitle() The fo:title item for this fo:page-sequence.
PageMasterResolver	makePageMasterResolver(int lastPageNumber) Creates a new PageMasterResolver instance for this PageSequence.

Methods inherited from interface org.axsl.foR.FObj

ancestorListRelatedObject, canContainBlock, canContainInline, canContainPCDATA, getBasicLink, getBPAxis, getFauxSmallCapFontSize, getFontConsumer, getIPAxis, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getName, getNearestTable, getPreviousSiblingFObj, getPrimaryFont, getSecondaryFont, getWritingMode, initialPageNumberSetExplicitly, isBlockLevelFO, isContentBlock, isContentInline, isContentPCDATA, isRAGenerator, refIdNeeded, traitAbsolutePosition, traitActiveState, traitAlignmentAdjust, traitAlignmentAdjustAmount, traitAlignmentBaseline, traitAutoRestore, traitAzimuth, traitBackgroundAttachment, traitBackgroundColor, traitBackgroundImage, traitBackgroundPositionHorizontal, traitBackgroundPositionVertical, traitBackgroundRepeat, traitBaselineShift, traitBlink, traitBorderAfterColor, traitBorderAfterPrecedence, traitBorderAfterStyle, traitBorderAfterWidth, traitBorderBeforeColor, traitBorderBeforePrecedence, traitBorderBeforeStyle, traitBorderBeforeWidth, traitBorderBottomColor, traitBorderBottomStyle, traitBorderBottomWidth, traitBorderCollapse, traitBorderEndColor, traitBorderEndPrecedence, traitBorderEndStyle, traitBorderEndWidth, traitBorderLeftColor, traitBorderLeftStyle, traitBorderLeftWidth, traitBorderRightColor, traitBorderRightStyle, traitBorderRightWidth, traitBorderSeparationBPD, traitBorderSeparationIPD, traitBorderStartColor, traitBorderStartPrecedence, traitBorderStartStyle, traitBorderStartWidth, traitBorderTopColor, traitBorderTopStyle, traitBorderTopWidth, traitBottom, traitBPDimensionMax, traitBPDimensionMin, traitBPDimensionOpt, traitBPDirection, traitBreakAfter, traitBreakBefore, traitCaptionSide, traitCaseName, traitCaseTitle, traitClear, traitClip, traitColor, traitColorProfileName, traitColumnCount, traitColumnGap, traitColumnWidth, 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, traitGlyphOrientationHorizontal, traitGlyphOrientationVertical, traitHalfLeadingConditionality, traitHalfLeadingMax, traitHalfLeadingMin, traitHalfLeadingOpt, traitHalfLeadingPrecedence, traitHyphenate, traitHyphenationCharacter, traitHyphenationKeep, traitHyphenationPushCharacterCount, traitHyphenationRemainCharacterCount, traitHyphLadderCount, traitId, traitIndicateDestination, traitInitialPageNumber, traitInternalDestination, traitIPDimensionMax, traitIPDimensionMin, traitIPDimensionOpt, traitIPDirectionEven, traitIPDirectionOdd, traitKeepTogetherWithinColumn, traitKeepTogetherWithinLine, traitKeepTogetherWithinPage, traitKeepWithNextWithinColumn, traitKeepWithNextWithinLine, traitKeepWithNextWithinPage, traitKeepWithPreviousWithinColumn, traitKeepWithPreviousWithinLine, traitKeepWithPreviousWithinPage, traitLanguage, traitLastLineEndIndent, traitLeaderAlignment, traitLeaderLengthMax, traitLeaderLengthMin, traitLeaderLengthOpt, traitLeaderPattern, traitLeaderPatternWidth, traitLeft, traitLetterSpacingConditionality, traitLetterSpacingMax, traitLetterSpacingMin, traitLetterSpacingOpt, traitLetterSpacingPrecedence, traitLinefeedTreatment, traitLineHeightShiftAdjustment, traitLineStackingStrategy, traitMediaUsage, traitNumberColumnsRepeated, traitOrphans, traitOverflow, traitOverlineScore, traitOverlineScoreColor, traitPaddingAfter, traitPaddingBefore, traitPaddingBottom, traitPaddingEnd, traitPaddingLeft, traitPaddingRight, traitPaddingStart, traitPaddingTop, traitPageHeight, traitPageWidth, traitPauseAfter, traitPauseBefore, traitPitch, traitPitchRange, traitPlayDuring, traitPlayDuringMix, traitPlayDuringRepeat, traitProvisionalDistanceBetweenStarts, traitProvisionalLabelSeparation, traitReferenceOrientation, traitRefId, traitRelativeAlign, traitRelativePosition, traitRenderingIntent, traitRichness, traitRight, traitRole, traitRuleStyle, traitRuleThickness, traitScaling, traitScalingMethod, traitScoreSpaces, traitScript, traitShiftDirectionEven, traitShiftDirectionOdd, 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, traitZIndex, traitZIndexIsAuto

Methods inherited from interface org.axsl.foR.FONode

ancestorMarker, childrenFO, getColumn, getContextMessage, getFONodeChildAt, getLine, getProxy, getResult, getSystemId, makeProxy, parentFO, reset, setProxy, setResult

Methods inherited from interface org.axsl.common.OrderedTreeNode

getChildren, getFirstChild, getFirstLeaf, getLastChild, getLastLeaf, getNextLeaf, getNextSibling, getPreviousLeaf, getPreviousSibling, getSiblings, hasChildren, nextPreOrderNode, siblingIndex

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

formatPageNumber

public java.lang.String formatPageNumber(int pageNumber)

For a given page-number in the page-sequence, provides a formatted String representation of that page-number, suitable for placement in the output document.

Parameters:

pageNumber - The page-number to be formatted.

Returns:

A formatted String representation of pageNumber.

makePageMasterResolver

public PageMasterResolver makePageMasterResolver(int lastPageNumber)

Creates a new PageMasterResolver instance for this PageSequence. Note that using more than one PageMasterResolver instance during the pagination of a PageSequence may result in incorrect output, because the PageMasterResolver keeps track of the state of which pages have already been generated, which sub-sequence specifiers have been exhausted, etc.

Parameters:

lastPageNumber - The last page number that was used by the previous page-sequence.

Returns:

The new PageMasterResolver instance.

getTitle

public Title getTitle()

The fo:title item for this fo:page-sequence.

Returns:

The fo:title for this fo:page-sequence, or null if there is none.

getFlow

public Flow getFlow()

The fo:flow item for this fo:page-sequence.

Returns:

The fo:flow for this fo:page-sequence.

getStaticContent

public StaticContent getStaticContent(Region region)

Returns the static-content for a given region in this page-sequence.

Parameters:

region - The Region for which static content should be returned.

Returns:

The static-content for region.

getBeforeFloatSeparator

public StaticContent getBeforeFloatSeparator()

Convenience method to obtain the static content for the before-float-separator.

Returns:

The fo:static-content item whose flow-name is "xsl-before-float-separator", or null if there is none.

getFootnoteSeparator

public StaticContent getFootnoteSeparator()

Convenience method to obtain the static content for the footnote-separator.

Returns:

The fo:static-content item whose flow-name is "xsl-footnote-separator", or null if there is none.