org.apache.fop.fo.flow
Class AbstractFlow

java.lang.Object
  extended byorg.apache.fop.fo.FONode
      extended byorg.apache.fop.fo.FObj
          extended byorg.apache.fop.fo.flow.AbstractFlow
Direct Known Subclasses:
Flow, StaticContent

public abstract class AbstractFlow
extends FObj


Nested Class Summary
 
Nested classes inherited from class org.apache.fop.fo.FObj
FObj.Maker
 
Field Summary
protected  java.lang.String _flowName
          flow-name attribute
protected  PageSequence pageSequence
          PageSequence container
 
Fields inherited from class org.apache.fop.fo.FObj
column, line, properties, propMgr, systemId
 
Fields inherited from class org.apache.fop.fo.FONode
areaClass, areasGenerated, BREAK_AFTER, children, forcedStartOffset, forcedWidth, isInTableCell, linkSet, log, marker, parent, START
 
Constructor Summary
protected AbstractFlow(FObj parent, PropertyList propertyList, java.lang.String systemId, int line, int column)
           
 
Method Summary
 boolean generatesReferenceAreas()
           
 int getContentWidth()
          Return the content width of this flow (really of the region in which it is flowing).
 java.lang.String getFlowName()
           
 int getStatus()
           
 int layout(Area area)
          generates the area or areas for this formatting object and adds these to the area.
 int layout(Area area, Region region)
           
protected  void setContentWidth(int contentWidth)
           
 
Methods inherited from class org.apache.fop.fo.FObj
addCharacters, addMarker, end, getName, getProperty, makePropertyManager, removeID, setWritingMode
 
Methods inherited from class org.apache.fop.fo.FONode
addChild, forceStartOffset, forceWidth, getLinkSet, getMarkerSnapshot, getParent, mayPrecedeMarker, removeAreas, resetMarker, rollback, setIsInTableCell, setLinkSet, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

pageSequence

protected PageSequence pageSequence
PageSequence container


_flowName

protected java.lang.String _flowName
flow-name attribute

Constructor Detail

AbstractFlow

protected AbstractFlow(FObj parent,
                       PropertyList propertyList,
                       java.lang.String systemId,
                       int line,
                       int column)
                throws FOPException
Method Detail

getFlowName

public java.lang.String getFlowName()

layout

public int layout(Area area)
           throws FOPException
Description copied from class: FObj
generates the area or areas for this formatting object and adds these to the area. This method should always be overridden by all sub classes

Overrides:
layout in class FObj
Parameters:
area -
Throws:
FOPException

layout

public int layout(Area area,
                  Region region)
           throws FOPException
Throws:
FOPException

setContentWidth

protected void setContentWidth(int contentWidth)

getContentWidth

public int getContentWidth()
Return the content width of this flow (really of the region in which it is flowing).

Overrides:
getContentWidth in class FObj

getStatus

public int getStatus()

generatesReferenceAreas

public boolean generatesReferenceAreas()
Overrides:
generatesReferenceAreas in class FObj


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