Package com.lowagie.text.pdf

Class PdfOutline

java.lang.Object
com.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfDictionary
com.lowagie.text.pdf.PdfOutline
@Deprecated public class PdfOutline extends PdfDictionary
Deprecated.
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)

See Also:

  • Field Details

    • kids

      protected List<PdfOutline> kids
      Deprecated.

    • writer

      protected PdfWriter writer
      Deprecated.

    • reference

      private PdfIndirectReference reference
      Deprecated.
      the PdfIndirectReference of this object

    • count

      private int count
      Deprecated.
      value of the Count-key

    • parent

      private PdfOutline parent
      Deprecated.
      value of the Parent-key

    • destination

      private PdfDestination destination
      Deprecated.
      value of the Destination-key

    • action

      private PdfAction action
      Deprecated.
      The PdfAction for this outline.

    • tag

      private String tag
      Deprecated.
      Holds value of property tag.

    • open

      private boolean open
      Deprecated.
      Holds value of property open.

    • color

      private Color color
      Deprecated.
      Holds value of property color.

    • style

      private int style
      Deprecated.
      Holds value of property style.

  • Constructor Details

    • PdfOutline

      PdfOutline(PdfWriter writer)
      Deprecated.
      Constructs a PdfOutline.

      This is the constructor for the outlines object.

      Parameters:
      writer - The PdfWriter you are adding the outline to

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfAction action, String title)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfAction action, String title, boolean open)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfDestination destination, String title)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfDestination destination, String title, boolean open)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfAction action, PdfString title)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfAction action, PdfString title, boolean open)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title, boolean open)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfAction action, Paragraph title)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfAction action, Paragraph title, boolean open)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title)
      Deprecated.
      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

    • PdfOutline

      public PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title, boolean open)
      Deprecated.
      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 Details

    • initOutline

      void initOutline(PdfOutline parent, String title, boolean open)
      Deprecated.
      Helper for the constructors.
      Parameters:
      parent - the parent outline
      title - the title for this outline
      open - true if the children are visible

    • setIndirectReference

      public void setIndirectReference(PdfIndirectReference reference)
      Deprecated.
      Sets the indirect reference of this PdfOutline.
      Parameters:
      reference - the PdfIndirectReference to this outline.

    • indirectReference

      public PdfIndirectReference indirectReference()
      Deprecated.
      Gets the indirect reference of this PdfOutline.
      Returns:
      the PdfIndirectReference to this outline.

    • parent

      public PdfOutline parent()
      Deprecated.
      Gets the parent of this PdfOutline.
      Returns:
      the PdfOutline that is the parent of this outline.

    • setDestinationPage

      public boolean setDestinationPage(PdfIndirectReference pageReference)
      Deprecated.
      Set the page of the PdfDestination-object.
      Parameters:
      pageReference - indirect reference to the page
      Returns:
      true if this page was set as the PdfDestination-page.

    • getPdfDestination

      public PdfDestination getPdfDestination()
      Deprecated.
      Gets the destination for this outline.
      Returns:
      the destination

    • getCount

      int getCount()
      Deprecated.

    • setCount

      void setCount(int count)
      Deprecated.

    • level

      public int level()
      Deprecated.
      returns the level of this outline.
      Returns:
      a level

    • toPdf

      public void toPdf(PdfWriter writer, OutputStream os) throws IOException
      Deprecated.
      Returns the PDF representation of this PdfOutline.
      Overrides:
      toPdf in class PdfDictionary
      Parameters:
      writer - the encryption information
      os - the OutputStream o write the bytes to
      Throws:
      IOException - on error of super.toPdf()

    • addKid

      public void addKid(PdfOutline outline)
      Deprecated.
      Adds a kid to the outline
      Parameters:
      outline - the PdfOutline to add a kid to

    • getKids

      public List<PdfOutline> getKids()
      Deprecated.
      Returns the kids of this outline
      Returns:
      an ArrayList with PdfOutlines

    • setKids

      public void setKids(List<PdfOutline> kids)
      Deprecated.
      Sets the kids of this outline
      Parameters:
      kids - the kids of the outline

    • getTag

      public String getTag()
      Deprecated.
      Getter for property tag.
      Returns:
      Value of property tag.

    • setTag

      public void setTag(String tag)
      Deprecated.
      Setter for property tag.
      Parameters:
      tag - New value of property tag.

    • getTitle

      public String getTitle()
      Deprecated.
      Gets the title of this outline
      Returns:
      the title as a String

    • setTitle

      public void setTitle(String title)
      Deprecated.
      Sets the title of this outline
      Parameters:
      title - the title of the outline

    • isOpen

      public boolean isOpen()
      Deprecated.
      Getter for property open.
      Returns:
      Value of property open.

    • setOpen

      public void setOpen(boolean open)
      Deprecated.
      Setter for property open.
      Parameters:
      open - New value of property open.

    • getColor

      public Color getColor()
      Deprecated.
      Getter for property color.
      Returns:
      Value of property color.

    • setColor

      public void setColor(Color color)
      Deprecated.
      Setter for property color.
      Parameters:
      color - New value of property color.

    • getStyle

      public int getStyle()
      Deprecated.
      Getter for property style.
      Returns:
      Value of property style.

    • setStyle

      public void setStyle(int style)
      Deprecated.
      Setter for property style.
      Parameters:
      style - New value of property style.