org.foray.fotree.fo.obj
Class AbstractCharacterSequence

java.lang.Object
  org.foray.common.AbstractOrderedTreeNode
      org.foray.fotree.FObj
          org.foray.fotree.fo.obj.AbstractCharacterSequence

All Implemented Interfaces:

Iterable<org.axsl.fo.Fo>, TreeNode, org.axsl.fo.Fo, org.axsl.fo.fo.CharacterSequence, 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.CharacterPa, 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, org.axsl.fo.FoLineText, org.axsl.text.line.LineContent, org.axsl.text.line.LineText, OrderedTreeNode

Direct Known Subclasses:

CharacterSequence4a, FoWordSequence

public abstract class AbstractCharacterSequence
extends FObj
implements org.axsl.fo.fo.CharacterSequence

Abstract superclass for representations of characters.

Nested Class Summary

Nested classes/interfaces inherited from class org.foray.common.AbstractOrderedTreeNode

AbstractOrderedTreeNode.PostOrderDescendantIterator

Field Summary

static char

DISCARD_CHAR Constant indicating that a given character should be discarded.

Fields inherited from class org.foray.fotree.FObj

EMPTY_CHILD_LIST, PAGE_CITATION_TEXT_SEGMENT

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

AbstractCharacterSequence(FObj parent) Constructor.

Method Summary

Object	acceptProxyFactory(org.axsl.fo.ProxyFactory factory)
void	addChild(FObj node) Add a child to this object.
static char	applyLinefeedTreatment(char c, org.axsl.common.value.LinefeedTreatment linefeedTreatment) Applies the linefeed treatment to a specific character.
static StringBuilder	applyLinefeedTreatment(StringBuilder charArray, org.axsl.common.value.LinefeedTreatment inputLinefeedTreatment) Applies linefeed-treatment to an array of characters.
static char	applyTextTransform(org.axsl.common.value.TextTransform textTransform, boolean isFirstCharInWord, char c) Applies text-transform to one character.
static char	applyWhiteSpaceCollapse(char charBefore, char c, char charAfter) Applies white-space-collapse to one char.
static char	applyWhiteSpaceCollapse(CharSequence charArray, int index) Applies white-space-collapse to one character of charArray.
static StringBuilder	applyWhiteSpaceCollapse(StringBuilder charArray, boolean whiteSpaceCollapse) Applies white-space-collapse to an array of characters.
static char	applyWhiteSpaceTreatment(char charBefore, char c, char charAfter, org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment) Applies white space treatment to a single character.
static char	applyWhiteSpaceTreatment(CharSequence charArray, int index, org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment) Applies white space treatment to a character array.
static StringBuilder	applyWhiteSpaceTreatment(StringBuilder charArray, org.axsl.common.value.WhiteSpaceTreatment inputWhiteSpaceTreatment) Applies white-space-treatment to an array of characters.
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.
boolean	getAllowsChildren()
FObj	getChildAt(int index)
List<FObj>	getChildren() Return the List of this node's children.
int	getColumn()
org.axsl.fo.FoLineText	getContextWrapper(org.axsl.fo.FoContext context)
org.axsl.fo.fo.GraftingPoint	getGraftingPoint()
int	getLine()
String	getName()
Namespace	getNamespace() Gets the Namespace instance that is associated with this object.
FObj	getParent()
org.axsl.font.FontUse	getPrimaryFont(org.axsl.fo.FoContext context)
PropertyList	getPropertyList() Returns the property list for this FObj.
String	getSystemId()
org.axsl.fo.FoLineText	getWrapped()
org.axsl.common.i18n.Country	inlineCountry() Returns the country code for this node.
int	inlineFauxSmallCapsFontSize()
int	inlineFauxSmallCapsFontSize(org.axsl.fo.FoContext context)
org.axsl.font.FontOptions	inlineFontOptions()
int	inlineFontSize()
int	inlineFontSize(org.axsl.fo.FoContext context)
boolean	inlineHyphenate()
boolean	inlineHyphenate(org.axsl.fo.FoContext context)
int	inlineHyphenationCharacter()
int	inlineHyphenationCharacter(org.axsl.fo.FoContext context)
int	inlineHyphenationPushCount()
int	inlineHyphenationPushCount(org.axsl.fo.FoContext context)
int	inlineHyphenationRemainCount()
int	inlineHyphenationRemainCount(org.axsl.fo.FoContext context)
boolean	inlineIsFauxSmallCaps()
boolean	inlineIsFauxSmallCaps(org.axsl.fo.FoContext context)
org.axsl.common.i18n.Language	inlineLanguage() Returns the language code for this node.
int	inlineLetterSpacingOptimum()
int	inlineLetterSpacingOptimum(org.axsl.fo.FoContext context)
org.axsl.common.i18n.Orthography	inlineOrthography()
org.axsl.font.FontUse	inlinePrimaryFont()
org.axsl.font.FontUse	inlinePrimaryFont(org.axsl.fo.FoContext context)
org.axsl.font.FontUse	inlineSecondaryFont(char c)
org.axsl.font.FontUse	inlineSecondaryFont(org.axsl.fo.FoContext context, char c)
CharSequence	inlineText()
CharSequence	inlineText(org.axsl.fo.FoContext context)
int	inlineWordSpacingOptimum()
int	inlineWordSpacingOptimum(org.axsl.fo.FoContext context)
boolean	inlineWrapOption()
boolean	inlineWrapOption(org.axsl.fo.FoContext context)
abstract boolean	isAllWhiteSpace() Indicates whether this text item is all whitespace.
boolean	isContentBlock() Reports whether the object fits the %block parameter entity described in XSL-FO Std 1.0, Section 6.2.
boolean	isContentInline() Reports whether the object fits the %inline parameter entity described in XSL-FO Std 1.0, Section 6.2.
boolean	isContentPcdata() Reports whether the object fits the #PCDATA content type in XSL-FO Std 1.0, Section 6.2.
boolean	isLastItemInBlock()
boolean	isValid()
org.axsl.text.line.LineText	nextContiguousLineText()
org.axsl.text.line.LineText	previousContiguousLineText()
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.
String	traitId() Overrides standard logic, because, although property "id" applies to fo:character, there is no way to set such a property on a sequence of fo:character objects that are inferred from #PCDATA.
void	validateAncestry() A hook into the parsing process which allows the subclass instance to validate its ancestry.
void	validateDescendants() A hook into the parsing process which allows the subclass instance to validate its descendants.
void	validateProperties() A hook into the parsing process which allows the subclass instance to validate its properties.

Methods inherited from class org.foray.fotree.FObj

addCharacters, addChildToEmptyContentModel, ancestorBasicLink, ancestorFlow, ancestorGeneratingRA, ancestorListRelatedObject, ancestorMarker, ancestorProperty, ancestorStaticContent, ancestorTable, checkExceptionLocation, computeAutoBaseline, containsText, effectiveParent, firstLineText, firstTextSegment, getAutoScript, getBaselineFromScript, getContainingBlock, getContentHeight, getContentWidth, getContextMessage, getContextMessage, getCookedExternalDestination, getDescendantIterator, getDescendantText, getDestination, getFauxSmallCapFontSize, getFlowMapName, getFlowMapReference, getFlowNameReference, getFontConsumer, getFoTree, getFullName, getGraphicServer, getHyphenationConsumer, getLinkType, getLogger, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMessageWithContext, getNearestAncestorListBlock, getNearestLeader, getNearestListItem, getNextContiguousTextInBlock, getOrderedParent, getParsedParent, getPreviousContiguousTextInBlock, getRegionNameReference, getRoot, getSecondaryFont, getSequentialIndex, getSiblings, getSpeechServer, getTextServer, getVoice, initialPageNumberSetExplicitly, invalidPageReference, isBlockLevelFo, isContentHeightDependentOnPd, isContentWidthDependentOnPd, iterator, logWarning, nearestGeneratingRA, qtyMarkerChildren, relativeAlignApplies, resolvePrimaryFont, scalingUniform, setLocation, throwException, throwException, throwExceptionContentModelViolation, throwExceptionInvalidLocation, traitAbsolutePosition, traitActiveState, traitAlignmentAdjust, traitAlignmentBaseline, traitAllowedHeightScale, traitAllowedHeightScale, traitAllowedWidthScale, traitAllowedWidthScale, traitAutoRestore, traitAzimuth, traitBackgroundAttachment, traitBackgroundColor, traitBackgroundImage, traitBackgroundPositionHorizontal, traitBackgroundPositionVertical, traitBackgroundRepeat, traitBaselineShift, traitBlankOrNotBlank, traitBlink, traitBorderAfterColor, traitBorderAfterPrecedence, traitBorderAfterStyle, traitBorderAfterWidth, traitBorderBeforeColor, traitBorderBeforePrecedence, traitBorderBeforeStyle, traitBorderBeforeWidth, traitBorderCollapse, traitBorderEndColor, traitBorderEndPrecedence, traitBorderEndStyle, traitBorderEndWidth, traitBorderSeparationBpd, traitBorderSeparationIpd, traitBorderStartColor, traitBorderStartPrecedence, traitBorderStartStyle, traitBorderStartWidth, traitBottom, traitBpDimensionMax, traitBpDimensionMin, traitBpDimensionOpt, traitBreakAfter, traitBreakBefore, traitCaptionSide, traitCaseName, traitCaseTitle, traitChangeBarClass, traitChangeBarColor, traitChangeBarOffset, traitChangeBarPlacement, traitChangeBarStyle, traitChangeBarWidth, traitCharacter, traitClear, traitClip, traitClipIsAuto, traitColor, traitColorProfileName, traitColumnCount, traitColumnGap, traitColumnNumber, traitContentType, traitCountry, traitCueAfter, traitCueBefore, traitDestinationPlacementOffset, traitDirection, traitDisplayAlign, traitDominantBaseline, traitElevation, traitEmptyCells, traitEndIndent, traitEndsRow, traitExtent, traitExternalDestination, traitFloat, traitFlowName, traitFontFamily, traitFontSelectionStrategy, traitFontSize, traitFontSizeActual, traitFontSizeAdjust, traitFontStretch, traitFontStyle, traitFontVariant, traitFontWeight, traitForcePageCount, traitFormat, traitGlyphOrientationHorizontal, traitGlyphOrientationVertical, traitGroupingSeparator, traitGroupingSize, traitHalfLeadingConditionality, traitHalfLeadingMax, traitHalfLeadingMin, traitHalfLeadingOpt, traitHalfLeadingPrecedence, traitHyphenate, traitHyphenationCharacter, traitHyphenationKeep, traitHyphenationLadderCount, traitHyphenationPushCharacterCount, traitHyphenationRemainCharacterCount, traitIndexClass, traitIndexKey, traitIndicateDestination, traitInitialPageNumber, traitInternalDestination, traitIntrusionDisplace, traitIpDimensionMax, traitIpDimensionMin, traitIpDimensionOpt, traitIsReferenceArea, traitKeepTogetherWithinColumn, traitKeepTogetherWithinLine, traitKeepTogetherWithinPage, traitKeepWithNextWithinColumn, traitKeepWithNextWithinLine, traitKeepWithNextWithinPage, traitKeepWithPreviousWithinColumn, traitKeepWithPreviousWithinLine, traitKeepWithPreviousWithinPage, traitLanguage, traitLastLineEndIndent, traitLeaderAlignment, traitLeaderLengthMax, traitLeaderLengthMin, traitLeaderLengthOpt, traitLeaderPattern, traitLeaderPatternWidth, traitLeft, traitLetterSpacingConditionality, traitLetterSpacingMax, traitLetterSpacingMin, traitLetterSpacingOpt, traitLetterSpacingPrecedence, traitLetterValue, traitLinefeedTreatment, traitLineHeightShiftAdjustment, traitLineStackingStrategy, traitMarkerClassName, traitMasterName, traitMasterReference, traitMaximumRepeats, traitMediaUsage, traitMergePagesAcrossIndexKeyReferences, traitMergeRangesAcrossIndexKeyReferences, traitMergeSequentialPageNumbers, traitNumberColumnsRepeated, traitNumberColumnsSpanned, traitNumberRowsSpanned, traitOddOrEven, traitOrphans, traitOverflow, traitOverlineScore, traitOverlineScoreColor, traitPaddingAfter, traitPaddingBefore, traitPaddingEnd, traitPaddingStart, traitPageCitationStrategy, traitPageHeight, traitPageNumberTreatment, traitPagePosition, traitPageWidth, traitPauseAfter, traitPauseBefore, traitPitch, traitPitchRange, traitPlayDuring, traitPlayDuringMix, traitPlayDuringRepeat, traitPrecedence, traitProvisionalDistanceBetweenStarts, traitProvisionalLabelSeparation, traitReferenceOrientation, traitRefId, traitRefIndexKey, traitRelativeAlign, traitRelativePosition, traitRenderingIntent, traitRetrieveBoundaryWithinTable, traitRetrieveClassName, traitRetrievePositionWithinTable, traitRichness, traitRight, traitRole, traitRuleStyle, traitRuleThickness, traitScaling, traitScalingMethod, traitScalingMethod, traitScoreSpaces, traitScript, traitShowDestination, traitSourceDocument, traitSpaceAfterConditionality, traitSpaceAfterMaximum, traitSpaceAfterMinimum, traitSpaceAfterOptimum, traitSpaceAfterPrecedence, traitSpaceBeforeConditionality, traitSpaceBeforeMaximum, traitSpaceBeforeMinimum, traitSpaceBeforeOptimum, traitSpaceBeforePrecedence, traitSpaceEndConditionality, traitSpaceEndMaximum, traitSpaceEndMinimum, traitSpaceEndOptimum, traitSpaceEndPrecedence, traitSpaceStartConditionality, traitSpaceStartMaximum, traitSpaceStartMinimum, traitSpaceStartOptimum, traitSpaceStartPrecedence, traitSpan, traitSpeak, traitSpeakHeader, traitSpeakNumeral, traitSpeakPunctuation, traitSpeechRate, traitSrc, traitStartIndent, traitStartingState, traitStartsRow, traitStress, traitSuppressAtLineBreak, traitSwitchTo, traitSwitchToNames, traitTableLayout, traitTableOmitFooterAtBreak, traitTableOmitHeaderAtBreak, traitTargetPresentationContext, traitTargetProcessingContext, traitTargetStylesheet, traitTextAlign, traitTextAlignLast, traitTextAlignString, traitTextAltitude, traitTextDepth, traitTextIndent, traitTextShadow, traitTextTransform, traitThroughScore, traitThroughScoreColor, traitTop, traitTreatAsWordSpace, traitUnderlineScore, traitUnderlineScoreColor, traitUnicodeBidi, traitVisibility, traitVoiceFamily, traitVolume, traitWhiteSpaceCollapse, traitWhiteSpaceTreatment, traitWidows, traitWordSpacingConditionality, traitWordSpacingMax, traitWordSpacingMin, traitWordSpacingOpt, traitWordSpacingPrecedence, traitWrapOption, traitWritingMode, traitZIndex, traitZIndexIsAuto, validateAtLeastOneChild, validateEmptyContent

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

ancestorBasicLink, ancestorListRelatedObject, ancestorMarker, ancestorTable, getContextMessage, getSequentialIndex, isBlockLevelFo, qtyMarkerChildren, traitIsReferenceArea

Methods inherited from interface javax.swing.tree.TreeNode

children, getChildCount, getIndex, isLeaf

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.axsl.fo.fo.prop.CommonAuralPa

getVoice, traitAzimuth, traitCueAfter, traitCueBefore, traitElevation, traitPauseAfter, traitPauseBefore, traitPitch, traitPitchRange, traitPlayDuring, traitPlayDuringMix, traitPlayDuringRepeat, traitRichness, traitSpeak, traitSpeakHeader, traitSpeakNumeral, traitSpeakPunctuation, traitSpeechRate, traitStress, traitVoiceFamily, traitVolume

Methods inherited from interface org.axsl.fo.fo.prop.CommonBorderPaddingBgPa

traitBackgroundAttachment, traitBackgroundColor, traitBackgroundImage, traitBackgroundPositionHorizontal, traitBackgroundPositionVertical, traitBackgroundRepeat, traitBorderAfterColor, traitBorderAfterStyle, traitBorderAfterWidth, traitBorderBeforeColor, traitBorderBeforeStyle, traitBorderBeforeWidth, traitBorderEndColor, traitBorderEndStyle, traitBorderEndWidth, traitBorderStartColor, traitBorderStartStyle, traitBorderStartWidth, traitPaddingAfter, traitPaddingBefore, traitPaddingEnd, traitPaddingStart

Methods inherited from interface org.axsl.fo.fo.prop.CommonFontPa

getSecondaryFont, traitFontSizeActual

Methods inherited from interface org.axsl.fo.fo.prop.CommonHyphenationPa

traitCountry, traitHyphenate, traitHyphenationCharacter, traitHyphenationPushCharacterCount, traitHyphenationRemainCharacterCount, traitLanguage, traitScript

Methods inherited from interface org.axsl.fo.fo.prop.CommonMarginInlinePa

traitSpaceEndConditionality, traitSpaceEndMaximum, traitSpaceEndMinimum, traitSpaceEndPrecedence, traitSpaceStartConditionality, traitSpaceStartMaximum, traitSpaceStartMinimum, traitSpaceStartPrecedence

Methods inherited from interface org.axsl.fo.fo.prop.CommonMarginInlineOptimumPa

traitSpaceEndOptimum, traitSpaceStartOptimum

Methods inherited from interface org.axsl.fo.fo.prop.CommonRelativePositionPa

traitRelativePosition

Methods inherited from interface org.axsl.fo.fo.prop.CommonPositionPa

traitBottom, traitLeft, traitRight, traitTop

Methods inherited from interface org.axsl.fo.fo.prop.AlignmentAdjustPa

traitAlignmentAdjust

Methods inherited from interface org.axsl.fo.fo.prop.TreatAsWordSpacePa

traitTreatAsWordSpace

Methods inherited from interface org.axsl.fo.fo.prop.AlignmentBaselinePa

traitAlignmentBaseline

Methods inherited from interface org.axsl.fo.fo.prop.BaselineShiftPa

traitBaselineShift

Methods inherited from interface org.axsl.fo.fo.prop.CharacterPa

getAreaTreeText

Methods inherited from interface org.axsl.fo.fo.prop.ColorPa

traitColor

Methods inherited from interface org.axsl.fo.fo.prop.DominantBaselinePa

traitDominantBaseline

Methods inherited from interface org.axsl.fo.fo.prop.TextDepthPa

traitTextDepth

Methods inherited from interface org.axsl.fo.fo.prop.TextAltitudePa

traitTextAltitude

Methods inherited from interface org.axsl.fo.fo.prop.GlyphOrientationHorizontalPa

traitGlyphOrientationHorizontal

Methods inherited from interface org.axsl.fo.fo.prop.GlyphOrientationVerticalPa

traitGlyphOrientationVertical

Methods inherited from interface org.axsl.fo.fo.prop.IndexClassPa

traitIndexClass

Methods inherited from interface org.axsl.fo.fo.prop.IndexKeyPa

traitIndexKey

Methods inherited from interface org.axsl.fo.fo.prop.KeepWithNextPa

traitKeepWithNextWithinColumn, traitKeepWithNextWithinLine, traitKeepWithNextWithinPage

Methods inherited from interface org.axsl.fo.fo.prop.KeepWithPreviousPa

traitKeepWithPreviousWithinColumn, traitKeepWithPreviousWithinLine, traitKeepWithPreviousWithinPage

Methods inherited from interface org.axsl.fo.fo.prop.LetterSpacingPa

traitLetterSpacingConditionality, traitLetterSpacingMax, traitLetterSpacingMin, traitLetterSpacingOpt, traitLetterSpacingPrecedence

Methods inherited from interface org.axsl.fo.fo.prop.LineHeightPa

traitHalfLeadingConditionality, traitHalfLeadingMax, traitHalfLeadingMin, traitHalfLeadingOpt, traitHalfLeadingPrecedence

Methods inherited from interface org.axsl.fo.fo.prop.ScoreSpacesPa

traitScoreSpaces

Methods inherited from interface org.axsl.fo.fo.prop.SuppressAtLineBreakPa

traitSuppressAtLineBreak

Methods inherited from interface org.axsl.fo.fo.prop.TextDecorationPa

traitBlink, traitOverlineScore, traitOverlineScoreColor, traitThroughScore, traitThroughScoreColor, traitUnderlineScore, traitUnderlineScoreColor

Methods inherited from interface org.axsl.fo.fo.prop.TextShadowPa

traitTextShadow

Methods inherited from interface org.axsl.fo.fo.prop.VisibilityPa

traitVisibility

Methods inherited from interface org.axsl.fo.fo.prop.WordSpacingPa

traitWordSpacingConditionality, traitWordSpacingMax, traitWordSpacingMin, traitWordSpacingOpt, traitWordSpacingPrecedence

Field Detail

DISCARD_CHAR

public static final char DISCARD_CHAR

Constant indicating that a given character should be discarded.

See Also:

Constant Field Values

Constructor Detail

AbstractCharacterSequence

protected AbstractCharacterSequence(FObj parent)

Constructor.

Parameters:

parent - The parent of

Method Detail

getParent

public FObj getParent()

Specified by:

getParent in interface TreeNode

Specified by:

getParent in interface org.axsl.fo.Fo

Specified by:

getParent in class FObj

getChildren

public List<FObj> getChildren()

Description copied from class: AbstractOrderedTreeNode

Return the List of this node's children.

Specified by:

getChildren in class FObj

Returns:

The List of this node's children.

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class FObj

isAllWhiteSpace

public abstract boolean isAllWhiteSpace()

Indicates whether this text item is all whitespace.

Returns:

True iff all of the text in this item is whitespace.

inlineText

public CharSequence inlineText()

Specified by:

inlineText in interface org.axsl.text.line.LineText

inlineText

public CharSequence inlineText(org.axsl.fo.FoContext context)

Specified by:

inlineText in interface org.axsl.fo.FoLineText

inlinePrimaryFont

public org.axsl.font.FontUse inlinePrimaryFont()

Specified by:

inlinePrimaryFont in interface org.axsl.text.line.LineText

inlinePrimaryFont

public org.axsl.font.FontUse inlinePrimaryFont(org.axsl.fo.FoContext context)

Specified by:

inlinePrimaryFont in interface org.axsl.fo.FoLineText

inlineSecondaryFont

public org.axsl.font.FontUse inlineSecondaryFont(char c)

Specified by:

inlineSecondaryFont in interface org.axsl.text.line.LineText

inlineSecondaryFont

public org.axsl.font.FontUse inlineSecondaryFont(org.axsl.fo.FoContext context,
                                                 char c)

Specified by:

inlineSecondaryFont in interface org.axsl.fo.FoLineText

inlineFontSize

public int inlineFontSize()

Specified by:

inlineFontSize in interface org.axsl.text.line.LineText

inlineFontSize

public int inlineFontSize(org.axsl.fo.FoContext context)

Specified by:

inlineFontSize in interface org.axsl.fo.FoLineText

inlineLetterSpacingOptimum

public int inlineLetterSpacingOptimum()

Specified by:

inlineLetterSpacingOptimum in interface org.axsl.text.line.LineText

inlineLetterSpacingOptimum

public int inlineLetterSpacingOptimum(org.axsl.fo.FoContext context)

Specified by:

inlineLetterSpacingOptimum in interface org.axsl.fo.FoLineText

inlineWordSpacingOptimum

public int inlineWordSpacingOptimum()

Specified by:

inlineWordSpacingOptimum in interface org.axsl.text.line.LineText

inlineWordSpacingOptimum

public int inlineWordSpacingOptimum(org.axsl.fo.FoContext context)

Specified by:

inlineWordSpacingOptimum in interface org.axsl.fo.FoLineText

inlineWrapOption

public boolean inlineWrapOption()

Specified by:

inlineWrapOption in interface org.axsl.text.line.LineText

inlineWrapOption

public boolean inlineWrapOption(org.axsl.fo.FoContext context)

Specified by:

inlineWrapOption in interface org.axsl.fo.FoLineText

inlineHyphenate

public boolean inlineHyphenate()

Specified by:

inlineHyphenate in interface org.axsl.text.line.LineText

inlineHyphenate

public boolean inlineHyphenate(org.axsl.fo.FoContext context)

Specified by:

inlineHyphenate in interface org.axsl.fo.FoLineText

inlineLanguage

public org.axsl.common.i18n.Language inlineLanguage()

Returns the language code for this node.

Returns:

The language code for this node.

inlineCountry

public org.axsl.common.i18n.Country inlineCountry()

Returns the country code for this node.

Returns:

The country code for this node.

inlineOrthography

public org.axsl.common.i18n.Orthography inlineOrthography()

Specified by:

inlineOrthography in interface org.axsl.text.line.LineText

inlineHyphenationRemainCount

public int inlineHyphenationRemainCount()

Specified by:

inlineHyphenationRemainCount in interface org.axsl.text.line.LineText

inlineHyphenationRemainCount

public int inlineHyphenationRemainCount(org.axsl.fo.FoContext context)

Specified by:

inlineHyphenationRemainCount in interface org.axsl.fo.FoLineText

inlineHyphenationPushCount

public int inlineHyphenationPushCount()

Specified by:

inlineHyphenationPushCount in interface org.axsl.text.line.LineText

inlineHyphenationPushCount

public int inlineHyphenationPushCount(org.axsl.fo.FoContext context)

Specified by:

inlineHyphenationPushCount in interface org.axsl.fo.FoLineText

inlineHyphenationCharacter

public int inlineHyphenationCharacter()

Specified by:

inlineHyphenationCharacter in interface org.axsl.text.line.LineText

inlineHyphenationCharacter

public int inlineHyphenationCharacter(org.axsl.fo.FoContext context)

Specified by:

inlineHyphenationCharacter in interface org.axsl.fo.FoLineText

inlineIsFauxSmallCaps

public boolean inlineIsFauxSmallCaps()

Specified by:

inlineIsFauxSmallCaps in interface org.axsl.text.line.LineText

inlineIsFauxSmallCaps

public boolean inlineIsFauxSmallCaps(org.axsl.fo.FoContext context)

Specified by:

inlineIsFauxSmallCaps in interface org.axsl.fo.FoLineText

inlineFauxSmallCapsFontSize

public int inlineFauxSmallCapsFontSize()

Specified by:

inlineFauxSmallCapsFontSize in interface org.axsl.text.line.LineText

inlineFauxSmallCapsFontSize

public int inlineFauxSmallCapsFontSize(org.axsl.fo.FoContext context)

Specified by:

inlineFauxSmallCapsFontSize in interface org.axsl.fo.FoLineText

nextContiguousLineText

public org.axsl.text.line.LineText nextContiguousLineText()

Specified by:

nextContiguousLineText in interface org.axsl.text.line.LineText

previousContiguousLineText

public org.axsl.text.line.LineText previousContiguousLineText()

Specified by:

previousContiguousLineText in interface org.axsl.text.line.LineText

isLastItemInBlock

public boolean isLastItemInBlock()

Specified by:

isLastItemInBlock in interface org.axsl.text.line.LineContent

applyWhiteSpaceTreatment

public static char applyWhiteSpaceTreatment(CharSequence charArray,
                                            int index,
                                            org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment)

Applies white space treatment to a character array.

Parameters:

charArray - char array containing character to be converted.

index - Index into charArray pointing to a char element that is to be converted.

whiteSpaceTreatment - The value of the whitespace-treatment trait.

Returns:

The character to which the charArray[index] should be converted for white-space-treatment purposes. Returns DISCARD_CHAR if charArray[index] should be discarded. Note that DISCARD_CHAR is not a valid Unicode codepoint, and should therefore never be in the input.

applyWhiteSpaceTreatment

public static char applyWhiteSpaceTreatment(char charBefore,
                                            char c,
                                            char charAfter,
                                            org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment)

Applies white space treatment to a single character.

Parameters:

charBefore - The char immediately before the char being tested, or -1 if there is none.

c - The char being tested.

charAfter - The char immediately after the char being tested, or -1 of there is none.

whiteSpaceTreatment - The value of the whitespace-treatment trait.

Returns:

The char at this index, or DISCARD_CHAR if this char should be discarded. Note that DISCARD_CHAR is not a valid Unicode codepoint, and should therefore never be in the input.

applyWhiteSpaceTreatment

public static StringBuilder applyWhiteSpaceTreatment(StringBuilder charArray,
                                                     org.axsl.common.value.WhiteSpaceTreatment inputWhiteSpaceTreatment)

Applies white-space-treatment to an array of characters. See XSL-FO Standard 1.0, Section 7.15.8.

Parameters:

charArray - The char array whose contents should be converted.

inputWhiteSpaceTreatment - The value of the white-space-treatment property, one of FoValue.IGNORE, FoValue.PRESERVE, FoValue.IGNORE_IF_BEFORE_LINEFEED, FoValue.IGNORE_IF_AFTER_LINEFEED, or FoValue.IGNORE_IF_SURROUNDING_LINEFEED.

Returns:

If no changes result from the application of white-space-treatment, charArray is returned. Otherwise, a new char array with the result is returned.

applyLinefeedTreatment

public static char applyLinefeedTreatment(char c,
                                          org.axsl.common.value.LinefeedTreatment linefeedTreatment)

Applies the linefeed treatment to a specific character.

Parameters:

c - The character being processed, which should always be a linefeed character.

linefeedTreatment - The value of the linefeed-treatment trait.

Returns:

The value by which the linefeed character should be replaced, or the marker DISCARD_CHAR indicating that the character should be removed.

applyLinefeedTreatment

public static StringBuilder applyLinefeedTreatment(StringBuilder charArray,
                                                   org.axsl.common.value.LinefeedTreatment inputLinefeedTreatment)

Applies linefeed-treatment to an array of characters. See XSL-FO Standard 1.0, Section 7.15.7.

Parameters:

charArray - The char array whose contents should be converted.

inputLinefeedTreatment - The value of the linefeed-treatment property, one of FoValue.IGNORE, FoValue.PRESERVE, FoValue.TREAT_AS_SPACE, or FoValue.TREAT_AS_ZERO_WIDTH_SPACE.

Returns:

If no changes result from the application of linefeed-treatment, charArray is returned. Otherwise, a new char array with the result is returned.

applyTextTransform

public static char applyTextTransform(org.axsl.common.value.TextTransform textTransform,
                                      boolean isFirstCharInWord,
                                      char c)

Applies text-transform to one character.

Parameters:

textTransform - The text-transform value to use.

isFirstCharInWord - Indicates whether this is the first character in a word.

c - The character to be converted.

Returns:

The converted character, or c if no conversion is performed.

applyWhiteSpaceCollapse

public static char applyWhiteSpaceCollapse(CharSequence charArray,
                                           int index)

Applies white-space-collapse to one character of charArray.

Per http://lists.w3.org/Archives/Public/xsl-editors/2002OctDec/0004, elements in previous or subsequent FOs should not be considered.

Parameters:

charArray - The char[] that is being converted.

index - The 0-based index into charArray that points to the char that is being tested.

Returns:

DISCARD_CHAR if the previous character is whitespace or if the next character is a line-feed. If neither of these is true, returns the original character.

applyWhiteSpaceCollapse

public static char applyWhiteSpaceCollapse(char charBefore,
                                           char c,
                                           char charAfter)

Applies white-space-collapse to one char.

Parameters:

charBefore - The character before c, or DISCARD_CHAR if there is none.

c - The character being considered for conversion.

charAfter - The character after c, or DISCARD_CHAR if there is none.

Returns:

DISCARD_CHAR if the previous character is whitespace or if the next character is a line-feed. If neither of these is true, returns the original character.

applyWhiteSpaceCollapse

public static StringBuilder applyWhiteSpaceCollapse(StringBuilder charArray,
                                                    boolean whiteSpaceCollapse)

Applies white-space-collapse to an array of characters. See XSL-FO Standard 1.0, Section 7.15.12.

Per http://lists.w3.org/Archives/Public/xsl-editors/2002OctDec/0004, elements in previous or subsequent FOs should not be considered.

Parameters:

charArray - The char array whose contents should be converted.

whiteSpaceCollapse - The value of the white-space-collapse property.

Returns:

If no changes result from the application of white-space-collapse, charArray is returned. Otherwise, a new char array with the result is returned.

getSystemId

public String getSystemId()

Specified by:

getSystemId in interface org.axsl.fo.Fo

Overrides:

getSystemId in class FObj

getLine

public int getLine()

Specified by:

getLine in interface org.axsl.fo.Fo

Overrides:

getLine in class FObj

getColumn

public int getColumn()

Specified by:

getColumn in interface org.axsl.fo.Fo

Overrides:

getColumn in class FObj

acceptProxyFactory

public Object acceptProxyFactory(org.axsl.fo.ProxyFactory factory)

Specified by:

acceptProxyFactory in interface org.axsl.fo.Fo

getContextWrapper

public org.axsl.fo.FoLineText getContextWrapper(org.axsl.fo.FoContext context)

Specified by:

getContextWrapper in interface org.axsl.fo.FoLineText

getWrapped

public org.axsl.fo.FoLineText getWrapped()

Specified by:

getWrapped in interface org.axsl.fo.FoLineText

getGraftingPoint

public org.axsl.fo.fo.GraftingPoint getGraftingPoint()

Specified by:

getGraftingPoint in interface org.axsl.fo.FoLineText

end

public void end()

Description copied from class: FObj

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.

Specified by:

end in class FObj

validateAncestry

public void validateAncestry()

Description copied from class: FObj

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.

Specified by:

validateAncestry in class FObj

validateProperties

public void validateProperties()

Description copied from class: FObj

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.

Specified by:

validateProperties in class FObj

validateDescendants

public void validateDescendants()
                         throws org.axsl.fo.FoTreeException

Description copied from class: FObj

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.

Specified by:

validateDescendants in class FObj

Throws:

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

setup

public void setup()

Description copied from class: FObj

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.

Specified by:

setup in class FObj

addChild

public void addChild(FObj node)

Description copied from class: FObj

Add a child to this object.

Specified by:

addChild in class FObj

Parameters:

node - The child to be added.

isContentBlock

public boolean isContentBlock()

Description copied from class: FObj

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.

Specified by:

isContentBlock in class FObj

Returns:

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

isContentInline

public boolean isContentInline()

Description copied from class: FObj

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.

Specified by:

isContentInline in class FObj

Returns:

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

isContentPcdata

public boolean isContentPcdata()

Description copied from class: FObj

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.

Specified by:

isContentPcdata in class FObj

Returns:

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

getName

public String getName()

Specified by:

getName in interface org.axsl.fo.Fo

Specified by:

getName in class FObj

getNamespace

public Namespace getNamespace()

Description copied from class: FObj

Gets the Namespace instance that is associated with this object.

Specified by:

getNamespace in class FObj

Returns:

The Namespace instance that is associated with this object.

getPropertyList

public PropertyList getPropertyList()

Returns the property list for this FObj. Overrides standard FO logic, because this object has no properties of its own.

Specified by:

getPropertyList in class FObj

Returns:

Returns the propertyList.

getPrimaryFont

public org.axsl.font.FontUse getPrimaryFont(org.axsl.fo.FoContext context)

Specified by:

getPrimaryFont in interface org.axsl.fo.fo.prop.CommonFontPa

traitId

public String traitId()

Overrides standard logic, because, although property "id" applies to fo:character, there is no way to set such a property on a sequence of fo:character objects that are inferred from #PCDATA. Any "id" for such data was designated on the parent, and, since "id" does not inherit, it cannot apply to this object.

Specified by:

traitId in interface org.axsl.fo.fo.prop.IdPa

Overrides:

traitId in class FObj

getChildAt

public FObj getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Specified by:

getChildAt in interface org.axsl.fo.Fo

isValid

public boolean isValid()

Specified by:

isValid in interface org.axsl.fo.Fo

inlineFontOptions

public org.axsl.font.FontOptions inlineFontOptions()

Specified by:

inlineFontOptions in interface org.axsl.text.line.LineText