org.apache.fop.fo.flow
Class Flow

java.lang.Object
  |
  +--org.apache.fop.fo.FONode
        |
        +--org.apache.fop.fo.FObj
              |
              +--org.apache.fop.fo.flow.Flow
Direct Known Subclasses:
StaticContent

public class Flow
extends FObj


Inner Class Summary
static class Flow.Maker
           
 
Inner classes inherited from class org.apache.fop.fo.FObj
FObj.Maker
 
Fields inherited from class org.apache.fop.fo.FObj
name, properties, propMgr
 
Fields inherited from class org.apache.fop.fo.FONode
areaClass, areasGenerated, BREAK_AFTER, bufferManager, children, forcedStartOffset, forcedWidth, isInTableCell, linkSet, log, marker, markers, orphans, parent, START, widows
 
Constructor Summary
protected Flow(FObj parent, PropertyList propertyList)
           
 
Method Summary
 boolean generatesReferenceAreas()
           
 int getContentWidth()
          Return the content width of this flow (really of the region in which it is flowing).
protected  java.lang.String getElementName()
           
 java.lang.String getFlowName()
           
 Status getStatus()
           
 Status layout(Area area)
          generates the area or areas for this formatting object and adds these to the area.
 Status layout(Area area, Region region)
           
static FObj.Maker maker()
           
protected  void setContentWidth(int contentWidth)
           
protected  void setFlowName(java.lang.String name)
           
 
Methods inherited from class org.apache.fop.fo.FObj
addCharacters, end, getName, getProperty, makePropertyManager, removeID, setWritingMode, start
 
Methods inherited from class org.apache.fop.fo.FONode
addChild, addMarker, forceStartOffset, forceWidth, getBufferManager, getLinkSet, getMarkers, getMarkerSnapshot, getParent, hasMarkers, removeAreas, resetMarker, rollback, setBufferManager, setIsInTableCell, setLinkSet, setLogger, setOrphans, setWidows
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Flow

protected Flow(FObj parent,
               PropertyList propertyList)
        throws FOPException
Method Detail

maker

public static FObj.Maker maker()

setFlowName

protected void setFlowName(java.lang.String name)
                    throws FOPException

getFlowName

public java.lang.String getFlowName()

layout

public Status 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
Following copied from class: org.apache.fop.fo.FObj
Parameters:
area -  

layout

public Status layout(Area area,
                     Region region)
              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

getElementName

protected java.lang.String getElementName()

getStatus

public Status getStatus()

generatesReferenceAreas

public boolean generatesReferenceAreas()
Overrides:
generatesReferenceAreas in class FObj


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