|
fop 2.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.area.AreaTreeObject
org.apache.fop.area.Area
org.apache.fop.area.inline.InlineArea
org.apache.fop.area.inline.InlineParent
org.apache.fop.area.inline.AbstractTextArea
org.apache.fop.area.inline.TextArea
public class TextArea
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, minChildOffset |
Fields inherited from class org.apache.fop.area.inline.InlineArea |
---|
adjustingInfo, blockProgressionOffset |
Fields inherited from class org.apache.fop.area.Area |
---|
bidiLevel, bpd, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, effectiveIPD, ipd, log, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, traits |
Fields inherited from class org.apache.fop.area.AreaTreeObject |
---|
extensionAttachments, 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 ipd,
boolean adjustable,
int blockProgressionOffset,
int level)
Create and add a SpaceArea child to this TextArea |
void |
addWord(java.lang.String word,
int offset)
Create and add a WordArea child to this TextArea. |
void |
addWord(java.lang.String word,
int offset,
int level)
Create and add a WordArea child to this TextArea. |
void |
addWord(java.lang.String word,
int ipd,
int[] letterAdjust,
int[] levels,
int[][] gposAdjustments,
int blockProgressionOffset)
Create and add a WordArea child to this TextArea. |
int |
getEffectiveIPD()
|
java.lang.String |
getText()
Get the whole text string. |
boolean |
isHyphenated()
Returns true if the last word in this area is hyphenated. |
void |
removeText()
Remove the old text |
void |
setHyphenated()
Records that the last word in this text area is hyphenated. |
java.lang.String |
toString()
|
void |
updateLevel(int newLevel)
|
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, collectInlineRuns, getChildAreas, resetChildrenLevel |
Methods inherited from class org.apache.fop.area.inline.InlineArea |
---|
getAdjustingInfo, getBlockProgressionOffset, getParentArea, handleIPDVariation, hasLineThrough, hasOverline, hasUnderline, increaseIPD, isAncestor, isAncestorOrSelf, isBlinking, notifyIPDVariation, setAdjustingInfo, setAdjustingInfo, setAdjustment, setBlockProgressionOffset, setParentArea |
Methods inherited from class org.apache.fop.area.Area |
---|
activateEffectiveIPD, addTrait, clone, getAllocBPD, getAllocIPD, getAreaClass, getBidiLevel, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getEffectiveAllocIPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsBoolean, getTraitAsInteger, getTraits, hasTrait, hasTraits, resetBidiLevel, setAreaClass, setBidiLevel, setBPD, setIPD, setTraits, setWritingModeTraits |
Methods inherited from class org.apache.fop.area.AreaTreeObject |
---|
addExtensionAttachment, getExtensionAttachments, getForeignAttributes, getForeignAttributeValue, hasExtensionAttachments, setExtensionAttachments, setForeignAttribute, setForeignAttributes |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TextArea()
public TextArea(int stretch, int shrink, int adj)
stretch
- the available stretch of the textshrink
- the available shrink of the textadj
- the current total adjustmentMethod Detail |
---|
public void removeText()
public void addWord(java.lang.String word, int offset)
word
- the word stringoffset
- the offset for the next areapublic void addWord(java.lang.String word, int offset, int level)
word
- the word stringoffset
- the offset for the next arealevel
- bidirectional level that applies to entire wordpublic void addWord(java.lang.String word, int ipd, int[] letterAdjust, int[] levels, int[][] gposAdjustments, int blockProgressionOffset)
word
- the word stringipd
- the word's ipdletterAdjust
- the letter adjustment array (may be null)levels
- array of resolved bidirectional levels of word characters,
or null if default levelgposAdjustments
- array of general position adjustments or null if none applyblockProgressionOffset
- the offset for the next areapublic void addSpace(char space, int ipd, boolean adjustable, int blockProgressionOffset, int level)
space
- the space characteripd
- the space's ipdblockProgressionOffset
- the offset for the next areaadjustable
- is this space adjustable?level
- resolved bidirection level of space characterpublic void setHyphenated()
public boolean isHyphenated()
true
if the last word in this area is hyphenated.
public java.lang.String getText()
public java.lang.String toString()
toString
in class Area
public void updateLevel(int newLevel)
public int getEffectiveIPD()
getEffectiveIPD
in class Area
|
fop 2.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |