ExtensionObj (Fop API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Home

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.fop.extensions
Class ExtensionObj

java.lang.Object
  org.apache.fop.fo.FONode
      org.apache.fop.fo.FObj
          org.apache.fop.extensions.ExtensionObj

Direct Known Subclasses:: ContinuedLabel, Destination, Label, Outline

public abstract class ExtensionObj
extends FObj

base class for extension objects

Nested Class Summary

Nested classes inherited from class org.apache.fop.fo.FObj

FObj.Maker

Field Summary

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
`ExtensionObj(FObj parent, PropertyList propertyList, java.lang.String systemId, int line, int column)`

Method Summary
`void`	`format(AreaTree areaTree)` Called for root extensions.
`int`	`layout(Area area)` Called for extensions within a page sequence or flow.

Methods inherited from class org.apache.fop.fo.FObj

addCharacters, addMarker, end, generatesReferenceAreas, getContentWidth, 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

Constructor Detail

ExtensionObj

public ExtensionObj(FObj parent,
                    PropertyList propertyList,
                    java.lang.String systemId,
                    int line,
                    int column)

Parameters:: parent - the parent formatting object; propertyList - the explicit properties of this object

Method Detail

layout

public int layout(Area area)
           throws FOPException

Called for extensions within a page sequence or flow. These extensions are allowed to generate visible areas within the layout.

Overrides:: layout in class FObj

Parameters:: area -
Throws:: FOPException

format

public void format(AreaTree areaTree)
            throws FOPException

Called for root extensions. Root extensions aren't allowed to generate any visible areas. They are used for extra items that don't show up in the page layout itself. For example: pdf outlines

Parameters:: areaTree -
Throws:: FOPException