org.apache.fop.fo
Class FONode

java.lang.Object
  |
  +--org.apache.fop.fo.FONode
Direct Known Subclasses:
FObj, FOText

public abstract class FONode
extends java.lang.Object

base class for nodes in the formatting object tree Modified by Mark Lillywhite mark-fop@inomial.com. Made Vector a protected member. (/me things this should be a private member with an API for adding children; this woudl save a lot of memory because the Vector would not have to be instantiated unless the node had children).


Field Summary
protected  java.lang.String areaClass
           
 int areasGenerated
           
static int BREAK_AFTER
          value of marker after break-after
 BufferManager bufferManager
           
protected  java.util.Vector children
           
protected  int forcedStartOffset
           
protected  int forcedWidth
           
protected  boolean isInTableCell
           
protected  LinkSet linkSet
           
protected  org.apache.log.Logger log
           
protected  int marker
          where the layout was up to. for FObjs it is the child number for FOText it is the character number
protected  java.util.Hashtable markers
           
protected  int orphans
           
protected  FObj parent
           
static int START
          value of marker before layout begins
protected  int widows
           
 
Constructor Summary
protected FONode(FObj parent)
           
 
Method Summary
protected  void addChild(FONode child)
           
 void addMarker(Marker marker)
           
 void forceStartOffset(int offset)
           
 void forceWidth(int width)
           
 BufferManager getBufferManager()
           
 LinkSet getLinkSet()
           
 java.util.Vector getMarkers()
           
 java.util.Vector getMarkerSnapshot(java.util.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.
 FObj getParent()
           
 Property getProperty(java.lang.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
 boolean hasMarkers()
           
abstract  Status layout(Area area)
           
 void removeAreas()
           
 void resetMarker()
           
 void rollback(java.util.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.
 void setBufferManager(BufferManager bufferManager)
           
 void setIsInTableCell()
           
 void setLinkSet(LinkSet linkSet)
           
 void setLogger(org.apache.log.Logger logger)
           
 void setOrphans(int orph)
           
 void setWidows(int wid)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

parent

protected FObj parent

areaClass

protected java.lang.String areaClass

bufferManager

public BufferManager bufferManager

children

protected java.util.Vector children

START

public static final int START
value of marker before layout begins

BREAK_AFTER

public static final int BREAK_AFTER
value of marker after break-after

marker

protected int marker
where the layout was up to. for FObjs it is the child number for FOText it is the character number

isInTableCell

protected boolean isInTableCell

forcedStartOffset

protected int forcedStartOffset

forcedWidth

protected int forcedWidth

widows

protected int widows

orphans

protected int orphans

linkSet

protected LinkSet linkSet

areasGenerated

public int areasGenerated

markers

protected java.util.Hashtable markers

log

protected org.apache.log.Logger log
Constructor Detail

FONode

protected FONode(FObj parent)
Method Detail

setLogger

public void setLogger(org.apache.log.Logger logger)

setIsInTableCell

public void setIsInTableCell()

forceStartOffset

public void forceStartOffset(int offset)

forceWidth

public void forceWidth(int width)

resetMarker

public void resetMarker()

setWidows

public void setWidows(int wid)

setOrphans

public void setOrphans(int orph)

removeAreas

public void removeAreas()

addChild

protected void addChild(FONode child)

getParent

public FObj getParent()

setBufferManager

public void setBufferManager(BufferManager bufferManager)

getBufferManager

public BufferManager getBufferManager()

setLinkSet

public void setLinkSet(LinkSet linkSet)

getLinkSet

public LinkSet getLinkSet()

layout

public abstract Status layout(Area area)
                       throws FOPException

getProperty

public Property getProperty(java.lang.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

getMarkerSnapshot

public java.util.Vector getMarkerSnapshot(java.util.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)

rollback

public void rollback(java.util.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)

addMarker

public void addMarker(Marker marker)
               throws FOPException

hasMarkers

public boolean hasMarkers()

getMarkers

public java.util.Vector getMarkers()


Copyright © 1999-2002 Apache Software Foundation. All Rights Reserved.