Save This Page
Home » iText-src-2.1.3 » com.lowagie » text » pdf » [javadoc | source]
com.lowagie.text.pdf
public class: PdfOutline [javadoc | source]
java.lang.Object
   com.lowagie.text.pdf.PdfObject
      com.lowagie.text.pdf.PdfDictionary
         com.lowagie.text.pdf.PdfOutline
PdfOutline is an object that represents a PDF outline entry.

An outline allows a user to access views of a document by name.
This object is described in the 'Portable Document Format Reference Manual version 1.3' section 6.7 (page 104-106)

Field Summary
protected  ArrayList kids     
protected  PdfWriter writer     
Fields inherited from com.lowagie.text.pdf.PdfDictionary:
FONT,  OUTLINES,  PAGE,  PAGES,  CATALOG,  hashMap
Fields inherited from com.lowagie.text.pdf.PdfObject:
BOOLEAN,  NUMBER,  STRING,  NAME,  ARRAY,  DICTIONARY,  STREAM,  NULL,  INDIRECT,  NOTHING,  TEXT_PDFDOCENCODING,  TEXT_UNICODE,  bytes,  type,  indRef
Constructor:
 PdfOutline(PdfWriter writer) 
    Constructs a PdfOutline.

    This is the constructor for the outlines object.

    Parameters:
    writer - The PdfWriter you are adding the outline to
 public PdfOutline(PdfOutline parent,
    PdfAction action,
    String title) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry. The open mode is true.

    Parameters:
    parent - the parent of this outline item
    action - the PdfAction for this outline item
    title - the title of this outline item
 public PdfOutline(PdfOutline parent,
    PdfDestination destination,
    String title) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry. The open mode is true.

    Parameters:
    parent - the parent of this outline item
    destination - the destination for this outline item
    title - the title of this outline item
 public PdfOutline(PdfOutline parent,
    PdfAction action,
    PdfString title) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry. The open mode is true.

    Parameters:
    parent - the parent of this outline item
    action - the PdfAction for this outline item
    title - the title of this outline item
 public PdfOutline(PdfOutline parent,
    PdfDestination destination,
    PdfString title) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry. The open mode is true.

    Parameters:
    parent - the parent of this outline item
    destination - the destination for this outline item
    title - the title of this outline item
 public PdfOutline(PdfOutline parent,
    PdfAction action,
    Paragraph title) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry. The open mode is true.

    Parameters:
    parent - the parent of this outline item
    action - the PdfAction for this outline item
    title - the title of this outline item
 public PdfOutline(PdfOutline parent,
    PdfDestination destination,
    Paragraph title) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry. The open mode is true.

    Parameters:
    parent - the parent of this outline item
    destination - the destination for this outline item
    title - the title of this outline item
 public PdfOutline(PdfOutline parent,
    PdfAction action,
    String title,
    boolean open) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry.

    Parameters:
    parent - the parent of this outline item
    action - the PdfAction for this outline item
    title - the title of this outline item
    open - true if the children are visible
 public PdfOutline(PdfOutline parent,
    PdfDestination destination,
    String title,
    boolean open) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry.

    Parameters:
    parent - the parent of this outline item
    destination - the destination for this outline item
    title - the title of this outline item
    open - true if the children are visible
 public PdfOutline(PdfOutline parent,
    PdfAction action,
    PdfString title,
    boolean open) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry.

    Parameters:
    parent - the parent of this outline item
    action - the PdfAction for this outline item
    title - the title of this outline item
    open - true if the children are visible
 public PdfOutline(PdfOutline parent,
    PdfDestination destination,
    PdfString title,
    boolean open) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry.

    Parameters:
    parent - the parent of this outline item
    destination - the destination for this outline item
    title - the title of this outline item
    open - true if the children are visible
 public PdfOutline(PdfOutline parent,
    PdfAction action,
    Paragraph title,
    boolean open) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry.

    Parameters:
    parent - the parent of this outline item
    action - the PdfAction for this outline item
    title - the title of this outline item
    open - true if the children are visible
 public PdfOutline(PdfOutline parent,
    PdfDestination destination,
    Paragraph title,
    boolean open) 
    Constructs a PdfOutline.

    This is the constructor for an outline entry.

    Parameters:
    parent - the parent of this outline item
    destination - the destination for this outline item
    title - the title of this outline item
    open - true if the children are visible
Method from com.lowagie.text.pdf.PdfOutline Summary:
addKid,   getColor,   getCount,   getKids,   getPdfDestination,   getStyle,   getTag,   getTitle,   indirectReference,   initOutline,   isOpen,   level,   parent,   setColor,   setCount,   setDestinationPage,   setIndirectReference,   setKids,   setOpen,   setStyle,   setTag,   setTitle,   toPdf
Methods from com.lowagie.text.pdf.PdfDictionary:
contains,   get,   getAsArray,   getAsBoolean,   getAsDict,   getAsIndirectObject,   getAsName,   getAsNumber,   getAsStream,   getAsString,   getDirectObject,   getKeys,   isCatalog,   isFont,   isOutlineTree,   isPage,   isPages,   merge,   mergeDifferent,   put,   putAll,   putEx,   remove,   size,   toPdf,   toString
Methods from com.lowagie.text.pdf.PdfObject:
canBeInObjStm,   getBytes,   getIndRef,   isArray,   isBoolean,   isDictionary,   isIndirect,   isName,   isNull,   isNumber,   isStream,   isString,   length,   setContent,   setIndRef,   toPdf,   toString,   type
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.lowagie.text.pdf.PdfOutline Detail:
 public  void addKid(PdfOutline outline) 
    Adds a kid to the outline
 public Color getColor() 
    Getter for property color.
 int getCount() 
 public ArrayList getKids() 
    Returns the kids of this outline
 public PdfDestination getPdfDestination() 
    Gets the destination for this outline.
 public int getStyle() 
    Getter for property style.
 public String getTag() 
    Getter for property tag.
 public String getTitle() 
    Gets the title of this outline
 public PdfIndirectReference indirectReference() 
    Gets the indirect reference of this PdfOutline.
  void initOutline(PdfOutline parent,
    String title,
    boolean open) 
    Helper for the constructors.
 public boolean isOpen() 
    Getter for property open.
 public int level() 
    returns the level of this outline.
 public PdfOutline parent() 
    Gets the parent of this PdfOutline.
 public  void setColor(Color color) 
    Setter for property color.
  void setCount(int count) 
 public boolean setDestinationPage(PdfIndirectReference pageReference) 
    Set the page of the PdfDestination-object.
 public  void setIndirectReference(PdfIndirectReference reference) 
    Sets the indirect reference of this PdfOutline.
 public  void setKids(ArrayList kids) 
    Sets the kids of this outline
 public  void setOpen(boolean open) 
    Setter for property open.
 public  void setStyle(int style) 
    Setter for property style.
 public  void setTag(String tag) 
    Setter for property tag.
 public  void setTitle(String title) 
    Sets the title of this outline
 public  void toPdf(PdfWriter writer,
    OutputStream os) throws IOException 
    Returns the PDF representation of this PdfOutline.