org.apache.fop.fo
Class FObj

java.lang.Object
  |
  +--org.apache.fop.fo.FONode
        |
        +--org.apache.fop.fo.FObj
Direct Known Subclasses:
AbstractFlow, AbstractTableBody, BlockContainer, Character, ColorProfile, ConditionalPageMasterReference, Declarations, ExtensionObj, ExternalGraphic, FObjMixed, Footnote, FootnoteBody, InstreamForeignObject, LayoutMasterSet, ListBlock, ListItem, ListItemBody, ListItemLabel, PageMasterReference, PageNumber, PageNumberCitation, PageSequence, PageSequenceMaster, Region, RepeatablePageMasterAlternatives, RetrieveMarker, Root, SimplePageMaster, Table, TableCell, TableColumn, TableRow, ToBeImplementedElement, Unknown, XMLObj

public abstract class FObj
extends FONode

base class for representation of formatting objects and their processing


Inner Class Summary
static class FObj.Maker
           
 
Field Summary
protected  int column
           
protected  int line
           
 PropertyList properties
           
protected  PropertyManager propMgr
           
protected  java.lang.String 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 FObj(FObj parent, PropertyList propertyList, java.lang.String systemId, int line, int column)
           
 
Method Summary
protected  void addCharacters(char[] data, int start, int length)
          adds characters (does nothing here)
 void addMarker(java.lang.String markerClassName)
           
protected  void end()
           
 boolean generatesReferenceAreas()
           
 int getContentWidth()
          Return the "content width" of the areas generated by this FO.
abstract  java.lang.String getName()
          returns the name of the formatting object
 Property getProperty(java.lang.String name)
          lets outside sources access the property list first used by PageNumberCitation to find the "id" property
 int layout(Area area)
          generates the area or areas for this formatting object and adds these to the area.
protected  PropertyManager makePropertyManager(PropertyList propertyList)
           
 void removeID(IDReferences idReferences)
          removes property id
protected  void setWritingMode()
          Set writing mode for this FO.
 
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

properties

public PropertyList properties

propMgr

protected PropertyManager propMgr

systemId

protected java.lang.String systemId

line

protected int line

column

protected int column
Constructor Detail

FObj

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

makePropertyManager

protected PropertyManager makePropertyManager(PropertyList propertyList)

addCharacters

protected void addCharacters(char[] data,
                             int start,
                             int length)
adds characters (does nothing here)
Parameters:
data - text
start - start position
length - length of the text

layout

public int layout(Area area)
           throws FOPException
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 FONode
Parameters:
area -  

getName

public abstract java.lang.String getName()
returns the name of the formatting object
Returns:
the name of this formatting objects

end

protected void end()

getProperty

public Property getProperty(java.lang.String name)
lets outside sources access the property list first used by PageNumberCitation to find the "id" property
Overrides:
getProperty in class FONode
Parameters:
name - - the name of the desired property to obtain
Returns:
the property

getContentWidth

public int getContentWidth()
Return the "content width" of the areas generated by this FO. This is used by percent-based properties to get the dimension of the containing block. If an FO has a property with a percentage value, that value is usually calculated on the basis of the corresponding dimension of the area which contains areas generated by the FO. NOTE: subclasses of FObj should implement this to return a reasonable value!

removeID

public void removeID(IDReferences idReferences)
removes property id
Parameters:
idReferences - the id to remove

generatesReferenceAreas

public boolean generatesReferenceAreas()

setWritingMode

protected void setWritingMode()
Set writing mode for this FO. Find nearest ancestor, including self, which generates reference areas and use the value of its writing-mode property. If no such ancestor is found, use the value on the root FO.

addMarker

public void addMarker(java.lang.String markerClassName)
               throws FOPException


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