org.apache.fop.extensions
Class Outline

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

public class Outline
extends ExtensionObj

Class representing an outline entry (an /OUT object in a PDF file, but referred to as a "Bookmark" from within Adobe Acrobat).


Inner Class Summary
static class Outline.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
Outline(FObj parent, PropertyList propertyList, java.lang.String systemId, int line, int column)
           
 
Method Summary
protected  void addChild(FONode obj)
           
 java.lang.String getInternalDestination()
           
 Label getLabel()
           
 java.lang.String getName()
          returns the name of the formatting object
 java.util.ArrayList getOutlines()
           
 Outline getParentOutline()
           
 java.lang.Object getRendererObject()
           
static FObj.Maker maker()
           
 void setRendererObject(java.lang.Object o)
           
 
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
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

Outline

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

maker

public static FObj.Maker maker()

addChild

protected void addChild(FONode obj)
Overrides:
addChild in class FONode

setRendererObject

public void setRendererObject(java.lang.Object o)

getRendererObject

public java.lang.Object getRendererObject()

getParentOutline

public Outline getParentOutline()

getLabel

public Label getLabel()

getOutlines

public java.util.ArrayList getOutlines()

getInternalDestination

public java.lang.String getInternalDestination()

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.