org.apache.fop.fo
Class FObj
org.apache.fop.fo.FONode
|
+--org.apache.fop.fo.FObj
- Direct Known Subclasses:
- BlockContainer, Character, DisplaySequence, ExternalGraphic, Flow, InlineGraphic, InstreamForeignObject, ListBlock, ListItem, ListItemBody, ListItemLabel, PageNumber, PageNumberCitation, Table, TableBody, TableCell, TableColumn, TableRow, FObjMixed, ConditionalPageMasterReference, LayoutMasterSet, PageMasterReference, PageSequence, PageSequenceMaster, Region, RepeatablePageMasterAlternatives, Root, SimplePageMaster, SVG, SVGObj
- public class FObj
- extends FONode
base class for representation of formatting objects and their processing
Methods inherited from class org.apache.fop.fo.FONode |
forceStartOffset, forceWidth, getLinkSet, getMarkerSnapshot, getParent, removeAreas, resetMarker, rollback, setBodyIndent, setDistanceBetweenStarts, setIsInLabel, setIsInListBody, setIsInTableCell, setLabelSeparation, setLinkSet, setOrphans, setWidows |
properties
public PropertyList properties
generatesReferenceAreas
public boolean generatesReferenceAreas()
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!
getName
public String getName()
- returns the name of the formatting object
- Returns: the name of this formatting objects
getProperty
public Property getProperty(String name)
- lets outside sources access the property list
first used by PageNumberCitation to find the "id" property
- Parameters:
- name - - the name of the desired property to obtain
- Returns: the property
layout
public Status layout(Area area)
throws org.apache.fop.apps.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
- Parameters:
- area
maker
public static Maker maker()
removeID
public void removeID(IDReferences idReferences)
- removes property id
- Parameters:
- idReferences - the id to remove
to Class org.apache.fop.fo.PropertyList
to Class java.lang.String