Class HtmlBookmarks

java.lang.Object

org.openpdf.toolbox.AbstractTool

org.openpdf.toolbox.plugins.HtmlBookmarks

All Implemented Interfaces:

ActionListener, EventListener

public class HtmlBookmarks
extends AbstractTool

Allows you to generate an index file in HTML containing Bookmarks to an existing PDF file.

Since:

2.1.1 (imported from itexttoolbox project)

Field Summary

Fields inherited from class AbstractTool

arguments, internalFrame, MENU_EXECUTE, MENU_EXECUTE_PRINT, MENU_EXECUTE_PRINT_SILENT, MENU_EXECUTE_SHOW, menuoptions, versionsarray

Constructor Summary

Constructors

Constructor	Description
HtmlBookmarks()	Constructs an HtmlBookmarks object.

Method Summary

Modifier and Type	Method	Description
private static void	addBookmark(String pdf, Section section, Map<String,Object> bookmark)	Recursive method to write Bookmark titles to the System.out.
private static Section	createBookmark(String pdf, Section section, Map<String,Object> bookmark)	Adds a line with the title and an anchor.
protected void	createFrame()	Creates the internal frame.
void	execute()	Executes the tool (in most cases this generates a PDF file).
protected File	getDestPathPDF()	Gets the PDF file that should be generated (or null if the output isn't a PDF file).
static void	main(String[] args)	Allows you to generate an index file in HTML containing Bookmarks to an existing PDF file.
void	valueHasChanged(AbstractArgument arg)	Indicates that the value of an argument has changed.

Methods inherited from class AbstractTool

actionPerformed, addVersion, getArguments, getInternalFrame, getMenubar, getUsage, getValue, setArguments, setInternalFrame, setMainArguments, setMenubar

Methods inherited from class Object

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

Constructor Details

HtmlBookmarks

public HtmlBookmarks()

Constructs an HtmlBookmarks object.

Method Details

addBookmark

private static void addBookmark(String pdf,
 Section section,
 Map<String,Object> bookmark)

Recursive method to write Bookmark titles to the System.out.

Parameters:

pdf - the path to the PDF file

section - the section to which the bookmarks should be added

bookmark - a Map containing a Bookmark (and possible kids)

createBookmark

private static Section createBookmark(String pdf,
 Section section,
 Map<String,Object> bookmark)

Adds a line with the title and an anchor.

Parameters:

pdf - the link to the PDF file

section - the section that gets the line

bookmark - the bookmark that has the data for the line

Returns:

a subsection of section

main

public static void main(String[] args)

Allows you to generate an index file in HTML containing Bookmarks to an existing PDF file.

Parameters:

args - String[]

createFrame

protected void createFrame()

Description copied from class: AbstractTool

Creates the internal frame.

Specified by:

createFrame in class AbstractTool

See Also:

• AbstractTool.createFrame()

execute

public void execute()

Description copied from class: AbstractTool

Executes the tool (in most cases this generates a PDF file).

Specified by:

execute in class AbstractTool

See Also:

• AbstractTool.execute()

valueHasChanged

public void valueHasChanged(AbstractArgument arg)

Description copied from class: AbstractTool

Indicates that the value of an argument has changed.

Specified by:

valueHasChanged in class AbstractTool

Parameters:

arg - StringArgument

See Also:

• AbstractTool.valueHasChanged(AbstractArgument)

getDestPathPDF

protected File getDestPathPDF()
                       throws InstantiationException

Description copied from class: AbstractTool

Gets the PDF file that should be generated (or null if the output isn't a PDF file).

Specified by:

getDestPathPDF in class AbstractTool

Returns:

File

Throws:

InstantiationException - on error

See Also:

• AbstractTool.getDestPathPDF()