org.apache.fop.area.inline

Class TextArea

Implemented Interfaces:
Serializable
Known Direct Subclasses:
UnresolvedPageNumber

public class TextArea
extends AbstractTextArea

A text inline area.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.fop.area.inline.AbstractTextArea

AbstractTextArea.TextAdjustingInfo

Nested classes/interfaces inherited from class org.apache.fop.area.inline.InlineArea

InlineArea.InlineAdjustingInfo

Field Summary

Fields inherited from class org.apache.fop.area.inline.InlineParent

autoSize, inlines

Fields inherited from class org.apache.fop.area.inline.InlineArea

adjustingInfo, offset

Fields inherited from class org.apache.fop.area.Area

BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, RL, TB, bpd, ipd, log, props

Fields inherited from class org.apache.fop.area.AreaTreeObject

foreignAttributes

Constructor Summary

TextArea()
Create a text inline area
TextArea(int stretch, int shrink, int adj)
Constructor with extra parameters: create a TextAdjustingInfo object

Method Summary

void
addSpace(char space, int offset, boolean adjustable)
Create and add a SpaceArea child to this TextArea
void
addWord(String word, int offset)
Create and add a WordArea child to this TextArea.
void
addWord(String word, int offset, int[] letterAdjust)
Create and add a WordArea child to this TextArea.
String
getText()
Get the whole text string.
void
removeText()
Remove the old text

Methods inherited from class org.apache.fop.area.inline.AbstractTextArea

applyVariationFactor, getBaselineOffset, getTextLetterSpaceAdjust, getTextWordSpaceAdjust, setBaselineOffset, setSpaceDifference, setTextLetterSpaceAdjust, setTextWordSpaceAdjust

Methods inherited from class org.apache.fop.area.inline.InlineParent

addChildArea, applyVariationFactor, getChildAreas

Methods inherited from class org.apache.fop.area.inline.InlineArea

addChildArea, applyVariationFactor, getAdjustingInfo, getOffset, getParentArea, handleIPDVariation, hasLineThrough, hasOverline, hasUnderline, increaseIPD, isBlinking, notifyIPDVariation, setAdjustingInfo, setAdjustment, setOffset, setParentArea

Methods inherited from class org.apache.fop.area.Area

addChildArea, addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBPD, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString

Methods inherited from class org.apache.fop.area.AreaTreeObject

getForeignAttributeValue, getForeignAttributes, setForeignAttribute, setForeignAttributes

Constructor Details

TextArea

public TextArea()
Create a text inline area

TextArea

public TextArea(int stretch,
                int shrink,
                int adj)
Constructor with extra parameters: create a TextAdjustingInfo object
Parameters:
stretch - the available stretch of the text
shrink - the available shrink of the text
adj - the current total adjustment

Method Details

addSpace

public void addSpace(char space,
                     int offset,
                     boolean adjustable)
Create and add a SpaceArea child to this TextArea
Parameters:
space - the space character
offset - the offset for the next area
adjustable - is this space adjustable?

addWord

public void addWord(String word,
                    int offset)
Create and add a WordArea child to this TextArea.
Parameters:
word - the word string
offset - the offset for the next area

addWord

public void addWord(String word,
                    int offset,
                    int[] letterAdjust)
Create and add a WordArea child to this TextArea.
Parameters:
word - the word string
offset - the offset for the next area

getText

public String getText()
Get the whole text string. Renderers whose space adjustment handling is not affected by multi-byte characters can use this method to render the whole TextArea at once; the other renderers (for example PDFRenderer) have to implement renderWord(WordArea) and renderSpace(SpaceArea) in order to correctly place each text fragment.
Returns:
the text string

removeText

public void removeText()
Remove the old text

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.