|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.itextpdf.text.pdf.PdfObject
com.itextpdf.text.pdf.PdfDictionary
com.itextpdf.text.pdf.PdfOutline
public class 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)
PdfDictionary| Field Summary | |
|---|---|
protected java.util.ArrayList<PdfOutline> |
kids
|
protected PdfWriter |
writer
|
| Fields inherited from class com.itextpdf.text.pdf.PdfDictionary |
|---|
CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES |
| Fields inherited from class com.itextpdf.text.pdf.PdfObject |
|---|
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type |
| Constructor Summary | |
|---|---|
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,
PdfAction action,
PdfString title)
Constructs a PdfOutline. |
|
PdfOutline(PdfOutline parent,
PdfAction action,
PdfString title,
boolean open)
Constructs a PdfOutline. |
|
PdfOutline(PdfOutline parent,
PdfAction action,
java.lang.String title)
Constructs a PdfOutline. |
|
PdfOutline(PdfOutline parent,
PdfAction action,
java.lang.String 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. |
|
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,
PdfDestination destination,
java.lang.String title)
Constructs a PdfOutline. |
|
PdfOutline(PdfOutline parent,
PdfDestination destination,
java.lang.String title,
boolean open)
Constructs a PdfOutline. |
|
| Method Summary | |
|---|---|
void |
addKid(PdfOutline outline)
Adds a kid to the outline |
BaseColor |
getColor()
Getter for property color. |
java.util.ArrayList<PdfOutline> |
getKids()
Returns the kids of this outline |
PdfDestination |
getPdfDestination()
Gets the destination for this outline. |
int |
getStyle()
Getter for property style. |
java.lang.String |
getTag()
Getter for property tag. |
java.lang.String |
getTitle()
Gets the title of this outline |
PdfIndirectReference |
indirectReference()
Gets the indirect reference of this PdfOutline. |
boolean |
isOpen()
Getter for property open. |
int |
level()
returns the level of this outline. |
PdfOutline |
parent()
Gets the parent of this PdfOutline. |
void |
setColor(BaseColor color)
Setter for property color. |
boolean |
setDestinationPage(PdfIndirectReference pageReference)
Set the page of the PdfDestination-object. |
void |
setIndirectReference(PdfIndirectReference reference)
Sets the indirect reference of this PdfOutline. |
void |
setKids(java.util.ArrayList<PdfOutline> 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(java.lang.String tag)
Setter for property tag. |
void |
setTitle(java.lang.String title)
Sets the title of this outline |
void |
toPdf(PdfWriter writer,
java.io.OutputStream os)
Returns the PDF representation of this PdfOutline. |
| Methods inherited from class com.itextpdf.text.pdf.PdfDictionary |
|---|
clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toString |
| Methods inherited from class com.itextpdf.text.pdf.PdfObject |
|---|
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected java.util.ArrayList<PdfOutline> kids
protected PdfWriter writer
| Constructor Detail |
|---|
public PdfOutline(PdfOutline parent,
PdfAction action,
java.lang.String title)
PdfOutline.
This is the constructor for an outline entry. The open mode is
true.
parent - the parent of this outline itemaction - the PdfAction for this outline itemtitle - the title of this outline item
public PdfOutline(PdfOutline parent,
PdfAction action,
java.lang.String title,
boolean open)
PdfOutline.
This is the constructor for an outline entry.
parent - the parent of this outline itemaction - the PdfAction for this outline itemtitle - the title of this outline itemopen - true if the children are visible
public PdfOutline(PdfOutline parent,
PdfDestination destination,
java.lang.String title)
PdfOutline.
This is the constructor for an outline entry. The open mode is
true.
parent - the parent of this outline itemdestination - the destination for this outline itemtitle - the title of this outline item
public PdfOutline(PdfOutline parent,
PdfDestination destination,
java.lang.String title,
boolean open)
PdfOutline.
This is the constructor for an outline entry.
parent - the parent of this outline itemdestination - the destination for this outline itemtitle - the title of this outline itemopen - true if the children are visible
public PdfOutline(PdfOutline parent,
PdfAction action,
PdfString title)
PdfOutline.
This is the constructor for an outline entry. The open mode is
true.
parent - the parent of this outline itemaction - the PdfAction for this outline itemtitle - the title of this outline item
public PdfOutline(PdfOutline parent,
PdfAction action,
PdfString title,
boolean open)
PdfOutline.
This is the constructor for an outline entry.
parent - the parent of this outline itemaction - the PdfAction for this outline itemtitle - the title of this outline itemopen - true if the children are visible
public PdfOutline(PdfOutline parent,
PdfDestination destination,
PdfString title)
PdfOutline.
This is the constructor for an outline entry. The open mode is
true.
parent - the parent of this outline itemdestination - the destination for this outline itemtitle - the title of this outline item
public PdfOutline(PdfOutline parent,
PdfDestination destination,
PdfString title,
boolean open)
PdfOutline.
This is the constructor for an outline entry.
parent - the parent of this outline itemdestination - the destination for this outline itemtitle - the title of this outline itemopen - true if the children are visible
public PdfOutline(PdfOutline parent,
PdfAction action,
Paragraph title)
PdfOutline.
This is the constructor for an outline entry. The open mode is
true.
parent - the parent of this outline itemaction - the PdfAction for this outline itemtitle - the title of this outline item
public PdfOutline(PdfOutline parent,
PdfAction action,
Paragraph title,
boolean open)
PdfOutline.
This is the constructor for an outline entry.
parent - the parent of this outline itemaction - the PdfAction for this outline itemtitle - the title of this outline itemopen - true if the children are visible
public PdfOutline(PdfOutline parent,
PdfDestination destination,
Paragraph title)
PdfOutline.
This is the constructor for an outline entry. The open mode is
true.
parent - the parent of this outline itemdestination - the destination for this outline itemtitle - the title of this outline item
public PdfOutline(PdfOutline parent,
PdfDestination destination,
Paragraph title,
boolean open)
PdfOutline.
This is the constructor for an outline entry.
parent - the parent of this outline itemdestination - the destination for this outline itemtitle - the title of this outline itemopen - true if the children are visible| Method Detail |
|---|
public void setIndirectReference(PdfIndirectReference reference)
PdfOutline.
reference - the PdfIndirectReference to this outline.public PdfIndirectReference indirectReference()
PdfOutline.
PdfIndirectReference to this outline.public PdfOutline parent()
PdfOutline.
PdfOutline that is the parent of this outline.public boolean setDestinationPage(PdfIndirectReference pageReference)
PdfDestination-object.
pageReference - indirect reference to the page
true if this page was set as the PdfDestination-page.public PdfDestination getPdfDestination()
public int level()
public void toPdf(PdfWriter writer,
java.io.OutputStream os)
throws java.io.IOException
PdfOutline.
toPdf in class PdfDictionarywriter - the PdfWriteros -
java.io.IOExceptionpublic void addKid(PdfOutline outline)
outline - public java.util.ArrayList<PdfOutline> getKids()
public void setKids(java.util.ArrayList<PdfOutline> kids)
kids - public java.lang.String getTag()
public void setTag(java.lang.String tag)
tag - New value of property tag.public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title - public boolean isOpen()
public void setOpen(boolean open)
open - New value of property open.public BaseColor getColor()
public void setColor(BaseColor color)
color - New value of property color.public int getStyle()
public void setStyle(int style)
style - New value of property style.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||