FObj (aXSL API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

aXSL API 0.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.axsl.foR
Interface FObj

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

All Known Subinterfaces:: AbstractFlow, AbstractTableBody, BasicLink, BidiOverride, Block, BlockContainer, Bookmark, BookmarkTitle, BookmarkTree, Character, ColorProfile, ContinuedLabel, Declarations, ExternalGraphic, Float, Flow, FObjMixed, FObjScaled, Footnote, FootnoteBody, ForeignXML, InitialPropertySet, Inline, InlineContainer, InstreamForeignObject, Leader, ListBlock, ListItem, ListItemBody, ListItemLabel, Marker, MultiCase, MultiProperties, MultiPropertySet, MultiSwitch, MultiToggle, PageNumber, PageNumberCitation, PageSequence, Region, RegionAfter, RegionBefore, RegionBody, RegionEnd, RegionStart, RetrieveMarker, Root, SimplePageMaster, StaticContent, SVGElement, Table, TableAndCaption, TableBody, TableCaption, TableCell, TableColumn, TableFooter, TableHeader, TableRow, Title, Wrapper

public interface FObj
extends FONode

Base interface for formatting objects.

Method Summary
`FObj`	`ancestorListRelatedObject(FOContext context)` Returns the nearest ancestor list-related object.
`boolean`	`canContainBlock()` Reports whether the object is allowed to contain %block content.
`boolean`	`canContainInline()` Reports whether the object is allowed to contain %inline content.
`boolean`	`canContainPCDATA()` Reports whether the object is allowed to contain PCDATA content.
`BasicLink`	`getBasicLink(FOContext context)` Returns the nearest ancestor BasicLink.
`byte`	`getBPAxis(FOContext context)` Tells which axis (horizontal or vertical) is the block-progression axis.
`int`	`getFauxSmallCapFontSize(FOContext context)` Returns the font-size for the lowercase characters when faux small caps are used by this FO.
`FontConsumer`	`getFontConsumer()` Convenience method for obtaining the FontConsumer for this document.
`byte`	`getIPAxis(FOContext context)` Tells which axis (horizontal or vertical) is the inline-progression axis.
`int`	`getMarginBottom(FOContext context, int widthContainingBlock)` Returns the bottom margin of this object.
`int`	`getMarginLeft(FOContext context, int widthContainingBlock)` Returns the left margin of this object.
`int`	`getMarginRight(FOContext context, int widthContainingBlock)` Returns the right margin of this object.
`int`	`getMarginTop(FOContext context, int widthContainingBlock)` Returns the top margin of this object.
`java.lang.String`	`getName()` Returns the name of this formatting object.
`Table`	`getNearestTable(FOContext context)` Returns the nearest ancestor Table.
`FObj`	`getPreviousSiblingFObj()` Returns the nearest preceding sibling FO.
`FontUse`	`getPrimaryFont(FOContext context)` Provides a resolved font to be used as the primary font for this object.
`FontUse`	`getSecondaryFont(FOContext context, int codePoint)` Provides a resolved font that can be used as the secondary font for a specific character in this object.
`WritingMode`	`getWritingMode(FOContext context)` Returns the writing-mode for this FO.
`boolean`	`initialPageNumberSetExplicitly()` Indicates whether the page number was set with a specific integer.
`boolean`	`isBlockLevelFO()` Only block-level objects are considered in an object's ancestry for certain computations.
`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`	`isRAGenerator()` Returns the value of the is-reference-area trait.
`java.lang.String`	`refIdNeeded(FOContext context)` Returns the ref-id or idref property for this object.
`short`	`traitAbsolutePosition(FOContext context)` Returns the "absolute-position" trait for this FO.
`short`	`traitActiveState(FOContext context)` Returns the "active-state" trait for this FO.
`short`	`traitAlignmentAdjust(FOContext context)` Returns the keyword component of the "alignment-adjust" trait for this FO.
`int`	`traitAlignmentAdjustAmount(FOContext context, int areaHeight)` Returns the length component, if any, of the "alignment-adjust" trait for this FO.
`short`	`traitAlignmentBaseline(FOContext context)` Returns the "alignment-baseline" trait for this FO.
`boolean`	`traitAutoRestore(FOContext context)` Returns the "auto-restore" trait for this FO.
`float`	`traitAzimuth(FOContext context)` Returns the "azimuth" trait for this FO.
`short`	`traitBackgroundAttachment(FOContext context)` Returns the "background-attachment" trait for this FO.
`java.awt.Color`	`traitBackgroundColor(FOContext context)` Returns the "background-color" trait for this FO.
`Graphic`	`traitBackgroundImage(FOContext context)` Returns the "background-image" trait for this FO.
`int`	`traitBackgroundPositionHorizontal(FOContext context, int paddingRectangleWidth, int backgroundImageWidth)` Returns the "background-position-horizontal" trait for this FO.
`int`	`traitBackgroundPositionVertical(FOContext context, int paddingRectangleHeight, int backgroundImageHeight)` Returns the "background-position-vertical" trait for this FO.
`short`	`traitBackgroundRepeat(FOContext context)` Returns the "background-repeat" trait for this FO.
`int`	`traitBaselineShift(FOContext context)` Returns the "baseline-shift" trait for this FO.
`boolean`	`traitBlink(FOContext context)` Returns the "blink" trait for this FO.
`java.awt.Color`	`traitBorderAfterColor(FOContext context)` Returns the "border-after-color" trait for this FO.
`int`	`traitBorderAfterPrecedence(FOContext context)` Returns the "border-after-precedence" trait for this FO.
`short`	`traitBorderAfterStyle(FOContext context)` Returns the "border-after-style" trait for this FO.
`int`	`traitBorderAfterWidth(FOContext context, boolean isLast)` Returns the "border-after-width" trait for this FO.
`java.awt.Color`	`traitBorderBeforeColor(FOContext context)` Returns the "border-before-color" trait for this FO.
`int`	`traitBorderBeforePrecedence(FOContext context)` Returns the "border-before-precedence" trait for this FO.
`short`	`traitBorderBeforeStyle(FOContext context)` Returns the "border-before-style" trait for this FO.
`int`	`traitBorderBeforeWidth(FOContext context, boolean isFirst)` Returns the "border-before-width" trait for this FO.
`java.awt.Color`	`traitBorderBottomColor(FOContext context)` Returns the "border-bottom-color" trait for this FO.
`short`	`traitBorderBottomStyle(FOContext context)` Returns the "border-bottom-style" trait for this FO.
`int`	`traitBorderBottomWidth(FOContext context)` Returns the "border-bottom-width" trait for this FO.
`short`	`traitBorderCollapse(FOContext context)` Returns the "border-collapse" trait for this FO.
`java.awt.Color`	`traitBorderEndColor(FOContext context)` Returns the "border-end-color" trait for this FO.
`int`	`traitBorderEndPrecedence(FOContext context)` Returns the "border-end-precedence" trait for this FO.
`short`	`traitBorderEndStyle(FOContext context)` Returns the "border-end-style" trait for this FO.
`int`	`traitBorderEndWidth(FOContext context, boolean isLast)` Returns the "border-end-width" trait for this FO.
`java.awt.Color`	`traitBorderLeftColor(FOContext context)` Returns the "border-left-color" trait for this FO.
`short`	`traitBorderLeftStyle(FOContext context)` Returns the "border-left-style" trait for this FO.
`int`	`traitBorderLeftWidth(FOContext context)` Returns the "border-left-width" trait for this FO.
`java.awt.Color`	`traitBorderRightColor(FOContext context)` Returns the "border-right-color" trait for this FO.
`short`	`traitBorderRightStyle(FOContext context)` Returns the "border-right-style" trait for this FO.
`int`	`traitBorderRightWidth(FOContext context)` Returns the "border-right-width" trait for this FO.
`int`	`traitBorderSeparationBPD(FOContext context)` Returns the BPD portion of the "border-separation" trait for this FO.
`int`	`traitBorderSeparationIPD(FOContext context)` Returns the IPD portion of the "border-separation" trait for this FO.
`java.awt.Color`	`traitBorderStartColor(FOContext context)` Returns the "border-start-color" trait for this FO.
`int`	`traitBorderStartPrecedence(FOContext context)` Returns the "border-start-precedence" trait for this FO.
`short`	`traitBorderStartStyle(FOContext context)` Returns the "border-start-style" trait for this FO.
`int`	`traitBorderStartWidth(FOContext context, boolean isFirst)` Returns the "border-start-width" trait for this FO.
`java.awt.Color`	`traitBorderTopColor(FOContext context)` Returns the "border-top-color" trait for this FO.
`short`	`traitBorderTopStyle(FOContext context)` Returns the "border-top-style" trait for this FO.
`int`	`traitBorderTopWidth(FOContext context)` Returns the "border-top-width" trait for this FO.
`int`	`traitBottom(FOContext context, int heightContainingBlock)` Returns the "bottom" trait for this FO.
`int`	`traitBPDimensionMax(FOContext context, int parentAreaContentBPD)` Returns the "maximum" component of the "block-progression-dimension" for this FO.
`int`	`traitBPDimensionMin(FOContext context, int parentAreaContentBPD)` Returns the "minimum" component of the "block-progression-dimension" for this FO.
`int`	`traitBPDimensionOpt(FOContext context, int parentAreaContentBPD)` Returns the "optimum" component of the "block-progression-dimension" for this FO.
`byte`	`traitBPDirection(FOContext context)` Returns the "block-progression-direction" for this FO.
`short`	`traitBreakAfter(FOContext context)` Returns the "break-after" trait for this FO.
`short`	`traitBreakBefore(FOContext context)` Returns the "break-before" trait for this FO.
`short`	`traitCaptionSide(FOContext context)` Returns the "caption-side" trait for this FO.
`java.lang.String`	`traitCaseName(FOContext context)` Returns the "case-name" trait for this FO.
`java.lang.String`	`traitCaseTitle()` Returns the "case-title" trait for this FO.
`short`	`traitClear(FOContext context)` Returns the "clear" trait for this FO.
`Shape`	`traitClip(FOContext context)` Returns the "clip" trait for this FO.
`java.awt.Color`	`traitColor(FOContext context)` Returns the resolved "color" trait for this FO.
`java.lang.String`	`traitColorProfileName(FOContext context)` Returns the "color-profile-name" trait for this FO.
`int`	`traitColumnCount(FOContext context)` Returns the "column-count" trait for this FO.
`int`	`traitColumnGap(FOContext context)` Returns the "column-gap" trait for this FO.
`int`	`traitColumnWidth(FOContext context, int tableWidth)` Returns the "column-width" trait for this FO.
`java.lang.String`	`traitContentType(FOContext context)` Returns the "content-type" trait for this FO.
`java.lang.String`	`traitCountry(FOContext context)` Returns the "country" trait for this FO.
`java.lang.String`	`traitCueAfter(FOContext context)` Returns the "cue-after" trait for this FO.
`java.lang.String`	`traitCueBefore(FOContext context)` Returns the "cue-before" trait for this FO.
`int`	`traitDestinationPlacementOffset(FOContext context)` Returns the "destination-placement-offset" trait for this FO.
`short`	`traitDirection(FOContext context)` Returns the "direction" trait for this FO.
`short`	`traitDisplayAlign(FOContext context)` Returns the "display-align" trait for this FO.
`short`	`traitDominantBaseline(FOContext context)` Returns the resolved dominant baseline for this object.
`float`	`traitElevation(FOContext context)` Returns the "elevation" trait for this FO.
`short`	`traitEmptyCells(FOContext context)` Returns the "empty-cells" trait for this FO.
`int`	`traitEndIndent(FOContext context, int ipdContainingRA)` Returns the "end-indent" trait for this FO.
`boolean`	`traitEndsRow(FOContext context)` Returns the "ends-row" trait for this FO.
`int`	`traitExtent()` Returns the "extent" trait for this FO.
`java.lang.String`	`traitExternalDestination()` Returns the "external-destination" trait for this FO.
`short`	`traitFloat(FOContext context)` Returns the "float" trait for this FO.
`java.lang.String`	`traitFlowName()` Returns the "flow-name" trait for this FO.
`java.lang.String[]`	`traitFontFamily(FOContext context)` Returns the "font-family" trait for this FO.
`short`	`traitFontSelectionStrategy(FOContext context)` Returns the "font-selection-strategy" trait for this FO.
`int`	`traitFontSize(FOContext context)` Returns the "font-size" trait for this FO.
`int`	`traitFontSizeActual(FOContext context, int xHeight)` Returns the "actual" value for font-size, as distinguished from the "computed" value returned by #traitFontSize().
`double`	`traitFontSizeAdjust(FOContext context)` Retrieves the computed value for "font-size-adjust".
`short`	`traitFontStretch(FOContext context)` Returns the "font-stretch" trait for this FO.
`short`	`traitFontStyle(FOContext context)` Returns the "font-style" trait for this FO.
`short`	`traitFontVariant(FOContext context)` Returns the "font-variant" trait for this FO.
`short`	`traitFontWeight(FOContext context)` Returns a numerical value indicating the relative boldness of the font-family typeface that should be used.
`short`	`traitForcePageCount(FOContext context)` Returns the "force-page-count" trait for this FO.
`short`	`traitGlyphOrientationHorizontal(FOContext context)` Returns the "glyph-orientation-horizontal" trait for this FO.
`short`	`traitGlyphOrientationVertical(FOContext context)` Returns the "glyph-orientation-vertical" trait for this FO.
`short`	`traitHalfLeadingConditionality(FOContext context)` Returns the "conditionality" component of the "half-leading" trait for this FO.
`int`	`traitHalfLeadingMax(FOContext context)` Returns the "maximum" component of the "half-leading" trait for this FO.
`int`	`traitHalfLeadingMin(FOContext context)` Returns the "minimum" component of the "half-leading" trait for this FO.
`int`	`traitHalfLeadingOpt(FOContext context)` Returns the "optimum" component of the "half-leading" trait for this FO.
`int`	`traitHalfLeadingPrecedence(FOContext context)` Returns the "precedence" component of the "half-leading" trait for this FO.
`boolean`	`traitHyphenate(FOContext context)` Returns the "hyphenate" trait for this FO.
`int`	`traitHyphenationCharacter(FOContext context)` Returns the "hyphenation-character" trait for this FO.
`short`	`traitHyphenationKeep(FOContext context)` Returns the "hyphenation-keep" trait for this FO.
`int`	`traitHyphenationPushCharacterCount(FOContext context)` Returns the "hyphenation-push-character-count" trait for this FO.
`int`	`traitHyphenationRemainCharacterCount(FOContext context)` Returns the "hyphenation-remain-character-count" trait for this FO.
`int`	`traitHyphLadderCount(FOContext context)` Returns the "hyphenation-ladder-count" trait for this FO.
`java.lang.String`	`traitId()` Returns the "id" trait for this FO.
`boolean`	`traitIndicateDestination(FOContext context)` Returns the "indicate-destination" trait for this FO.
`int`	`traitInitialPageNumber(int lastPageNumberUsed)` Returns the "initial-page-number" trait for this FO.
`java.lang.String`	`traitInternalDestination()` Returns the "internal-destination" trait for this FO.
`int`	`traitIPDimensionMax(FOContext context, int parentAreaContentIPD)` Returns the "maximum" component of the "inline-progression-dimension" for this FO.
`int`	`traitIPDimensionMin(FOContext context, int parentAreaContentIPD)` Returns the "minimum" component of the "inline-progression-dimension" for this FO.
`int`	`traitIPDimensionOpt(FOContext context, int parentAreaContentIPD)` Returns the "optimum" component of the "inline-progression-dimension" for this FO.
`byte`	`traitIPDirectionEven(FOContext context)` Returns the "inline-progression-direction" for even-numbered lines for this FO.
`byte`	`traitIPDirectionOdd(FOContext context)` Returns the "inline-progression-direction" for odd-numbered lines for this FO.
`int`	`traitKeepTogetherWithinColumn(FOContext context)` Returns the "within-column" portion of the "keep-together" trait for this FO.
`int`	`traitKeepTogetherWithinLine(FOContext context)` Returns the "within-line" portion of the "keep-together" trait for this FO.
`int`	`traitKeepTogetherWithinPage(FOContext context)` Returns the "within-page" portion of the "keep-together" trait for this FO.
`int`	`traitKeepWithNextWithinColumn(FOContext context)` Returns the "within-column" portion of the "keep-with-next" trait for this FO.
`int`	`traitKeepWithNextWithinLine(FOContext context)` Returns the "within-line" portion of the "keep-with-next" trait for this FO.
`int`	`traitKeepWithNextWithinPage(FOContext context)` Returns the "within-page" portion of the "keep-with-next" trait for this FO.
`int`	`traitKeepWithPreviousWithinColumn(FOContext context)` Returns the "within-column" portion of the "keep-with-previous" trait for this FO.
`int`	`traitKeepWithPreviousWithinLine(FOContext context)` Returns the "within-line" portion of the "keep-with-previous" trait for this FO.
`int`	`traitKeepWithPreviousWithinPage(FOContext context)` Returns the "within-page" portion of the "keep-with-previous" trait for this FO.
`java.lang.String`	`traitLanguage(FOContext context)` Returns the "language" trait for this FO.
`int`	`traitLastLineEndIndent(FOContext context, int ipdAncestorBANotLA)` Returns the "last-line-end-indent" for this FO.
`short`	`traitLeaderAlignment(FOContext context)` Returns the value of the "leader-alignment" trait for this FO.
`int`	`traitLeaderLengthMax(FOContext context, int parentAreaContentIPD)` Returns the "maximum" component of the "leader-length" trait for this FO.
`int`	`traitLeaderLengthMin(FOContext context, int parentAreaContentIPD)` Returns the "minimum" component of the "leader-length" trait for this FO.
`int`	`traitLeaderLengthOpt(FOContext context, int parentAreaContentIPD)` Returns the "optimum" component of the "leader-length" trait for this FO.
`short`	`traitLeaderPattern(FOContext context)` Returns the "leader-pattern" trait for this FO.
`int`	`traitLeaderPatternWidth(FOContext context, int ipdParentContent)` Returns the value for the "leader-pattern-width" trait for this FO.
`int`	`traitLeft(FOContext context, int widthContainingBlock)` Returns the "left" trait for this FO.
`short`	`traitLetterSpacingConditionality()` Returns the "conditionality" component of the "letter-spacing" trait for this FO.
`int`	`traitLetterSpacingMax(FOContext context)` Returns the "maximum" component of the "letter-spacing" trait for this FO.
`int`	`traitLetterSpacingMin(FOContext context)` Returns the "minimum" component of the "letter-spacing" trait for this FO.
`int`	`traitLetterSpacingOpt(FOContext context)` Returns the "optimum" component of the "letter-spacing" trait for this FO.
`int`	`traitLetterSpacingPrecedence()` Returns the "precedence" component of the "letter-spacing" trait for this FO.
`short`	`traitLinefeedTreatment(FOContext context)` Returns the "linefeed-treatment" trait for this FO.
`short`	`traitLineHeightShiftAdjustment(FOContext context)` Returns the "line-height-shift-adjustment" trait for this FO.
`short`	`traitLineStackingStrategy(FOContext context)` Returns the "line-stacking-strategy" trait for this FO.
`short`	`traitMediaUsage(FOContext context)` Returns the "media-usage" trait for this FO.
`int`	`traitNumberColumnsRepeated()` Returns the "number-columns-repeated" trait for this FO.
`int`	`traitOrphans(FOContext context)` Returns the "orphans" trait for this FO.
`short`	`traitOverflow(FOContext context)` Returns the "overflow" trait for this FO.
`boolean`	`traitOverlineScore(FOContext context)` Returns the "overline-score" trait for this FO.
`java.awt.Color`	`traitOverlineScoreColor(FOContext context)` Returns the "overline-score-color" trait for this FO.
`int`	`traitPaddingAfter(FOContext context, boolean isLast)` Returns the "padding-after" trait for this FO.
`int`	`traitPaddingBefore(FOContext context, boolean isFirst)` Returns the "padding-before" trait for this FO.
`int`	`traitPaddingBottom(FOContext context)` Returns the "padding-bottom" trait for this FO.
`int`	`traitPaddingEnd(FOContext context, boolean isLast)` Returns the "padding-end" trait for this FO.
`int`	`traitPaddingLeft(FOContext context)` Returns the "padding-left" trait for this FO.
`int`	`traitPaddingRight(FOContext context)` Returns the "padding-right" trait for this FO.
`int`	`traitPaddingStart(FOContext context, boolean isFirst)` Returns the "padding-start" trait for this FO.
`int`	`traitPaddingTop(FOContext context)` Returns the "padding-top" trait for this FO.
`int`	`traitPageHeight()` Returns the "page-height" trait for this FO.
`int`	`traitPageWidth()` Returns the "page-width" trait for this FO.
`double`	`traitPauseAfter(FOContext context)` Returns the "pause-after" trait for this FO.
`double`	`traitPauseBefore(FOContext context)` Returns the "pause-before" trait for this FO.
`double`	`traitPitch(FOContext context, double mediumRange)` Returns the frequency for the audio for the current voice.
`double`	`traitPitchRange(FOContext context)` Returns the "pitch-range" trait for this FO.
`java.lang.String`	`traitPlayDuring(FOContext context)` Returns the "URL" component of the "play-during" trait for this FO.
`boolean`	`traitPlayDuringMix(FOContext context)` Returns the "mix" component of the "play-during" trait for this FO.
`boolean`	`traitPlayDuringRepeat(FOContext context)` Returns the "repeat" component of the "play-during" trait for this FO.
`int`	`traitProvisionalDistanceBetweenStarts(FOContext context, int ipdNearestBlockAreaNotLineArea)` Returns the "provisional-distance-between-starts" trait for this FO.
`int`	`traitProvisionalLabelSeparation(FOContext context, int ipdNearestBlockAreaNotLineArea)` Returns the "provisional-label-separation" trait for this FO.
`short`	`traitReferenceOrientation(FOContext context)` Returns the "reference-orientation" trait for this FO.
`java.lang.String`	`traitRefId(FOContext context)` Returns the "ref-id" trait for this FO.
`short`	`traitRelativeAlign(FOContext context)` Returns the "relative-align" trait for this FO.
`short`	`traitRelativePosition(FOContext context)` Returns the "relative-position" trait for this FO.
`short`	`traitRenderingIntent(FOContext context)` Returns the "rendering-intent" trait for this FO.
`double`	`traitRichness(FOContext context)` Returns the "richness" trait for this FO.
`int`	`traitRight(FOContext context, int widthContainingBlock)` Returns the "right" trait for this FO.
`java.lang.String`	`traitRole(FOContext context)` Returns the "role" trait for this FO.
`short`	`traitRuleStyle(FOContext context)` Returns the "rule-style" trait for this FO.
`int`	`traitRuleThickness(FOContext context)` Returns the "rule-thickness" trait for this FO.
`short`	`traitScaling(FOContext context)` Returns the "scaling" trait for this FO.
`short`	`traitScalingMethod(FOContext context)` Returns the "scaling-method" trait for this FO.
`boolean`	`traitScoreSpaces(FOContext context)` Returns the "score-spaces" trait for this FO.
`java.lang.String`	`traitScript(FOContext context)` Returns the "script" trait for this FO.
`byte`	`traitShiftDirectionEven(FOContext context)` Returns the "shift-direction" trait for even-numbered lines for this FO.
`byte`	`traitShiftDirectionOdd(FOContext context)` Returns the "shift-direction" trait for odd-numbered lines for this FO.
`short`	`traitShowDestination(FOContext context)` Returns the "show-destination" trait for this FO.
`java.lang.String[]`	`traitSourceDocument(FOContext context)` Returns the "source-document" trait for this FO.
`short`	`traitSpaceAfterConditionality(FOContext context)` Returns the "conditionality" component of the "space-after" trait for this FO.
`int`	`traitSpaceAfterMaximum(FOContext context)` Returns the "maximum" component of the "space-after" trait for this FO.
`int`	`traitSpaceAfterMinimum(FOContext context)` Returns the "minimum" component of the "space-after" trait for this FO.
`int`	`traitSpaceAfterOptimum(FOContext context)` Returns the "optimum" component of the "space-after" trait for this FO.
`int`	`traitSpaceAfterPrecedence()` Returns the "precedence" component of the "space-after" trait for this FO.
`short`	`traitSpaceBeforeConditionality(FOContext context)` Returns the "conditionality" component of the "space-before" trait for this FO.
`int`	`traitSpaceBeforeMaximum(FOContext context)` Returns the "maximum" component of the "space-before" trait for this FO.
`int`	`traitSpaceBeforeMinimum(FOContext context)` Returns the "minimum" component of the "space-before" trait for this FO.
`int`	`traitSpaceBeforeOptimum(FOContext context)` Returns the "optimum" component of the "space-before" trait for this FO.
`int`	`traitSpaceBeforePrecedence()` Returns the "precedence" component of the "space-before" trait for this FO.
`short`	`traitSpaceEndConditionality()` Returns the "conditionality" component of the "space-end" trait for this FO.
`int`	`traitSpaceEndMaximum(FOContext context, int ipdAncestorBlockArea)` Returns the "maximum" component of the "space-end" trait for this FO.
`int`	`traitSpaceEndMinimum(FOContext context, int ipdAncestorBlockArea)` Returns the "minimum" component of the "space-end" trait for this FO.
`int`	`traitSpaceEndOptimum(FOContext context, int ipdAncestorBlockArea)` Returns the "optimum" component of the "space-end" trait for this FO.
`int`	`traitSpaceEndPrecedence()` Returns the "precedence" component of the "space-end" trait for this FO.
`short`	`traitSpaceStartConditionality()` Returns the "conditionality" component of the "space-start" trait for this FO.
`int`	`traitSpaceStartMaximum(FOContext context, int ipdAncestorBlockArea)` Returns the "maximum" component of the "space-start" trait for this FO.
`int`	`traitSpaceStartMinimum(FOContext context, int ipdAncestorBlockArea)` Returns the "minimum" component of the "space-start" trait for this FO.
`int`	`traitSpaceStartOptimum(FOContext context, int ipdAncestorBlockArea)` Returns the "optimum" component of the "space-start" trait for this FO.
`int`	`traitSpaceStartPrecedence()` Returns the "precedence" component of the "space-start" trait for this FO.
`short`	`traitSpan(FOContext context)` Returns the "span" trait for this FO.
`short`	`traitSpeak(FOContext context)` Returns the "speak" trait for this FO.
`short`	`traitSpeakHeader(FOContext context)` Returns the "speak-header" trait for this FO.
`short`	`traitSpeakNumeral(FOContext context)` Returns the "speak-numeral" trait for this FO.
`short`	`traitSpeakPunctuation(FOContext context)` Returns the "speak-punctuation" trait for this FO.
`double`	`traitSpeechRate(FOContext context)` Returns the desired speech-rate, in words-per-minute.
`java.lang.String`	`traitSrc(FOContext context)` Returns the "src" trait for this FO.
`int`	`traitStartIndent(FOContext context, int ipdContainingRA)` Returns the "start-indent" trait for this FO.
`short`	`traitStartingState(FOContext context)` Returns the "starting-state" trait for this FO.
`boolean`	`traitStartsRow(FOContext context)` Returns the "starts-row" trait for this FO.
`double`	`traitStress(FOContext context)` Returns the "stress" trait for this FO.
`short`	`traitSuppressAtLineBreak(FOContext context)` Returns the "suppress-at-line-break" trait for this FO.
`short`	`traitSwitchTo()` Returns an enumerated value for the "switch-to" trait for this FO.
`java.lang.String[]`	`traitSwitchToNames()` Returns an array of names for the "switch-to" trait for this FO.
`short`	`traitTableLayout()` Returns the "table-layout" trait for this FO.
`boolean`	`traitTableOmitFooterAtBreak(FOContext context)` Returns the "table-omit-footer-at-break" trait for this FO.
`boolean`	`traitTableOmitHeaderAtBreak(FOContext context)` Returns the "table-omit-header-at-break" trait for this FO.
`java.lang.String`	`traitTargetPresentationContext()` Returns the "target-presentation-context" trait for this FO.
`java.lang.String`	`traitTargetProcessingContext()` Returns the "target-processing-context" trait for this FO.
`java.lang.String`	`traitTargetStylesheet()` Returns the "target-stylesheet" trait for this FO.
`short`	`traitTextAlign(FOContext context)` Returns the "text-align" trait for this FO.
`short`	`traitTextAlignLast(FOContext context)` Returns the "text-align-last" trait for this FO.
`java.lang.String`	`traitTextAlignString()` Returns the String value, if any, of the "text-align" trait for this FO.
`int`	`traitTextAltitude(FOContext context)` Returns the "text-altitude" trait for this FO.
`int`	`traitTextDepth(FOContext context)` Returns the "text-depth" trait for this FO.
`int`	`traitTextIndent(FOContext context, int widthContainingBlock)` Returns the "text-indent" trait for this FO.
`ShadowEffect`	`traitTextShadow(FOContext context)` Returns the "shadow-effect" trait for this FO.
`short`	`traitTextTransform(FOContext context)` Returns the "text-transform" trait for this FO.
`boolean`	`traitThroughScore(FOContext context)` Returns the "through-score" trait for this FO.
`java.awt.Color`	`traitThroughScoreColor(FOContext context)` Returns the "through-score-color" trait for this FO.
`int`	`traitTop(FOContext context, int heightContainingBlock)` Returns the "top" trait for this FO.
`boolean`	`traitTreatAsWordSpace(FOContext context, char character)` Returns the "treat-as-word-space" trait for this FO.
`boolean`	`traitUnderlineScore(FOContext context)` Returns the "underline-score" trait for this FO.
`java.awt.Color`	`traitUnderlineScoreColor(FOContext context)` Returns the "underline-score-color" trait for this FO.
`short`	`traitUnicodeBidi(FOContext context)` Returns the "unicode-bidi" trait for this FO.
`short`	`traitVisibility(FOContext context)` Returns the "visibility" trait for this FO.
`java.lang.String[]`	`traitVoiceFamily(FOContext context)` Returns the "voice-family" trait for this FO.
`double`	`traitVolume(FOContext context)` Returns the computed value for the "volume" property.
`boolean`	`traitWhiteSpaceCollapse(FOContext context)` Returns the "white-space-collapse" trait for this FO.
`short`	`traitWhiteSpaceTreatment(FOContext context)` Returns the "white-space-treatement" trait for this FO.
`int`	`traitWidows(FOContext context)` Returns the "widows" trait for this FO.
`short`	`traitWordSpacingConditionality()` Returns the "conditionality" component of the "word-spacing" trait for this FO.
`int`	`traitWordSpacingMax(FOContext context)` Returns the amount of additional space to create between letters.
`int`	`traitWordSpacingMin(FOContext context)` Returns the amount of additional space to create between letters.
`int`	`traitWordSpacingOpt(FOContext context)` Returns the amount of additional space to create between letters.
`int`	`traitWordSpacingPrecedence()` Returns the "precedence" component of the "word-spacing" trait for this FO.
`short`	`traitWrapOption(FOContext context)` Returns the "wrap-option" trait for this FO.
`int`	`traitZIndex(FOContext context)` Returns the "z-index" trait for this FO if it is not "auto".
`boolean`	`traitZIndexIsAuto(FOContext context)` Indicates whether the "z-index" trait for this FO is "auto".

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

isBlockLevelFO

public boolean isBlockLevelFO()

Only block-level objects are considered in an object's ancestry for certain computations. See the percentage values for the inline-progression-dimension and block-progression-dimension properties for examples.

Returns:: True if this is a block-level FO, false otherwise.

isRAGenerator

public boolean isRAGenerator()

Returns the value of the is-reference-area trait. XSL-FO 1.0 citations include: 4.1, 4.2.2, and 5.6.

Returns:: True if this object type generates reference areas, false otherwise.

getNearestTable

public Table getNearestTable(FOContext context)

Returns the nearest ancestor Table.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The nearest Table, if any, that is an ancestor of this node, or null if there is none.

getBasicLink

public BasicLink getBasicLink(FOContext context)

Returns the nearest ancestor BasicLink.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The nearest BasicLink, if any, that is an ancestor of this node, or null if there is none.

ancestorListRelatedObject

public FObj ancestorListRelatedObject(FOContext context)

Returns the nearest ancestor list-related object.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The nearest ancestor ListItemLabel or ListItemBody object, or null if there is none.

refIdNeeded

public java.lang.String refIdNeeded(FOContext context)

Returns the ref-id or idref property for this object.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "ref-id" trait (XSL-FO Standard 1.0, Section 7.28.5) or "idref" property type (Section 5.11) needed by this object, or null if no such trait is relevant to this FO.

getFontConsumer

public FontConsumer getFontConsumer()

Convenience method for obtaining the FontConsumer for this document.

Returns:: The FontConsumer for this document.

getMarginLeft

public int getMarginLeft(FOContext context,
                         int widthContainingBlock)

Returns the left margin of this object.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; widthContainingBlock - The width of the containing block.
Returns:: The left margin, in millipoints, of this object.

getMarginRight

public int getMarginRight(FOContext context,
                          int widthContainingBlock)

Returns the right margin of this object.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; widthContainingBlock - The width of the containing block.
Returns:: The right margin, in millipoints, of this object.

getMarginTop

public int getMarginTop(FOContext context,
                        int widthContainingBlock)

Returns the top margin of this object.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; widthContainingBlock - The width of the containing block.
Returns:: The top margin, in millipoints, of this object.

getMarginBottom

public int getMarginBottom(FOContext context,
                           int widthContainingBlock)

Returns the bottom margin of this object.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; widthContainingBlock - The width of the containing block.
Returns:: The bottom margin, in millipoints, of this object.

traitColor

public java.awt.Color traitColor(FOContext context)

Returns the resolved "color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The color of this object, or null if this object has no color.
See Also:: "XSL-FO Standard 1.0, Section 7.17.1"

traitWrapOption

public short traitWrapOption(FOContext context)

Returns the "wrap-option" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "wrap-option" trait for this object, one of Constants.FOVAL_WRAP, or Constants.FOVAL_NO_WRAP.
See Also:: "XSL-FO Standard 1.0, Section 7.15.13"

traitWhiteSpaceCollapse

public boolean traitWhiteSpaceCollapse(FOContext context)

Returns the "white-space-collapse" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "white-space-collapse" trait for this object.
See Also:: "XSL-FO Standard 1.0, Section 7.15.12"

traitUnderlineScore

public boolean traitUnderlineScore(FOContext context)

Returns the "underline-score" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: True iff the FO should be underlined.
See Also:: "XSL-FO Standard 1.0, Section 5.5.6", "XSL-FO Standard 1.0, Section 7.16.4"

traitOverlineScore

public boolean traitOverlineScore(FOContext context)

Returns the "overline-score" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: True iff the FO should be overlined.
See Also:: "XSL-FO Standard 1.0, Section 5.5.6", "XSL-FO Standard 1.0, Section 7.16.4"

traitThroughScore

public boolean traitThroughScore(FOContext context)

Returns the "through-score" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: True iff the FO should have a through-score (a line through the object).
See Also:: "XSL-FO Standard 1.0, Section 5.5.6", "XSL-FO Standard 1.0, Section 7.16.4"

traitUnderlineScoreColor

public java.awt.Color traitUnderlineScoreColor(FOContext context)

Returns the "underline-score-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The color that should be used to render the underline-score.
See Also:: "XSL-FO Standard 1.0, Section 5.5.6", "XSL-FO Standard 1.0, Section 7.16.4"

traitOverlineScoreColor

public java.awt.Color traitOverlineScoreColor(FOContext context)

Returns the "overline-score-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The color that should be used to render the overline-score.
See Also:: "XSL-FO Standard 1.0, Section 5.5.6", "XSL-FO Standard 1.0, Section 7.16.4"

traitThroughScoreColor

public java.awt.Color traitThroughScoreColor(FOContext context)

Returns the "through-score-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The color that should be used to render the through-score.
See Also:: "XSL-FO Standard 1.0, Section 5.5.6", "XSL-FO Standard 1.0, Section 7.16.4"

traitBlink

public boolean traitBlink(FOContext context)

Returns the "blink" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: True iff the FO should blink (on media that can blink).
See Also:: "XSL-FO Standard 1.0, Section 5.5.6", "XSL-FO Standard 1.0, Section 7.16.4"

traitId

public java.lang.String traitId()

Returns the "id" trait for this FO.

Returns:: The "id" for this FO, or null if it has none.
See Also:: "XSL-FO Standard 1.0, Section 7.28.2"

traitInternalDestination

public java.lang.String traitInternalDestination()

Returns the "internal-destination" trait for this FO.

Returns:: The "internal-destination" for this FO, or null if it has none.
See Also:: "XSL-FO Standard 1.0, Section 7.22.8"

traitExternalDestination

public java.lang.String traitExternalDestination()

Returns the "external-destination" trait for this FO.

Returns:: The "external-destination" for this FO, or null if it has none.
See Also:: "XSL-FO Standard 1.0, Section 7.22.6"

traitStartIndent

public int traitStartIndent(FOContext context,
                            int ipdContainingRA)

Returns the "start-indent" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdContainingRA - The inline-progression-dimension of the containing reference area, in millipoints. This is used when the property value is a percentage.
Returns:: The start-indent value, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.10.7"

traitSpan

public short traitSpan(FOContext context)

Returns the "span" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The effective span trait for this FO, one of Constants.FOVAL_ALL, or Constants.FOVAL_NONE. For FOs that are not block-level FOs, this will always return Constants.FOVAL_ALL.
See Also:: "XSL-FO Standard 1.1, Section 7.20.4"

traitFlowName

public java.lang.String traitFlowName()

Returns the "flow-name" trait for this FO.

Returns:: The "flow-name" trait for this FO.
See Also:: "XSL-FO Standard 1.1, Section 7.25.5"

traitBorderCollapse

public short traitBorderCollapse(FOContext context)

Returns the "border-collapse" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "border-collapse" trait for this FO, one of Constants.FOVAL_COLLAPSE, Constants.FOVAL_COLLAPSE_WITH_PRECEDENCE, or Constants.FOVAL_SEPARATE.
See Also:: "XSL-FO Standard 1.0, Section 7.26.3"

traitDisplayAlign

public short traitDisplayAlign(FOContext context)

Returns the "display-align" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "display-align" trait for this FO, one of Constants.FOVAL_AUTO, Constants.FOVAL_BEFORE, Constants.FOVAL_CENTER, Constants.FOVAL_AFTER.
See Also:: "XSL-FO Standard 1.0, Section 7.13.4"

traitRelativeAlign

public short traitRelativeAlign(FOContext context)

Returns the "relative-align" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "relative-align" trait for this FO, one of Constants.FOVAL_BEFORE, or Constants.FOVAL_BASELINE.
See Also:: "XSL-FO Standard 1.0, Section 7.13.6"

traitBorderSeparationIPD

public int traitBorderSeparationIPD(FOContext context)

Returns the IPD portion of the "border-separation" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The length, in millipoints, of the IPD portion of the "border-separation" trait for this FO.
See Also:: "XSL-FO Standard 1.0, Section 7.26.5"

traitBorderSeparationBPD

public int traitBorderSeparationBPD(FOContext context)

Returns the BPD portion of the "border-separation" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The length, in millipoints, of the BPD portion of the "border-separation" trait for this FO.
See Also:: "XSL-FO Standard 1.0, Section 7.26.5"

traitNumberColumnsRepeated

public int traitNumberColumnsRepeated()

Returns the "number-columns-repeated" trait for this FO.

Returns:: The "number-columns-repeated" trait for this FO.
See Also:: "XSL-FO Standard 1.0, Section 7.26.12"

traitColumnWidth

public int traitColumnWidth(FOContext context,
                            int tableWidth)

Returns the "column-width" trait for this FO. Caveat: This is the nominal width, which may differ from the resolved width in the AreaTree.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; tableWidth - The width, in millipoints, of the table in which this column exists.
Returns:: The nominal "column-width" for the column, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.26.9"

traitBreakAfter

public short traitBreakAfter(FOContext context)

Returns the "break-after" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "break-after" trait for this FO, one of Constants.FOVAL_AUTO, Constants.FOVAL_COLUMN, Constants.FOVAL_PAGE, Constants.FOVAL_EVEN_PAGE, or Constants.FOVAL_ODD_PAGE.
See Also:: "XSL-FO Standard 1.0, Section 7.19.1"

traitKeepTogetherWithinLine

public int traitKeepTogetherWithinLine(FOContext context)

Returns the "within-line" portion of the "keep-together" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "within-line" portion of the "keep-together" trait for this FO, ranging from zero ("auto") to Integer.MAX_VALUE (indicating "always"). Values between these extremes indicate the relative strength of competing keep conditions.
See Also:: "XSL-FO Standard 1.0, Section 7.19.3", "XSL-FO Standard 1.0, Section 4.8"

traitKeepTogetherWithinColumn

public int traitKeepTogetherWithinColumn(FOContext context)

Returns the "within-column" portion of the "keep-together" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "within-column" portion of the "keep-together" trait for this FO, ranging from zero ("auto") to Integer.MAX_VALUE (indicating "always"). Values between these extremes indicate the relative strength of competing keep conditions.
See Also:: "XSL-FO Standard 1.0, Section 7.19.3", "XSL-FO Standard 1.0, Section 4.8"

traitKeepTogetherWithinPage

public int traitKeepTogetherWithinPage(FOContext context)

Returns the "within-page" portion of the "keep-together" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "within-page" portion of the "keep-together" trait for this FO, ranging from zero ("auto") to Integer.MAX_VALUE (indicating "always"). Values between these extremes indicate the relative strength of competing keep conditions.
See Also:: "XSL-FO Standard 1.0, Section 7.19.3", "XSL-FO Standard 1.0, Section 4.8"

traitKeepWithNextWithinLine

public int traitKeepWithNextWithinLine(FOContext context)

Returns the "within-line" portion of the "keep-with-next" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "within-line" portion of the "keep-with-next" trait for this FO, ranging from zero ("auto") to Integer.MAX_VALUE (indicating "always"). Values between these extremes indicate the relative strength of competing keep conditions.
See Also:: "XSL-FO Standard 1.0, Section 7.19.4", "XSL-FO Standard 1.0, Section 4.8"

traitKeepWithNextWithinColumn

public int traitKeepWithNextWithinColumn(FOContext context)

Returns the "within-column" portion of the "keep-with-next" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "within-column" portion of the "keep-with-next" trait for this FO, ranging from zero ("auto") to Integer.MAX_VALUE (indicating "always"). Values between these extremes indicate the relative strength of competing keep conditions.
See Also:: "XSL-FO Standard 1.0, Section 7.19.4", "XSL-FO Standard 1.0, Section 4.8"

traitKeepWithNextWithinPage

public int traitKeepWithNextWithinPage(FOContext context)

Returns the "within-page" portion of the "keep-with-next" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "within-page" portion of the "keep-with-next" trait for this FO, ranging from zero ("auto") to Integer.MAX_VALUE (indicating "always"). Values between these extremes indicate the relative strength of competing keep conditions.
See Also:: "XSL-FO Standard 1.0, Section 7.19.4", "XSL-FO Standard 1.0, Section 4.8"

traitKeepWithPreviousWithinLine

public int traitKeepWithPreviousWithinLine(FOContext context)

Returns the "within-line" portion of the "keep-with-previous" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "within-line" portion of the "keep-with-previous" trait for this FO, ranging from zero ("auto") to Integer.MAX_VALUE (indicating "always"). Values between these extremes indicate the relative strength of competing keep conditions.
See Also:: "XSL-FO Standard 1.0, Section 7.19.5", "XSL-FO Standard 1.0, Section 4.8"

traitKeepWithPreviousWithinColumn

public int traitKeepWithPreviousWithinColumn(FOContext context)

Returns the "within-column" portion of the "keep-with-previous" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "within-column" portion of the "keep-with-previous" trait for this FO, ranging from zero ("auto") to Integer.MAX_VALUE (indicating "always"). Values between these extremes indicate the relative strength of competing keep conditions.
See Also:: "XSL-FO Standard 1.0, Section 7.19.5", "XSL-FO Standard 1.0, Section 4.8"

traitKeepWithPreviousWithinPage

public int traitKeepWithPreviousWithinPage(FOContext context)

Returns the "within-page" portion of the "keep-with-previous" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "within-page" portion of the "keep-with-previous" trait for this FO, ranging from zero ("auto") to Integer.MAX_VALUE (indicating "always"). Values between these extremes indicate the relative strength of competing keep conditions.
See Also:: "XSL-FO Standard 1.0, Section 7.19.5", "XSL-FO Standard 1.0, Section 4.8"

traitInitialPageNumber

public int traitInitialPageNumber(int lastPageNumberUsed)

Returns the "initial-page-number" trait for this FO.

Parameters:: lastPageNumberUsed - The page number of the last page of the previous page-sequence. If there is no previous page-sequence, this value should be set to zero.
Returns:: The resolved initial page number for this page-sequence.
See Also:: "XSL-FO Standard 1.0, Section 7.25.7"

initialPageNumberSetExplicitly

public boolean initialPageNumberSetExplicitly()

Indicates whether the page number was set with a specific integer.

Returns:: True iff a specific integer was used to set the initial page number, false if it is a computed value.
See Also:: traitInitialPageNumber(int)

traitForcePageCount

public short traitForcePageCount(FOContext context)

Returns the "force-page-count" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "force-page-count" trait for this FO, one of Constants.FOVAL_AUTO, Constants.FOVAL_EVEN, Constants.FOVAL_ODD, Constants.FOVAL_END_ON_EVEN, Constants.FOVAL_END_ON_ODD, or Constants.FOVAL_NO_FORCE.
See Also:: "XSL-FO Standard 1.0, Section 7.25.6"

traitExtent

public int traitExtent()

Returns the "extent" trait for this FO.

Returns:: The "extent" trait, in millipoints, for this FO.
See Also:: "XSL-FO Standard 1.0, Section 7.25.4"

traitColumnGap

public int traitColumnGap(FOContext context)

Returns the "column-gap" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "column-gap" trait, in millipoints, for this FO.
See Also:: "XSL-FO Standard 1.0, Section 7.25.3"

traitOverflow

public short traitOverflow(FOContext context)

Returns the "overflow" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "overflow" trait for this FO, one of Constants.FOVAL_VISIBLE, Constants.FOVAL_HIDDEN, Constants.FOVAL_SCROLL, Constants.FOVAL_ERROR_IF_OVERFLOW, or Constants.FOVAL_AUTO.
See Also:: "XSL-FO Standard 1.0, Section 7.20.2"

traitColumnCount

public int traitColumnCount(FOContext context)

Returns the "column-count" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "column-count" trait for this FO.
See Also:: "XSL-FO Standard 1.0, Section 7.25.2"

traitPageWidth

public int traitPageWidth()

Returns the "page-width" trait for this FO.

Returns:: The "page-width" trait, in millipoints, for this FO.
See Also:: "XSL-FO Standard 1.0, Section 7.25.15"

traitPageHeight

public int traitPageHeight()

Returns the "page-height" trait for this FO.

Returns:: The "page-height" trait, in millipoints, for this FO.
See Also:: "XSL-FO Standard 1.0, Section 7.25.13"

traitTextAlign

public short traitTextAlign(FOContext context)

Returns the "text-align" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "text-align" trait for this FO, one of Constants.FOVAL_START, Constants.FOVAL_CENTER, Constants.FOVAL_END, Constants.FOVAL_JUSTIFY, Constants.FOVAL_INSIDE, Constants.FOVAL_OUTSIDE, or Constants.FOVAL_NOT_A_KEYWORD. If Constants.FOVAL_NOT_A_KEYWORD is returned, this indicates that text should be aligned on a specific string, which string can be obtained from traitTextAlignString(). Note that input values of Constants.FOVAL_LEFT or Constants.FOVAL_RIGHT are converted to their writing-mode relative values.
See Also:: traitTextAlignString(), "XSL-FO Standard 1.0, Section 7.15.9", "XSL-FO Standard 1.0, Section 5.4.3"

traitTextAlignString

public java.lang.String traitTextAlignString()

Returns the String value, if any, of the "text-align" trait for this FO.

Returns:: The String value specified for the "text-align" trait for this FO. This will always be null unless the return value from traitTextAlign(FOContext) is Constants.FOVAL_NOT_A_KEYWORD
See Also:: traitTextAlign(FOContext)

traitTextAlignLast

public short traitTextAlignLast(FOContext context)

Returns the "text-align-last" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "text-align-last" trait for this FO, one of Constants.FOVAL_RELATIVE, Constants.FOVAL_START, Constants.FOVAL_CENTER, Constants.FOVAL_END, Constants.FOVAL_JUSTIFY, Constants.FOVAL_INSIDE, or Constants.FOVAL_OUTSIDE. Note that input value of Constants.FOVAL_LEFT is converted to Constants.FOVAL_START and Constants.FOVAL_RIGHT is converted to Constants.FOVAL_END.
See Also:: "XSL-FO Standard 1.0, Section 7.15.10", "XSL-FO Standard 1.0, Section 5.4.4"

traitEndIndent

public int traitEndIndent(FOContext context,
                          int ipdContainingRA)

Returns the "end-indent" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdContainingRA - The inline-progression-dimension of the containing reference area, in millipoints. This is used when the property value is a percentage.
Returns:: The end-indent value, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.10.8"

traitSpaceBeforeMinimum

public int traitSpaceBeforeMinimum(FOContext context)

Returns the "minimum" component of the "space-before" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "minimum" component of the "space-before" trait for this FO, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceBeforeOptimum

public int traitSpaceBeforeOptimum(FOContext context)

Returns the "optimum" component of the "space-before" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "optimum" component of the "space-before" trait for this FO, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceBeforeMaximum

public int traitSpaceBeforeMaximum(FOContext context)

Returns the "maximum" component of the "space-before" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "maximum" component of the "space-before" trait for this FO, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceBeforeConditionality

public short traitSpaceBeforeConditionality(FOContext context)

Returns the "conditionality" component of the "space-before" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The space-before conditionality, one of Constants.FOVAL_DISCARD or Constants.FOVAL_RETAIN.
See Also:: "XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceBeforePrecedence

public int traitSpaceBeforePrecedence()

Returns the "precedence" component of the "space-before" trait for this FO.

Returns:: The space-before precedence. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterMinimum

public int traitSpaceAfterMinimum(FOContext context)

Returns the "minimum" component of the "space-after" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "minimum" component of the "space-after" trait for this FO, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterOptimum

public int traitSpaceAfterOptimum(FOContext context)

Returns the "optimum" component of the "space-after" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "optimum" component of the "space-after" trait for this FO, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterMaximum

public int traitSpaceAfterMaximum(FOContext context)

Returns the "maximum" component of the "space-after" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "maximum" component of the "space-after" trait for this FO, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterConditionality

public short traitSpaceAfterConditionality(FOContext context)

Returns the "conditionality" component of the "space-after" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The space-after conditionality, one of Constants.FOVAL_DISCARD or Constants.FOVAL_RETAIN.
See Also:: "XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterPrecedence

public int traitSpaceAfterPrecedence()

Returns the "precedence" component of the "space-after" trait for this FO.

Returns:: The space-after precedence. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceStartMinimum

public int traitSpaceStartMinimum(FOContext context,
                                  int ipdAncestorBlockArea)

Returns the "minimum" component of the "space-start" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdAncestorBlockArea - The (content-rectangle) IPD of the nearest ancestor block area that is not a line area.
Returns:: The "minimum" component of the "space-start" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.11.2", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceStartOptimum

public int traitSpaceStartOptimum(FOContext context,
                                  int ipdAncestorBlockArea)

Returns the "optimum" component of the "space-start" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdAncestorBlockArea - The (content-rectangle) IPD of the nearest ancestor block area that is not a line area.
Returns:: The "optimum" component of the "space-start" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.11.2", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceStartMaximum

public int traitSpaceStartMaximum(FOContext context,
                                  int ipdAncestorBlockArea)

Returns the "maximum" component of the "space-start" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdAncestorBlockArea - The (content-rectangle) IPD of the nearest ancestor block area that is not a line area.
Returns:: The "maximum" component of the "space-start" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.11.2", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceStartConditionality

public short traitSpaceStartConditionality()

Returns the "conditionality" component of the "space-start" trait for this FO.

Returns:: The space-start conditionality, one of Constants.FOVAL_DISCARD or Constants.FOVAL_RETAIN.
See Also:: "XSL-FO Standard 1.0, Section 7.11.2", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceStartPrecedence

public int traitSpaceStartPrecedence()

Returns the "precedence" component of the "space-start" trait for this FO.

Returns:: The space-start precedence. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.11.2", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceEndMinimum

public int traitSpaceEndMinimum(FOContext context,
                                int ipdAncestorBlockArea)

Returns the "minimum" component of the "space-end" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdAncestorBlockArea - The (content-rectangle) IPD of the nearest ancestor block area that is not a line area.
Returns:: The "minimum" component of the "space-end" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.11.1", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceEndOptimum

public int traitSpaceEndOptimum(FOContext context,
                                int ipdAncestorBlockArea)

Returns the "optimum" component of the "space-end" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdAncestorBlockArea - The (content-rectangle) IPD of the nearest ancestor block area that is not a line area.
Returns:: The "optimum" component of the "space-end" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.11.1", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceEndMaximum

public int traitSpaceEndMaximum(FOContext context,
                                int ipdAncestorBlockArea)

Returns the "maximum" component of the "space-end" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdAncestorBlockArea - The (content-rectangle) IPD of the nearest ancestor block area that is not a line area.
Returns:: The "maximum" component of the "space-end" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.11.1", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceEndConditionality

public short traitSpaceEndConditionality()

Returns the "conditionality" component of the "space-end" trait for this FO.

Returns:: The space-end conditionality, one of Constants.FOVAL_DISCARD or Constants.FOVAL_RETAIN.
See Also:: "XSL-FO Standard 1.0, Section 7.11.1", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceEndPrecedence

public int traitSpaceEndPrecedence()

Returns the "precedence" component of the "space-end" trait for this FO.

Returns:: The space-end precedence. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.11.1", "XSL-FO Standard 1.0, Section 4.3"

traitTextIndent

public int traitTextIndent(FOContext context,
                           int widthContainingBlock)

Returns the "text-indent" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; widthContainingBlock - The width of the containing block. Used for percentage computations.
Returns:: The "text-indent" for this FO, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.15.11"

traitTop

public int traitTop(FOContext context,
                    int heightContainingBlock)

Returns the "top" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; heightContainingBlock - The height of the containing block, used in percentage computations.
Returns:: The specified offset from the top of the containing block's top edge to the generated area's content-rectangle's top edge, or Constants.ABSOLUTE_POSITION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.5.2"

traitBottom

public int traitBottom(FOContext context,
                       int heightContainingBlock)

Returns the "bottom" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; heightContainingBlock - The height of the containing block, used in percentage computations.
Returns:: The specified offset from the generated area's content-rectangle's bottom edge to the containing block's bottom edge, or Constants.ABSOLUTE_POSITION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.5.4"

traitLeft

public int traitLeft(FOContext context,
                     int widthContainingBlock)

Returns the "left" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; widthContainingBlock - The width of the containing block, used in percentage computations.
Returns:: The specified offset from the containing block's left edge to the generated area's content-rectangle's left edge, or Constants.ABSOLUTE_POSITION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.5.5"

traitRight

public int traitRight(FOContext context,
                      int widthContainingBlock)

Returns the "right" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; widthContainingBlock - The width of the containing block, used in percentage computations.
Returns:: The specified offset from the generated area's content-rectangle's left edge to the containing block's left edge, or Constants.ABSOLUTE_POSITION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.5.3"

traitSrc

public java.lang.String traitSrc(FOContext context)

Returns the "src" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "src" trait for this FO, or null if it has none.
See Also:: "XSL-FO Standard 1.0, Section 7.28.7"

traitBreakBefore

public short traitBreakBefore(FOContext context)

Returns the "break-before" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "break-before" trait for this FO, one of Constants.FOVAL_AUTO, Constants.FOVAL_COLUMN, Constants.FOVAL_PAGE, Constants.FOVAL_EVEN_PAGE, or Constants.FOVAL_ODD_PAGE.
See Also:: "XSL-FO Standard 1.0, Section 7.19.2"

traitScaling

public short traitScaling(FOContext context)

Returns the "scaling" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "scaling" trait, one of Constants.FOVAL_UNIFORM, or Constants.FOVAL_NON_UNIFORM.
See Also:: "XSL-FO Standard 1.0, Section 7.14.10"

traitLeaderPattern

public short traitLeaderPattern(FOContext context)

Returns the "leader-pattern" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The leader-pattern trait for this FO, one of Constants.FOVAL_SPACE, Constants.FOVAL_RULE, Constants.FOVAL_DOTS, or Constants.FOVAL_USE_CONTENT. It is tempting to force the value here to "space" if the specified value is "rule" and the effective value for rule-thickness is 0, either because it is specified as 0 or because rule-style="none". That may be a good thing for the client application to do, but it is deliberately not done here because it may result in a loss of information to the client application. In all cases, the specified value is returned here.
See Also:: "XSL-FO Standard 1.0, Section 7.21.2"

traitLeaderLengthMin

public int traitLeaderLengthMin(FOContext context,
                                int parentAreaContentIPD)

Returns the "minimum" component of the "leader-length" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; parentAreaContentIPD - The IPD of the content-rectangle of the parent area, per XSL-FO 1.0, Sec. 7.21.4. This value is needed for computations that are percent-based, but is ignored for others.
Returns:: The "minimum" component of the "leader-length", in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.21.4"

traitLeaderLengthOpt

public int traitLeaderLengthOpt(FOContext context,
                                int parentAreaContentIPD)

Returns the "optimum" component of the "leader-length" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; parentAreaContentIPD - The IPD of the content-rectangle of the parent area, per XSL-FO 1.0, Sec. 7.21.4. This value is needed for computations that are percent-based, but is ignored for others.
Returns:: The "optimum" component of the "leader-length", in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.21.4"

traitLeaderLengthMax

public int traitLeaderLengthMax(FOContext context,
                                int parentAreaContentIPD)

Returns the "maximum" component of the "leader-length" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; parentAreaContentIPD - The IPD of the content-rectangle of the parent area, per XSL-FO 1.0, Sec. 7.21.4. This value is needed for computations that are percent-based, but is ignored for others.
Returns:: The "maximum" component of the "leader-length", in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.21.4"

traitRuleThickness

public int traitRuleThickness(FOContext context)

Returns the "rule-thickness" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The length, in millipoints, of the thickness of the rule. In accordance with Section 7.21.5 of XSL-FO Standard 1.0, if the rule-style is "none", a zero is returned here regardless of the value specified in the FO document.
See Also:: "XSL-FO Standard 1.0, Section 7.21.6", "XSL-FO Standard 1.0, Section 7.21.5"

traitRuleStyle

public short traitRuleStyle(FOContext context)

Returns the "rule-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "rule-style", one of Constants.FOVAL_NONE, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, or Constants.FOVAL_RIDGE.
See Also:: "XSL-FO Standard 1.0, Section 7.21.5"

traitLeaderPatternWidth

public int traitLeaderPatternWidth(FOContext context,
                                   int ipdParentContent)

Returns the value for the "leader-pattern-width" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdParentContent - The inline-progression-dimension of the content rectangle of the parent area, usually a line-area.
Returns:: The length, in millipoints, between the start of each leader pattern cycle. For example, if the leader-pattern is "dots", each dot should be positioned this length apart from the previous one. Returns a -1 if the specified value is "use-font-metrics". Although this value can be computed in the FOTree for dot leaders, it cannot be computed for use-content leaders.
See Also:: "XSL-FO Standard 1.0, Section 7.21.3"

traitLeaderAlignment

public short traitLeaderAlignment(FOContext context)

Returns the value of the "leader-alignment" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "leader-alignment" trait, one of Constants.FOVAL_NONE, Constants.FOVAL_REFERENCE_AREA, or Constants.FOVAL_PAGE.
See Also:: "XSL-FO Standard 1.0, Section 7.21.1"

traitRefId

public java.lang.String traitRefId(FOContext context)

Returns the "ref-id" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "ref-id" trait, or null if this trait is not set.
See Also:: "XSL-FO Standard 1.0, Section 7.28.5"

traitTableLayout

public short traitTableLayout()

Returns the "table-layout" trait for this FO.

Returns:: The "table-layout" trait, one of Constants.FOVAL_AUTO, or Constants.FOVAL_FIXED.
See Also:: "XSL-FO Standard 1.0, Section 7.26.16"

traitTableOmitHeaderAtBreak

public boolean traitTableOmitHeaderAtBreak(FOContext context)

Returns the "table-omit-header-at-break" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "table-omit-header-at-break" trait. This specifies whether a table whose first area is not at the beginning of an area produced by the table should start with the content of the fo:table-header formatting object or not.
See Also:: "XSL-FO Standard 1.0, Section 7.26.18"

traitTableOmitFooterAtBreak

public boolean traitTableOmitFooterAtBreak(FOContext context)

Returns the "table-omit-footer-at-break" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "table-omit-footer-at-break" trait. This specifies whether a table whose last area is not at the end of an area produced by the table should end with the content of the fo:table-footer formatting object or not.
See Also:: "XSL-FO Standard 1.0, Section 7.26.17"

traitBPDimensionMax

public int traitBPDimensionMax(FOContext context,
                               int parentAreaContentBPD)

Returns the "maximum" component of the "block-progression-dimension" for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; parentAreaContentBPD - Per XSL-FO Std 1.0, Section 7.14.1, "the corresponding dimension of the closest area ancestor that was generated by a block-level formatting object." Used only when the block-progression-dimension is expressed as a percentage.
Returns:: The computed value, or Constants.DIMENSION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.14.1"

traitBPDimensionOpt

public int traitBPDimensionOpt(FOContext context,
                               int parentAreaContentBPD)

Returns the "optimum" component of the "block-progression-dimension" for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; parentAreaContentBPD - Per XSL-FO Std 1.0, Section 7.14.1, "the corresponding dimension of the closest area ancestor that was generated by a block-level formatting object." Used only when the block-progression-dimension is expressed as a percentage.
Returns:: The computed value, or Constants.DIMENSION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.14.1"

traitBPDimensionMin

public int traitBPDimensionMin(FOContext context,
                               int parentAreaContentBPD)

Returns the "minimum" component of the "block-progression-dimension" for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; parentAreaContentBPD - Per XSL-FO Std 1.0, Section 7.14.1, "the corresponding dimension of the closest area ancestor that was generated by a block-level formatting object." Used only when the block-progression-dimension is expressed as a percentage.
Returns:: The computed value, or Constants.DIMENSION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.14.1"

traitIPDimensionMax

public int traitIPDimensionMax(FOContext context,
                               int parentAreaContentIPD)

Returns the "maximum" component of the "inline-progression-dimension" for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; parentAreaContentIPD - Per XSL-FO Std 1.0, Section 7.14.5, "the corresponding dimension of the closest area ancestor that was generated by a block-level formatting object." Used only when the inline-progression-dimension is expressed as a percentage.
Returns:: The computed value, or Constants.DIMENSION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.14.5"

traitIPDimensionOpt

public int traitIPDimensionOpt(FOContext context,
                               int parentAreaContentIPD)

Returns the "optimum" component of the "inline-progression-dimension" for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; parentAreaContentIPD - Per XSL-FO Std 1.0, Section 7.14.5, "the corresponding dimension of the closest area ancestor that was generated by a block-level formatting object." Used only when the inline-progression-dimension is expressed as a percentage.
Returns:: The computed value, or Constants.DIMENSION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.14.5"

traitIPDimensionMin

public int traitIPDimensionMin(FOContext context,
                               int parentAreaContentIPD)

Returns the "minimum" component of the "inline-progression-dimension" for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; parentAreaContentIPD - Per XSL-FO Std 1.0, Section 7.14.5, "the corresponding dimension of the closest area ancestor that was generated by a block-level formatting object." Used only when the inline-progression-dimension is expressed as a percentage.
Returns:: The computed value, or Constants.DIMENSION_AUTO for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.14.5"

traitFontFamily

public java.lang.String[] traitFontFamily(FOContext context)

Returns the "font-family" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: An ordered array of "font-family" possibilities for this FO. This may include both "family-name" and "generic-family" items as specified in the standard.
See Also:: "XSL-FO Standard 1.0, Section 7.8.2"

traitFontStyle

public short traitFontStyle(FOContext context)

Returns the "font-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: One of Font.FONT_STYLE_NORMAL, Font.FONT_STYLE_ITALIC, Font.FONT_STYLE_OBLIQUE, or Font.FONT_STYLE_BACKSLANT.
See Also:: "XSL-FO Standard 1.0, Section 7.8.7"

traitFontWeight

public short traitFontWeight(FOContext context)

Returns a numerical value indicating the relative boldness of the font-family typeface that should be used.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: One of Font.FONT_WEIGHT_100 (lightest), Font.FONT_WEIGHT_200, Font.FONT_WEIGHT_300, Font.FONT_WEIGHT_400 (normal), Font.FONT_WEIGHT_500, Font.FONT_WEIGHT_600, Font.FONT_WEIGHT_700 (bold), Font.FONT_WEIGHT_800, or Font.FONT_WEIGHT_900 (boldest).
See Also:: "XSL-FO Standard 1.0, Section 7.8.9"

traitFontSize

public int traitFontSize(FOContext context)

Returns the "font-size" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "font-size", in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.8.4"

traitFontVariant

public short traitFontVariant(FOContext context)

Returns the "font-variant" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "font-variant" trait, one of Constants.FOVAL_NORMAL, or Constants.FOVAL_SMALL_CAPS.
See Also:: "XSL-FO Standard 1.0, Section 7.8.8"

traitFontStretch

public short traitFontStretch(FOContext context)

Returns the "font-stretch" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "font-stretch" trait, one of Constants.FOVAL_NORMAL, Constants.FOVAL_WIDER, Constants.FOVAL_NARROWER, Constants.FOVAL_ULTRA_CONDENSED, Constants.FOVAL_EXTRA_CONDENSED, Constants.FOVAL_CONDENSED, Constants.FOVAL_SEMI_CONDENSED, Constants.FOVAL_SEMI_EXPANDED, Constants.FOVAL_EXPANDED, Constants.FOVAL_EXTRA_EXPANDED, Constants.FOVAL_ULTRA_EXPANDED,
See Also:: "XSL-FO Standard 1.0, Section 7.8.5"

traitProvisionalDistanceBetweenStarts

public int traitProvisionalDistanceBetweenStarts(FOContext context,
                                                 int ipdNearestBlockAreaNotLineArea)

Returns the "provisional-distance-between-starts" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdNearestBlockAreaNotLineArea - The IPD of the nearest block area that is not a line area. This is used for percentage computations.
Returns:: The length, in millipoints, of the provisional distance between starts.
See Also:: "XSL-FO Standard 1.0, Section 7.28.4"

traitProvisionalLabelSeparation

public int traitProvisionalLabelSeparation(FOContext context,
                                           int ipdNearestBlockAreaNotLineArea)

Returns the "provisional-label-separation" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdNearestBlockAreaNotLineArea - The IPD of the nearest block area that is not a line area. This is used for percentage computations.
Returns:: The length, in millipoints, of the provisional label separation.
See Also:: "XSL-FO Standard 1.0, Section 7.28.3"

traitBorderBeforeColor

public java.awt.Color traitBorderBeforeColor(FOContext context)

Returns the "border-before-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-before-color.
See Also:: "XSL-FO Standard 1.0, Section 7.7.7"

traitBorderAfterColor

public java.awt.Color traitBorderAfterColor(FOContext context)

Returns the "border-after-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-after-color.
See Also:: "XSL-FO Standard 1.0, Section 7.7.10"

traitBorderStartColor

public java.awt.Color traitBorderStartColor(FOContext context)

Returns the "border-start-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-start-color.
See Also:: "XSL-FO Standard 1.0, Section 7.7.13"

traitBorderEndColor

public java.awt.Color traitBorderEndColor(FOContext context)

Returns the "border-end-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-end-color.
See Also:: "XSL-FO Standard 1.0, Section 7.7.16"

traitBorderLeftColor

public java.awt.Color traitBorderLeftColor(FOContext context)

Returns the "border-left-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-left-color.
See Also:: "XSL-FO Standard 1.0, Section 7.7.25"

traitBorderRightColor

public java.awt.Color traitBorderRightColor(FOContext context)

Returns the "border-right-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-right-color.
See Also:: "XSL-FO Standard 1.0, Section 7.7.28"

traitBorderTopColor

public java.awt.Color traitBorderTopColor(FOContext context)

Returns the "border-top-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-top-color.
See Also:: "XSL-FO Standard 1.0, Section 7.7.19"

traitBorderBottomColor

public java.awt.Color traitBorderBottomColor(FOContext context)

Returns the "border-bottom-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-bottom-color.
See Also:: "XSL-FO Standard 1.0, Section 7.7.22"

traitBorderBeforeStyle

public short traitBorderBeforeStyle(FOContext context)

Returns the "border-before-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-before-style, one of Constants.FOVAL_NONE, Constants.FOVAL_HIDDEN, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, Constants.FOVAL_RIDGE, Constants.FOVAL_INSET, Constants.FOVAL_OUTSET,
See Also:: "XSL-FO Standard 1.0, Section 7.7.8"

traitBorderAfterStyle

public short traitBorderAfterStyle(FOContext context)

Returns the "border-after-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-after-style, one of Constants.FOVAL_NONE, Constants.FOVAL_HIDDEN, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, Constants.FOVAL_RIDGE, Constants.FOVAL_INSET, Constants.FOVAL_OUTSET,
See Also:: "XSL-FO Standard 1.0, Section 7.7.11"

traitBorderStartStyle

public short traitBorderStartStyle(FOContext context)

Returns the "border-start-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-start-style, one of Constants.FOVAL_NONE, Constants.FOVAL_HIDDEN, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, Constants.FOVAL_RIDGE, Constants.FOVAL_INSET, Constants.FOVAL_OUTSET,
See Also:: "XSL-FO Standard 1.0, Section 7.7.14"

traitBorderEndStyle

public short traitBorderEndStyle(FOContext context)

Returns the "border-end-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-end-style, one of Constants.FOVAL_NONE, Constants.FOVAL_HIDDEN, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, Constants.FOVAL_RIDGE, Constants.FOVAL_INSET, Constants.FOVAL_OUTSET,
See Also:: "XSL-FO Standard 1.0, Section 7.7.17"

traitBorderLeftStyle

public short traitBorderLeftStyle(FOContext context)

Returns the "border-left-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-left-style, one of Constants.FOVAL_NONE, Constants.FOVAL_HIDDEN, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, Constants.FOVAL_RIDGE, Constants.FOVAL_INSET, Constants.FOVAL_OUTSET,
See Also:: "XSL-FO Standard 1.0, Section 7.7.26"

traitBorderRightStyle

public short traitBorderRightStyle(FOContext context)

Returns the "border-right-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-right-style, one of Constants.FOVAL_NONE, Constants.FOVAL_HIDDEN, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, Constants.FOVAL_RIDGE, Constants.FOVAL_INSET, Constants.FOVAL_OUTSET,
See Also:: "XSL-FO Standard 1.0, Section 7.7.29"

traitBorderTopStyle

public short traitBorderTopStyle(FOContext context)

Returns the "border-top-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-top-style, one of Constants.FOVAL_NONE, Constants.FOVAL_HIDDEN, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, Constants.FOVAL_RIDGE, Constants.FOVAL_INSET, Constants.FOVAL_OUTSET,
See Also:: "XSL-FO Standard 1.0, Section 7.7.20"

traitBorderBottomStyle

public short traitBorderBottomStyle(FOContext context)

Returns the "border-bottom-style" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The border-bottom-style, one of Constants.FOVAL_NONE, Constants.FOVAL_HIDDEN, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, Constants.FOVAL_RIDGE, Constants.FOVAL_INSET, Constants.FOVAL_OUTSET,
See Also:: "XSL-FO Standard 1.0, Section 7.7.23"

traitBorderBeforeWidth

public int traitBorderBeforeWidth(FOContext context,
                                  boolean isFirst)

Returns the "border-before-width" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; isFirst - Set to true if the area for which this border is computed "is-first" within the reference-area.
Returns:: The size, in millipoints, of the border-before-width trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.9"

traitBorderAfterWidth

public int traitBorderAfterWidth(FOContext context,
                                 boolean isLast)

Returns the "border-after-width" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; isLast - Set to true if the area for which this border is computed "is-last" within the reference-area.
Returns:: The size, in millipoints, of the border-after-width trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.12"

traitBorderStartWidth

public int traitBorderStartWidth(FOContext context,
                                 boolean isFirst)

Returns the "border-start-width" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; isFirst - Set to true if the area for which this border is computed "is-first" within the reference-area.
Returns:: The size, in millipoints, of the border-start-width trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.15"

traitBorderEndWidth

public int traitBorderEndWidth(FOContext context,
                               boolean isLast)

Returns the "border-end-width" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; isLast - Set to true if the area for which this border is computed "is-last" within the reference-area.
Returns:: The size, in millipoints, of the border-end-width trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.18"

traitBorderLeftWidth

public int traitBorderLeftWidth(FOContext context)

Returns the "border-left-width" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the border-left-width trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.27"

traitBorderRightWidth

public int traitBorderRightWidth(FOContext context)

Returns the "border-right-width" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the border-right-width trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.30"

traitBorderTopWidth

public int traitBorderTopWidth(FOContext context)

Returns the "border-top-width" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the border-top-width trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.21"

traitBorderBottomWidth

public int traitBorderBottomWidth(FOContext context)

Returns the "border-bottom-width" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the border-bottom-width trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.24"

traitPaddingBefore

public int traitPaddingBefore(FOContext context,
                              boolean isFirst)

Returns the "padding-before" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; isFirst - Set to true if the area for which this padding is computed "is-first" within the reference-area.
Returns:: The size, in millipoints, of the padding-before trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.31"

traitPaddingAfter

public int traitPaddingAfter(FOContext context,
                             boolean isLast)

Returns the "padding-after" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; isLast - Set to true if the area for which this padding is computed "is-last" within the reference-area.
Returns:: The size, in millipoints, of the padding-after trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.32"

traitPaddingStart

public int traitPaddingStart(FOContext context,
                             boolean isFirst)

Returns the "padding-start" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; isFirst - Set to true if the area for which this padding is computed "is-first" within the reference-area.
Returns:: The size, in millipoints, of the padding-start trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.33"

traitPaddingEnd

public int traitPaddingEnd(FOContext context,
                           boolean isLast)

Returns the "padding-end" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; isLast - Set to true if the area for which this padding is computed "is-last" within the reference-area.
Returns:: The size, in millipoints, of the padding-end trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.34"

traitPaddingLeft

public int traitPaddingLeft(FOContext context)

Returns the "padding-left" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the padding-left trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.37"

traitPaddingRight

public int traitPaddingRight(FOContext context)

Returns the "padding-right" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the padding-right trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.38"

traitPaddingTop

public int traitPaddingTop(FOContext context)

Returns the "padding-top" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the padding-top trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.35"

traitPaddingBottom

public int traitPaddingBottom(FOContext context)

Returns the "padding-bottom" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the padding-bottom trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.36"

traitBackgroundColor

public java.awt.Color traitBackgroundColor(FOContext context)

Returns the "background-color" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The background-color trait.
See Also:: "XSL-FO Standard 1.0, Section 7.7.2"

traitHyphenate

public boolean traitHyphenate(FOContext context)

Returns the "hyphenate" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The hyphenate trait.
See Also:: "XSL-FO Standard 1.0, Section 7.9.4"

traitHyphenationCharacter

public int traitHyphenationCharacter(FOContext context)

Returns the "hyphenation-character" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The hyphenation-character, as an unsigned 21-bit Unicode code point.
See Also:: "XSL-FO Standard 1.0, Section 7.9.5"

traitHyphenationPushCharacterCount

public int traitHyphenationPushCharacterCount(FOContext context)

Returns the "hyphenation-push-character-count" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The hyphenation-push-character-count trait.
See Also:: "XSL-FO Standard 1.0, Section 7.9.6"

traitHyphenationRemainCharacterCount

public int traitHyphenationRemainCharacterCount(FOContext context)

Returns the "hyphenation-remain-character-count" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The hyphenation-remain-character-count trait.
See Also:: "XSL-FO Standard 1.0, Section 7.9.7"

traitLanguage

public java.lang.String traitLanguage(FOContext context)

Returns the "language" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The language code if it is available, or "" for "none".
See Also:: "XSL-FO Standard 1.0, Section 7.9.2"

traitCountry

public java.lang.String traitCountry(FOContext context)

Returns the "country" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The country code if it is available, or "" for "none".
See Also:: "XSL-FO Standard 1.0, Section 7.9.1"

traitBackgroundImage

public Graphic traitBackgroundImage(FOContext context)

Returns the "background-image" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The resolved background image for this FO, or null if none was specified or if the one specified cannot be resolved.
See Also:: "XSL-FO Standard 1.0, Section 7.7.3"

traitBackgroundRepeat

public short traitBackgroundRepeat(FOContext context)

Returns the "background-repeat" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The background-repeat trait, one of Constants.FOVAL_REPEAT, Constants.FOVAL_REPEAT_X, Constants.FOVAL_REPEAT_Y, or Constants.FOVAL_NO_REPEAT.
See Also:: "XSL-FO Standard 1.0, Section 7.7.4"

traitSourceDocument

public java.lang.String[] traitSourceDocument(FOContext context)

Returns the "source-document" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The source-document trait, or null if it is "none".
See Also:: "XSL-FO Standard 1.0, Section 7.4.1"

traitRole

public java.lang.String traitRole(FOContext context)

Returns the "role" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The role trait, or null if it is "none". Note that the return value can be either a <string> or a <uri-specification> This method makes no distinction between the two. It is the responsibility of the client application to determine which is actually returned, and to act accordingly.
See Also:: "XSL-FO Standard 1.0, Section 7.4.2"

traitTextAltitude

public int traitTextAltitude(FOContext context)

Returns the "text-altitude" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The text-altitude trait, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.27.4"

traitTextDepth

public int traitTextDepth(FOContext context)

Returns the "text-depth" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The text-depth trait, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.27.5"

traitHalfLeadingMin

public int traitHalfLeadingMin(FOContext context)

Returns the "minimum" component of the "half-leading" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The minimum half-leading value. The half-leading trait is controlled by the line-height, text-altitude, and text-depth properties.
See Also:: "XSL-FO Standard 1.0, Section 4.5", "XSL-FO Standard 1.0, Section 6.5.2", "XSL-FO Standard 1.0, Section 7.15.4"

traitHalfLeadingOpt

public int traitHalfLeadingOpt(FOContext context)

Returns the "optimum" component of the "half-leading" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The optimum half-leading value. The half-leading trait is controlled by the line-height, text-altitude, and text-depth properties.
See Also:: "XSL-FO Standard 1.0, Section 4.5", "XSL-FO Standard 1.0, Section 6.5.2", "XSL-FO Standard 1.0, Section 7.15.4"

traitHalfLeadingMax

public int traitHalfLeadingMax(FOContext context)

Returns the "maximum" component of the "half-leading" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The maximum half-leading value. The half-leading trait is controlled by the line-height, text-altitude, and text-depth properties.
See Also:: "XSL-FO Standard 1.0, Section 4.5", "XSL-FO Standard 1.0, Section 6.5.2", "XSL-FO Standard 1.0, Section 7.15.4"

traitHalfLeadingConditionality

public short traitHalfLeadingConditionality(FOContext context)

Returns the "conditionality" component of the "half-leading" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The half-leading conditionality, one of Constants.FOVAL_DISCARD or Constants.FOVAL_RETAIN. The half-leading trait is controlled by the line-height, text-altitude, and text-depth properties.
See Also:: "XSL-FO Standard 1.0, Section 4.5", "XSL-FO Standard 1.0, Section 6.5.2", "XSL-FO Standard 1.0, Section 7.15.4"

traitHalfLeadingPrecedence

public int traitHalfLeadingPrecedence(FOContext context)

Returns the "precedence" component of the "half-leading" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The space-end precedence. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE. The half-leading trait is controlled by the line-height, text-altitude, and text-depth properties.
See Also:: "XSL-FO Standard 1.0, Section 4.5", "XSL-FO Standard 1.0, Section 6.5.2", "XSL-FO Standard 1.0, Section 7.15.4"

traitIPDirectionOdd

public byte traitIPDirectionOdd(FOContext context)

Returns the "inline-progression-direction" for odd-numbered lines for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: One of Constants.DIRECTION_TOP_TO_BOTTOM, Constants.DIRECTION_BOTTOM_TO_TOP, Constants.DIRECTION_LEFT_TO_RIGHT, or Constants.DIRECTION_RIGHT_TO_LEFT, depending on the writing-mode.
See Also:: traitIPDirectionEven(FOContext), "XSL-FO Standard 1.0, Section 4.1", "XSL-FO Standard 1.0, Section 4.2.2", "XSL-FO Standard 1.0, Section 5.5.3"

traitIPDirectionEven

public byte traitIPDirectionEven(FOContext context)

Returns the "inline-progression-direction" for even-numbered lines for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: One of Constants.DIRECTION_TOP_TO_BOTTOM, Constants.DIRECTION_BOTTOM_TO_TOP, Constants.DIRECTION_LEFT_TO_RIGHT, or Constants.DIRECTION_RIGHT_TO_LEFT, depending on the writing-mode.
See Also:: traitIPDirectionOdd(FOContext), "XSL-FO Standard 1.0, Section 4.1", "XSL-FO Standard 1.0, Section 4.2.2", "XSL-FO Standard 1.0, Section 5.5.3"

traitBPDirection

public byte traitBPDirection(FOContext context)

Returns the "block-progression-direction" for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: One of Constants.DIRECTION_TOP_TO_BOTTOM, Constants.DIRECTION_BOTTOM_TO_TOP, Constants.DIRECTION_LEFT_TO_RIGHT, or Constants.DIRECTION_RIGHT_TO_LEFT, depending on the writing-mode.
See Also:: "XSL-FO Standard 1.0, Section 4.1", "XSL-FO Standard 1.0, Section 4.2.2", "XSL-FO Standard 1.0, Section 5.5.3"

traitShiftDirectionOdd

public byte traitShiftDirectionOdd(FOContext context)

Returns the "shift-direction" trait for odd-numbered lines for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: One of Constants.DIRECTION_TOP_TO_BOTTOM, Constants.DIRECTION_BOTTOM_TO_TOP, Constants.DIRECTION_LEFT_TO_RIGHT, or Constants.DIRECTION_RIGHT_TO_LEFT, depending on the writing-mode.
See Also:: traitShiftDirectionEven(FOContext), "XSL-FO Standard 1.0, Section 1.2.5", "XSL-FO Standard 1.0, Section 4.1", "XSL-FO Standard 1.0, Section 4.2.2", "XSL-FO Standard 1.0, Section 5.5.3"

traitShiftDirectionEven

public byte traitShiftDirectionEven(FOContext context)

Returns the "shift-direction" trait for even-numbered lines for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: One of Constants.DIRECTION_TOP_TO_BOTTOM, Constants.DIRECTION_BOTTOM_TO_TOP, Constants.DIRECTION_LEFT_TO_RIGHT, or Constants.DIRECTION_RIGHT_TO_LEFT, depending on the writing-mode.
See Also:: traitShiftDirectionOdd(FOContext), "XSL-FO Standard 1.0, Section 1.2.5", "XSL-FO Standard 1.0, Section 4.1", "XSL-FO Standard 1.0, Section 4.2.2", "XSL-FO Standard 1.0, Section 5.5.3"

traitAlignmentBaseline

public short traitAlignmentBaseline(FOContext context)

Returns the "alignment-baseline" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The alignment-baseline-trait, one of Constants.FOVAL_AUTO, Constants.FOVAL_BASELINE, Constants.FOVAL_BEFORE_EDGE, Constants.FOVAL_TEXT_BEFORE_EDGE, Constants.FOVAL_MIDDLE, Constants.FOVAL_CENTRAL, Constants.FOVAL_AFTER_EDGE, Constants.FOVAL_TEXT_AFTER_EDGE, Constants.FOVAL_IDEOGRAPHIC, Constants.FOVAL_ALPHABETIC, Constants.FOVAL_HANGING, or Constants.FOVAL_MATHEMATICAL.
See Also:: "XSL-FO Standard 1.0, Section 7.13.2"

traitAlignmentAdjust

public short traitAlignmentAdjust(FOContext context)

Returns the keyword component of the "alignment-adjust" trait for this FO. The alignment-adjust can be either a keyword value or a length. Client applications should consult this method first, to see if the return value is a keyword. If so, then that keyword contains all of the information needed. If the value is Constants.FOVAL_NOT_A_KEYWORD, then the method traitAlignmentAdjustAmount(FOContext, int) should be consulted to get the length.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The keyword component of alignment-adjust, one of Constants.FOVAL_AUTO, Constants.FOVAL_BASELINE, Constants.FOVAL_BEFORE_EDGE, Constants.FOVAL_TEXT_BEFORE_EDGE, Constants.FOVAL_MIDDLE, Constants.FOVAL_CENTRAL, Constants.FOVAL_AFTER_EDGE, Constants.FOVAL_TEXT_AFTER_EDGE, Constants.FOVAL_IDEOGRAPHIC, Constants.FOVAL_ALPHABETIC, Constants.FOVAL_HANGING, Constants.FOVAL_MATHEMATICAL, or Constants.FOVAL_NOT_A_KEYWORD.
See Also:: "XSL-FO Standard 1.0, Section 7.13.1", traitAlignmentAdjustAmount(FOContext, int)

traitAlignmentAdjustAmount

public int traitAlignmentAdjustAmount(FOContext context,
                                      int areaHeight)

Returns the length component, if any, of the "alignment-adjust" trait for this FO.

Note that this method returns zero unless a length was specified. The method traitAlignmentAdjust(FOContext) should be consulted before this method, to ensure that a lenth was specified.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; areaHeight - If the area is generated by an fo:external-graphic or fo:instream-foreign-object, this value should be the the area's computed "height". If the area was generated by an fo:character, this value is the "font-size". If neither of these is true, this value is the "line-height".
Returns:: The length, in millipoints, of the alignment-adjust, if the value is a length, or zero otherwise.
See Also:: "XSL-FO Standard 1.0, Section 7.13.1", traitAlignmentAdjust(FOContext)

traitBaselineShift

public int traitBaselineShift(FOContext context)

Returns the "baseline-shift" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The baseline-shift, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.13.3"

traitDominantBaseline

public short traitDominantBaseline(FOContext context)

Returns the resolved dominant baseline for this object.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: One of Constants.BASELINE_ALPHABETIC, Constants.BASELINE_IDEOGRAPHIC, Constants.BASELINE_HANGING, Constants.BASELINE_MATHEMATICAL, Constants.BASELINE_CENTRAL, Constants.BASELINE_MIDDLE, Constants.BASELINE_TEXT_BEFORE_EDGE, or Constants.BASELINE_TEXT_AFTER_EDGE.
See Also:: "XSL-FO Standard 1.0, Section 7.13.5"

traitLastLineEndIndent

public int traitLastLineEndIndent(FOContext context,
                                  int ipdAncestorBANotLA)

Returns the "last-line-end-indent" for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; ipdAncestorBANotLA - The inline-progression-dimension of the ancestor block area that is not a line area.
Returns:: The length, in millipoints, of the last-line-end-indent.
See Also:: "XSL-FO Standard 1.0, Section 7.15.3"

traitLetterSpacingMin

public int traitLetterSpacingMin(FOContext context)

Returns the "minimum" component of the "letter-spacing" trait for this FO. This is additional space to create between letters, and does not include the spacing intrinsic to the font.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the letter-spacing.minimum trait.
See Also:: "XSL-FO Standard 1.0, Section 7.16.2"

traitLetterSpacingOpt

public int traitLetterSpacingOpt(FOContext context)

Returns the "optimum" component of the "letter-spacing" trait for this FO. This is additional space to create between letters, and does not include the spacing intrinsic to the font.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the letter-spacing.optimum trait.
See Also:: "XSL-FO Standard 1.0, Section 7.16.2"

traitLetterSpacingMax

public int traitLetterSpacingMax(FOContext context)

Returns the "maximum" component of the "letter-spacing" trait for this FO. This is additional space to create between letters, and does not include the spacing intrinsic to the font.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the letter-spacing.maximum trait.
See Also:: "XSL-FO Standard 1.0, Section 7.16.2"

traitLetterSpacingConditionality

public short traitLetterSpacingConditionality()

Returns the "conditionality" component of the "letter-spacing" trait for this FO.

Returns:: The letter-spacing conditionality, one of Constants.FOVAL_DISCARD or Constants.FOVAL_RETAIN.
See Also:: "XSL-FO Standard 1.0, Section 7.16.2"

traitLetterSpacingPrecedence

public int traitLetterSpacingPrecedence()

Returns the "precedence" component of the "letter-spacing" trait for this FO.

Returns:: The letter-spacing precedence. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.16.2"

traitOrphans

public int traitOrphans(FOContext context)

Returns the "orphans" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "orphans" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.19.6"

traitWidows

public int traitWidows(FOContext context)

Returns the "widows" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "widows" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.19.7"

traitIndicateDestination

public boolean traitIndicateDestination(FOContext context)

Returns the "indicate-destination" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "indicate-destination" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.22.7"

traitAutoRestore

public boolean traitAutoRestore(FOContext context)

Returns the "auto-restore" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "auto-restore" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.22.2"

traitEndsRow

public boolean traitEndsRow(FOContext context)

Returns the "ends-row" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "ends-row" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.26.11"

traitStartsRow

public boolean traitStartsRow(FOContext context)

Returns the "starts-row" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "starts-row" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.26.15"

traitScoreSpaces

public boolean traitScoreSpaces(FOContext context)

Returns the "score-spaces" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "score-spaces" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.28.6"

traitTreatAsWordSpace

public boolean traitTreatAsWordSpace(FOContext context,
                                     char character)

Returns the "treat-as-word-space" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; character - The character which should be evaluated for purposes of an "auto" setting.
Returns:: The "treat-as-word-space" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.16.7"

traitColorProfileName

public java.lang.String traitColorProfileName(FOContext context)

Returns the "color-profile-name" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "color-profile-name" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.17.2"

traitCaseName

public java.lang.String traitCaseName(FOContext context)

Returns the "case-name" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "case-name" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.22.3"

traitContentType

public java.lang.String traitContentType(FOContext context)

Returns the "content-type" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "content-type" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.28.1"

traitAbsolutePosition

public short traitAbsolutePosition(FOContext context)

Returns the "absolute-position" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "absolute-position" trait, one of Constants.FOVAL_AUTO, Constants.FOVAL_ABSOLUTE, or Constants.FOVAL_FIXED.
See Also:: "XSL-FO Standard 1.0, Section 7.5.1"

traitBackgroundAttachment

public short traitBackgroundAttachment(FOContext context)

Returns the "background-attachment" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "background-attachment" trait, one of Constants.FOVAL_SCROLL, or Constants.FOVAL_FIXED.
See Also:: "XSL-FO Standard 1.0, Section 7.7.1"

traitCaptionSide

public short traitCaptionSide(FOContext context)

Returns the "caption-side" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "caption-side" trait, one of Constants.FOVAL_BEFORE, Constants.FOVAL_AFTER, Constants.FOVAL_START, Constants.FOVAL_END, Constants.FOVAL_TOP, Constants.FOVAL_BOTTOM, Constants.FOVAL_LEFT, or Constants.FOVAL_RIGHT.
See Also:: "XSL-FO Standard 1.0, Section 7.26.7"

traitDirection

public short traitDirection(FOContext context)

Returns the "direction" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "direction" trait, one of Constants.FOVAL_LTR, or Constants.FOVAL_RTL.
See Also:: "XSL-FO Standard 1.0, Section 7.27.1"

traitFontSelectionStrategy

public short traitFontSelectionStrategy(FOContext context)

Returns the "font-selection-strategy" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "font-selection-strategy" trait, one of Constants.FOVAL_AUTO, or Constants.FOVAL_CHARACTER_BY_CHARACTER.
See Also:: "XSL-FO Standard 1.0, Section 7.8.3"

traitHyphenationKeep

public short traitHyphenationKeep(FOContext context)

Returns the "hyphenation-keep" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "hyphenation-keep" trait, one of Constants.FOVAL_AUTO, Constants.FOVAL_COLUMN, or Constants.FOVAL_PAGE.
See Also:: "XSL-FO Standard 1.0, Section 7.15.1"

traitLinefeedTreatment

public short traitLinefeedTreatment(FOContext context)

Returns the "linefeed-treatment" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "linefeed-treatment" trait, one of Constants.FOVAL_IGNORE, Constants.FOVAL_PRESERVE, Constants.FOVAL_TREAT_AS_SPACE, or Constants.FOVAL_TREAT_AS_ZERO_WIDTH_SPACE.
See Also:: "XSL-FO Standard 1.0, Section 7.15.7"

traitLineHeightShiftAdjustment

public short traitLineHeightShiftAdjustment(FOContext context)

Returns the "line-height-shift-adjustment" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "line-height-shift-adjustment" trait, one of Constants.FOVAL_CONSIDER_SHIFTS, or Constants.FOVAL_DISREGARD_SHIFTS.
See Also:: "XSL-FO Standard 1.0, Section 7.15.5"

traitLineStackingStrategy

public short traitLineStackingStrategy(FOContext context)

Returns the "line-stacking-strategy" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "line-stacking-strategy" trait, one of Constants.FOVAL_LINE_HEIGHT, Constants.FOVAL_FONT_HEIGHT, or Constants.FOVAL_MAX_HEIGHT.
See Also:: "XSL-FO Standard 1.0, Section 7.15.6"

traitRelativePosition

public short traitRelativePosition(FOContext context)

Returns the "relative-position" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "relative-position" trait, one of Constants.FOVAL_STATIC, or Constants.FOVAL_RELATIVE.
See Also:: "XSL-FO Standard 1.0, Section 7.12.1"

traitScalingMethod

public short traitScalingMethod(FOContext context)

Returns the "scaling-method" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "scaling-method" trait, one of Constants.FOVAL_AUTO, Constants.FOVAL_INTEGER_PIXELS, or Constants.FOVAL_RESAMPLE_ANY_METHOD.
See Also:: "XSL-FO Standard 1.0, Section 7.14.11"

traitSuppressAtLineBreak

public short traitSuppressAtLineBreak(FOContext context)

Returns the "suppress-at-line-break" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "suppress-at-line-break" trait, one of Constants.FOVAL_AUTO, Constants.FOVAL_SUPPRESS, or Constants.FOVAL_RETAIN.
See Also:: "XSL-FO Standard 1.0, Section 7.16.3"

traitUnicodeBidi

public short traitUnicodeBidi(FOContext context)

Returns the "unicode-bidi" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "unicode-bidi" trait, one of Constants.FOVAL_NORMAL, Constants.FOVAL_EMBED, or Constants.FOVAL_BIDI_OVERRIDE.
See Also:: "XSL-FO Standard 1.0, Section 7.27.6"

traitWhiteSpaceTreatment

public short traitWhiteSpaceTreatment(FOContext context)

Returns the "white-space-treatement" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "white-space-treatment" trait, one of Constants.FOVAL_IGNORE, Constants.FOVAL_PRESERVE, Constants.FOVAL_IGNORE_IF_BEFORE_LINEFEED, Constants.FOVAL_IGNORE_IF_AFTER_LINEFEED, or Constants.FOVAL_IGNORE_IF_SURROUNDING_LINEFEED.
See Also:: "XSL-FO Standard 1.0, Section 7.15.8"

traitCaseTitle

public java.lang.String traitCaseTitle()

Returns the "case-title" trait for this FO.

Returns:: The "case-title" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.22.4"

traitActiveState

public short traitActiveState(FOContext context)

Returns the "active-state" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "active-state" trait, one of Constants.FOVAL_LINK, Constants.FOVAL_VISITED, Constants.FOVAL_ACTIVE, Constants.FOVAL_HOVER, or Constants.FOVAL_FOCUS.
See Also:: "XSL-FO Standard 1.0, Section 7.22.1"

traitClear

public short traitClear(FOContext context)

Returns the "clear" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "clear" trait, one of Constants.FOVAL_START, Constants.FOVAL_END, Constants.FOVAL_BOTH, or Constants.FOVAL_NONE.
See Also:: "XSL-FO Standard 1.0, Section 7.18.1"

traitEmptyCells

public short traitEmptyCells(FOContext context)

Returns the "empty-cells" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "empty-cells" trait, one of Constants.FOVAL_SHOW, or Constants.FOVAL_HIDE.
See Also:: "XSL-FO Standard 1.0, Section 7.26.10"

traitFloat

public short traitFloat(FOContext context)

Returns the "float" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "float" trait, one of Constants.FOVAL_BEFORE, Constants.FOVAL_START, Constants.FOVAL_END, or Constants.FOVAL_NONE.
See Also:: "XSL-FO Standard 1.0, Section 7.18.2"

traitMediaUsage

public short traitMediaUsage(FOContext context)

Returns the "media-usage" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "media-usage" trait, one of Constants.FOVAL_AUTO, Constants.FOVAL_PAGINATE, Constants.FOVAL_BOUNDED_IN_ONE_DIMENSION, or Constants.FOVAL_UNBOUNDED.
See Also:: "XSL-FO Standard 1.0, Section 7.25.11"

traitReferenceOrientation

public short traitReferenceOrientation(FOContext context)

Returns the "reference-orientation" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "reference-orientation" trait, one of Constants.FOVAL_NUM_ZERO, Constants.FOVAL_NUM_90, Constants.FOVAL_NUM_180, Constants.FOVAL_NUM_270, Constants.FOVAL_NUM_NEGATIVE_90, Constants.FOVAL_NUM_NEGATIVE_180, or Constants.FOVAL_NUM_NEGATIVE_270.
See Also:: "XSL-FO Standard 1.0, Section 7.20.3"

traitRenderingIntent

public short traitRenderingIntent(FOContext context)

Returns the "rendering-intent" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "rendering-intent" trait, one of Constants.FOVAL_AUTO, Constants.FOVAL_PERCEPTUAL, Constants.FOVAL_RELATIVE_COLORIMETRIC, Constants.FOVAL_SATURATION, or Constants.FOVAL_ABSOLUTE_COLORIMETRIC.
See Also:: "XSL-FO Standard 1.0, Section 7.17.3"

traitShowDestination

public short traitShowDestination(FOContext context)

Returns the "show-destination" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "show-destination" trait, one of Constants.FOVAL_REPLACE, or Constants.FOVAL_NEW.
See Also:: "XSL-FO Standard 1.0, Section 7.22.9"

traitSpeakHeader

public short traitSpeakHeader(FOContext context)

Returns the "speak-header" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "speak-header" trait, one of Constants.FOVAL_ONCE, or Constants.FOVAL_ALWAYS.
See Also:: "XSL-FO Standard 1.0, Section 7.6.12"

traitSpeak

public short traitSpeak(FOContext context)

Returns the "speak" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "speak" trait, one of Constants.FOVAL_NORMAL, Constants.FOVAL_NONE, or Constants.FOVAL_SPELL_OUT.
See Also:: "XSL-FO Standard 1.0, Section 7.6.11"

traitSpeakNumeral

public short traitSpeakNumeral(FOContext context)

Returns the "speak-numeral" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "speak-numeral" trait, one of Constants.FOVAL_DIGITS, or Constants.FOVAL_CONTINUOUS.
See Also:: "XSL-FO Standard 1.0, Section 7.6.13"

traitSpeakPunctuation

public short traitSpeakPunctuation(FOContext context)

Returns the "speak-punctuation" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "speak-punctuation" trait, one of Constants.FOVAL_CODE, or Constants.FOVAL_NONE.
See Also:: "XSL-FO Standard 1.0, Section 7.6.14"

traitStartingState

public short traitStartingState(FOContext context)

Returns the "starting-state" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "starting-state" trait, one of Constants.FOVAL_SHOW, or Constants.FOVAL_HIDE.
See Also:: "XSL-FO Standard 1.0, Section 7.22.10"

traitTextTransform

public short traitTextTransform(FOContext context)

Returns the "text-transform" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "text-transform" trait, one of Constants.FOVAL_CAPITALIZE, Constants.FOVAL_UPPERCASE, Constants.FOVAL_LOWERCASE, or Constants.FOVAL_NONE.
See Also:: "XSL-FO Standard 1.0, Section 7.16.6", "XSL-FO Standard 1.0, Section 5.7.1"

traitVisibility

public short traitVisibility(FOContext context)

Returns the "visibility" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "visibility" trait, one of Constants.FOVAL_VISIBLE, Constants.FOVAL_HIDDEN, or Constants.FOVAL_COLLAPSE.
See Also:: "XSL-FO Standard 1.0, Section 7.28.8"

traitAzimuth

public float traitAzimuth(FOContext context)

Returns the "azimuth" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "azimuth" trait, in degrees.
See Also:: "XSL-FO Standard 1.0, Section 7.6.1"

traitElevation

public float traitElevation(FOContext context)

Returns the "elevation" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "elevation" trait, in degrees.
See Also:: "XSL-FO Standard 1.0, Section 7.6.4"

traitCueBefore

public java.lang.String traitCueBefore(FOContext context)

Returns the "cue-before" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "cue-before" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.6.3"

traitCueAfter

public java.lang.String traitCueAfter(FOContext context)

Returns the "cue-after" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "cue-after" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.6.2"

traitClip

public Shape traitClip(FOContext context)

Returns the "clip" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "clip" trait, or null for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.20.1"

traitBorderBeforePrecedence

public int traitBorderBeforePrecedence(FOContext context)

Returns the "border-before-precedence" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "border-before-precedence" trait. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.26.2"

traitBorderAfterPrecedence

public int traitBorderAfterPrecedence(FOContext context)

Returns the "border-after-precedence" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "border-after-precedence" trait. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.26.1"

traitBorderStartPrecedence

public int traitBorderStartPrecedence(FOContext context)

Returns the "border-start-precedence" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "border-start-precedence" trait. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.26.6"

traitBorderEndPrecedence

public int traitBorderEndPrecedence(FOContext context)

Returns the "border-end-precedence" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "border-end-precedence" trait. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.26.4"

traitDestinationPlacementOffset

public int traitDestinationPlacementOffset(FOContext context)

Returns the "destination-placement-offset" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "destination-placement-offset" trait, in millipoints.
See Also:: "XSL-FO Standard 1.0, Section 7.22.5"

traitZIndex

public int traitZIndex(FOContext context)

Returns the "z-index" trait for this FO if it is not "auto". This method should be consulted only if traitZIndexIsAuto(FOContext) returns false.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "z-index" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.28.9", traitZIndexIsAuto(FOContext)

traitZIndexIsAuto

public boolean traitZIndexIsAuto(FOContext context)

Indicates whether the "z-index" trait for this FO is "auto". If this method returns false, consult traitZIndex(FOContext).

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: True iff the "z-index" trait for this FO is "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.28.9", traitZIndex(FOContext)

traitHyphLadderCount

public int traitHyphLadderCount(FOContext context)

Returns the "hyphenation-ladder-count" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The hyphenation-ladder-count trait, that is, the number of consecutive lines that may be hyphenated. The value Integer.MAX_VALUE is returned for the input value of "no-limit".
See Also:: "XSL-FO Standard 1.0, Section 7.15.2"

traitFontSizeAdjust

public double traitFontSizeAdjust(FOContext context)

Retrieves the computed value for "font-size-adjust".

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The desired aspect ratio for the font, or -1 if no adjustment should be made to the actual font-size.

traitFontSizeActual

public int traitFontSizeActual(FOContext context,
                               int xHeight)

Returns the "actual" value for font-size, as distinguished from the "computed" value returned by #traitFontSize().

Parameters:: context - An object that knows how to resolve FO Tree context issues.; xHeight - The x-height of the selected Font, scaled to the current font-size.
Returns:: The actual font-size to be used, in millipoints.

traitSpeechRate

public double traitSpeechRate(FOContext context)

Returns the desired speech-rate, in words-per-minute.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The desired speech-rate, in words-per-minute.

traitPauseBefore

public double traitPauseBefore(FOContext context)

Returns the "pause-before" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The pause-before trait value, in milliseconds.
See Also:: "XSL-FO Standard 1.0, Section 7.6.6"

traitPauseAfter

public double traitPauseAfter(FOContext context)

Returns the "pause-after" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The pause-after trait value, in milliseconds.
See Also:: "XSL-FO Standard 1.0, Section 7.6.5"

traitPitch

public double traitPitch(FOContext context,
                         double mediumRange)

Returns the frequency for the audio for the current voice.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; mediumRange - The frequency, in Hertz, of the middle of the current voice's range. This must presumably be obtained from the voice "font" itself.
Returns:: The frequency to be used by the voice for reading.
See Also:: "XSL-FO Standard 1.0, Section 7.6.7"

traitPitchRange

public double traitPitchRange(FOContext context)

Returns the "pitch-range" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The pitch-range trait value, in milliseconds.
See Also:: "XSL-FO Standard 1.0, Section 7.6.8"

traitVolume

public double traitVolume(FOContext context)

Returns the computed value for the "volume" property.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: A value in the range from 0 to 100, or a -1 for "silent".
See Also:: "XSL-FO Standard 1.0, Section 7.6.18"

traitPlayDuring

public java.lang.String traitPlayDuring(FOContext context)

Returns the "URL" component of the "play-during" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The URL for the "play-during" trait. The special return value of "" (a valid String object with no characters) indicates a value of "auto", that is, that the sound (if any) of the parent element should continue to play. The special return value of null indicates a value of "none", that is, that no sound should be played at all.
See Also:: "XSL-FO Standard 1.0, Section 7.6.9", traitPlayDuringMix(FOContext), traitPlayDuringRepeat(FOContext)

traitPlayDuringMix

public boolean traitPlayDuringMix(FOContext context)

Returns the "mix" component of the "play-during" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: True if the "play-during" should be mixed.
See Also:: "XSL-FO Standard 1.0, Section 7.6.9", traitPlayDuring(FOContext), traitPlayDuringRepeat(FOContext)

traitPlayDuringRepeat

public boolean traitPlayDuringRepeat(FOContext context)

Returns the "repeat" component of the "play-during" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: True if the "play-during" should repeat.
See Also:: "XSL-FO Standard 1.0, Section 7.6.9", traitPlayDuring(FOContext), traitPlayDuringMix(FOContext)

traitVoiceFamily

public java.lang.String[] traitVoiceFamily(FOContext context)

Returns the "voice-family" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "voice-family" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.6.15"

traitRichness

public double traitRichness(FOContext context)

Returns the "richness" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "richness" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.6.10"

traitStress

public double traitStress(FOContext context)

Returns the "stress" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The "stress" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.6.16"

traitScript

public java.lang.String traitScript(FOContext context)

Returns the "script" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The name of the ISO-15924 script, or "" for "none".
See Also:: "XSL-FO Standard 1.0, Section 7.9.3"

traitSwitchTo

public short traitSwitchTo()

Returns an enumerated value for the "switch-to" trait for this FO.

Returns:: An enumeration for the "switch-to" trait, one of Constants.FOVAL_XSL_PRECEDING, Constants.FOVAL_XSL_FOLLOWING, Constants.FOVAL_XSL_ANY, or Constants.FOVAL_NOT_A_KEYWORD. If Constants.FOVAL_NOT_A_KEYWORD is returned, then traitSwitchToNames() should be consulted for the switch-to names.
See Also:: "XSL-FO Standard 1.0, Section 7.22.11", traitSwitchToNames()

traitSwitchToNames

public java.lang.String[] traitSwitchToNames()

Returns an array of names for the "switch-to" trait for this FO. This value is only meaningful if traitSwitchTo() returned Constants.FOVAL_NOT_A_KEYWORD.

Returns:: The names for the "switch-to" trait.
See Also:: "XSL-FO Standard 1.0, Section 7.22.11", traitSwitchTo()

traitTextShadow

public ShadowEffect traitTextShadow(FOContext context)

Returns the "shadow-effect" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The ShadowEffectDT that applies to this object, or null if there is none.
See Also:: "XSL-FO Standard 1.0, Section 7.16.5"

traitTargetProcessingContext

public java.lang.String traitTargetProcessingContext()

Returns the "target-processing-context" trait for this FO.

Returns:: Either a uri-specification or null if the document root should be used.
See Also:: "XSL-FO Standard 1.0, Section 7.22.13"

traitTargetPresentationContext

public java.lang.String traitTargetPresentationContext()

Returns the "target-presentation-context" trait for this FO.

Returns:: Either a uri-specification or null if the document root should be used.
See Also:: "XSL-FO Standard 1.0, Section 7.22.12"

traitTargetStylesheet

public java.lang.String traitTargetStylesheet()

Returns the "target-stylesheet" trait for this FO.

Returns:: Either a uri-specification or null if "use-normal-stylesheet" should be used.
See Also:: "XSL-FO Standard 1.0, Section 7.22.14"

traitGlyphOrientationHorizontal

public short traitGlyphOrientationHorizontal(FOContext context)

Returns the "glyph-orientation-horizontal" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The glyph-orientation-horizontal trait, as a clockwise angle from the top of the reference-area, one of 0, 90, 180, or 270.
See Also:: "XSL-FO Standard 1.0, Section 7.27.2"

traitGlyphOrientationVertical

public short traitGlyphOrientationVertical(FOContext context)

Returns the "glyph-orientation-vertical" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The glyph-orientation-vertical trait, as a clockwise angle from the top of the reference-area, one of 0, 90, 180, 270, or Short.MIN_VALUE for "auto".
See Also:: "XSL-FO Standard 1.0, Section 7.27.3"

traitBackgroundPositionHorizontal

public int traitBackgroundPositionHorizontal(FOContext context,
                                             int paddingRectangleWidth,
                                             int backgroundImageWidth)

Returns the "background-position-horizontal" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; paddingRectangleWidth - The width of the padding rectangle, used for percentage computations.; backgroundImageWidth - The width, in millipoints, of the background-image.
Returns:: The length, in millipoints, that the background-image should be moved to the right, starting from the left edge of the padding-rectangle.
See Also:: "XSL-FO Standard 1.0, Section 7.7.5"

traitBackgroundPositionVertical

public int traitBackgroundPositionVertical(FOContext context,
                                           int paddingRectangleHeight,
                                           int backgroundImageHeight)

Returns the "background-position-vertical" trait for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; paddingRectangleHeight - The height of the padding rectangle, used for percentage computations.; backgroundImageHeight - The height, in millipoints, of the background-image.
Returns:: The length, in millipoints, that the background-image should be moved down, starting from the top edge of the padding-rectangle.
See Also:: "XSL-FO Standard 1.0, Section 7.7.6"

traitWordSpacingMin

public int traitWordSpacingMin(FOContext context)

Returns the amount of additional space to create between letters. The base size comes from the font itself, which is not included here.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the word-spacing.minimum trait.
See Also:: "XSL-FO Standard 1.0, Section 7.16.8", traitWordSpacingOpt(FOContext), traitWordSpacingMax(FOContext), traitWordSpacingConditionality(), traitWordSpacingPrecedence()

traitWordSpacingOpt

public int traitWordSpacingOpt(FOContext context)

Returns the amount of additional space to create between letters. The base size comes from the font itself, which is not included here.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the word-spacing.optimum trait.
See Also:: "XSL-FO Standard 1.0, Section 7.16.8", traitWordSpacingMin(FOContext), traitWordSpacingMax(FOContext), traitWordSpacingConditionality(), traitWordSpacingPrecedence()

traitWordSpacingMax

public int traitWordSpacingMax(FOContext context)

Returns the amount of additional space to create between letters. The base size comes from the font itself, which is not included here.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the word-spacing.maximum trait.
See Also:: "XSL-FO Standard 1.0, Section 7.16.8", traitWordSpacingMin(FOContext), traitWordSpacingOpt(FOContext), traitWordSpacingConditionality(), traitWordSpacingPrecedence()

traitWordSpacingConditionality

public short traitWordSpacingConditionality()

Returns the "conditionality" component of the "word-spacing" trait for this FO.

Returns:: The word-spacing conditionality, one of Constants.FOVAL_DISCARD or Constants.FOVAL_RETAIN.
See Also:: "XSL-FO Standard 1.0, Section 7.16.8", traitWordSpacingMin(FOContext), traitWordSpacingOpt(FOContext), traitWordSpacingMax(FOContext), traitWordSpacingPrecedence()

traitWordSpacingPrecedence

public int traitWordSpacingPrecedence()

Returns the "precedence" component of the "word-spacing" trait for this FO.

Returns:: The word-spacing precedence. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:: "XSL-FO Standard 1.0, Section 7.16.8", traitWordSpacingMin(FOContext), traitWordSpacingOpt(FOContext), traitWordSpacingMax(FOContext), traitWordSpacingConditionality()

getPrimaryFont

public FontUse getPrimaryFont(FOContext context)

Provides a resolved font to be used as the primary font for this object. Specifically, the font is selected as the best font for the first fo:character found in the object.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The primary resolved FontUse instance for this object.

getSecondaryFont

public FontUse getSecondaryFont(FOContext context,
                                int codePoint)

Provides a resolved font that can be used as the secondary font for a specific character in this object.

Parameters:: context - An object that knows how to resolve FO Tree context issues.; codePoint - The character for whom a secondary font should be found. This char is really the content of an fo:character object, and presumably has no glyph in the font returned by getPrimaryFont(FOContext).
Returns:: The best secondary FontUse instance that has a glyph for c.

getFauxSmallCapFontSize

public int getFauxSmallCapFontSize(FOContext context)

Returns the font-size for the lowercase characters when faux small caps are used by this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The size, in millipoints, of the font for lowercase faux small caps characters.

getBPAxis

public byte getBPAxis(FOContext context)

Tells which axis (horizontal or vertical) is the block-progression axis.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: Either Constants.AXIS_HORIZONTAL or Constants.AXIS_VERTICAL. If writing mode is invalid, returns Constants.AXIS_INVALID.

getIPAxis

public byte getIPAxis(FOContext context)

Tells which axis (horizontal or vertical) is the inline-progression axis.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: Either Constants.AXIS_HORIZONTAL or Constants.AXIS_VERTICAL. If writing mode is invalid, returns Constants.AXIS_INVALID.

getWritingMode

public WritingMode getWritingMode(FOContext context)

Returns the writing-mode for this FO.

Parameters:: context - An object that knows how to resolve FO Tree context issues.
Returns:: The writing-mode for this FO.

getPreviousSiblingFObj

public FObj getPreviousSiblingFObj()

Returns the nearest preceding sibling FO.

Returns:: Return the nearest preceding sibling FObj in the parent's children, or null if this is the first FObj child.

isContentBlock

public boolean isContentBlock()

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. Subclasses should override this as appropriate.

Returns:: Returns true iff the object fits the %block content model.

isContentInline

public boolean isContentInline()

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. Subclasses should override this as appropriate.

Returns:: Returns true iff the object fits the %inline content model.

isContentPCDATA

public boolean isContentPCDATA()

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. Subclasses should override this as appropriate.

Returns:: Returns true iff the object fits the #PCDATA content model.

canContainBlock

public boolean canContainBlock()

Reports whether the object is allowed to contain %block content. Subclasses should override this as appropriate.

Returns:: Returns true iff the can (ever) contain %block content.

canContainInline

public boolean canContainInline()

Reports whether the object is allowed to contain %inline content. Subclasses should override this as appropriate.

Returns:: Returns true iff the can (ever) contain %inline content.

canContainPCDATA

public boolean canContainPCDATA()

Reports whether the object is allowed to contain PCDATA content. Subclasses should override this as appropriate.

Returns:: Returns true iff the can (ever) contain PCDATA content.

getName

public java.lang.String getName()

Returns the name of this formatting object. For example, an external-graphic object returns "external-graphic". returns the name of the formatting object

Returns:: the name of this formatting objects

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

aXSL API 0.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

org.axsl.foR Interface FObj

isBlockLevelFO

isRAGenerator

getNearestTable

getBasicLink

ancestorListRelatedObject

refIdNeeded

getFontConsumer

getMarginLeft

getMarginRight

getMarginTop

getMarginBottom

traitColor

traitWrapOption

traitWhiteSpaceCollapse

traitUnderlineScore

traitOverlineScore

traitThroughScore

traitUnderlineScoreColor

traitOverlineScoreColor

traitThroughScoreColor

traitBlink

traitId

traitInternalDestination

traitExternalDestination

traitStartIndent

traitSpan

traitFlowName

traitBorderCollapse

traitDisplayAlign

traitRelativeAlign

traitBorderSeparationIPD

traitBorderSeparationBPD

traitNumberColumnsRepeated

traitColumnWidth

traitBreakAfter

traitKeepTogetherWithinLine

traitKeepTogetherWithinColumn

traitKeepTogetherWithinPage

traitKeepWithNextWithinLine

traitKeepWithNextWithinColumn

traitKeepWithNextWithinPage

traitKeepWithPreviousWithinLine

traitKeepWithPreviousWithinColumn

traitKeepWithPreviousWithinPage

traitInitialPageNumber

initialPageNumberSetExplicitly

traitForcePageCount

traitExtent

traitColumnGap

traitOverflow

traitColumnCount

traitPageWidth

traitPageHeight

traitTextAlign

traitTextAlignString

traitTextAlignLast

traitEndIndent

traitSpaceBeforeMinimum

traitSpaceBeforeOptimum

traitSpaceBeforeMaximum

traitSpaceBeforeConditionality

traitSpaceBeforePrecedence

traitSpaceAfterMinimum

traitSpaceAfterOptimum

traitSpaceAfterMaximum

traitSpaceAfterConditionality

traitSpaceAfterPrecedence

traitSpaceStartMinimum

traitSpaceStartOptimum

traitSpaceStartMaximum

traitSpaceStartConditionality

traitSpaceStartPrecedence

traitSpaceEndMinimum

traitSpaceEndOptimum

traitSpaceEndMaximum

traitSpaceEndConditionality

traitSpaceEndPrecedence

traitTextIndent

traitTop

org.axsl.foR
Interface FObj