org.apache.fop.fo
Class FONode
- Direct Known Subclasses:
- FObj, FOText
- public abstract class FONode
base class for nodes in the formatting object tree
Field Summary |
final static int | BREAK_AFTER value of marker after break-after |
Vector | children |
final static int | START value of marker before layout begins |
BREAK_AFTER
public final static int BREAK_AFTER
- value of marker after break-after
children
public Vector children
START
public final static int START
- value of marker before layout begins
forceStartOffset
public void forceStartOffset(int offset)
forceWidth
public void forceWidth(int width)
getLinkSet
public LinkSet getLinkSet()
getMarkerSnapshot
public Vector getMarkerSnapshot(Vector snapshot)
- At the start of a new span area layout may be partway through a
nested FO, and balancing requires rollback to this known point.
The snapshot records exactly where layout is at.
- Parameters:
- snapshot - a Vector of markers (Integer)
- returns the updated Vector of markers (Integers)
getParent
public FObj getParent()
getProperty
public Property getProperty(String name)
- lets outside sources access the property list
first used by PageNumberCitation to find the "id" property
returns null by default, overide this function when there is a property list
- Parameters:
- name - - the name of the desired property to obtain
- returns the property
layout
public abstract Status layout(Area area)
throws org.apache.fop.apps.FOPException
removeAreas
public void removeAreas()
resetMarker
public void resetMarker()
rollback
public void rollback(Vector snapshot)
- When balancing occurs, the flow layout() method restarts at the
point specified by the current marker snapshot, which is retrieved
and restored using this method.
- Parameters:
- snapshot - the Vector of saved markers (Integers)
setBodyIndent
public void setBodyIndent(int indent)
setDistanceBetweenStarts
public void setDistanceBetweenStarts(int distance)
setIsInLabel
public void setIsInLabel()
setIsInListBody
public void setIsInListBody()
setIsInTableCell
public void setIsInTableCell()
setLabelSeparation
public void setLabelSeparation(int separation)
setLinkSet
public void setLinkSet(LinkSet linkSet)
setOrphans
public void setOrphans(int orph)
setWidows
public void setWidows(int wid)
to Class org.apache.fop.fo.FObj
to Class java.util.Vector
to Class org.apache.fop.layout.LinkSet