SourceForge.net Logo
aXSL API 0.1

org.axsl.foR.fo
Interface RetrieveMarker

All Superinterfaces:
FObj, FOContext, FONode, OrderedTreeNode, javax.swing.tree.TreeNode

public interface RetrieveMarker
extends FObj, FOContext

An fo:retrieve-marker object in XSL-FO. See XSL-FO 1.0 Section 6.11.4.


Method Summary
 short traitRetrieveBoundary()
          The "retrieve-boundary" property.
 java.lang.String traitRetrieveClassName()
          The "retrieve-class-name" property.
 short traitRetrievePosition()
          The "retrieve-position" property.
 
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
 
Methods inherited from interface org.axsl.foR.FOContext
getRetrieveMarker
 

Method Detail

traitRetrieveClassName

public java.lang.String traitRetrieveClassName()
The "retrieve-class-name" property. See XSL-FO 1.0 Section 7.23.2.

Returns:
The "retrieve-class-name" property for this object.

traitRetrievePosition

public short traitRetrievePosition()
The "retrieve-position" property. See XSL-FO 1.0 Section 7.23.3.

Returns:
The "retrieve-position" property for this object, one of Constants.FOVAL_FIRST_STARTING_WITHIN_PAGE, Constants.FOVAL_FIRST_INCLUDING_CARRYOVER, Constants.FOVAL_LAST_STARTING_WITHIN_PAGE, or Constants.FOVAL_LAST_ENDING_WITHIN_PAGE.

traitRetrieveBoundary

public short traitRetrieveBoundary()
The "retrieve-boundary" property. See XSL-FO 1.0 Section 7.23.4.

Returns:
The "retrieve-boundary" property for this object, one of Constants.FOVAL_PAGE, Constants.FOVAL_PAGE_SEQUENCE, or Constants.FOVAL_DOCUMENT.

SourceForge.net Logo
aXSL API 0.1

This documentation was created September 6 2006 by The aXSL Group and may be freely copied. See license for details.