|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.fop.layoutmgr.AbstractBaseLayoutManager
org.apache.fop.layoutmgr.inline.ContentLayoutManager
public class ContentLayoutManager
Content Layout Manager. For use with objects that contain inline areas such as leader use-content and title.
| Field Summary |
|---|
| Fields inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
|---|
fobj, generatesBlockArea, generatesReferenceArea |
| Constructor Summary | |
|---|---|
ContentLayoutManager(Area area,
LayoutManager parentLM)
Constructs a new ContentLayoutManager |
|
ContentLayoutManager(PageSequenceLayoutManager pslm,
Title foTitle)
Constructor using a fo:title formatting object and its PageSequenceLayoutManager parent. |
|
| Method Summary | |
|---|---|
java.util.List |
addALetterSpaceTo(java.util.List oldList)
Tell the LM to modify its data, adding a letter space to the word fragment represented by the given elements, and returning the corrected elements |
java.util.List |
addALetterSpaceTo(java.util.List oldList,
int depth)
Tell the LM to modify its data, adding a letter space to the word fragment represented by the given elements, and returning the corrected elements |
void |
addAreas(PositionIterator posIter,
LayoutContext context)
Tell the layout manager to add all the child areas implied by Position objects which will be returned by the Iterator. |
void |
addChildArea(Area childArea)
Add the area as a child of the current area. |
void |
addChildLM(LayoutManager lm)
Add the LM in the argument to the list of child LMs; set this LM as the parent; initialize the LM. |
void |
addChildLMs(java.util.List newLMs)
Add the LMs in the argument to the list of child LMs; |
boolean |
applyChanges(java.util.List oldList)
Tell the LM to apply the changes due to hyphenation |
boolean |
applyChanges(java.util.List oldList,
int depth)
Tell the LM to apply the changes due to hyphenation |
boolean |
createNextChildLMs(int pos)
Create more child LMs of the parent, up to child LM index pos |
java.util.List |
getChangedKnuthElements(java.util.List oldList,
int alignment)
Get a sequence of KnuthElements representing the content of the node assigned to the LM, after changes have been applied In the context of line breaking, this method is called after hyphenation has been performed, in order to receive the sequence of elements representing the text together with all possible hyphenation points. |
java.util.List |
getChangedKnuthElements(java.util.List oldList,
int alignment,
int depth)
Get a sequence of KnuthElements representing the content of the node assigned to the LM, after changes have been applied |
java.util.List |
getChildLMs()
|
int |
getContentAreaBPD()
Returns the BPD of the content area |
int |
getContentAreaIPD()
Returns the IPD of the content area |
boolean |
getGeneratesBlockArea()
Returns an indication if the layout manager generates a block area. |
boolean |
getGeneratesLineArea()
Returns an indication if the layout manager generates a line area. |
boolean |
getGeneratesReferenceArea()
Returns an indication if the layout manager generates a reference area. |
java.util.List |
getNextKnuthElements(LayoutContext context,
int alignment)
Get a sequence of KnuthElements representing the content of the node assigned to the LM. |
LayoutManager |
getParent()
Get the parent layout manager. |
Area |
getParentArea(Area childArea)
Get the parent area for an area. |
PageSequenceLayoutManager |
getPSLM()
Get the active PageSequenceLayoutManager instance for this layout process. |
int |
getStackingSize()
|
java.lang.String |
getWordChars(Position pos)
Get the word chars corresponding to the given position. |
void |
hyphenate(Position pos,
HyphContext hc)
Tell the LM to hyphenate a word |
void |
initialize()
initialize the layout manager. |
boolean |
isFinished()
Return a value indicating whether this LayoutManager has laid out all its content (or generated BreakPossibilities for all content.) |
Position |
notifyPos(Position pos)
Adds a Position to the Position participating in the first|last determination by assigning it a unique position index. |
void |
setFinished(boolean isFinished)
Set a flag indicating whether the LayoutManager has laid out all its content. |
void |
setParent(LayoutManager lm)
Set the parent layout manager. |
| Methods inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
|---|
getAncestorBlockAreaBPD, getAncestorBlockAreaIPD, getBaseLength, getFObj, getNextKnuthElements, getParentAreaBPD, getParentAreaIPD, getReferenceAreaBPD, getReferenceAreaIPD, isRestartable, reset, setGeneratesBlockArea, setGeneratesReferenceArea |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.apache.fop.layoutmgr.LayoutManager |
|---|
getFObj, getNextKnuthElements, isRestartable, reset |
| Methods inherited from interface org.apache.fop.datatypes.PercentBaseContext |
|---|
getBaseLength |
| Constructor Detail |
|---|
public ContentLayoutManager(Area area,
LayoutManager parentLM)
area - The parent areaparentLM - the parent layout manager
public ContentLayoutManager(PageSequenceLayoutManager pslm,
Title foTitle)
pslm - the PageSequenceLayoutManager parent of this LMfoTitle - the Title FO for which this LM is made| Method Detail |
|---|
public void initialize()
initialize in interface LayoutManager
public void addAreas(PositionIterator posIter,
LayoutContext context)
addAreas in interface LayoutManagerposIter - the position iteratorcontext - the contextpublic int getStackingSize()
public Area getParentArea(Area childArea)
getParentArea in interface LayoutManagerchildArea - the child area to get the parent for
public void addChildArea(Area childArea)
addChildArea in interface LayoutManagerchildArea - the child area to addpublic void setParent(LayoutManager lm)
setParent in interface LayoutManagerlm - the parent layout managerpublic LayoutManager getParent()
getParent in interface LayoutManagerpublic boolean isFinished()
isFinished in interface LayoutManagerpublic void setFinished(boolean isFinished)
setFinished in interface LayoutManagerisFinished - the value to set the finished flag topublic boolean createNextChildLMs(int pos)
createNextChildLMs in interface LayoutManagerpos - index up to which child LMs are requested
public java.util.List getChildLMs()
getChildLMs in interface LayoutManagerpublic void addChildLM(LayoutManager lm)
addChildLM in interface LayoutManagerlm - the LM to be addedpublic void addChildLMs(java.util.List newLMs)
addChildLMs in interface LayoutManagernewLMs - the list of LMs to be added
public java.util.List getNextKnuthElements(LayoutContext context,
int alignment)
getNextKnuthElements in interface LayoutManagercontext - the LayoutContext used to store layout informationalignment - the desired text alignment
public java.util.List addALetterSpaceTo(java.util.List oldList)
addALetterSpaceTo in interface InlineLevelLayoutManageroldList - the elements which must be given one more letter space
public java.util.List addALetterSpaceTo(java.util.List oldList,
int depth)
addALetterSpaceTo in interface InlineLevelLayoutManageroldList - the elements which must be given one more letter spacedepth - the depth at which the Positions for this LM in oldList are found
public java.lang.String getWordChars(Position pos)
getWordChars in interface InlineLevelLayoutManagerpos - the position referring to the needed word chars.
public void hyphenate(Position pos,
HyphContext hc)
hyphenate in interface InlineLevelLayoutManagerpos - the Position referring to the wordhc - the HyphContext storing hyphenation informationpublic boolean applyChanges(java.util.List oldList)
applyChanges in interface InlineLevelLayoutManageroldList - the list of the old elements the changes refer to
public boolean applyChanges(java.util.List oldList,
int depth)
applyChanges in interface InlineLevelLayoutManageroldList - the list of the old elements the changes refer todepth - the depth at which the Positions for this LM in oldList are found
public java.util.List getChangedKnuthElements(java.util.List oldList,
int alignment)
getChangedKnuthElements in interface LayoutManageroldList - the elements to replacealignment - the desired text alignment
public java.util.List getChangedKnuthElements(java.util.List oldList,
int alignment,
int depth)
getChangedKnuthElements in interface InlineLevelLayoutManageroldList - the elements to replacealignment - the desired text alignmentdepth - the depth at which the Positions for this LM in oldList are found
public PageSequenceLayoutManager getPSLM()
getPSLM in interface LayoutManagerpublic int getContentAreaIPD()
getContentAreaIPD in interface LayoutManagergetContentAreaIPD in class AbstractBaseLayoutManagerpublic int getContentAreaBPD()
getContentAreaBPD in interface LayoutManagergetContentAreaBPD in class AbstractBaseLayoutManagerpublic boolean getGeneratesReferenceArea()
getGeneratesReferenceArea in interface LayoutManagergetGeneratesReferenceArea in class AbstractBaseLayoutManagerpublic boolean getGeneratesBlockArea()
getGeneratesBlockArea in interface LayoutManagergetGeneratesBlockArea in class AbstractBaseLayoutManagerpublic boolean getGeneratesLineArea()
getGeneratesLineArea in interface LayoutManagergetGeneratesLineArea in class AbstractBaseLayoutManagerpublic Position notifyPos(Position pos)
notifyPos in interface LayoutManagerpos - the Position
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||