com.lowagie.text.pdf
public class PdfOutline extends PdfDictionary
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: PdfDictionary
Field Summary | |
---|---|
PdfAction | action The PdfAction for this outline. |
Color | color Holds value of property color. |
int | count value of the Count-key |
PdfDestination | destination value of the Destination-key |
protected ArrayList | kids |
boolean | open Holds value of property open. |
PdfOutline | parent value of the Parent-key |
PdfIndirectReference | reference the PdfIndirectReference of this object |
int | style Holds value of property style. |
String | tag Holds value of property tag. |
protected PdfWriter | writer |
Constructor Summary | |
---|---|
PdfOutline(PdfWriter writer)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfAction action, String title)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfAction action, String title, boolean open)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfDestination destination, String title)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfDestination destination, String title, boolean open)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfAction action, PdfString title)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfAction action, PdfString title, boolean open)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title, boolean open)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfAction action, Paragraph title)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfAction action, Paragraph title, boolean open)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title)
Constructs a PdfOutline .
| |
PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title, boolean open)
Constructs a PdfOutline .
|
Method Summary | |
---|---|
void | addKid(PdfOutline outline)
Adds a kid to the outline |
Color | getColor() Getter for property color. |
int | getCount() |
ArrayList | getKids()
Returns the kids of this outline |
PdfDestination | getPdfDestination()
Gets the destination for this outline. |
int | getStyle() Getter for property style. |
String | getTag() Getter for property tag. |
String | getTitle()
Gets the title of this outline |
PdfIndirectReference | indirectReference()
Gets the indirect reference of this PdfOutline .
|
void | initOutline(PdfOutline parent, String title, boolean open) Helper for the constructors. |
boolean | isOpen() Getter for property open. |
int | level()
returns the level of this outline.
|
PdfOutline | parent()
Gets the parent of this PdfOutline .
|
void | setColor(Color color) Setter for property color. |
void | setCount(int count) |
boolean | setDestinationPage(PdfIndirectReference pageReference)
Set the page of the PdfDestination -object.
|
void | setIndirectReference(PdfIndirectReference reference)
Sets the indirect reference of this PdfOutline .
|
void | setKids(ArrayList kids)
Sets the kids of this outline |
void | setOpen(boolean open) Setter for property open. |
void | setStyle(int style) Setter for property style. |
void | setTag(String tag) Setter for property tag. |
void | setTitle(String title)
Sets the title of this outline |
void | toPdf(PdfWriter writer, OutputStream os)
Returns the PDF representation of this PdfOutline .
|
PdfAction
for this outline.PdfIndirectReference
of this objectPdfOutline
.
This is the constructor for the outlines object
.
Parameters: writer The PdfWriter you are adding the outline to
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
Parameters: outline
Returns: Value of property color.
Returns: an ArrayList with PdfOutlines
Returns: the destination
Returns: Value of property style.
Returns: Value of property tag.
Returns: the title as a String
PdfOutline
.
Returns: the PdfIndirectReference
to this outline.
Parameters: parent the parent outline title the title for this outline open true
if the children are visible
Returns: Value of property open.
Returns: a level
PdfOutline
.
Returns: the PdfOutline
that is the parent of this outline.
Parameters: color New value of property color.
PdfDestination
-object.
Parameters: pageReference indirect reference to the page
Returns: true
if this page was set as the PdfDestination
-page.
PdfOutline
.
Parameters: reference the PdfIndirectReference
to this outline.
Parameters: kids
Parameters: open New value of property open.
Parameters: style New value of property style.
Parameters: tag New value of property tag.
Parameters: title
PdfOutline
.
Parameters: writer the encryption information os
Throws: IOException