SourceForge.net Logo
aXSL API 0.1

org.axsl.foR.fo
Interface Region

All Superinterfaces:
FObj, FONode, OrderedTreeNode, javax.swing.tree.TreeNode
All Known Subinterfaces:
RegionAfter, RegionBefore, RegionBody, RegionEnd, RegionStart

public interface Region
extends FObj

Abstract base interface for pagination regions.


Method Summary
 int getHeightVPContent(FOContext context)
          Convenience method reporting the region's height.
 SimplePageMaster getPage()
          Returns the parent page of this Region.
 int getWidthVPContent(FOContext context)
          Convenience method reporting the region's width.
 int getXPositionVPContent(FOContext context)
          Convenience method reporting the region's horizontal position.
 int getYPositionVPContent(FOContext context)
          Convenience method reporting the region's vertical position.
 java.lang.String traitRegionName()
          Returns the name of this region.
 
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

getPage

public SimplePageMaster getPage()
Returns the parent page of this Region.

Returns:
The parent page of this Region.

getXPositionVPContent

public int getXPositionVPContent(FOContext context)

Convenience method reporting the region's horizontal position.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The X coordinate of the upper left corner of the region's viewport's content rectangle, in millipoints.

getYPositionVPContent

public int getYPositionVPContent(FOContext context)

Convenience method reporting the region's vertical position.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The Y coordinate of the upper left corner of the region's viewport's content rectangle, in millipoints.

getWidthVPContent

public int getWidthVPContent(FOContext context)

Convenience method reporting the region's width.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The width of the region's viewport's content rectangle, in millipoints.

getHeightVPContent

public int getHeightVPContent(FOContext context)

Convenience method reporting the region's height.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The height of the region's viewport's content rectangle, in millipoints.

traitRegionName

public java.lang.String traitRegionName()
Returns the name of this region.

Returns:
The name of this region.

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.