org.apache.fop.extensions
Class Destination

java.lang.Object
  |
  +--org.apache.fop.fo.FONode
        |
        +--org.apache.fop.fo.FObj
              |
              +--org.apache.fop.extensions.ExtensionObj
                    |
                    +--org.apache.fop.extensions.Destination

public class Destination
extends ExtensionObj

Provides support for PDF destinations, which allow external files to link into a particular place within the generated document.

Author:
Stefan Wachter (based on work by Lloyd McKenzie)

Inner Class Summary
static class Destination.Maker
           
 
Inner classes inherited from class org.apache.fop.fo.FObj
FObj.Maker
 
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
Destination(FObj parent, PropertyList propertyList, java.lang.String systemId, int line, int column)
           
 
Method Summary
 java.lang.String getDestinationName()
          Gets the name under which the destination may be referenced.
 java.lang.String getInternalDestination()
          Gets the internal destination.
 java.lang.String getName()
          returns the name of the formatting object
static FObj.Maker maker()
           
 
Methods inherited from class org.apache.fop.extensions.ExtensionObj
format, layout
 
Methods inherited from class org.apache.fop.fo.FObj
addCharacters, addMarker, end, generatesReferenceAreas, getContentWidth, 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

Destination

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

maker

public static FObj.Maker maker()

getDestinationName

public java.lang.String getDestinationName()
Gets the name under which the destination may be referenced.

getInternalDestination

public java.lang.String getInternalDestination()
Gets the internal destination. The internal destination must be equal to the value of an id-attribute of some xsl:fo-Element.

getName

public java.lang.String getName()
Description copied from class: FObj
returns the name of the formatting object
Overrides:
getName in class FObj
Following copied from class: org.apache.fop.fo.FObj
Returns:
the name of this formatting objects


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