public static class

HTML2PDF.TOCSettings

extends Object
implements AutoCloseable
java.lang.Object
   ↳ com.pdftron.pdf.HTML2PDF.TOCSettings

Class Overview

Settings for table of contents. This option is deprecated in the latest HTML2PDF module and may have no effect.

Summary

Public Constructors
TOCSettings()
Default table of contents settings.
Public Methods
void close()
Frees the native memory of the object.
void destroy()
Frees the native memory of the object.
void setCaptionText(String caption)
Caption text to be used with TOC.
void setDottedLines(boolean enable)
Use a dotted line when creating TOC.
void setLevelIndentation(int indentation)
Indentation used for every TOC level...
void setLinks(boolean enable)
Create links from TOC to actual content.
void setTextSizeShrink(double shrink)
How much to shrink font for every level, e.g.
void setXsl(String style_sheet)
xsl style sheet used to convert outline XML into a table of content.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.AutoCloseable

Public Constructors

public TOCSettings ()

Default table of contents settings.

Throws
PDFNetException

Public Methods

public void close ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Throws
PDFNetException

public void destroy ()

Frees the native memory of the object. This can be explicitly called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

public void setCaptionText (String caption)

Caption text to be used with TOC.

Parameters
caption - Text that will appear with the table of contents. Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Throws
PDFNetException

public void setDottedLines (boolean enable)

Use a dotted line when creating TOC.

Parameters
enable - Table of contents will use dotted lines. Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Throws
PDFNetException

public void setLevelIndentation (int indentation)

Indentation used for every TOC level...

Parameters
indentation - How much to indent each level, e.g. "2" Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Throws
PDFNetException

public void setLinks (boolean enable)

Create links from TOC to actual content.

Parameters
enable - Entries in table of contents will link to section in the PDF. Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Throws
PDFNetException

public void setTextSizeShrink (double shrink)

How much to shrink font for every level, e.g. 0.8

Parameters
shrink - Rate at which lower level entries will appear smaller Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Throws
PDFNetException

public void setXsl (String style_sheet)

xsl style sheet used to convert outline XML into a table of content.

Parameters
style_sheet - Path to xsl style sheet to be used to generate this table of contents. Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Throws
PDFNetException