com.cete.dynamicpdf.merger
Class PdfOutline

java.lang.Object
  com.cete.dynamicpdf.merger.PdfOutline

public class PdfOutline
extends java.lang.Object

Represents an imported outline.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Method Summary

Action	getAction() Gets the action of the imported outline.
PdfOutlineList	getChildOutlines() Gets a list of imported child outlines.
RgbColor	getColor() Gets the color of the imported outline.
boolean	getExpanded() Gets a value indicating if the child outline is expanded by default.
TextStyle	getStyle() Gets the text style of the imported outline.
int	getTargetPageNumber() Gets the target page number of the imported outlines action.
java.lang.String	getText() Get the text of the imported outline.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getChildOutlines

public PdfOutlineList getChildOutlines()

Gets a list of imported child outlines. This property will be null if there are no child outlines.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Returns:

the pdf outline list.

getText

public java.lang.String getText()

Get the text of the imported outline.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Returns:

the text of the imported outline.

getStyle

public TextStyle getStyle()

Gets the text style of the imported outline.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Returns:

the text style of the imported outline.

getExpanded

public boolean getExpanded()

Gets a value indicating if the child outline is expanded by default.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Returns:

the expanded status of the outline.

getColor

public RgbColor getColor()

Gets the color of the imported outline.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Returns:

the color of the imported outline.

getAction

public Action getAction()

Gets the action of the imported outline.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Returns:

the action of the imported outline.

getTargetPageNumber

public int getTargetPageNumber()

Gets the target page number of the imported outlines action. This will return a value of -1 if the target page number is now known. The target page number is only known for imported outline actions that use a direct reference to a page.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Returns:

the target page number.