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 PdfDictionary
*/
public class PdfOutline : PdfDictionary {
// membervariables
/** the PdfIndirectReference of this object */
private PdfIndirectReference reference;
/** value of the Count-key */
private int count = 0;
/** value of the Parent-key */
private PdfOutline parent;
/** value of the Destination-key */
private PdfDestination destination;
/** The PdfAction for this outline.
*/
private PdfAction action;
protected ArrayList kids = new ArrayList();
protected PdfWriter writer;
/** Holds value of property tag. */
private string tag;
/** Holds value of property open. */
private bool open;
/** Holds value of property color. */
private Color color;
/** Holds value of property style. */
private int style = 0;
// constructors
/**
* Constructs a PdfOutline.
*
* This is the constructor for the outlines object.
*/
internal PdfOutline(PdfWriter writer) : base(OUTLINES) {
open = true;
parent = null;
this.writer = writer;
}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry. The open mode is
* true.
*
* @param parent the parent of this outline item
* @param action the PdfAction for this outline item
* @param title the title of this outline item
*/
public PdfOutline(PdfOutline parent, PdfAction action, string title) : this(parent, action, title, true) {}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry.
*
* @param parent the parent of this outline item
* @param action the PdfAction for this outline item
* @param title the title of this outline item
* @param open true if the children are visible
*/
public PdfOutline(PdfOutline parent, PdfAction action, string title, bool open) : base() {
this.action = action;
InitOutline(parent, title, open);
}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry. The open mode is
* true.
*
* @param parent the parent of this outline item
* @param destination the destination for this outline item
* @param title the title of this outline item
*/
public PdfOutline(PdfOutline parent, PdfDestination destination, string title) : this(parent, destination, title, true) {}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry.
*
* @param parent the parent of this outline item
* @param destination the destination for this outline item
* @param title the title of this outline item
* @param open true if the children are visible
*/
public PdfOutline(PdfOutline parent, PdfDestination destination, string title, bool open) : base() {
this.destination = destination;
InitOutline(parent, title, open);
}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry. The open mode is
* true.
*
* @param parent the parent of this outline item
* @param action the PdfAction for this outline item
* @param title the title of this outline item
*/
public PdfOutline(PdfOutline parent, PdfAction action, PdfString title) : this(parent, action, title, true) {}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry.
*
* @param parent the parent of this outline item
* @param action the PdfAction for this outline item
* @param title the title of this outline item
* @param open true if the children are visible
*/
public PdfOutline(PdfOutline parent, PdfAction action, PdfString title, bool open) : this(parent, action, title.ToString(), open) {}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry. The open mode is
* true.
*
* @param parent the parent of this outline item
* @param destination the destination for this outline item
* @param title the title of this outline item
*/
public PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title) : this(parent, destination, title, true) {}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry.
*
* @param parent the parent of this outline item
* @param destination the destination for this outline item
* @param title the title of this outline item
* @param open true if the children are visible
*/
public PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title, bool open) : this(parent, destination, title.ToString(), true) {}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry. The open mode is
* true.
*
* @param parent the parent of this outline item
* @param action the PdfAction for this outline item
* @param title the title of this outline item
*/
public PdfOutline(PdfOutline parent, PdfAction action, Paragraph title) : this(parent, action, title, true) {}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry.
*
* @param parent the parent of this outline item
* @param action the PdfAction for this outline item
* @param title the title of this outline item
* @param open true if the children are visible
*/
public PdfOutline(PdfOutline parent, PdfAction action, Paragraph title, bool open) : base() {
StringBuilder buf = new StringBuilder();
foreach (Chunk chunk in title.Chunks) {
buf.Append(chunk.Content);
}
this.action = action;
InitOutline(parent, buf.ToString(), open);
}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry. The open mode is
* true.
*
* @param parent the parent of this outline item
* @param destination the destination for this outline item
* @param title the title of this outline item
*/
public PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title) : this(parent, destination, title, true) {}
/**
* Constructs a PdfOutline.
*
* This is the constructor for an outline entry.
*
* @param parent the parent of this outline item
* @param destination the destination for this outline item
* @param title the title of this outline item
* @param open true if the children are visible
*/
public PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title, bool open) : base() {
StringBuilder buf = new StringBuilder();
foreach (Chunk chunk in title.Chunks) {
buf.Append(chunk.Content);
}
this.destination = destination;
InitOutline(parent, buf.ToString(), open);
}
// methods
/** Helper for the constructors.
* @param parent the parent outline
* @param title the title for this outline
* @param open true if the children are visible
*/
internal void InitOutline(PdfOutline parent, string title, bool open) {
this.open = open;
this.parent = parent;
writer = parent.writer;
Put(PdfName.TITLE, new PdfString(title, PdfObject.TEXT_UNICODE));
parent.AddKid(this);
if (destination != null && !destination.HasPage()) // bugfix Finn Bock
SetDestinationPage(writer.CurrentPage);
}
/**
* Gets the indirect reference of this PdfOutline.
*
* @return the PdfIndirectReference to this outline.
*/
public PdfIndirectReference IndirectReference {
get {
return reference;
}
set {
this.reference = value;
}
}
/**
* Gets the parent of this PdfOutline.
*
* @return the PdfOutline that is the parent of this outline.
*/
public PdfOutline Parent {
get {
return parent;
}
}
/**
* Set the page of the PdfDestination-object.
*
* @param pageReference indirect reference to the page
* @return true if this page was set as the PdfDestination-page.
*/
public bool SetDestinationPage(PdfIndirectReference pageReference) {
if (destination == null) {
return false;
}
return destination.AddPage(pageReference);
}
/**
* Gets the destination for this outline.
* @return the destination
*/
public PdfDestination PdfDestination {
get {
return destination;
}
}
internal int Count {
get {
return count;
}
set {
this.count = value;
}
}
/**
* returns the level of this outline.
*
* @return a level
*/
public int Level {
get {
if (parent == null) {
return 0;
}
return (parent.Level + 1);
}
}
/**
* Returns the PDF representation of this PdfOutline.
*
* @param writer the encryption information
* @param os
* @throws IOException
*/
public override void ToPdf(PdfWriter writer, Stream os) {
if (color != null && !color.Equals(Color.BLACK)) {
Put(PdfName.C, new PdfArray(new float[]{color.R/255f,color.G/255f,color.B/255f}));
}
int flag = 0;
if ((style & Font.BOLD) != 0)
flag |= 2;
if ((style & Font.ITALIC) != 0)
flag |= 1;
if (flag != 0)
Put(PdfName.F, new PdfNumber(flag));
if (parent != null) {
Put(PdfName.PARENT, parent.IndirectReference);
}
if (destination != null && destination.HasPage()) {
Put(PdfName.DEST, destination);
}
if (action != null)
Put(PdfName.A, action);
if (count != 0) {
Put(PdfName.COUNT, new PdfNumber(count));
}
base.ToPdf(writer, os);
}
public void AddKid(PdfOutline outline) {
kids.Add(outline);
}
public ArrayList Kids {
get {
return kids;
}
set {
this.kids = value;
}
}
/** Getter for property tag.
* @return Value of property tag.
*/
public string Tag {
get {
return tag;
}
set {
this.tag = value;
}
}
public string Title {
get {
PdfString title = (PdfString)Get(PdfName.TITLE);
return title.ToString();
}
set {
Put(PdfName.TITLE, new PdfString(value, PdfObject.TEXT_UNICODE));
}
}
/** Setter for property open.
* @param open New value of property open.
*/
public bool Open {
set {
this.open = value;
}
get {
return open;
}
}
public Color Color {
get {
return color;
}
set {
color = value;
}
}
public int Style {
get {
return style;
}
set {
style = value;
}
}
}
}