Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.foray.fotree
Class FObj

java.lang.Object
  extended by org.foray.common.AbstractOrderedTreeNode
      extended by org.foray.fotree.FObj
All Implemented Interfaces:
Iterable<org.axsl.fo.Fo>, TreeNode, org.axsl.fo.Fo, org.axsl.fo.fo.proforma.CommonFontExcludedPa, org.axsl.fo.fo.proforma.LinefeedTreatmentPa, org.axsl.fo.fo.proforma.WhiteSpaceCollapsePa, org.axsl.fo.fo.prop.ActiveStatePa, org.axsl.fo.fo.prop.AlignmentAdjustPa, org.axsl.fo.fo.prop.AlignmentBaselinePa, org.axsl.fo.fo.prop.AllowedHeightScalePa, org.axsl.fo.fo.prop.AllowedWidthScalePa, org.axsl.fo.fo.prop.AutoRestorePa, org.axsl.fo.fo.prop.BaselineShiftPa, org.axsl.fo.fo.prop.BlockProgressionDimensionPa, org.axsl.fo.fo.prop.BorderAfterPrecedencePa, org.axsl.fo.fo.prop.BorderBeforePrecedencePa, org.axsl.fo.fo.prop.BorderCollapsePa, org.axsl.fo.fo.prop.BorderEndPrecedencePa, org.axsl.fo.fo.prop.BorderSeparationPa, org.axsl.fo.fo.prop.BorderStartPrecedencePa, org.axsl.fo.fo.prop.BreakAfterPa, org.axsl.fo.fo.prop.BreakBeforePa, org.axsl.fo.fo.prop.CaptionSidePa, org.axsl.fo.fo.prop.CaseNamePa, org.axsl.fo.fo.prop.CaseTitlePa, org.axsl.fo.fo.prop.ChangeBarClassPa, org.axsl.fo.fo.prop.ChangeBarColorPa, org.axsl.fo.fo.prop.ChangeBarOffsetPa, org.axsl.fo.fo.prop.ChangeBarPlacementPa, org.axsl.fo.fo.prop.ChangeBarStylePa, org.axsl.fo.fo.prop.ChangeBarWidthPa, org.axsl.fo.fo.prop.ClearPa, org.axsl.fo.fo.prop.ClipPa, org.axsl.fo.fo.prop.ColorPa, org.axsl.fo.fo.prop.ColorProfileNamePa, org.axsl.fo.fo.prop.ColumnCountPa, org.axsl.fo.fo.prop.ColumnGapPa, org.axsl.fo.fo.prop.CommonAbsolutePositionPa, org.axsl.fo.fo.prop.CommonAccessibilityPa, org.axsl.fo.fo.prop.CommonAuralPa, org.axsl.fo.fo.prop.CommonBorderPaddingBgPa, org.axsl.fo.fo.prop.CommonFontPa, org.axsl.fo.fo.prop.CommonHyphenationPa, org.axsl.fo.fo.prop.CommonMarginBlockPa, org.axsl.fo.fo.prop.CommonMarginInlineOptimumPa, org.axsl.fo.fo.prop.CommonMarginInlinePa, org.axsl.fo.fo.prop.CommonPositionPa, org.axsl.fo.fo.prop.CommonRelativePositionPa, org.axsl.fo.fo.prop.ContentTypePa, org.axsl.fo.fo.prop.DestinationPa, org.axsl.fo.fo.prop.DestinationPlacementOffsetPa, org.axsl.fo.fo.prop.DirectionPa, org.axsl.fo.fo.prop.DisplayAlignPa, org.axsl.fo.fo.prop.DominantBaselinePa, org.axsl.fo.fo.prop.EmptyCellsPa, org.axsl.fo.fo.prop.ExtentPa, org.axsl.fo.fo.prop.FloatPa, org.axsl.fo.fo.prop.FlowNamePa, org.axsl.fo.fo.prop.FontStylePa, org.axsl.fo.fo.prop.FontWeightPa, org.axsl.fo.fo.prop.ForcePageCountPa, org.axsl.fo.fo.prop.FormatPa, org.axsl.fo.fo.prop.GlyphOrientationHorizontalPa, org.axsl.fo.fo.prop.GlyphOrientationVerticalPa, org.axsl.fo.fo.prop.HyphenationKeepPa, org.axsl.fo.fo.prop.HyphenationLadderCountPa, org.axsl.fo.fo.prop.IdPa, org.axsl.fo.fo.prop.IndexClassPa, org.axsl.fo.fo.prop.IndexKeyPa, org.axsl.fo.fo.prop.IndicateDestinationPa, org.axsl.fo.fo.prop.InitialPageNumberPa, org.axsl.fo.fo.prop.InlineProgressionDimensionPa, org.axsl.fo.fo.prop.IntrusionDisplacePa, org.axsl.fo.fo.prop.KeepTogetherPa, org.axsl.fo.fo.prop.KeepWithNextPa, org.axsl.fo.fo.prop.KeepWithPreviousPa, org.axsl.fo.fo.prop.LastLineEndIndentPa, org.axsl.fo.fo.prop.LeaderAlignmentPa, org.axsl.fo.fo.prop.LeaderLengthPa, org.axsl.fo.fo.prop.LeaderPatternPa, org.axsl.fo.fo.prop.LeaderPatternWidthPa, org.axsl.fo.fo.prop.LetterSpacingPa, org.axsl.fo.fo.prop.LineHeightPa, org.axsl.fo.fo.prop.LineHeightShiftAdjustmentPa, org.axsl.fo.fo.prop.LineStackingStrategyPa, org.axsl.fo.fo.prop.MediaUsagePa, org.axsl.fo.fo.prop.MergePagesAcrossIndexKeyReferencesPa, org.axsl.fo.fo.prop.MergeRangesAcrossIndexKeyReferencesPa, org.axsl.fo.fo.prop.MergeSequentialPageNumbersPa, org.axsl.fo.fo.prop.NumberColumnsRepeatedPa, org.axsl.fo.fo.prop.OrphansPa, org.axsl.fo.fo.prop.OverflowPa, org.axsl.fo.fo.prop.PageCitationStrategyPa, org.axsl.fo.fo.prop.PageHeightPa, org.axsl.fo.fo.prop.PageNumberTreatmentPa, org.axsl.fo.fo.prop.PageWidthPa, org.axsl.fo.fo.prop.ProvisionalDistanceBetweenStartsPa, org.axsl.fo.fo.prop.ProvisionalLabelSeparationPa, org.axsl.fo.fo.prop.ReferenceOrientationPa, org.axsl.fo.fo.prop.RefIdPa, org.axsl.fo.fo.prop.RefIndexKeyPa, org.axsl.fo.fo.prop.RelativeAlignPa, org.axsl.fo.fo.prop.RenderingIntentPa, org.axsl.fo.fo.prop.RetrieveBoundaryWithinTablePa, org.axsl.fo.fo.prop.RetrievePositionWithinTablePa, org.axsl.fo.fo.prop.RuleStylePa, org.axsl.fo.fo.prop.RuleThicknessPa, org.axsl.fo.fo.prop.ScalingMethodPa, org.axsl.fo.fo.prop.ScoreSpacesPa, org.axsl.fo.fo.prop.ShowDestinationPa, org.axsl.fo.fo.prop.SpanPa, org.axsl.fo.fo.prop.SrcPa, org.axsl.fo.fo.prop.StartingStatePa, org.axsl.fo.fo.prop.SuppressAtLineBreakPa, org.axsl.fo.fo.prop.SwitchToPa, org.axsl.fo.fo.prop.TableLayoutPa, org.axsl.fo.fo.prop.TableOmitFooterAtBreakPa, org.axsl.fo.fo.prop.TableOmitHeaderAtBreakPa, org.axsl.fo.fo.prop.TargetPresentationContextPa, org.axsl.fo.fo.prop.TargetProcessingContextPa, org.axsl.fo.fo.prop.TargetStylesheetPa, org.axsl.fo.fo.prop.TextAlignLastPa, org.axsl.fo.fo.prop.TextAlignPa, org.axsl.fo.fo.prop.TextAltitudePa, org.axsl.fo.fo.prop.TextDecorationPa, org.axsl.fo.fo.prop.TextDepthPa, org.axsl.fo.fo.prop.TextIndentPa, org.axsl.fo.fo.prop.TextShadowPa, org.axsl.fo.fo.prop.TextTransformPa, org.axsl.fo.fo.prop.TreatAsWordSpacePa, org.axsl.fo.fo.prop.UnicodeBidiPa, org.axsl.fo.fo.prop.VisibilityPa, org.axsl.fo.fo.prop.WhiteSpaceTreatmentPa, org.axsl.fo.fo.prop.WidowsPa, org.axsl.fo.fo.prop.WordSpacingPa, org.axsl.fo.fo.prop.WrapOptionPa, org.axsl.fo.fo.prop.ZIndexPa, OrderedTreeNode
Direct Known Subclasses:
AbstractCharacterSequence, AbstractFlow, AbstractPageMaster, AbstractPageReference, AbstractTablePart, BlockContainer, Bookmark, BookmarkTree, ChangeBarBegin, ChangeBarEnd, Character, ColorProfile, ConditionalPageMasterReference, Declarations, Float, FlowAssignment, FlowMap, FlowNameSpecifier, FlowSourceList, FlowTargetList, FObjMixed, FObjScaled, Footnote, FootnoteBody, ForeignXML, IndexKeyReference, IndexPageCitationList, IndexRangeBegin, IndexRangeEnd, InitialPropertySet, InlineContainer, LayoutMasterSet, ListBlock, ListItem, ListItemBody, ListItemLabel, MultiCase, MultiProperties, MultiPropertySet, MultiSwitch, MultiToggle, PageSequence, PageSequenceMaster, PageSequenceWrapper, Region, RegionNameSpecifier, RetrieveMarker, RetrieveTableMarker, Root, SubSequenceSpecifier, Table, TableAndCaption, TableCaption, TableCell, TableColumn, TableRow
public abstract class FObj
extends AbstractOrderedTreeNode
implements org.axsl.fo.Fo, org.axsl.fo.fo.prop.CommonAccessibilityPa, org.axsl.fo.fo.prop.CommonAbsolutePositionPa, org.axsl.fo.fo.prop.CommonAuralPa, org.axsl.fo.fo.prop.CommonBorderPaddingBgPa, org.axsl.fo.fo.prop.CommonFontPa, org.axsl.fo.fo.proforma.CommonFontExcludedPa, org.axsl.fo.fo.prop.CommonHyphenationPa, org.axsl.fo.fo.prop.CommonMarginBlockPa, org.axsl.fo.fo.prop.CommonMarginInlinePa, org.axsl.fo.fo.prop.CommonRelativePositionPa, org.axsl.fo.fo.prop.ActiveStatePa, org.axsl.fo.fo.prop.AlignmentAdjustPa, org.axsl.fo.fo.prop.AlignmentBaselinePa, org.axsl.fo.fo.prop.AllowedHeightScalePa, org.axsl.fo.fo.prop.AllowedWidthScalePa, org.axsl.fo.fo.prop.AutoRestorePa, org.axsl.fo.fo.prop.BaselineShiftPa, org.axsl.fo.fo.prop.BlockProgressionDimensionPa, org.axsl.fo.fo.prop.BorderAfterPrecedencePa, org.axsl.fo.fo.prop.BorderBeforePrecedencePa, org.axsl.fo.fo.prop.BorderCollapsePa, org.axsl.fo.fo.prop.BorderEndPrecedencePa, org.axsl.fo.fo.prop.BorderSeparationPa, org.axsl.fo.fo.prop.BorderStartPrecedencePa, org.axsl.fo.fo.prop.BreakAfterPa, org.axsl.fo.fo.prop.BreakBeforePa, org.axsl.fo.fo.prop.CaptionSidePa, org.axsl.fo.fo.prop.CaseNamePa, org.axsl.fo.fo.prop.CaseTitlePa, org.axsl.fo.fo.prop.ChangeBarClassPa, org.axsl.fo.fo.prop.ChangeBarColorPa, org.axsl.fo.fo.prop.ChangeBarOffsetPa, org.axsl.fo.fo.prop.ChangeBarPlacementPa, org.axsl.fo.fo.prop.ChangeBarStylePa, org.axsl.fo.fo.prop.ChangeBarWidthPa, org.axsl.fo.fo.prop.ClearPa, org.axsl.fo.fo.prop.ClipPa, org.axsl.fo.fo.prop.ColorPa, org.axsl.fo.fo.prop.ColorProfileNamePa, org.axsl.fo.fo.prop.ColumnCountPa, org.axsl.fo.fo.prop.ColumnGapPa, org.axsl.fo.fo.prop.ContentTypePa, org.axsl.fo.fo.prop.DestinationPa, org.axsl.fo.fo.prop.DestinationPlacementOffsetPa, org.axsl.fo.fo.prop.DirectionPa, org.axsl.fo.fo.prop.DisplayAlignPa, org.axsl.fo.fo.prop.DominantBaselinePa, org.axsl.fo.fo.prop.EmptyCellsPa, org.axsl.fo.fo.prop.ExtentPa, org.axsl.fo.fo.prop.FloatPa, org.axsl.fo.fo.prop.FlowNamePa, org.axsl.fo.fo.prop.ForcePageCountPa, org.axsl.fo.fo.prop.FormatPa, org.axsl.fo.fo.prop.GlyphOrientationHorizontalPa, org.axsl.fo.fo.prop.GlyphOrientationVerticalPa, org.axsl.fo.fo.prop.HyphenationKeepPa, org.axsl.fo.fo.prop.HyphenationLadderCountPa, org.axsl.fo.fo.prop.IdPa, org.axsl.fo.fo.prop.IndexClassPa, org.axsl.fo.fo.prop.IndexKeyPa, org.axsl.fo.fo.prop.IndicateDestinationPa, org.axsl.fo.fo.prop.InitialPageNumberPa, org.axsl.fo.fo.prop.InlineProgressionDimensionPa, org.axsl.fo.fo.prop.IntrusionDisplacePa, org.axsl.fo.fo.prop.KeepTogetherPa, org.axsl.fo.fo.prop.KeepWithNextPa, org.axsl.fo.fo.prop.KeepWithPreviousPa, org.axsl.fo.fo.prop.LastLineEndIndentPa, org.axsl.fo.fo.prop.LeaderAlignmentPa, org.axsl.fo.fo.prop.LeaderLengthPa, org.axsl.fo.fo.prop.LeaderPatternPa, org.axsl.fo.fo.prop.LeaderPatternWidthPa, org.axsl.fo.fo.prop.LetterSpacingPa, org.axsl.fo.fo.proforma.LinefeedTreatmentPa, org.axsl.fo.fo.prop.LineHeightShiftAdjustmentPa, org.axsl.fo.fo.prop.LineHeightPa, org.axsl.fo.fo.prop.LineStackingStrategyPa, org.axsl.fo.fo.prop.MediaUsagePa, org.axsl.fo.fo.prop.MergePagesAcrossIndexKeyReferencesPa, org.axsl.fo.fo.prop.MergeRangesAcrossIndexKeyReferencesPa, org.axsl.fo.fo.prop.MergeSequentialPageNumbersPa, org.axsl.fo.fo.prop.NumberColumnsRepeatedPa, org.axsl.fo.fo.prop.OrphansPa, org.axsl.fo.fo.prop.OverflowPa, org.axsl.fo.fo.prop.PageCitationStrategyPa, org.axsl.fo.fo.prop.PageHeightPa, org.axsl.fo.fo.prop.PageWidthPa, org.axsl.fo.fo.prop.PageNumberTreatmentPa, org.axsl.fo.fo.prop.ProvisionalDistanceBetweenStartsPa, org.axsl.fo.fo.prop.ProvisionalLabelSeparationPa, org.axsl.fo.fo.prop.ReferenceOrientationPa, org.axsl.fo.fo.prop.RefIdPa, org.axsl.fo.fo.prop.RefIndexKeyPa, org.axsl.fo.fo.prop.RelativeAlignPa, org.axsl.fo.fo.prop.RenderingIntentPa, org.axsl.fo.fo.prop.RetrieveBoundaryWithinTablePa, org.axsl.fo.fo.prop.RetrievePositionWithinTablePa, org.axsl.fo.fo.prop.RuleStylePa, org.axsl.fo.fo.prop.RuleThicknessPa, org.axsl.fo.fo.prop.ScalingMethodPa, org.axsl.fo.fo.prop.ScoreSpacesPa, org.axsl.fo.fo.prop.ShowDestinationPa, org.axsl.fo.fo.prop.SpanPa, org.axsl.fo.fo.prop.SrcPa, org.axsl.fo.fo.prop.StartingStatePa, org.axsl.fo.fo.prop.SuppressAtLineBreakPa, org.axsl.fo.fo.prop.SwitchToPa, org.axsl.fo.fo.prop.TableLayoutPa, org.axsl.fo.fo.prop.TableOmitFooterAtBreakPa, org.axsl.fo.fo.prop.TableOmitHeaderAtBreakPa, org.axsl.fo.fo.prop.TargetPresentationContextPa, org.axsl.fo.fo.prop.TargetProcessingContextPa, org.axsl.fo.fo.prop.TargetStylesheetPa, org.axsl.fo.fo.prop.TextAlignPa, org.axsl.fo.fo.prop.TextAlignLastPa, org.axsl.fo.fo.prop.TextAltitudePa, org.axsl.fo.fo.prop.TextDecorationPa, org.axsl.fo.fo.prop.TextDepthPa, org.axsl.fo.fo.prop.TextIndentPa, org.axsl.fo.fo.prop.TextShadowPa, org.axsl.fo.fo.prop.TextTransformPa, org.axsl.fo.fo.prop.TreatAsWordSpacePa, org.axsl.fo.fo.prop.UnicodeBidiPa, org.axsl.fo.fo.prop.VisibilityPa, org.axsl.fo.fo.proforma.WhiteSpaceCollapsePa, org.axsl.fo.fo.prop.WhiteSpaceTreatmentPa, org.axsl.fo.fo.prop.WidowsPa, org.axsl.fo.fo.prop.WordSpacingPa, org.axsl.fo.fo.prop.WrapOptionPa, org.axsl.fo.fo.prop.ZIndexPa

Base class for formatting objects.

Nested Class Summary
 
Nested classes/interfaces inherited from class org.foray.common.AbstractOrderedTreeNode
AbstractOrderedTreeNode.PostOrderDescendantIterator
 
Field Summary
protected static List<FObj> EMPTY_CHILD_LIST
          A static empty and immutable list of children, suitable for return by objects that have no children.
protected static String PAGE_CITATION_TEXT_SEGMENT
          Static CharSequence containing one space, to be used for obtaining a font for the page-citation-* objects.
 
Fields inherited from interface org.axsl.fo.Fo
DIMENSION_AUTO
 
Fields inherited from interface org.axsl.fo.fo.prop.CommonPositionPa
ABSOLUTE_POSITION_AUTO
 
Constructor Summary
protected FObj(FObj parent)
          Constructor.
 
Method Summary
protected  void addCharacters(char[] data, int start, int length, String systemId, int line, int column)
          Adds text characters to the object.
abstract  void addChild(FObj child)
          Add a child to this object.
 void addChildToEmptyContentModel(FObj child)
          Throws a standard exception when an attempt is made to add content to an object that has an empty content model.
 BasicLink ancestorBasicLink(org.axsl.fo.FoContext context)
           
 Flow ancestorFlow(org.axsl.fo.FoContext context)
          Returns the ancestor Flow, if any.
 FObj ancestorGeneratingRA(org.axsl.fo.FoContext context)
          Returns the nearest ancestor FObj that generates reference areas.
 FObj ancestorListRelatedObject(org.axsl.fo.FoContext context)
           
 org.axsl.fo.fo.Marker ancestorMarker()
           
 Property ancestorProperty(FoProperty propertyType)
          Returns the nearest ancestor property of a specified type.
 StaticContent ancestorStaticContent(org.axsl.fo.FoContext context)
          Returns the ancestor StaticContent, if any.
 Table ancestorTable(org.axsl.fo.FoContext context)
           
 void checkExceptionLocation(org.axsl.fo.FoTreeException exception)
          Sets the location (from the SAX Locator) of an exception if it has not been set already.
 org.axsl.common.value.Baseline computeAutoBaseline(org.axsl.fo.FoContext context)
          Computes the dominant-baseline="auto" value.
protected  boolean containsText(char[] data, int start, int length)
          Indicates whether a given char array contains non-whitespace text.
 FObj effectiveParent(org.axsl.fo.FoContext context)
          Return this node's effective parent, cast as an FObj.
protected abstract  void end()
          This method is a hook into the parsing process, primarily to allow the subclass to do some validation or setup work after the object and all of its properties have been parsed and all of its children processed.
 org.axsl.text.line.LineText firstLineText()
          Recursively searched the descendants of this object looking for and returning the first descendant text item.
 CharSequence firstTextSegment()
          Returns the underlying text of the first descendant text item.
 boolean getAllowsChildren()
           
protected  org.axsl.common.i18n.Script getAutoScript()
          Computes the script to be used for this object based on its content.
 org.axsl.common.value.Baseline getBaselineFromScript(org.axsl.fo.FoContext context)
          Returns this object's dominant-baseline, as computed from its font and script.
abstract  List<? extends FObj> getChildren()
          Return the List of this node's children.
 int getColumn()
           
 Block getContainingBlock(org.axsl.fo.FoContext context)
          Finds the nearest self-or-ancestor that is a Block.
 float getContentHeight(org.axsl.fo.FoContext context, FObjScaled fobjScaled)
          Return the scaling factor that should be applied to the intrinsic height to compute the actual content height.
 float getContentWidth(org.axsl.fo.FoContext context, FObjScaled fobjScaled)
          Return the scaling factor that should be applied to the intrinsic width to compute the actual content width.
 String getContextMessage()
           
static String getContextMessage(String systemId, int line, int column)
          Creates a context message from a given set of Locator information, which is useful in user messages.
 String getCookedExternalDestination()
          Returns the external destination stripped of the "url()" wrapping, leading and trailing spaces, and leading and trailing quotation marks.
 DescendantIterator getDescendantIterator()
          Returns an iterator for the descendants of this node.
 String getDescendantText()
          Returns the descendant text nodes concatenated together.
 String getDestination()
           
 int getFauxSmallCapFontSize(org.axsl.fo.FoContext context)
          Returns the font-size for the lowercase characters when faux small caps are used by this FO.
 String getFlowMapName()
          Returns the flow-map-name property for this object.
 String getFlowMapReference()
          Returns the flow-map-reference property for this object.
 String getFlowNameReference()
          Returns the flow-name-reference property for this object.
 org.axsl.font.FontConsumer getFontConsumer()
          Convenience method for obtaining the FontConsumer for this document.
 FOTreeBuilder getFoTree()
          Return the ancestor tree builder.
 String getFullName()
          Provides a formatted version of the full name of this object in the form namespace-abbreviation:object-name.
 org.axsl.graphic.GraphicServer getGraphicServer()
          Returns the graphic server being used by this tree.
 org.axsl.hyphen.HyphenationConsumer getHyphenationConsumer()
          Returns the hyphenation consumer.
 int getLine()
           
 org.axsl.common.value.LinkType getLinkType()
           
 org.apache.commons.logging.Log getLogger()
          Return the logger.
 int getMarginBottom(org.axsl.fo.FoContext context)
          Returns the bottom margin of this object.
 int getMarginLeft(org.axsl.fo.FoContext context)
          Returns the left margin of this object.
 int getMarginRight(org.axsl.fo.FoContext context)
          Returns the right margin of this object.
 int getMarginTop(org.axsl.fo.FoContext context)
          Returns the top margin of this object.
 String getMessageWithContext(String message)
          Adds the context information to a given message.
abstract  String getName()
           
abstract  Namespace getNamespace()
          Gets the Namespace instance that is associated with this object.
 ListBlock getNearestAncestorListBlock(org.axsl.fo.FoContext context)
          Returns the nearest ancestor FObj that is a ListBlock.
 Leader getNearestLeader(org.axsl.fo.FoContext context)
          Return the nearest ancestor Leader instance, if any.
 ListItem getNearestListItem(org.axsl.fo.FoContext context)
          Returns self or the nearest ancestor FObj that is a ListItem.
protected  CharacterSequence4a getNextContiguousTextInBlock()
          Returns the next contiguous FOText item that has exactly the same closest ancestor block.
 OrderedTreeNode getOrderedParent()
          Returns the parent of this node, cast as an OrderedTreeNode.
abstract  FObj getParent()
           
 FObj getParsedParent()
          Returns the parent that was parsed from the FO document.
protected  CharacterSequence4a getPreviousContiguousTextInBlock()
          Returns the previous contiguous FOText item that has exactly the same closest ancestor block.
abstract  PropertyList getPropertyList()
          Returns the property list for this FObj.
 String getRegionNameReference()
          Returns the flow-name-reference property for this object.
 Root getRoot()
          Return the root of this tree.
 org.axsl.font.FontUse getSecondaryFont(org.axsl.fo.FoContext context, int codePoint)
           
 int getSequentialIndex()
           
 List<? extends FObj> getSiblings()
          Returns the List of this node's parent's children, which includes this node.
 org.axsl.speech.SpeechServer getSpeechServer()
          Returns the speech server.
 String getSystemId()
           
 org.axsl.text.TextServer getTextServer()
          Returns the text server being used by this tree.
 org.axsl.speech.Voice getVoice(org.axsl.fo.FoContext context)
           
 boolean initialPageNumberSetExplicitly()
           
 void invalidPageReference(String invalidReference)
          Creates a suitable exception or warning if an object references a non-existent page.
 boolean isBlockLevelFo()
           
abstract  boolean isContentBlock()
          Reports whether the object fits the %block parameter entity described in XSL-FO Std 1.0, Section 6.2.
 boolean isContentHeightDependentOnPd(org.axsl.fo.FoContext context)
          Indicates whether the content-height is a known value or is dependent on the viewport dimensions.
abstract  boolean isContentInline()
          Reports whether the object fits the %inline parameter entity described in XSL-FO Std 1.0, Section 6.2.
abstract  boolean isContentPcdata()
          Reports whether the object fits the #PCDATA content type in XSL-FO Std 1.0, Section 6.2.
 boolean isContentWidthDependentOnPd(org.axsl.fo.FoContext context)
          Indicates whether the content-width is a known value or is dependent on the viewport dimensions.
 Iterator<org.axsl.fo.Fo> iterator()
           
 void logWarning(String message)
          Convenience method for logging a warning.
 FObj nearestGeneratingRA(org.axsl.fo.FoContext context)
          Returns self or the nearest ancestor FObj that generates reference areas.
 int qtyMarkerChildren()
           
 boolean relativeAlignApplies()
          Indicates whether the relative-align property applies to this Fo.
protected  org.axsl.font.FontUse resolvePrimaryFont(org.axsl.fo.FoContext context)
          Resolves the font to be used for this object.
 boolean scalingUniform(org.axsl.fo.FoContext context)
          Indicates whether this object has uniform scaling or not.
 void setLocation(String systemId, int line, int column)
          Sets the location of this object.
protected abstract  void setup()
          A hook into the parsing process which allows the subclass instance to do some initialization-type work after all of the properties have been parsed, but before any of the children have been parsed.
 void throwException(String message)
          Convenience method handling some details of throwing a parsing exception.
static void throwException(String contextMessage, String message)
          Convenience method handling some details of throwing a parsing exception.
 void throwExceptionContentModelViolation()
          Convenience method that throws a general content model violation exception.
 void throwExceptionInvalidLocation()
          Convenience method that throws a general exception indicating that an element is not valid at this location.
 org.axsl.common.value.AbsolutePosition traitAbsolutePosition(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.ActiveState traitActiveState(org.axsl.fo.FoContext context)
           
 int traitAlignmentAdjust(org.axsl.fo.FoContext context, org.axsl.fo.FoInlineContext inlineContext)
           
 org.axsl.common.value.AlignmentBaseline traitAlignmentBaseline(org.axsl.fo.FoContext context)
           
 float[] traitAllowedHeightScale()
          Returns the allowed-height-scale trait.
 float[] traitAllowedHeightScale(org.axsl.fo.FoContext context)
           
 float[] traitAllowedWidthScale()
          Returns the allowed-height-scale trait.
 float[] traitAllowedWidthScale(org.axsl.fo.FoContext context)
           
 boolean traitAutoRestore(org.axsl.fo.FoContext context)
           
 float traitAzimuth(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.BackgroundAttachment traitBackgroundAttachment(org.axsl.fo.FoContext context)
           
 Color traitBackgroundColor(org.axsl.fo.FoContext context)
           
 org.axsl.graphic.Graphic traitBackgroundImage(org.axsl.fo.FoContext context)
           
 int traitBackgroundPositionHorizontal(org.axsl.fo.FoContext context, int paddingRectangleWidth, int backgroundImageWidth)
           
 int traitBackgroundPositionVertical(org.axsl.fo.FoContext context, int paddingRectangleHeight, int backgroundImageHeight)
           
 org.axsl.common.value.BackgroundRepeat traitBackgroundRepeat(org.axsl.fo.FoContext context)
           
 int traitBaselineShift(org.axsl.fo.FoContext context)
           
 FoValue traitBlankOrNotBlank()
          Returns the "blank-or-not-blank" trait.
 boolean traitBlink(org.axsl.fo.FoContext context)
           
 Color traitBorderAfterColor(org.axsl.fo.FoContext context)
           
 int traitBorderAfterPrecedence(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.BorderStyle traitBorderAfterStyle(org.axsl.fo.FoContext context)
           
 int traitBorderAfterWidth(org.axsl.fo.FoContext context)
           
 Color traitBorderBeforeColor(org.axsl.fo.FoContext context)
           
 int traitBorderBeforePrecedence(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.BorderStyle traitBorderBeforeStyle(org.axsl.fo.FoContext context)
           
 int traitBorderBeforeWidth(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.BorderModel traitBorderCollapse(org.axsl.fo.FoContext context)
           
 Color traitBorderEndColor(org.axsl.fo.FoContext context)
           
 int traitBorderEndPrecedence(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.BorderStyle traitBorderEndStyle(org.axsl.fo.FoContext context)
           
 int traitBorderEndWidth(org.axsl.fo.FoContext context)
           
 int traitBorderSeparationBpd(org.axsl.fo.FoContext context)
           
 int traitBorderSeparationIpd(org.axsl.fo.FoContext context)
           
 Color traitBorderStartColor(org.axsl.fo.FoContext context)
           
 int traitBorderStartPrecedence(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.BorderStyle traitBorderStartStyle(org.axsl.fo.FoContext context)
           
 int traitBorderStartWidth(org.axsl.fo.FoContext context)
           
 int traitBottom(org.axsl.fo.FoContext context)
           
 int traitBpDimensionMax(org.axsl.fo.FoContext context)
           
 int traitBpDimensionMin(org.axsl.fo.FoContext context)
           
 int traitBpDimensionOpt(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.Break traitBreakAfter(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.Break traitBreakBefore(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.RelativeCompass traitCaptionSide(org.axsl.fo.FoContext context)
           
 String traitCaseName(org.axsl.fo.FoContext context)
           
 String traitCaseTitle()
           
 String traitChangeBarClass()
           
 Color traitChangeBarColor(org.axsl.fo.FoContext context)
           
 int traitChangeBarOffset(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.ChangeBarPlacement traitChangeBarPlacement(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.BorderStyle traitChangeBarStyle(org.axsl.fo.FoContext context)
           
 int traitChangeBarWidth(org.axsl.fo.FoContext context)
           
 char traitCharacter()
          Returns the "character" trait.
 org.axsl.common.value.Clear traitClear(org.axsl.fo.FoContext context)
           
 Shape traitClip(org.axsl.fo.FoContext context, Shape containerShape)
           
 boolean traitClipIsAuto(org.axsl.fo.FoContext context)
           
 Color traitColor(org.axsl.fo.FoContext context)
           
 String traitColorProfileName(org.axsl.fo.FoContext context)
           
 int traitColumnCount(org.axsl.fo.FoContext context)
           
 int traitColumnGap(org.axsl.fo.FoContext context)
           
 int traitColumnNumber(org.axsl.fo.FoContext context)
          Returns the "column-number" trait.
 String traitContentType(org.axsl.fo.FoContext context)
           
 org.axsl.common.i18n.Country traitCountry(org.axsl.fo.FoContext context)
           
 String traitCueAfter(org.axsl.fo.FoContext context)
           
 String traitCueBefore(org.axsl.fo.FoContext context)
           
 int traitDestinationPlacementOffset(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.AbsoluteDirection traitDirection(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.DisplayAlign traitDisplayAlign(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.Baseline traitDominantBaseline(org.axsl.fo.FoContext context)
           
 float traitElevation(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.EmptyCells traitEmptyCells(org.axsl.fo.FoContext context)
           
 int traitEndIndent(org.axsl.fo.FoContext context)
           
 boolean traitEndsRow(org.axsl.fo.FoContext context)
          Returns the "ends-row" trait for this FO.
 int traitExtent()
           
 String traitExternalDestination()
          Returns the "external-destination" trait for this FO.
 org.axsl.common.value.Float traitFloat(org.axsl.fo.FoContext context)
           
 String traitFlowName()
           
 List<String> traitFontFamily(org.axsl.fo.FoContext context)
           
 org.axsl.font.Font.SelectionStrategy traitFontSelectionStrategy(org.axsl.fo.FoContext context)
           
 int traitFontSize(org.axsl.fo.FoContext context)
           
 int traitFontSizeActual(org.axsl.fo.FoContext context, org.axsl.font.Font font)
           
 double traitFontSizeAdjust(org.axsl.fo.FoContext context)
           
 org.axsl.font.Font.Stretch traitFontStretch(org.axsl.fo.FoContext context)
           
 org.axsl.font.Font.Style traitFontStyle(org.axsl.fo.FoContext context)
           
 org.axsl.font.Font.Variant traitFontVariant(org.axsl.fo.FoContext context)
           
 org.axsl.font.Font.Weight traitFontWeight(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.ForcePageCount traitForcePageCount(org.axsl.fo.FoContext context)
           
 String traitFormat()
          Returns the "format" trait.
 short traitGlyphOrientationHorizontal(org.axsl.fo.FoContext context)
           
 short traitGlyphOrientationVertical(org.axsl.fo.FoContext context)
           
 char traitGroupingSeparator()
          Returns the "grouping-separator" trait.
 int traitGroupingSize()
          Returns the "grouping-size" trait.
 org.axsl.common.value.Conditionality traitHalfLeadingConditionality(org.axsl.fo.FoContext context)
           
 int traitHalfLeadingMax(org.axsl.fo.FoContext context)
           
 int traitHalfLeadingMin(org.axsl.fo.FoContext context)
           
 int traitHalfLeadingOpt(org.axsl.fo.FoContext context)
           
 int traitHalfLeadingPrecedence(org.axsl.fo.FoContext context)
           
 boolean traitHyphenate(org.axsl.fo.FoContext context)
           
 int traitHyphenationCharacter(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.HyphenationKeep traitHyphenationKeep(org.axsl.fo.FoContext context)
           
 int traitHyphenationLadderCount(org.axsl.fo.FoContext context)
           
 int traitHyphenationPushCharacterCount(org.axsl.fo.FoContext context)
           
 int traitHyphenationRemainCharacterCount(org.axsl.fo.FoContext context)
           
 String traitId()
           
 String traitIndexClass()
           
 String traitIndexKey()
           
 boolean traitIndicateDestination(org.axsl.fo.FoContext context)
           
 int traitInitialPageNumber(int lastPageNumberUsed)
           
 String traitInternalDestination()
          Returns the "internal-destination" trait for this FO.
 org.axsl.common.value.IntrusionDisplace traitIntrusionDisplace(org.axsl.fo.FoContext context)
           
 int traitIpDimensionMax(org.axsl.fo.FoContext context)
           
 int traitIpDimensionMin(org.axsl.fo.FoContext context)
           
 int traitIpDimensionOpt(org.axsl.fo.FoContext context)
           
 boolean traitIsReferenceArea()
           
 int traitKeepTogetherWithinColumn(org.axsl.fo.FoContext context)
           
 int traitKeepTogetherWithinLine(org.axsl.fo.FoContext context)
           
 int traitKeepTogetherWithinPage(org.axsl.fo.FoContext context)
           
 int traitKeepWithNextWithinColumn(org.axsl.fo.FoContext context)
           
 int traitKeepWithNextWithinLine(org.axsl.fo.FoContext context)
           
 int traitKeepWithNextWithinPage(org.axsl.fo.FoContext context)
           
 int traitKeepWithPreviousWithinColumn(org.axsl.fo.FoContext context)
           
 int traitKeepWithPreviousWithinLine(org.axsl.fo.FoContext context)
           
 int traitKeepWithPreviousWithinPage(org.axsl.fo.FoContext context)
           
 org.axsl.common.i18n.Language traitLanguage(org.axsl.fo.FoContext context)
           
 int traitLastLineEndIndent(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.LeaderAlignment traitLeaderAlignment(org.axsl.fo.FoContext context)
           
 int traitLeaderLengthMax(org.axsl.fo.FoContext context)
           
 int traitLeaderLengthMin(org.axsl.fo.FoContext context)
           
 int traitLeaderLengthOpt(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.LeaderPattern traitLeaderPattern(org.axsl.fo.FoContext context)
           
 int traitLeaderPatternWidth(org.axsl.fo.FoContext context)
           
 int traitLeft(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.Conditionality traitLetterSpacingConditionality()
           
 int traitLetterSpacingMax(org.axsl.fo.FoContext context)
           
 int traitLetterSpacingMin(org.axsl.fo.FoContext context)
           
 int traitLetterSpacingOpt(org.axsl.fo.FoContext context)
           
 int traitLetterSpacingPrecedence()
           
 FoValue traitLetterValue()
          Returns the "letter-value" trait.
 org.axsl.common.value.LinefeedTreatment traitLinefeedTreatment(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.LineHeightShiftAdjustment traitLineHeightShiftAdjustment(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.LineStackingStrategy traitLineStackingStrategy(org.axsl.fo.FoContext context)
           
 String traitMarkerClassName()
          Returns the "marker-class-name" trait.
 String traitMasterName()
          Returns the "master-name" trait.
 String traitMasterReference()
          Returns the "master-reference" trait.
 int traitMaximumRepeats()
          Returns the "maximum-repeats" trait.
 org.axsl.common.value.MediaUsage traitMediaUsage(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.IndexMerge traitMergePagesAcrossIndexKeyReferences(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.IndexMerge traitMergeRangesAcrossIndexKeyReferences(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.IndexMerge traitMergeSequentialPageNumbers(org.axsl.fo.FoContext context)
           
 int traitNumberColumnsRepeated()
           
 int traitNumberColumnsSpanned()
          Returns the "number-columns-spanned" trait.
 int traitNumberRowsSpanned()
          Returns the "number-rows-spanned" trait.
 FoValue traitOddOrEven()
          Returns the "odd-or-even" trait.
 int traitOrphans(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.Overflow traitOverflow(org.axsl.fo.FoContext context)
           
 boolean traitOverlineScore(org.axsl.fo.FoContext context)
           
 Color traitOverlineScoreColor(org.axsl.fo.FoContext context)
           
 int traitPaddingAfter(org.axsl.fo.FoContext context)
           
 int traitPaddingBefore(org.axsl.fo.FoContext context)
           
 int traitPaddingEnd(org.axsl.fo.FoContext context)
           
 int traitPaddingStart(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.PageCitationStrategy traitPageCitationStrategy()
           
 int traitPageHeight()
           
 org.axsl.common.value.PageNumberTreatment traitPageNumberTreatment(org.axsl.fo.FoContext context)
           
 FoValue traitPagePosition()
          Returns the "page-position" trait.
 int traitPageWidth()
           
 double traitPauseAfter(org.axsl.fo.FoContext context)
           
 double traitPauseBefore(org.axsl.fo.FoContext context)
           
 double traitPitch(org.axsl.fo.FoContext context)
           
 double traitPitchRange(org.axsl.fo.FoContext context)
           
 String traitPlayDuring(org.axsl.fo.FoContext context)
           
 boolean traitPlayDuringMix(org.axsl.fo.FoContext context)
           
 boolean traitPlayDuringRepeat(org.axsl.fo.FoContext context)
           
 boolean traitPrecedence()
          Returns the "precedence" trait.
 int traitProvisionalDistanceBetweenStarts(org.axsl.fo.FoContext context)
           
 int traitProvisionalLabelSeparation(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.ReferenceOrientation traitReferenceOrientation(org.axsl.fo.FoContext context)
           
 String traitRefId(org.axsl.fo.FoContext context)
           
 String traitRefIndexKey()
           
 org.axsl.common.value.RelativeAlign traitRelativeAlign(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.RelativePosition traitRelativePosition(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.RenderingIntent traitRenderingIntent(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.RetrieveBoundaryWithinTable traitRetrieveBoundaryWithinTable()
           
 String traitRetrieveClassName()
          Returns the "retrieve-class-name" trait.
 org.axsl.common.value.RetrievePositionWithinTable traitRetrievePositionWithinTable()
           
 double traitRichness(org.axsl.fo.FoContext context)
           
 int traitRight(org.axsl.fo.FoContext context)
           
 String traitRole(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.RuleStyle traitRuleStyle(org.axsl.fo.FoContext context)
           
 int traitRuleThickness(org.axsl.fo.FoContext context)
           
 Scaling traitScaling(org.axsl.fo.FoContext context)
          Returns the "scaling" trait for this FO.
 org.axsl.common.value.ScalingMethod traitScalingMethod()
           
 ScalingMethod traitScalingMethod(org.axsl.fo.FoContext context)
          Returns the "scaling-method" trait for this FO.
 boolean traitScoreSpaces(org.axsl.fo.FoContext context)
           
 org.axsl.common.i18n.Script traitScript(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.ShowDestination traitShowDestination(org.axsl.fo.FoContext context)
           
 String[] traitSourceDocument(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.Conditionality traitSpaceAfterConditionality(org.axsl.fo.FoContext context)
           
 int traitSpaceAfterMaximum(org.axsl.fo.FoContext context)
           
 int traitSpaceAfterMinimum(org.axsl.fo.FoContext context)
           
 int traitSpaceAfterOptimum(org.axsl.fo.FoContext context)
           
 int traitSpaceAfterPrecedence()
           
 org.axsl.common.value.Conditionality traitSpaceBeforeConditionality(org.axsl.fo.FoContext context)
           
 int traitSpaceBeforeMaximum(org.axsl.fo.FoContext context)
           
 int traitSpaceBeforeMinimum(org.axsl.fo.FoContext context)
           
 int traitSpaceBeforeOptimum(org.axsl.fo.FoContext context)
           
 int traitSpaceBeforePrecedence()
           
 org.axsl.common.value.Conditionality traitSpaceEndConditionality()
           
 int traitSpaceEndMaximum(org.axsl.fo.FoContext context)
           
 int traitSpaceEndMinimum(org.axsl.fo.FoContext context)
           
 int traitSpaceEndOptimum(org.axsl.fo.FoContext context)
           
 int traitSpaceEndPrecedence()
           
 org.axsl.common.value.Conditionality traitSpaceStartConditionality()
           
 int traitSpaceStartMaximum(org.axsl.fo.FoContext context)
           
 int traitSpaceStartMinimum(org.axsl.fo.FoContext context)
           
 int traitSpaceStartOptimum(org.axsl.fo.FoContext context)
           
 int traitSpaceStartPrecedence()
           
 org.axsl.common.value.Span traitSpan(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.Speak traitSpeak(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.SpeakHeader traitSpeakHeader(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.SpeakNumeral traitSpeakNumeral(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.SpeakPunctuation traitSpeakPunctuation(org.axsl.fo.FoContext context)
           
 double traitSpeechRate(org.axsl.fo.FoContext context)
           
 String traitSrc(org.axsl.fo.FoContext context)
           
 int traitStartIndent(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.StartingState traitStartingState(org.axsl.fo.FoContext context)
           
 boolean traitStartsRow(org.axsl.fo.FoContext context)
          Returns the "starts-row" trait for this FO.
 double traitStress(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.SuppressAtLineBreak traitSuppressAtLineBreak(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.SwitchTo traitSwitchTo()
           
 String[] traitSwitchToNames()
           
 org.axsl.common.value.TableLayout traitTableLayout()
           
 boolean traitTableOmitFooterAtBreak(org.axsl.fo.FoContext context)
           
 boolean traitTableOmitHeaderAtBreak(org.axsl.fo.FoContext context)
           
 String traitTargetPresentationContext()
           
 String traitTargetProcessingContext()
           
 String traitTargetStylesheet()
           
 org.axsl.common.value.TextAlign traitTextAlign(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.TextAlignLast traitTextAlignLast(org.axsl.fo.FoContext context)
           
 String traitTextAlignString()
           
 int traitTextAltitude(org.axsl.fo.FoContext context)
           
 int traitTextDepth(org.axsl.fo.FoContext context)
           
 int traitTextIndent(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.ShadowEffect[] traitTextShadow(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.TextTransform traitTextTransform(org.axsl.fo.FoContext context)
           
 boolean traitThroughScore(org.axsl.fo.FoContext context)
           
 Color traitThroughScoreColor(org.axsl.fo.FoContext context)
           
 int traitTop(org.axsl.fo.FoContext context)
           
 boolean traitTreatAsWordSpace(org.axsl.fo.FoContext context, char character)
           
 boolean traitUnderlineScore(org.axsl.fo.FoContext context)
           
 Color traitUnderlineScoreColor(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.UnicodeBidi traitUnicodeBidi(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.Visibility traitVisibility(org.axsl.fo.FoContext context)
           
 String[] traitVoiceFamily(org.axsl.fo.FoContext context)
           
 double traitVolume(org.axsl.fo.FoContext context)
           
 boolean traitWhiteSpaceCollapse(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.WhiteSpaceTreatment traitWhiteSpaceTreatment(org.axsl.fo.FoContext context)
           
 int traitWidows(org.axsl.fo.FoContext context)
           
 org.axsl.common.value.Conditionality traitWordSpacingConditionality()
           
 int traitWordSpacingMax(org.axsl.fo.FoContext context)
           
 int traitWordSpacingMin(org.axsl.fo.FoContext context)
           
 int traitWordSpacingOpt(org.axsl.fo.FoContext context)
           
 int traitWordSpacingPrecedence()
           
 org.axsl.common.value.WrapOption traitWrapOption(org.axsl.fo.FoContext context)
           
 DtWritingMode traitWritingMode(org.axsl.fo.FoContext context)
          Returns the writing-mode for this FO.
 int traitZIndex(org.axsl.fo.FoContext context)
           
 boolean traitZIndexIsAuto(org.axsl.fo.FoContext context)
           
protected abstract  void validateAncestry()
          A hook into the parsing process which allows the subclass instance to validate its ancestry.
 void validateAtLeastOneChild()
          Ensures that this has at least one child by throwing an exception if it does not.
protected abstract  void validateDescendants()
          A hook into the parsing process which allows the subclass instance to validate its descendants.
 void validateEmptyContent()
          Ensures that this has no children by throwing an exception if it does.
protected abstract  void validateProperties()
          A hook into the parsing process which allows the subclass instance to validate its properties.
 
Methods inherited from class org.foray.common.AbstractOrderedTreeNode
children, getChildCount, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLevel, getNextLeaf, getNextSibling, getPreviousLeaf, getPreviousSibling, getSharedAncestor, hasChildren, isLeaf, isNodeAncestor, isNodeDescendant, nextPostOrderNode, nextPreOrderNode, postOrderDescendantIterator, siblingIndex
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.axsl.fo.Fo
acceptProxyFactory, getChildAt, isValid
 
Methods inherited from interface javax.swing.tree.TreeNode
children, getChildCount, getIndex, isLeaf
 
Methods inherited from interface org.axsl.fo.fo.prop.CommonFontPa
getPrimaryFont
 

Field Detail

EMPTY_CHILD_LIST

protected static final List<FObj> EMPTY_CHILD_LIST
A static empty and immutable list of children, suitable for return by objects that have no children.

PAGE_CITATION_TEXT_SEGMENT

protected static final String PAGE_CITATION_TEXT_SEGMENT
Static CharSequence containing one space, to be used for obtaining a font for the page-citation-* objects.

See Also:
Constant Field Values
Constructor Detail

FObj

protected FObj(FObj parent)
Constructor.

Parameters:
parent - The parent FObj.
Method Detail

getParent

public abstract FObj getParent()
Specified by:
getParent in interface TreeNode
Specified by:
getParent in interface org.axsl.fo.Fo

getParsedParent

public FObj getParsedParent()
Returns the parent that was parsed from the FO document. This can be different from the parent, in cases where pseudo-objects are placed in the tree to normalize it. For example, table-cells that are direct children of a table-body (instead of a table-row), are reparented with a pseudo table-row. Subclasses should override this method as necessary.

Returns:
The parent that was parsed from the FO tree.

getOrderedParent

public OrderedTreeNode getOrderedParent()
Description copied from interface: OrderedTreeNode
Returns the parent of this node, cast as an OrderedTreeNode.

Specified by:
getOrderedParent in interface OrderedTreeNode
Returns:
The parent of this node.

getChildren

public abstract List<? extends FObj> getChildren()
Description copied from class: AbstractOrderedTreeNode
Return the List of this node's children.

Specified by:
getChildren in class AbstractOrderedTreeNode
Returns:
The List of this node's children.

effectiveParent

public FObj effectiveParent(org.axsl.fo.FoContext context)
Return this node's effective parent, cast as an FObj. This differs from the value returned by

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
This node's effective parent.

getSiblings

public List<? extends FObj> getSiblings()
Description copied from class: AbstractOrderedTreeNode
Returns the List of this node's parent's children, which includes this node.

Specified by:
getSiblings in class AbstractOrderedTreeNode
Returns:
The List of this node's parent's children.

getMessageWithContext

public String getMessageWithContext(String message)
Adds the context information to a given message.

Parameters:
message - The message to which context information should be added.
Returns:
The original message plus the context information.

getContextMessage

public String getContextMessage()
Specified by:
getContextMessage in interface org.axsl.fo.Fo

getContextMessage

public static String getContextMessage(String systemId,
                                       int line,
                                       int column)
Creates a context message from a given set of Locator information, which is useful in user messages.

Parameters:
systemId - The path to the document.
line - The line number in systemId.
column - The column number in line.
Returns:
A String describing the location specified.

ancestorMarker

public org.axsl.fo.fo.Marker ancestorMarker()
Specified by:
ancestorMarker in interface org.axsl.fo.Fo

getFoTree

public FOTreeBuilder getFoTree()
Return the ancestor tree builder.

Returns:
The ancestor tree builder.

getLogger

public org.apache.commons.logging.Log getLogger()
Return the logger.

Returns:
The logger.

throwException

public void throwException(String message)
                    throws org.axsl.fo.FoTreeException
Convenience method handling some details of throwing a parsing exception.

Parameters:
message - The message indicating the reason for the exception.
Throws:
org.axsl.fo.FoTreeException - Always, as that is the purpose of this method.

throwException

public static void throwException(String contextMessage,
                                  String message)
                           throws org.axsl.fo.FoTreeException
Convenience method handling some details of throwing a parsing exception.

Parameters:
contextMessage - The context portion of the exception message.
message - The message indicating the reason for the exception.
Throws:
org.axsl.fo.FoTreeException - Always, as that is the purpose of this method.

throwExceptionContentModelViolation

public void throwExceptionContentModelViolation()
                                         throws org.axsl.fo.FoTreeException
Convenience method that throws a general content model violation exception.

Throws:
org.axsl.fo.FoTreeException - Always, as that is the purpose of this method.

throwExceptionInvalidLocation

public void throwExceptionInvalidLocation()
                                   throws org.axsl.fo.FoTreeException
Convenience method that throws a general exception indicating that an element is not valid at this location.

Throws:
org.axsl.fo.FoTreeException - Always, as that is the purpose of this method.

addChildToEmptyContentModel

public void addChildToEmptyContentModel(FObj child)
                                 throws org.axsl.fo.FoTreeException
Throws a standard exception when an attempt is made to add content to an object that has an empty content model.

Parameters:
child - The child object which was attempting to be added to this.
Throws:
org.axsl.fo.FoTreeException - Always, as that is the purpose of this method.

getSequentialIndex

public int getSequentialIndex()
Specified by:
getSequentialIndex in interface org.axsl.fo.Fo

getSystemId

public String getSystemId()
Specified by:
getSystemId in interface org.axsl.fo.Fo

getLine

public int getLine()
Specified by:
getLine in interface org.axsl.fo.Fo

getColumn

public int getColumn()
Specified by:
getColumn in interface org.axsl.fo.Fo

setLocation

public void setLocation(String systemId,
                        int line,
                        int column)
Sets the location of this object.

Parameters:
systemId - The system ID (document) in which this object is located.
line - The line number in the document at which this object is located.
column - The column number in line as which this object is located.

getFullName

public String getFullName()
Provides a formatted version of the full name of this object in the form namespace-abbreviation:object-name. For example, "fo:bookmark".

Returns:
The name of this object, with the typical namespace abbreviation prepended.

addCharacters

protected void addCharacters(char[] data,
                             int start,
                             int length,
                             String systemId,
                             int line,
                             int column)
                      throws org.axsl.fo.FoTreeException
Adds text characters to the object. Since most FOs cannot have PCDATA content, the default behavior is to ignore white-space content, and to throw an exception for any other content. Subclasses should override this as appropriate.

Parameters:
data - text
start - start position
length - length of the text
systemId - The systemId of the file containing the text being added (used in error messages).
line - The line number of the location of the text being added (used in error messages).
column - The columns number of the location of the text being added (used in error messages).
Throws:
org.axsl.fo.FoTreeException - If the object contains text but is not allowed to.

containsText

protected boolean containsText(char[] data,
                               int start,
                               int length)
Indicates whether a given char array contains non-whitespace text.

Parameters:
data - The char array of text.
start - The first item in the char array to be examined.
length - The length of the text in the char array to be examined.
Returns:
True iff the char array contains non-whitespace text.

validateAncestry

protected abstract void validateAncestry()
                                  throws org.axsl.fo.FoTreeException
A hook into the parsing process which allows the subclass instance to validate its ancestry. This method is called after object construction, but before any properties are parsed.

Throws:
org.axsl.fo.FoTreeException - For invalid ancestry.

validateProperties

protected abstract void validateProperties()
                                    throws org.axsl.fo.FoTreeException
A hook into the parsing process which allows the subclass instance to validate its properties. This method is called after all properties have been parsed, but before any children have been read.

Throws:
org.axsl.fo.FoTreeException - For invalid properties.

setup

protected abstract void setup()
                       throws org.axsl.fo.FoTreeException
A hook into the parsing process which allows the subclass instance to do some initialization-type work after all of the properties have been parsed, but before any of the children have been parsed.

Throws:
org.axsl.fo.FoTreeException - For errors during initialization.

validateDescendants

protected abstract void validateDescendants()
                                     throws org.axsl.fo.FoTreeException
A hook into the parsing process which allows the subclass instance to validate its descendants. This method is called after all children have been parsed.

Throws:
org.axsl.fo.FoTreeException - For invalid descendants.

end

protected abstract void end()
                     throws org.axsl.fo.FoTreeException
This method is a hook into the parsing process, primarily to allow the subclass to do some validation or setup work after the object and all of its properties have been parsed and all of its children processed.

Throws:
org.axsl.fo.FoTreeException - For errors during validation or setup.

validateEmptyContent

public void validateEmptyContent()
                          throws org.axsl.fo.FoTreeException
Ensures that this has no children by throwing an exception if it does.

Throws:
org.axsl.fo.FoTreeException - If this has any children.

validateAtLeastOneChild

public void validateAtLeastOneChild()
                             throws org.axsl.fo.FoTreeException
Ensures that this has at least one child by throwing an exception if it does not.

Throws:
org.axsl.fo.FoTreeException - If this has no children.

invalidPageReference

public void invalidPageReference(String invalidReference)
                          throws org.axsl.fo.FoTreeException
Creates a suitable exception or warning if an object references a non-existent page.

Parameters:
invalidReference - The page reference that is invalid.
Throws:
org.axsl.fo.FoTreeException - If a non-existent page is referenced.

isBlockLevelFo

public boolean isBlockLevelFo()
Specified by:
isBlockLevelFo in interface org.axsl.fo.Fo

traitIsReferenceArea

public boolean traitIsReferenceArea()
Specified by:
traitIsReferenceArea in interface org.axsl.fo.Fo

ancestorGeneratingRA

public FObj ancestorGeneratingRA(org.axsl.fo.FoContext context)
Returns the nearest ancestor FObj that generates reference areas.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The nearest ancestor FObj that generates reference areas.

nearestGeneratingRA

public FObj nearestGeneratingRA(org.axsl.fo.FoContext context)
Returns self or the nearest ancestor FObj that generates reference areas.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
Self or the nearest ancestor FObj that generates reference areas.

getNearestListItem

public ListItem getNearestListItem(org.axsl.fo.FoContext context)
Returns self or the nearest ancestor FObj that is a ListItem.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
Self or the nearest ancestor FObj that is a ListItem.

getNearestAncestorListBlock

public ListBlock getNearestAncestorListBlock(org.axsl.fo.FoContext context)
Returns the nearest ancestor FObj that is a ListBlock.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The nearest ancestor FObj that is a ListBlock.

getRoot

public Root getRoot()
Return the root of this tree.

Returns:
The root of this tree.

getContainingBlock

public Block getContainingBlock(org.axsl.fo.FoContext context)
Finds the nearest self-or-ancestor that is a Block.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
If this is an instance of Block, returns this, otherwise returns the nearest ancestor that is a Block, or null if there is no ancestor Block.

ancestorFlow

public Flow ancestorFlow(org.axsl.fo.FoContext context)
Returns the ancestor Flow, if any.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The ancestor Flow, or null if this object does not descend from a Flow.

ancestorStaticContent

public StaticContent ancestorStaticContent(org.axsl.fo.FoContext context)
Returns the ancestor StaticContent, if any.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The ancestor StaticContent, or null if this object does not descend from a StaticContent.

ancestorTable

public Table ancestorTable(org.axsl.fo.FoContext context)
Specified by:
ancestorTable in interface org.axsl.fo.Fo

getNearestLeader

public Leader getNearestLeader(org.axsl.fo.FoContext context)
Return the nearest ancestor Leader instance, if any.

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

ancestorBasicLink

public BasicLink ancestorBasicLink(org.axsl.fo.FoContext context)
Specified by:
ancestorBasicLink in interface org.axsl.fo.Fo

ancestorListRelatedObject

public FObj ancestorListRelatedObject(org.axsl.fo.FoContext context)
Specified by:
ancestorListRelatedObject in interface org.axsl.fo.Fo

addChild

public abstract void addChild(FObj child)
                       throws org.axsl.fo.FoTreeException
Add a child to this object.

Parameters:
child - The child to be added.
Throws:
org.axsl.fo.FoTreeException - If the child cannot be added as a child for any reason, either because it an invalid type or is in the wrong order.

getAllowsChildren

public boolean getAllowsChildren()
Specified by:
getAllowsChildren in interface TreeNode
Specified by:
getAllowsChildren in class AbstractOrderedTreeNode

checkExceptionLocation

public void checkExceptionLocation(org.axsl.fo.FoTreeException exception)
Sets the location (from the SAX Locator) of an exception if it has not been set already.

Parameters:
exception - The exception whose location information is to be checked.

logWarning

public void logWarning(String message)
Convenience method for logging a warning.

Parameters:
message - The warning to be logged.

getFontConsumer

public org.axsl.font.FontConsumer getFontConsumer()
Convenience method for obtaining the FontConsumer for this document.

Returns:
The FontConsumer for this document.

getSpeechServer

public org.axsl.speech.SpeechServer getSpeechServer()
Returns the speech server.

Returns:
The speech server.

getGraphicServer

public org.axsl.graphic.GraphicServer getGraphicServer()
Returns the graphic server being used by this tree.

Returns:
The graphic server being used by this tree.

getTextServer

public org.axsl.text.TextServer getTextServer()
Returns the text server being used by this tree.

Returns:
The text server being used by this tree.

getNamespace

public abstract Namespace getNamespace()
Gets the Namespace instance that is associated with this object.

Returns:
The Namespace instance that is associated with this object.

getMarginLeft

public int getMarginLeft(org.axsl.fo.FoContext context)
Returns the left margin of this object.

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

getMarginRight

public int getMarginRight(org.axsl.fo.FoContext context)
Returns the right margin of this object.

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

getMarginTop

public int getMarginTop(org.axsl.fo.FoContext context)
Returns the top margin of this object.

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

getMarginBottom

public int getMarginBottom(org.axsl.fo.FoContext context)
Returns the bottom margin of this object.

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

traitColor

public Color traitColor(org.axsl.fo.FoContext context)
Specified by:
traitColor in interface org.axsl.fo.fo.prop.ColorPa

traitWrapOption

public org.axsl.common.value.WrapOption traitWrapOption(org.axsl.fo.FoContext context)
Specified by:
traitWrapOption in interface org.axsl.fo.fo.prop.WrapOptionPa

traitWhiteSpaceCollapse

public boolean traitWhiteSpaceCollapse(org.axsl.fo.FoContext context)
Specified by:
traitWhiteSpaceCollapse in interface org.axsl.fo.fo.proforma.WhiteSpaceCollapsePa

traitUnderlineScore

public boolean traitUnderlineScore(org.axsl.fo.FoContext context)
Specified by:
traitUnderlineScore in interface org.axsl.fo.fo.prop.TextDecorationPa

traitOverlineScore

public boolean traitOverlineScore(org.axsl.fo.FoContext context)
Specified by:
traitOverlineScore in interface org.axsl.fo.fo.prop.TextDecorationPa

traitThroughScore

public boolean traitThroughScore(org.axsl.fo.FoContext context)
Specified by:
traitThroughScore in interface org.axsl.fo.fo.prop.TextDecorationPa

traitUnderlineScoreColor

public Color traitUnderlineScoreColor(org.axsl.fo.FoContext context)
Specified by:
traitUnderlineScoreColor in interface org.axsl.fo.fo.prop.TextDecorationPa

traitOverlineScoreColor

public Color traitOverlineScoreColor(org.axsl.fo.FoContext context)
Specified by:
traitOverlineScoreColor in interface org.axsl.fo.fo.prop.TextDecorationPa

traitThroughScoreColor

public Color traitThroughScoreColor(org.axsl.fo.FoContext context)
Specified by:
traitThroughScoreColor in interface org.axsl.fo.fo.prop.TextDecorationPa

traitBlink

public boolean traitBlink(org.axsl.fo.FoContext context)
Specified by:
traitBlink in interface org.axsl.fo.fo.prop.TextDecorationPa

traitId

public String traitId()
Specified by:
traitId in interface org.axsl.fo.fo.prop.IdPa

traitInternalDestination

public 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 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(org.axsl.fo.FoContext context)
Specified by:
traitStartIndent in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpan

public org.axsl.common.value.Span traitSpan(org.axsl.fo.FoContext context)
Specified by:
traitSpan in interface org.axsl.fo.fo.prop.SpanPa

traitFlowName

public String traitFlowName()
Specified by:
traitFlowName in interface org.axsl.fo.fo.prop.FlowNamePa

traitMarkerClassName

public String traitMarkerClassName()
Returns the "marker-class-name" trait.

Returns:
The "marker-class-name" trait.

traitRetrieveClassName

public String traitRetrieveClassName()
Returns the "retrieve-class-name" trait.

Returns:
The "retrieve-class-name" trait.

traitColumnNumber

public int traitColumnNumber(org.axsl.fo.FoContext context)
Returns the "column-number" trait.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The "column-number" trait.

traitNumberColumnsSpanned

public int traitNumberColumnsSpanned()
Returns the "number-columns-spanned" trait.

Returns:
The "number-columns-spanned" trait.

traitNumberRowsSpanned

public int traitNumberRowsSpanned()
Returns the "number-rows-spanned" trait.

Returns:
The "number-rows-spanned" trait.

traitBorderCollapse

public org.axsl.common.value.BorderModel traitBorderCollapse(org.axsl.fo.FoContext context)
Specified by:
traitBorderCollapse in interface org.axsl.fo.fo.prop.BorderCollapsePa

traitDisplayAlign

public org.axsl.common.value.DisplayAlign traitDisplayAlign(org.axsl.fo.FoContext context)
Specified by:
traitDisplayAlign in interface org.axsl.fo.fo.prop.DisplayAlignPa

traitRelativeAlign

public org.axsl.common.value.RelativeAlign traitRelativeAlign(org.axsl.fo.FoContext context)
Specified by:
traitRelativeAlign in interface org.axsl.fo.fo.prop.RelativeAlignPa

traitBorderSeparationIpd

public int traitBorderSeparationIpd(org.axsl.fo.FoContext context)
Specified by:
traitBorderSeparationIpd in interface org.axsl.fo.fo.prop.BorderSeparationPa

traitBorderSeparationBpd

public int traitBorderSeparationBpd(org.axsl.fo.FoContext context)
Specified by:
traitBorderSeparationBpd in interface org.axsl.fo.fo.prop.BorderSeparationPa

traitNumberColumnsRepeated

public int traitNumberColumnsRepeated()
Specified by:
traitNumberColumnsRepeated in interface org.axsl.fo.fo.prop.NumberColumnsRepeatedPa

traitBreakAfter

public org.axsl.common.value.Break traitBreakAfter(org.axsl.fo.FoContext context)
Specified by:
traitBreakAfter in interface org.axsl.fo.fo.prop.BreakAfterPa

traitKeepTogetherWithinLine

public int traitKeepTogetherWithinLine(org.axsl.fo.FoContext context)
Specified by:
traitKeepTogetherWithinLine in interface org.axsl.fo.fo.prop.KeepTogetherPa

traitKeepTogetherWithinColumn

public int traitKeepTogetherWithinColumn(org.axsl.fo.FoContext context)
Specified by:
traitKeepTogetherWithinColumn in interface org.axsl.fo.fo.prop.KeepTogetherPa

traitKeepTogetherWithinPage

public int traitKeepTogetherWithinPage(org.axsl.fo.FoContext context)
Specified by:
traitKeepTogetherWithinPage in interface org.axsl.fo.fo.prop.KeepTogetherPa

traitKeepWithNextWithinLine

public int traitKeepWithNextWithinLine(org.axsl.fo.FoContext context)
Specified by:
traitKeepWithNextWithinLine in interface org.axsl.fo.fo.prop.KeepWithNextPa

traitKeepWithNextWithinColumn

public int traitKeepWithNextWithinColumn(org.axsl.fo.FoContext context)
Specified by:
traitKeepWithNextWithinColumn in interface org.axsl.fo.fo.prop.KeepWithNextPa

traitKeepWithNextWithinPage

public int traitKeepWithNextWithinPage(org.axsl.fo.FoContext context)
Specified by:
traitKeepWithNextWithinPage in interface org.axsl.fo.fo.prop.KeepWithNextPa

traitKeepWithPreviousWithinLine

public int traitKeepWithPreviousWithinLine(org.axsl.fo.FoContext context)
Specified by:
traitKeepWithPreviousWithinLine in interface org.axsl.fo.fo.prop.KeepWithPreviousPa

traitKeepWithPreviousWithinColumn

public int traitKeepWithPreviousWithinColumn(org.axsl.fo.FoContext context)
Specified by:
traitKeepWithPreviousWithinColumn in interface org.axsl.fo.fo.prop.KeepWithPreviousPa

traitKeepWithPreviousWithinPage

public int traitKeepWithPreviousWithinPage(org.axsl.fo.FoContext context)
Specified by:
traitKeepWithPreviousWithinPage in interface org.axsl.fo.fo.prop.KeepWithPreviousPa

traitMasterReference

public String traitMasterReference()
Returns the "master-reference" trait.

Returns:
The "master-reference" trait.

traitPagePosition

public FoValue traitPagePosition()
Returns the "page-position" trait.

Returns:
The "page-position" trait.

traitOddOrEven

public FoValue traitOddOrEven()
Returns the "odd-or-even" trait.

Returns:
The "odd-or-even" trait.

traitBlankOrNotBlank

public FoValue traitBlankOrNotBlank()
Returns the "blank-or-not-blank" trait.

Returns:
The "blank-or-not-blank" trait.

traitInitialPageNumber

public int traitInitialPageNumber(int lastPageNumberUsed)
Specified by:
traitInitialPageNumber in interface org.axsl.fo.fo.prop.InitialPageNumberPa

initialPageNumberSetExplicitly

public boolean initialPageNumberSetExplicitly()
Specified by:
initialPageNumberSetExplicitly in interface org.axsl.fo.fo.prop.InitialPageNumberPa

traitFormat

public String traitFormat()
Returns the "format" trait.

Specified by:
traitFormat in interface org.axsl.fo.fo.prop.FormatPa
Returns:
The "format" trait.

traitGroupingSeparator

public char traitGroupingSeparator()
Returns the "grouping-separator" trait.

Returns:
The "grouping-separator" trait.

traitGroupingSize

public int traitGroupingSize()
Returns the "grouping-size" trait.

Returns:
The "grouping-size" trait.

traitLetterValue

public FoValue traitLetterValue()
Returns the "letter-value" trait.

Returns:
The "letter-value" trait.

traitForcePageCount

public org.axsl.common.value.ForcePageCount traitForcePageCount(org.axsl.fo.FoContext context)
Specified by:
traitForcePageCount in interface org.axsl.fo.fo.prop.ForcePageCountPa

traitMasterName

public String traitMasterName()
Returns the "master-name" trait.

Returns:
The "master-name" trait.

traitPrecedence

public boolean traitPrecedence()
Returns the "precedence" trait.

Returns:
The "precedence" trait.

traitExtent

public int traitExtent()
Specified by:
traitExtent in interface org.axsl.fo.fo.prop.ExtentPa

traitColumnGap

public int traitColumnGap(org.axsl.fo.FoContext context)
Specified by:
traitColumnGap in interface org.axsl.fo.fo.prop.ColumnGapPa

traitOverflow

public org.axsl.common.value.Overflow traitOverflow(org.axsl.fo.FoContext context)
Specified by:
traitOverflow in interface org.axsl.fo.fo.prop.OverflowPa

traitColumnCount

public int traitColumnCount(org.axsl.fo.FoContext context)
Specified by:
traitColumnCount in interface org.axsl.fo.fo.prop.ColumnCountPa

traitMaximumRepeats

public int traitMaximumRepeats()
Returns the "maximum-repeats" trait.

Returns:
The "maximum-repeats" trait.

traitPageWidth

public int traitPageWidth()
Specified by:
traitPageWidth in interface org.axsl.fo.fo.prop.PageWidthPa

traitPageHeight

public int traitPageHeight()
Specified by:
traitPageHeight in interface org.axsl.fo.fo.prop.PageHeightPa

traitTextAlign

public org.axsl.common.value.TextAlign traitTextAlign(org.axsl.fo.FoContext context)
Specified by:
traitTextAlign in interface org.axsl.fo.fo.prop.TextAlignPa

traitTextAlignString

public String traitTextAlignString()
Specified by:
traitTextAlignString in interface org.axsl.fo.fo.prop.TextAlignPa

traitTextAlignLast

public org.axsl.common.value.TextAlignLast traitTextAlignLast(org.axsl.fo.FoContext context)
Specified by:
traitTextAlignLast in interface org.axsl.fo.fo.prop.TextAlignLastPa

traitEndIndent

public int traitEndIndent(org.axsl.fo.FoContext context)
Specified by:
traitEndIndent in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceBeforeMinimum

public int traitSpaceBeforeMinimum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceBeforeMinimum in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceBeforeOptimum

public int traitSpaceBeforeOptimum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceBeforeOptimum in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceBeforeMaximum

public int traitSpaceBeforeMaximum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceBeforeMaximum in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceBeforeConditionality

public org.axsl.common.value.Conditionality traitSpaceBeforeConditionality(org.axsl.fo.FoContext context)
Specified by:
traitSpaceBeforeConditionality in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceBeforePrecedence

public int traitSpaceBeforePrecedence()
Specified by:
traitSpaceBeforePrecedence in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceAfterMinimum

public int traitSpaceAfterMinimum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceAfterMinimum in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceAfterOptimum

public int traitSpaceAfterOptimum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceAfterOptimum in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceAfterMaximum

public int traitSpaceAfterMaximum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceAfterMaximum in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceAfterConditionality

public org.axsl.common.value.Conditionality traitSpaceAfterConditionality(org.axsl.fo.FoContext context)
Specified by:
traitSpaceAfterConditionality in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceAfterPrecedence

public int traitSpaceAfterPrecedence()
Specified by:
traitSpaceAfterPrecedence in interface org.axsl.fo.fo.prop.CommonMarginBlockPa

traitSpaceStartMinimum

public int traitSpaceStartMinimum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceStartMinimum in interface org.axsl.fo.fo.prop.CommonMarginInlinePa

traitSpaceStartOptimum

public int traitSpaceStartOptimum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceStartOptimum in interface org.axsl.fo.fo.prop.CommonMarginInlineOptimumPa

traitSpaceStartMaximum

public int traitSpaceStartMaximum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceStartMaximum in interface org.axsl.fo.fo.prop.CommonMarginInlinePa

traitSpaceStartConditionality

public org.axsl.common.value.Conditionality traitSpaceStartConditionality()
Specified by:
traitSpaceStartConditionality in interface org.axsl.fo.fo.prop.CommonMarginInlinePa

traitSpaceStartPrecedence

public int traitSpaceStartPrecedence()
Specified by:
traitSpaceStartPrecedence in interface org.axsl.fo.fo.prop.CommonMarginInlinePa

traitSpaceEndMinimum

public int traitSpaceEndMinimum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceEndMinimum in interface org.axsl.fo.fo.prop.CommonMarginInlinePa

traitSpaceEndOptimum

public int traitSpaceEndOptimum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceEndOptimum in interface org.axsl.fo.fo.prop.CommonMarginInlineOptimumPa

traitSpaceEndMaximum

public int traitSpaceEndMaximum(org.axsl.fo.FoContext context)
Specified by:
traitSpaceEndMaximum in interface org.axsl.fo.fo.prop.CommonMarginInlinePa

traitSpaceEndConditionality

public org.axsl.common.value.Conditionality traitSpaceEndConditionality()
Specified by:
traitSpaceEndConditionality in interface org.axsl.fo.fo.prop.CommonMarginInlinePa

traitSpaceEndPrecedence

public int traitSpaceEndPrecedence()
Specified by:
traitSpaceEndPrecedence in interface org.axsl.fo.fo.prop.CommonMarginInlinePa

traitTextIndent

public int traitTextIndent(org.axsl.fo.FoContext context)
Specified by:
traitTextIndent in interface org.axsl.fo.fo.prop.TextIndentPa

traitTop

public int traitTop(org.axsl.fo.FoContext context)
Specified by:
traitTop in interface org.axsl.fo.fo.prop.CommonPositionPa

traitBottom

public int traitBottom(org.axsl.fo.FoContext context)
Specified by:
traitBottom in interface org.axsl.fo.fo.prop.CommonPositionPa

traitLeft

public int traitLeft(org.axsl.fo.FoContext context)
Specified by:
traitLeft in interface org.axsl.fo.fo.prop.CommonPositionPa

traitRight

public int traitRight(org.axsl.fo.FoContext context)
Specified by:
traitRight in interface org.axsl.fo.fo.prop.CommonPositionPa

traitCharacter

public char traitCharacter()
Returns the "character" trait.

Returns:
The "character" trait.

traitSrc

public String traitSrc(org.axsl.fo.FoContext context)
Specified by:
traitSrc in interface org.axsl.fo.fo.prop.SrcPa

traitBreakBefore

public org.axsl.common.value.Break traitBreakBefore(org.axsl.fo.FoContext context)
Specified by:
traitBreakBefore in interface org.axsl.fo.fo.prop.BreakBeforePa

traitScaling

public Scaling traitScaling(org.axsl.fo.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.
See Also:
"XSL-FO Standard 1.0, Section 7.14.10"

traitLeaderPattern

public org.axsl.common.value.LeaderPattern traitLeaderPattern(org.axsl.fo.FoContext context)
Specified by:
traitLeaderPattern in interface org.axsl.fo.fo.prop.LeaderPatternPa

traitLeaderLengthMin

public int traitLeaderLengthMin(org.axsl.fo.FoContext context)
Specified by:
traitLeaderLengthMin in interface org.axsl.fo.fo.prop.LeaderLengthPa

traitLeaderLengthOpt

public int traitLeaderLengthOpt(org.axsl.fo.FoContext context)
Specified by:
traitLeaderLengthOpt in interface org.axsl.fo.fo.prop.LeaderLengthPa

traitLeaderLengthMax

public int traitLeaderLengthMax(org.axsl.fo.FoContext context)
Specified by:
traitLeaderLengthMax in interface org.axsl.fo.fo.prop.LeaderLengthPa

traitRuleThickness

public int traitRuleThickness(org.axsl.fo.FoContext context)
Specified by:
traitRuleThickness in interface org.axsl.fo.fo.prop.RuleThicknessPa

traitRuleStyle

public org.axsl.common.value.RuleStyle traitRuleStyle(org.axsl.fo.FoContext context)
Specified by:
traitRuleStyle in interface org.axsl.fo.fo.prop.RuleStylePa

traitLeaderPatternWidth

public int traitLeaderPatternWidth(org.axsl.fo.FoContext context)
Specified by:
traitLeaderPatternWidth in interface org.axsl.fo.fo.prop.LeaderPatternWidthPa

traitLeaderAlignment

public org.axsl.common.value.LeaderAlignment traitLeaderAlignment(org.axsl.fo.FoContext context)
Specified by:
traitLeaderAlignment in interface org.axsl.fo.fo.prop.LeaderAlignmentPa

traitRefId

public String traitRefId(org.axsl.fo.FoContext context)
Specified by:
traitRefId in interface org.axsl.fo.fo.prop.RefIdPa

traitTableLayout

public org.axsl.common.value.TableLayout traitTableLayout()
Specified by:
traitTableLayout in interface org.axsl.fo.fo.prop.TableLayoutPa

traitTableOmitHeaderAtBreak

public boolean traitTableOmitHeaderAtBreak(org.axsl.fo.FoContext context)
Specified by:
traitTableOmitHeaderAtBreak in interface org.axsl.fo.fo.prop.TableOmitHeaderAtBreakPa

traitTableOmitFooterAtBreak

public boolean traitTableOmitFooterAtBreak(org.axsl.fo.FoContext context)
Specified by:
traitTableOmitFooterAtBreak in interface org.axsl.fo.fo.prop.TableOmitFooterAtBreakPa

traitBpDimensionMax

public int traitBpDimensionMax(org.axsl.fo.FoContext context)
Specified by:
traitBpDimensionMax in interface org.axsl.fo.fo.prop.BlockProgressionDimensionPa

traitBpDimensionOpt

public int traitBpDimensionOpt(org.axsl.fo.FoContext context)
Specified by:
traitBpDimensionOpt in interface org.axsl.fo.fo.prop.BlockProgressionDimensionPa

traitBpDimensionMin

public int traitBpDimensionMin(org.axsl.fo.FoContext context)
Specified by:
traitBpDimensionMin in interface org.axsl.fo.fo.prop.BlockProgressionDimensionPa

traitIpDimensionMax

public int traitIpDimensionMax(org.axsl.fo.FoContext context)
Specified by:
traitIpDimensionMax in interface org.axsl.fo.fo.prop.InlineProgressionDimensionPa

traitIpDimensionOpt

public int traitIpDimensionOpt(org.axsl.fo.FoContext context)
Specified by:
traitIpDimensionOpt in interface org.axsl.fo.fo.prop.InlineProgressionDimensionPa

traitIpDimensionMin

public int traitIpDimensionMin(org.axsl.fo.FoContext context)
Specified by:
traitIpDimensionMin in interface org.axsl.fo.fo.prop.InlineProgressionDimensionPa

traitFontFamily

public List<String> traitFontFamily(org.axsl.fo.FoContext context)
Specified by:
traitFontFamily in interface org.axsl.fo.fo.proforma.CommonFontExcludedPa

traitFontStyle

public org.axsl.font.Font.Style traitFontStyle(org.axsl.fo.FoContext context)
Specified by:
traitFontStyle in interface org.axsl.fo.fo.prop.FontStylePa

traitFontWeight

public org.axsl.font.Font.Weight traitFontWeight(org.axsl.fo.FoContext context)
Specified by:
traitFontWeight in interface org.axsl.fo.fo.prop.FontWeightPa

traitFontSize

public int traitFontSize(org.axsl.fo.FoContext context)
Specified by:
traitFontSize in interface org.axsl.fo.fo.proforma.CommonFontExcludedPa

traitFontVariant

public org.axsl.font.Font.Variant traitFontVariant(org.axsl.fo.FoContext context)
Specified by:
traitFontVariant in interface org.axsl.fo.fo.proforma.CommonFontExcludedPa

traitFontStretch

public org.axsl.font.Font.Stretch traitFontStretch(org.axsl.fo.FoContext context)
Specified by:
traitFontStretch in interface org.axsl.fo.fo.proforma.CommonFontExcludedPa

traitProvisionalDistanceBetweenStarts

public int traitProvisionalDistanceBetweenStarts(org.axsl.fo.FoContext context)
Specified by:
traitProvisionalDistanceBetweenStarts in interface org.axsl.fo.fo.prop.ProvisionalDistanceBetweenStartsPa

traitProvisionalLabelSeparation

public int traitProvisionalLabelSeparation(org.axsl.fo.FoContext context)
Specified by:
traitProvisionalLabelSeparation in interface org.axsl.fo.fo.prop.ProvisionalLabelSeparationPa

traitBorderBeforeColor

public Color traitBorderBeforeColor(org.axsl.fo.FoContext context)
Specified by:
traitBorderBeforeColor in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderAfterColor

public Color traitBorderAfterColor(org.axsl.fo.FoContext context)
Specified by:
traitBorderAfterColor in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderStartColor

public Color traitBorderStartColor(org.axsl.fo.FoContext context)
Specified by:
traitBorderStartColor in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderEndColor

public Color traitBorderEndColor(org.axsl.fo.FoContext context)
Specified by:
traitBorderEndColor in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderBeforeStyle

public org.axsl.common.value.BorderStyle traitBorderBeforeStyle(org.axsl.fo.FoContext context)
Specified by:
traitBorderBeforeStyle in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderAfterStyle

public org.axsl.common.value.BorderStyle traitBorderAfterStyle(org.axsl.fo.FoContext context)
Specified by:
traitBorderAfterStyle in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderStartStyle

public org.axsl.common.value.BorderStyle traitBorderStartStyle(org.axsl.fo.FoContext context)
Specified by:
traitBorderStartStyle in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderEndStyle

public org.axsl.common.value.BorderStyle traitBorderEndStyle(org.axsl.fo.FoContext context)
Specified by:
traitBorderEndStyle in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderBeforeWidth

public int traitBorderBeforeWidth(org.axsl.fo.FoContext context)
Specified by:
traitBorderBeforeWidth in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderAfterWidth

public int traitBorderAfterWidth(org.axsl.fo.FoContext context)
Specified by:
traitBorderAfterWidth in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderStartWidth

public int traitBorderStartWidth(org.axsl.fo.FoContext context)
Specified by:
traitBorderStartWidth in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBorderEndWidth

public int traitBorderEndWidth(org.axsl.fo.FoContext context)
Specified by:
traitBorderEndWidth in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitPaddingBefore

public int traitPaddingBefore(org.axsl.fo.FoContext context)
Specified by:
traitPaddingBefore in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitPaddingAfter

public int traitPaddingAfter(org.axsl.fo.FoContext context)
Specified by:
traitPaddingAfter in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitPaddingStart

public int traitPaddingStart(org.axsl.fo.FoContext context)
Specified by:
traitPaddingStart in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitPaddingEnd

public int traitPaddingEnd(org.axsl.fo.FoContext context)
Specified by:
traitPaddingEnd in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBackgroundColor

public Color traitBackgroundColor(org.axsl.fo.FoContext context)
Specified by:
traitBackgroundColor in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitHyphenate

public boolean traitHyphenate(org.axsl.fo.FoContext context)
Specified by:
traitHyphenate in interface org.axsl.fo.fo.prop.CommonHyphenationPa

traitHyphenationCharacter

public int traitHyphenationCharacter(org.axsl.fo.FoContext context)
Specified by:
traitHyphenationCharacter in interface org.axsl.fo.fo.prop.CommonHyphenationPa

traitHyphenationPushCharacterCount

public int traitHyphenationPushCharacterCount(org.axsl.fo.FoContext context)
Specified by:
traitHyphenationPushCharacterCount in interface org.axsl.fo.fo.prop.CommonHyphenationPa

traitHyphenationRemainCharacterCount

public int traitHyphenationRemainCharacterCount(org.axsl.fo.FoContext context)
Specified by:
traitHyphenationRemainCharacterCount in interface org.axsl.fo.fo.prop.CommonHyphenationPa

traitLanguage

public org.axsl.common.i18n.Language traitLanguage(org.axsl.fo.FoContext context)
Specified by:
traitLanguage in interface org.axsl.fo.fo.prop.CommonHyphenationPa

traitCountry

public org.axsl.common.i18n.Country traitCountry(org.axsl.fo.FoContext context)
Specified by:
traitCountry in interface org.axsl.fo.fo.prop.CommonHyphenationPa

traitBackgroundImage

public org.axsl.graphic.Graphic traitBackgroundImage(org.axsl.fo.FoContext context)
Specified by:
traitBackgroundImage in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBackgroundRepeat

public org.axsl.common.value.BackgroundRepeat traitBackgroundRepeat(org.axsl.fo.FoContext context)
Specified by:
traitBackgroundRepeat in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitSourceDocument

public String[] traitSourceDocument(org.axsl.fo.FoContext context)
Specified by:
traitSourceDocument in interface org.axsl.fo.fo.prop.CommonAccessibilityPa

traitRole

public String traitRole(org.axsl.fo.FoContext context)
Specified by:
traitRole in interface org.axsl.fo.fo.prop.CommonAccessibilityPa

traitTextAltitude

public int traitTextAltitude(org.axsl.fo.FoContext context)
Specified by:
traitTextAltitude in interface org.axsl.fo.fo.prop.TextAltitudePa

traitTextDepth

public int traitTextDepth(org.axsl.fo.FoContext context)
Specified by:
traitTextDepth in interface org.axsl.fo.fo.prop.TextDepthPa

traitHalfLeadingMin

public int traitHalfLeadingMin(org.axsl.fo.FoContext context)
Specified by:
traitHalfLeadingMin in interface org.axsl.fo.fo.prop.LineHeightPa

traitHalfLeadingOpt

public int traitHalfLeadingOpt(org.axsl.fo.FoContext context)
Specified by:
traitHalfLeadingOpt in interface org.axsl.fo.fo.prop.LineHeightPa

traitHalfLeadingMax

public int traitHalfLeadingMax(org.axsl.fo.FoContext context)
Specified by:
traitHalfLeadingMax in interface org.axsl.fo.fo.prop.LineHeightPa

traitHalfLeadingConditionality

public org.axsl.common.value.Conditionality traitHalfLeadingConditionality(org.axsl.fo.FoContext context)
Specified by:
traitHalfLeadingConditionality in interface org.axsl.fo.fo.prop.LineHeightPa

traitHalfLeadingPrecedence

public int traitHalfLeadingPrecedence(org.axsl.fo.FoContext context)
Specified by:
traitHalfLeadingPrecedence in interface org.axsl.fo.fo.prop.LineHeightPa

traitAlignmentBaseline

public org.axsl.common.value.AlignmentBaseline traitAlignmentBaseline(org.axsl.fo.FoContext context)
Specified by:
traitAlignmentBaseline in interface org.axsl.fo.fo.prop.AlignmentBaselinePa

traitAlignmentAdjust

public int traitAlignmentAdjust(org.axsl.fo.FoContext context,
                                org.axsl.fo.FoInlineContext inlineContext)
Specified by:
traitAlignmentAdjust in interface org.axsl.fo.fo.prop.AlignmentAdjustPa

traitBaselineShift

public int traitBaselineShift(org.axsl.fo.FoContext context)
Specified by:
traitBaselineShift in interface org.axsl.fo.fo.prop.BaselineShiftPa

traitDominantBaseline

public org.axsl.common.value.Baseline traitDominantBaseline(org.axsl.fo.FoContext context)
Specified by:
traitDominantBaseline in interface org.axsl.fo.fo.prop.DominantBaselinePa

computeAutoBaseline

public org.axsl.common.value.Baseline computeAutoBaseline(org.axsl.fo.FoContext context)
Computes the dominant-baseline="auto" value.

Parameters:
context - An object that knows how to resolve FO context issues.
Returns:
The value for dominant-baseline="auto".

getBaselineFromScript

public org.axsl.common.value.Baseline getBaselineFromScript(org.axsl.fo.FoContext context)
Returns this object's dominant-baseline, as computed from its font and script.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
This object's dominant-baseline, as computed from its font and script.

traitLastLineEndIndent

public int traitLastLineEndIndent(org.axsl.fo.FoContext context)
Specified by:
traitLastLineEndIndent in interface org.axsl.fo.fo.prop.LastLineEndIndentPa

traitLetterSpacingMin

public int traitLetterSpacingMin(org.axsl.fo.FoContext context)
Specified by:
traitLetterSpacingMin in interface org.axsl.fo.fo.prop.LetterSpacingPa

traitLetterSpacingOpt

public int traitLetterSpacingOpt(org.axsl.fo.FoContext context)
Specified by:
traitLetterSpacingOpt in interface org.axsl.fo.fo.prop.LetterSpacingPa

traitLetterSpacingMax

public int traitLetterSpacingMax(org.axsl.fo.FoContext context)
Specified by:
traitLetterSpacingMax in interface org.axsl.fo.fo.prop.LetterSpacingPa

traitLetterSpacingConditionality

public org.axsl.common.value.Conditionality traitLetterSpacingConditionality()
Specified by:
traitLetterSpacingConditionality in interface org.axsl.fo.fo.prop.LetterSpacingPa

traitLetterSpacingPrecedence

public int traitLetterSpacingPrecedence()
Specified by:
traitLetterSpacingPrecedence in interface org.axsl.fo.fo.prop.LetterSpacingPa

traitOrphans

public int traitOrphans(org.axsl.fo.FoContext context)
Specified by:
traitOrphans in interface org.axsl.fo.fo.prop.OrphansPa

traitWidows

public int traitWidows(org.axsl.fo.FoContext context)
Specified by:
traitWidows in interface org.axsl.fo.fo.prop.WidowsPa

traitIndicateDestination

public boolean traitIndicateDestination(org.axsl.fo.FoContext context)
Specified by:
traitIndicateDestination in interface org.axsl.fo.fo.prop.IndicateDestinationPa

traitAutoRestore

public boolean traitAutoRestore(org.axsl.fo.FoContext context)
Specified by:
traitAutoRestore in interface org.axsl.fo.fo.prop.AutoRestorePa

traitEndsRow

public boolean traitEndsRow(org.axsl.fo.FoContext context)
Returns the "ends-row" trait for this FO. Note: This trait is not exposed in the aXSL API because that API requires that table-rows be added to table content that does not contain them. In other words, the use of this method is strictly internal to the implementation.

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(org.axsl.fo.FoContext context)
Returns the "starts-row" trait for this FO. Note: This trait is not exposed in the aXSL API because that API requires that table-rows be added to table content that does not contain them. In other words, the use of this method is strictly internal to the implementation.

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(org.axsl.fo.FoContext context)
Specified by:
traitScoreSpaces in interface org.axsl.fo.fo.prop.ScoreSpacesPa

traitTreatAsWordSpace

public boolean traitTreatAsWordSpace(org.axsl.fo.FoContext context,
                                     char character)
Specified by:
traitTreatAsWordSpace in interface org.axsl.fo.fo.prop.TreatAsWordSpacePa

traitColorProfileName

public String traitColorProfileName(org.axsl.fo.FoContext context)
Specified by:
traitColorProfileName in interface org.axsl.fo.fo.prop.ColorProfileNamePa

traitCaseName

public String traitCaseName(org.axsl.fo.FoContext context)
Specified by:
traitCaseName in interface org.axsl.fo.fo.prop.CaseNamePa

traitContentType

public String traitContentType(org.axsl.fo.FoContext context)
Specified by:
traitContentType in interface org.axsl.fo.fo.prop.ContentTypePa

traitAbsolutePosition

public org.axsl.common.value.AbsolutePosition traitAbsolutePosition(org.axsl.fo.FoContext context)
Specified by:
traitAbsolutePosition in interface org.axsl.fo.fo.prop.CommonAbsolutePositionPa

traitBackgroundAttachment

public org.axsl.common.value.BackgroundAttachment traitBackgroundAttachment(org.axsl.fo.FoContext context)
Specified by:
traitBackgroundAttachment in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitCaptionSide

public org.axsl.common.value.RelativeCompass traitCaptionSide(org.axsl.fo.FoContext context)
Specified by:
traitCaptionSide in interface org.axsl.fo.fo.prop.CaptionSidePa

traitDirection

public org.axsl.common.value.AbsoluteDirection traitDirection(org.axsl.fo.FoContext context)
Specified by:
traitDirection in interface org.axsl.fo.fo.prop.DirectionPa

traitFontSelectionStrategy

public org.axsl.font.Font.SelectionStrategy traitFontSelectionStrategy(org.axsl.fo.FoContext context)
Specified by:
traitFontSelectionStrategy in interface org.axsl.fo.fo.proforma.CommonFontExcludedPa

traitHyphenationKeep

public org.axsl.common.value.HyphenationKeep traitHyphenationKeep(org.axsl.fo.FoContext context)
Specified by:
traitHyphenationKeep in interface org.axsl.fo.fo.prop.HyphenationKeepPa

traitLinefeedTreatment

public org.axsl.common.value.LinefeedTreatment traitLinefeedTreatment(org.axsl.fo.FoContext context)
Specified by:
traitLinefeedTreatment in interface org.axsl.fo.fo.proforma.LinefeedTreatmentPa

traitLineHeightShiftAdjustment

public org.axsl.common.value.LineHeightShiftAdjustment traitLineHeightShiftAdjustment(org.axsl.fo.FoContext context)
Specified by:
traitLineHeightShiftAdjustment in interface org.axsl.fo.fo.prop.LineHeightShiftAdjustmentPa

traitLineStackingStrategy

public org.axsl.common.value.LineStackingStrategy traitLineStackingStrategy(org.axsl.fo.FoContext context)
Specified by:
traitLineStackingStrategy in interface org.axsl.fo.fo.prop.LineStackingStrategyPa

traitRelativePosition

public org.axsl.common.value.RelativePosition traitRelativePosition(org.axsl.fo.FoContext context)
Specified by:
traitRelativePosition in interface org.axsl.fo.fo.prop.CommonRelativePositionPa

traitScalingMethod

public ScalingMethod traitScalingMethod(org.axsl.fo.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.
See Also:
"XSL-FO Standard 1.0, Section 7.14.11"

traitSuppressAtLineBreak

public org.axsl.common.value.SuppressAtLineBreak traitSuppressAtLineBreak(org.axsl.fo.FoContext context)
Specified by:
traitSuppressAtLineBreak in interface org.axsl.fo.fo.prop.SuppressAtLineBreakPa

traitUnicodeBidi

public org.axsl.common.value.UnicodeBidi traitUnicodeBidi(org.axsl.fo.FoContext context)
Specified by:
traitUnicodeBidi in interface org.axsl.fo.fo.prop.UnicodeBidiPa

traitWhiteSpaceTreatment

public org.axsl.common.value.WhiteSpaceTreatment traitWhiteSpaceTreatment(org.axsl.fo.FoContext context)
Specified by:
traitWhiteSpaceTreatment in interface org.axsl.fo.fo.prop.WhiteSpaceTreatmentPa

traitCaseTitle

public String traitCaseTitle()
Specified by:
traitCaseTitle in interface org.axsl.fo.fo.prop.CaseTitlePa

traitActiveState

public org.axsl.common.value.ActiveState traitActiveState(org.axsl.fo.FoContext context)
Specified by:
traitActiveState in interface org.axsl.fo.fo.prop.ActiveStatePa

traitClear

public org.axsl.common.value.Clear traitClear(org.axsl.fo.FoContext context)
Specified by:
traitClear in interface org.axsl.fo.fo.prop.ClearPa

traitEmptyCells

public org.axsl.common.value.EmptyCells traitEmptyCells(org.axsl.fo.FoContext context)
Specified by:
traitEmptyCells in interface org.axsl.fo.fo.prop.EmptyCellsPa

traitFloat

public org.axsl.common.value.Float traitFloat(org.axsl.fo.FoContext context)
Specified by:
traitFloat in interface org.axsl.fo.fo.prop.FloatPa

traitMediaUsage

public org.axsl.common.value.MediaUsage traitMediaUsage(org.axsl.fo.FoContext context)
Specified by:
traitMediaUsage in interface org.axsl.fo.fo.prop.MediaUsagePa

traitReferenceOrientation

public org.axsl.common.value.ReferenceOrientation traitReferenceOrientation(org.axsl.fo.FoContext context)
Specified by:
traitReferenceOrientation in interface org.axsl.fo.fo.prop.ReferenceOrientationPa

traitRenderingIntent

public org.axsl.common.value.RenderingIntent traitRenderingIntent(org.axsl.fo.FoContext context)
Specified by:
traitRenderingIntent in interface org.axsl.fo.fo.prop.RenderingIntentPa

traitShowDestination

public org.axsl.common.value.ShowDestination traitShowDestination(org.axsl.fo.FoContext context)
Specified by:
traitShowDestination in interface org.axsl.fo.fo.prop.ShowDestinationPa

traitSpeakHeader

public org.axsl.common.value.SpeakHeader traitSpeakHeader(org.axsl.fo.FoContext context)
Specified by:
traitSpeakHeader in interface org.axsl.fo.fo.prop.CommonAuralPa

traitSpeak

public org.axsl.common.value.Speak traitSpeak(org.axsl.fo.FoContext context)
Specified by:
traitSpeak in interface org.axsl.fo.fo.prop.CommonAuralPa

traitSpeakNumeral

public org.axsl.common.value.SpeakNumeral traitSpeakNumeral(org.axsl.fo.FoContext context)
Specified by:
traitSpeakNumeral in interface org.axsl.fo.fo.prop.CommonAuralPa

traitSpeakPunctuation

public org.axsl.common.value.SpeakPunctuation traitSpeakPunctuation(org.axsl.fo.FoContext context)
Specified by:
traitSpeakPunctuation in interface org.axsl.fo.fo.prop.CommonAuralPa

traitStartingState

public org.axsl.common.value.StartingState traitStartingState(org.axsl.fo.FoContext context)
Specified by:
traitStartingState in interface org.axsl.fo.fo.prop.StartingStatePa

traitTextTransform

public org.axsl.common.value.TextTransform traitTextTransform(org.axsl.fo.FoContext context)
Specified by:
traitTextTransform in interface org.axsl.fo.fo.prop.TextTransformPa

traitVisibility

public org.axsl.common.value.Visibility traitVisibility(org.axsl.fo.FoContext context)
Specified by:
traitVisibility in interface org.axsl.fo.fo.prop.VisibilityPa

traitAzimuth

public float traitAzimuth(org.axsl.fo.FoContext context)
Specified by:
traitAzimuth in interface org.axsl.fo.fo.prop.CommonAuralPa

traitElevation

public float traitElevation(org.axsl.fo.FoContext context)
Specified by:
traitElevation in interface org.axsl.fo.fo.prop.CommonAuralPa

traitCueBefore

public String traitCueBefore(org.axsl.fo.FoContext context)
Specified by:
traitCueBefore in interface org.axsl.fo.fo.prop.CommonAuralPa

traitCueAfter

public String traitCueAfter(org.axsl.fo.FoContext context)
Specified by:
traitCueAfter in interface org.axsl.fo.fo.prop.CommonAuralPa

traitClipIsAuto

public boolean traitClipIsAuto(org.axsl.fo.FoContext context)
Specified by:
traitClipIsAuto in interface org.axsl.fo.fo.prop.ClipPa

traitClip

public Shape traitClip(org.axsl.fo.FoContext context,
                       Shape containerShape)
Specified by:
traitClip in interface org.axsl.fo.fo.prop.ClipPa

traitBorderBeforePrecedence

public int traitBorderBeforePrecedence(org.axsl.fo.FoContext context)
Specified by:
traitBorderBeforePrecedence in interface org.axsl.fo.fo.prop.BorderBeforePrecedencePa

traitBorderAfterPrecedence

public int traitBorderAfterPrecedence(org.axsl.fo.FoContext context)
Specified by:
traitBorderAfterPrecedence in interface org.axsl.fo.fo.prop.BorderAfterPrecedencePa

traitBorderStartPrecedence

public int traitBorderStartPrecedence(org.axsl.fo.FoContext context)
Specified by:
traitBorderStartPrecedence in interface org.axsl.fo.fo.prop.BorderStartPrecedencePa

traitBorderEndPrecedence

public int traitBorderEndPrecedence(org.axsl.fo.FoContext context)
Specified by:
traitBorderEndPrecedence in interface org.axsl.fo.fo.prop.BorderEndPrecedencePa

traitDestinationPlacementOffset

public int traitDestinationPlacementOffset(org.axsl.fo.FoContext context)
Specified by:
traitDestinationPlacementOffset in interface org.axsl.fo.fo.prop.DestinationPlacementOffsetPa

traitZIndex

public int traitZIndex(org.axsl.fo.FoContext context)
Specified by:
traitZIndex in interface org.axsl.fo.fo.prop.ZIndexPa

traitZIndexIsAuto

public boolean traitZIndexIsAuto(org.axsl.fo.FoContext context)
Specified by:
traitZIndexIsAuto in interface org.axsl.fo.fo.prop.ZIndexPa

traitHyphenationLadderCount

public int traitHyphenationLadderCount(org.axsl.fo.FoContext context)
Specified by:
traitHyphenationLadderCount in interface org.axsl.fo.fo.prop.HyphenationLadderCountPa

traitFontSizeAdjust

public double traitFontSizeAdjust(org.axsl.fo.FoContext context)
Specified by:
traitFontSizeAdjust in interface org.axsl.fo.fo.proforma.CommonFontExcludedPa

traitFontSizeActual

public int traitFontSizeActual(org.axsl.fo.FoContext context,
                               org.axsl.font.Font font)
Specified by:
traitFontSizeActual in interface org.axsl.fo.fo.prop.CommonFontPa

traitSpeechRate

public double traitSpeechRate(org.axsl.fo.FoContext context)
Specified by:
traitSpeechRate in interface org.axsl.fo.fo.prop.CommonAuralPa

traitPauseBefore

public double traitPauseBefore(org.axsl.fo.FoContext context)
Specified by:
traitPauseBefore in interface org.axsl.fo.fo.prop.CommonAuralPa

traitPauseAfter

public double traitPauseAfter(org.axsl.fo.FoContext context)
Specified by:
traitPauseAfter in interface org.axsl.fo.fo.prop.CommonAuralPa

traitPitch

public double traitPitch(org.axsl.fo.FoContext context)
Specified by:
traitPitch in interface org.axsl.fo.fo.prop.CommonAuralPa

traitPitchRange

public double traitPitchRange(org.axsl.fo.FoContext context)
Specified by:
traitPitchRange in interface org.axsl.fo.fo.prop.CommonAuralPa

traitVolume

public double traitVolume(org.axsl.fo.FoContext context)
Specified by:
traitVolume in interface org.axsl.fo.fo.prop.CommonAuralPa

traitPlayDuring

public String traitPlayDuring(org.axsl.fo.FoContext context)
Specified by:
traitPlayDuring in interface org.axsl.fo.fo.prop.CommonAuralPa

traitPlayDuringMix

public boolean traitPlayDuringMix(org.axsl.fo.FoContext context)
Specified by:
traitPlayDuringMix in interface org.axsl.fo.fo.prop.CommonAuralPa

traitPlayDuringRepeat

public boolean traitPlayDuringRepeat(org.axsl.fo.FoContext context)
Specified by:
traitPlayDuringRepeat in interface org.axsl.fo.fo.prop.CommonAuralPa

traitVoiceFamily

public String[] traitVoiceFamily(org.axsl.fo.FoContext context)
Specified by:
traitVoiceFamily in interface org.axsl.fo.fo.prop.CommonAuralPa

traitRichness

public double traitRichness(org.axsl.fo.FoContext context)
Specified by:
traitRichness in interface org.axsl.fo.fo.prop.CommonAuralPa

traitStress

public double traitStress(org.axsl.fo.FoContext context)
Specified by:
traitStress in interface org.axsl.fo.fo.prop.CommonAuralPa

traitScript

public org.axsl.common.i18n.Script traitScript(org.axsl.fo.FoContext context)
Specified by:
traitScript in interface org.axsl.fo.fo.prop.CommonHyphenationPa

getAutoScript

protected org.axsl.common.i18n.Script getAutoScript()
Computes the script to be used for this object based on its content.

Returns:
The content-based script for this object.

traitSwitchTo

public org.axsl.common.value.SwitchTo traitSwitchTo()
Specified by:
traitSwitchTo in interface org.axsl.fo.fo.prop.SwitchToPa

traitSwitchToNames

public String[] traitSwitchToNames()
Specified by:
traitSwitchToNames in interface org.axsl.fo.fo.prop.SwitchToPa

traitTextShadow

public org.axsl.common.value.ShadowEffect[] traitTextShadow(org.axsl.fo.FoContext context)
Specified by:
traitTextShadow in interface org.axsl.fo.fo.prop.TextShadowPa

traitTargetProcessingContext

public String traitTargetProcessingContext()
Specified by:
traitTargetProcessingContext in interface org.axsl.fo.fo.prop.TargetProcessingContextPa

traitTargetPresentationContext

public String traitTargetPresentationContext()
Specified by:
traitTargetPresentationContext in interface org.axsl.fo.fo.prop.TargetPresentationContextPa

traitTargetStylesheet

public String traitTargetStylesheet()
Specified by:
traitTargetStylesheet in interface org.axsl.fo.fo.prop.TargetStylesheetPa

traitGlyphOrientationHorizontal

public short traitGlyphOrientationHorizontal(org.axsl.fo.FoContext context)
Specified by:
traitGlyphOrientationHorizontal in interface org.axsl.fo.fo.prop.GlyphOrientationHorizontalPa

traitGlyphOrientationVertical

public short traitGlyphOrientationVertical(org.axsl.fo.FoContext context)
Specified by:
traitGlyphOrientationVertical in interface org.axsl.fo.fo.prop.GlyphOrientationVerticalPa

traitBackgroundPositionHorizontal

public int traitBackgroundPositionHorizontal(org.axsl.fo.FoContext context,
                                             int paddingRectangleWidth,
                                             int backgroundImageWidth)
Specified by:
traitBackgroundPositionHorizontal in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBackgroundPositionVertical

public int traitBackgroundPositionVertical(org.axsl.fo.FoContext context,
                                           int paddingRectangleHeight,
                                           int backgroundImageHeight)
Specified by:
traitBackgroundPositionVertical in interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitWordSpacingMin

public int traitWordSpacingMin(org.axsl.fo.FoContext context)
Specified by:
traitWordSpacingMin in interface org.axsl.fo.fo.prop.WordSpacingPa

traitWordSpacingOpt

public int traitWordSpacingOpt(org.axsl.fo.FoContext context)
Specified by:
traitWordSpacingOpt in interface org.axsl.fo.fo.prop.WordSpacingPa

traitWordSpacingMax

public int traitWordSpacingMax(org.axsl.fo.FoContext context)
Specified by:
traitWordSpacingMax in interface org.axsl.fo.fo.prop.WordSpacingPa

traitWordSpacingConditionality

public org.axsl.common.value.Conditionality traitWordSpacingConditionality()
Specified by:
traitWordSpacingConditionality in interface org.axsl.fo.fo.prop.WordSpacingPa

traitWordSpacingPrecedence

public int traitWordSpacingPrecedence()
Specified by:
traitWordSpacingPrecedence in interface org.axsl.fo.fo.prop.WordSpacingPa

getVoice

public org.axsl.speech.Voice getVoice(org.axsl.fo.FoContext context)
Specified by:
getVoice in interface org.axsl.fo.fo.prop.CommonAuralPa

resolvePrimaryFont

protected org.axsl.font.FontUse resolvePrimaryFont(org.axsl.fo.FoContext context)
Resolves the font to be used for this object.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The resolved primary font.

getSecondaryFont

public org.axsl.font.FontUse getSecondaryFont(org.axsl.fo.FoContext context,
                                              int codePoint)
Specified by:
getSecondaryFont in interface org.axsl.fo.fo.prop.CommonFontPa

getFauxSmallCapFontSize

public int getFauxSmallCapFontSize(org.axsl.fo.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.

traitWritingMode

public DtWritingMode traitWritingMode(org.axsl.fo.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.

isContentBlock

public abstract 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.

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

isContentInline

public abstract 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.

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

isContentPcdata

public abstract 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.

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

getName

public abstract String getName()
Specified by:
getName in interface org.axsl.fo.Fo

firstTextSegment

public CharSequence firstTextSegment()
Returns the underlying text of the first descendant text item.

Returns:
The underlying text of the first descendant text item.

firstLineText

public org.axsl.text.line.LineText firstLineText()
Recursively searched the descendants of this object looking for and returning the first descendant text item.

Returns:
The first descendant text item.

getContentHeight

public float getContentHeight(org.axsl.fo.FoContext context,
                              FObjScaled fobjScaled)
Return the scaling factor that should be applied to the intrinsic height to compute the actual content height.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
fobjScaled - The object containing the scalable item whose content dimension is needed. This may be the same as this, but will not be the same for cases where we are looking for the dimension using "inherit".
Returns:
The content-height.

isContentHeightDependentOnPd

public boolean isContentHeightDependentOnPd(org.axsl.fo.FoContext context)
Indicates whether the content-height is a known value or is dependent on the viewport dimensions.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
True iff the viewport dimension must be known before the content-height can be computed.

getContentWidth

public float getContentWidth(org.axsl.fo.FoContext context,
                             FObjScaled fobjScaled)
Return the scaling factor that should be applied to the intrinsic width to compute the actual content width.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
fobjScaled - The object containing the scalable item whose content dimension is needed. This may be the same as this, but will not be the same for cases where we are looking for the dimension using "inherit".
Returns:
The content-width.

isContentWidthDependentOnPd

public boolean isContentWidthDependentOnPd(org.axsl.fo.FoContext context)
Indicates whether the content-width is a known value or is dependent on the viewport dimensions.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
True iff the viewport dimension must be known before the content-width can be computed.

getPropertyList

public abstract PropertyList getPropertyList()
Returns the property list for this FObj.

Returns:
Returns the propertyList.

qtyMarkerChildren

public int qtyMarkerChildren()
Specified by:
qtyMarkerChildren in interface org.axsl.fo.Fo

relativeAlignApplies

public boolean relativeAlignApplies()
Indicates whether the relative-align property applies to this Fo.

Returns:
True iff the relative-align property applies to this Fo.

getDescendantIterator

public DescendantIterator getDescendantIterator()
Returns an iterator for the descendants of this node.

Returns:
An iterator for the descendants of this node.

getDescendantText

public String getDescendantText()
Returns the descendant text nodes concatenated together.

Returns:
The descendant fo:character nodes, concatenated together.

traitAllowedHeightScale

public float[] traitAllowedHeightScale()
Returns the allowed-height-scale trait.

Returns:
The allowed-height-scale trait.

traitAllowedWidthScale

public float[] traitAllowedWidthScale()
Returns the allowed-height-scale trait.

Returns:
The allowed-height-scale trait.

ancestorProperty

public Property ancestorProperty(FoProperty propertyType)
Returns the nearest ancestor property of a specified type. The FO Tree is recursively searched (going up the tree) until a node is found that has the requested property. Note that this does not currently look for properties that might be inside a compound or shorhand property.

Parameters:
propertyType - The property which is sought.
Returns:
The requested property, or null if the root node is reached without finding the property.

scalingUniform

public boolean scalingUniform(org.axsl.fo.FoContext context)
Indicates whether this object has uniform scaling or not.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
True iff this object is required to preserve the aspect ratio for embedded graphical objects.

getFlowMapName

public String getFlowMapName()
Returns the flow-map-name property for this object.

Returns:
the flow-map-name property for this object, or null if none is specified.

getFlowMapReference

public String getFlowMapReference()
Returns the flow-map-reference property for this object.

Returns:
the flow-map-reference property for this object, or null if none is specified.

getFlowNameReference

public String getFlowNameReference()
Returns the flow-name-reference property for this object.

Returns:
the flow-name-reference property for this object, or null if none is specified.

getRegionNameReference

public String getRegionNameReference()
Returns the flow-name-reference property for this object.

Returns:
the flow-name-reference property for this object, or null if none is specified.

iterator

public Iterator<org.axsl.fo.Fo> iterator()
Specified by:
iterator in interface Iterable<org.axsl.fo.Fo>

getNextContiguousTextInBlock

protected CharacterSequence4a getNextContiguousTextInBlock()
Returns the next contiguous FOText item that has exactly the same closest ancestor block.

Returns:
The next contiguous FOText item. If there is no subsequent FOText item with the same closest ancestor block, or if there is a non-text leaf between, null is returned.

getPreviousContiguousTextInBlock

protected CharacterSequence4a getPreviousContiguousTextInBlock()
Returns the previous contiguous FOText item that has exactly the same closest ancestor block.

Returns:
The previous contiguous FOText item. If there is no previous FOText item with the same closest ancestor block, or if there is a non-text leaf between, null is returned.

traitAllowedHeightScale

public float[] traitAllowedHeightScale(org.axsl.fo.FoContext context)
Specified by:
traitAllowedHeightScale in interface org.axsl.fo.fo.prop.AllowedHeightScalePa

traitAllowedWidthScale

public float[] traitAllowedWidthScale(org.axsl.fo.FoContext context)
Specified by:
traitAllowedWidthScale in interface org.axsl.fo.fo.prop.AllowedWidthScalePa

traitChangeBarClass

public String traitChangeBarClass()
Specified by:
traitChangeBarClass in interface org.axsl.fo.fo.prop.ChangeBarClassPa

traitChangeBarColor

public Color traitChangeBarColor(org.axsl.fo.FoContext context)
Specified by:
traitChangeBarColor in interface org.axsl.fo.fo.prop.ChangeBarColorPa

traitChangeBarOffset

public int traitChangeBarOffset(org.axsl.fo.FoContext context)
Specified by:
traitChangeBarOffset in interface org.axsl.fo.fo.prop.ChangeBarOffsetPa

traitChangeBarPlacement

public org.axsl.common.value.ChangeBarPlacement traitChangeBarPlacement(org.axsl.fo.FoContext context)
Specified by:
traitChangeBarPlacement in interface org.axsl.fo.fo.prop.ChangeBarPlacementPa

traitChangeBarStyle

public org.axsl.common.value.BorderStyle traitChangeBarStyle(org.axsl.fo.FoContext context)
Specified by:
traitChangeBarStyle in interface org.axsl.fo.fo.prop.ChangeBarStylePa

traitChangeBarWidth

public int traitChangeBarWidth(org.axsl.fo.FoContext context)
Specified by:
traitChangeBarWidth in interface org.axsl.fo.fo.prop.ChangeBarWidthPa

traitIndexClass

public String traitIndexClass()
Specified by:
traitIndexClass in interface org.axsl.fo.fo.prop.IndexClassPa

traitIndexKey

public String traitIndexKey()
Specified by:
traitIndexKey in interface org.axsl.fo.fo.prop.IndexKeyPa

traitPageNumberTreatment

public org.axsl.common.value.PageNumberTreatment traitPageNumberTreatment(org.axsl.fo.FoContext context)
Specified by:
traitPageNumberTreatment in interface org.axsl.fo.fo.prop.PageNumberTreatmentPa

traitMergeRangesAcrossIndexKeyReferences

public org.axsl.common.value.IndexMerge traitMergeRangesAcrossIndexKeyReferences(org.axsl.fo.FoContext context)
Specified by:
traitMergeRangesAcrossIndexKeyReferences in interface org.axsl.fo.fo.prop.MergeRangesAcrossIndexKeyReferencesPa

traitMergeSequentialPageNumbers

public org.axsl.common.value.IndexMerge traitMergeSequentialPageNumbers(org.axsl.fo.FoContext context)
Specified by:
traitMergeSequentialPageNumbers in interface org.axsl.fo.fo.prop.MergeSequentialPageNumbersPa

traitMergePagesAcrossIndexKeyReferences

public org.axsl.common.value.IndexMerge traitMergePagesAcrossIndexKeyReferences(org.axsl.fo.FoContext context)
Specified by:
traitMergePagesAcrossIndexKeyReferences in interface org.axsl.fo.fo.prop.MergePagesAcrossIndexKeyReferencesPa

traitRefIndexKey

public String traitRefIndexKey()
Specified by:
traitRefIndexKey in interface org.axsl.fo.fo.prop.RefIndexKeyPa

traitIntrusionDisplace

public org.axsl.common.value.IntrusionDisplace traitIntrusionDisplace(org.axsl.fo.FoContext context)
Specified by:
traitIntrusionDisplace in interface org.axsl.fo.fo.prop.IntrusionDisplacePa

traitPageCitationStrategy

public org.axsl.common.value.PageCitationStrategy traitPageCitationStrategy()
Specified by:
traitPageCitationStrategy in interface org.axsl.fo.fo.prop.PageCitationStrategyPa

traitScalingMethod

public org.axsl.common.value.ScalingMethod traitScalingMethod()
Specified by:
traitScalingMethod in interface org.axsl.fo.fo.prop.ScalingMethodPa

traitRetrieveBoundaryWithinTable

public org.axsl.common.value.RetrieveBoundaryWithinTable traitRetrieveBoundaryWithinTable()
Specified by:
traitRetrieveBoundaryWithinTable in interface org.axsl.fo.fo.prop.RetrieveBoundaryWithinTablePa

traitRetrievePositionWithinTable

public org.axsl.common.value.RetrievePositionWithinTable traitRetrievePositionWithinTable()
Specified by:
traitRetrievePositionWithinTable in interface org.axsl.fo.fo.prop.RetrievePositionWithinTablePa

getLinkType

public org.axsl.common.value.LinkType getLinkType()
Specified by:
getLinkType in interface org.axsl.fo.fo.prop.DestinationPa

getDestination

public String getDestination()
Specified by:
getDestination in interface org.axsl.fo.fo.prop.DestinationPa

getCookedExternalDestination

public String getCookedExternalDestination()
Returns the external destination stripped of the "url()" wrapping, leading and trailing spaces, and leading and trailing quotation marks.

Returns:
The normalized external destination.

getHyphenationConsumer

public org.axsl.hyphen.HyphenationConsumer getHyphenationConsumer()
Returns the hyphenation consumer.

Returns:
The hyphenation consumer.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2017. All rights reserved.