Modifier and Type	Class and Description
pack-priv abstract static class	PDFDebugger.DocumentOpener Internal class to avoid double code in password entry loop.

Modifier and Type	Field and Description
public static final Properties	configuration
private String	currentFilePath
private String	currentTreeViewMode
private PDDocument	document
private final JPanel	documentPanel
private JMenu	findMenu
private JMenuItem	findMenuItem
private JMenuItem	findNextMenuItem
private JMenuItem	findPreviousMenuItem
private File	infile
private static final boolean	IS_MAC_OS
private JScrollPane	jScrollPaneRight
private JSplitPane	jSplitPane
private JTextPane	jTextPane
private static Log	LOG
private static final String	OS_NAME
private static final Set<COSName>	OTHERCOLORSPACES
private String	password
private static final FileFilter	PDF_FILTER
private JMenuItem	printMenuItem
private RecentFiles	recentFiles
private JMenu	recentFilesMenu
private JMenuItem	reopenMenuItem
private JMenuItem	saveAsMenuItem
private int	shortcutKeyMask
pack-priv CommandLine.Model.CommandSpec	spec
private static final Set<COSName>	SPECIALCOLORSPACES
private ReaderBottomPanel	statusBar
private TreeStatusPane	statusPane
private final PrintStream	SYSERR
private Tree	tree
pack-priv boolean	usageHelpRequested
private boolean	viewstructure
private WindowPrefs	windowPrefs

Access	Constructor and Description
public	PDFDebugger() Constructor.
public	PDFDebugger(String initial view mode for the tree view on the left hand side. initialViewMode) Constructor.

Method Summary

Modifier and Type	Method and Description
private void	addRecentFileItems()
public Integer	call() Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
private String	convertToString(Object selectedNode)
private JMenu	createEditMenu()
private JMenu	createFileMenu()
private JMenu	createFindMenu()
private void	exitMenuItemActionPerformed(ActionEvent ignored)
public JMenu	Returns: the File menu getFindMenu() Returns the File menu.
public JMenuItem	Returns: the Find menu getFindMenuItem() Returns the Edit > Find > Find menu item.
public JMenuItem	Returns: the FindNext menu getFindNextMenuItem() Returns the Edit > Find > Find Next menu item.
public JMenuItem	Returns: the FindPrevious menu getFindPreviousMenuItem() Returns the Edit > Find > Find Previous menu item.
private COSName	getNodeKey(Object selectedNode)
public static String	Returns: a page label or null if not available. getPageLabel(PDDocument the current document document, int 0-based page number. pageIndex) Convenience method to get the page label if available.
public String	getTreeViewMode() Provide the current view mode of the tree view.
private COSBase	getUnderneathObject(Object selectedNode)
public boolean	hasDocument()
public void	hyperlinkUpdate(HyperlinkEvent the event responsible for the update he) Implements javax.swing.event.HyperlinkListener.hyperlinkUpdate. Called when a hypertext link is updated.
private void	initComponents() This method is called from within the constructor to initialize the form.
protected void	initGlobalEventHandlers() Initialize application global event handlers.
public void	initTree()
private boolean	isAnnot(Object obj)
private boolean	isCIDFont(COSDictionary dic)
private boolean	isEncrypt(Object obj)
private boolean	isFlagNode(Object selectedNode, Object parentNode)
private boolean	isFont(Object selectedNode)
private boolean	isFontDescriptor(Object obj)
private boolean	isOtherColorSpace(Object selectedNode)
private boolean	isPage(Object selectedNode)
private boolean	isSignature(Object selectedNode, Object parentNode)
private boolean	isSpecialColorSpace(Object selectedNode)
private boolean	isStream(Object selectedNode)
private boolean	isString(Object selectedNode)
private void	jTree1ValueChanged(TreeSelectionEvent evt)
private void	loadConfiguration() Loads the local configuration file, if any.
public static void	main(String[] the command line arguments args) Entry point.
private void	openMenuItemActionPerformed(ActionEvent evt)
private void	osxOpenFiles(String filename) This method is called via reflection on Mac OS X.
private void	osxQuit() This method is called via reflection on Mac OS X.
protected void	performApplicationExit() Exit the application after the window is closed.
private void	printMenuItemActionPerformed(ActionEvent evt)
private void	readPDFFile(String filePath, String password)
private void	readPDFFile(final File file, String password)
private void	readPDFurl(final String urlString, String password)
private void	replaceRightComponent(Component pane)
private void	saveAsMenuItemActionPerformed(ActionEvent evt)
public void	setTreeViewMode(String the view mode to be set viewMode) Set the current view mode of the tree view.
private void	showColorPane(Object the special color space containing node. csNode) Show a Panel describing color spaces in more detail and interactive way.
private void	showFlagPane(Object parentNode, Object selectedNode)
private void	showFont(Object selectedNode, TreePath path)
private void	showPage(Object selectedNode)
private void	showSignaturePane(Object selectedNode)
private void	showStream(COSStream stream, TreePath path)
private void	showString(Object selectedNode)
private void	textDialog(String title, URL resource)

Field Detail

configuration	back to summary
public static final Properties configuration

currentFilePath	back to summary
private String currentFilePath

currentTreeViewMode	back to summary
private String currentTreeViewMode

document	back to summary
private PDDocument document

documentPanel	back to summary
private final JPanel documentPanel

findMenu	back to summary
private JMenu findMenu

findMenuItem	back to summary
private JMenuItem findMenuItem

findNextMenuItem	back to summary
private JMenuItem findNextMenuItem

findPreviousMenuItem	back to summary
private JMenuItem findPreviousMenuItem

infile	back to summary
private File infile Annotations @Parameters paramLabel:inputfile arity:0..1 description:the PDF file to be loaded

IS_MAC_OS	back to summary
private static final boolean IS_MAC_OS

jScrollPaneRight	back to summary
private JScrollPane jScrollPaneRight

jSplitPane	back to summary
private JSplitPane jSplitPane

jTextPane	back to summary
private JTextPane jTextPane

LOG	back to summary
private static Log LOG

OS_NAME	back to summary
private static final String OS_NAME

OTHERCOLORSPACES	back to summary
private static final Set<COSName> OTHERCOLORSPACES

password	back to summary
private String password Annotations @Option names:-password description:password to decrypt the document arity:0..1 interactive:true

PDF_FILTER	back to summary
private static final FileFilter PDF_FILTER

printMenuItem	back to summary
private JMenuItem printMenuItem

recentFiles	back to summary
private RecentFiles recentFiles

recentFilesMenu	back to summary
private JMenu recentFilesMenu

reopenMenuItem	back to summary
private JMenuItem reopenMenuItem

saveAsMenuItem	back to summary
private JMenuItem saveAsMenuItem

shortcutKeyMask	back to summary
private int shortcutKeyMask

spec	back to summary
pack-priv CommandLine.Model.CommandSpec spec Annotations @Spec

SPECIALCOLORSPACES	back to summary
private static final Set<COSName> SPECIALCOLORSPACES

statusBar	back to summary
private ReaderBottomPanel statusBar

statusPane	back to summary
private TreeStatusPane statusPane

SYSERR	back to summary
private final PrintStream SYSERR Annotations @SuppressWarnings:squid:S106

tree	back to summary
private Tree tree

usageHelpRequested	back to summary
pack-priv boolean usageHelpRequested Annotations @Option names:-h, --help usageHelp:true description:display this help message

viewstructure	back to summary
private boolean viewstructure Annotations @Option names:-viewstructure description:activate structure mode on startup

windowPrefs	back to summary
private WindowPrefs windowPrefs

Constructor Detail

PDFDebugger	back to summary
public PDFDebugger() Constructor.

PDFDebugger	back to summary
public PDFDebugger(String initialViewMode) Constructor. Parameters initialViewMode:String initial view mode for the tree view on the left hand side.

PDFDebugger

back to summary

public PDFDebugger(String initialViewMode)

Constructor.

Parameters

initialViewMode:String: initial view mode for the tree view on the left hand side.

Method Detail

addRecentFileItems	back to summary
private void addRecentFileItems()

call	back to summary
public Integer call() Implements java.util.concurrent.Callable.call. Doc from java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so. Returns:Integer computed result Annotations @Override

call

back to summary

public Integer call()

Implements java.util.concurrent.Callable.call.

Doc from java.util.concurrent.Callable.call.

Computes a result, or throws an exception if unable to do so.

Returns:Integer

computed result

Annotations

@Override

convertToString	back to summary
private String convertToString(Object selectedNode)

createEditMenu	back to summary
private JMenu createEditMenu()

createFileMenu	back to summary
private JMenu createFileMenu()

createFindMenu	back to summary
private JMenu createFindMenu()

exitMenuItemActionPerformed	back to summary
private void exitMenuItemActionPerformed(ActionEvent ignored)

getFindMenu	back to summary
public JMenu getFindMenu() Returns the File menu. Returns:JMenu the File menu

getFindMenu

back to summary

public JMenu getFindMenu()

Returns the File menu.

Returns:JMenu: the File menu

getFindMenuItem	back to summary
public JMenuItem getFindMenuItem() Returns the Edit > Find > Find menu item. Returns:JMenuItem the Find menu

getFindMenuItem

back to summary

public JMenuItem getFindMenuItem()

Returns the Edit > Find > Find menu item.

Returns:JMenuItem: the Find menu

getFindNextMenuItem	back to summary
public JMenuItem getFindNextMenuItem() Returns the Edit > Find > Find Next menu item. Returns:JMenuItem the FindNext menu

getFindNextMenuItem

back to summary

public JMenuItem getFindNextMenuItem()

Returns the Edit > Find > Find Next menu item.

Returns:JMenuItem: the FindNext menu

getFindPreviousMenuItem

back to summary

public JMenuItem getFindPreviousMenuItem()

Returns the Edit > Find > Find Previous menu item.

Returns:JMenuItem: the FindPrevious menu

getNodeKey	back to summary
private COSName getNodeKey(Object selectedNode)

getPageLabel

back to summary

public static String getPageLabel(PDDocument document, int pageIndex)

Convenience method to get the page label if available.

Parameters

document:PDDocument: the current document
pageIndex:int: 0-based page number.

Returns:String

a page label or null if not available.

getTreeViewMode	back to summary
public String getTreeViewMode() Provide the current view mode of the tree view. see `TreeViewMenu` for valid values

getUnderneathObject	back to summary
private COSBase getUnderneathObject(Object selectedNode)

hasDocument	back to summary
public boolean hasDocument()

hyperlinkUpdate

back to summary

public void hyperlinkUpdate(HyperlinkEvent he)

Implements javax.swing.event.HyperlinkListener.hyperlinkUpdate.

Doc from javax.swing.event.HyperlinkListener.hyperlinkUpdate.

Called when a hypertext link is updated.

Parameters

he:HyperlinkEvent: the event responsible for the update

Annotations

@Override

initComponents	back to summary
private void initComponents() This method is called from within the constructor to initialize the form.

initGlobalEventHandlers

back to summary

protected void initGlobalEventHandlers()

Initialize application global event handlers. Protected to allow subclasses to override this method if they don't want the global event handler overridden.

Annotations

@SuppressWarnings:WeakerAccess

initTree	back to summary
public void initTree()

isAnnot	back to summary
private boolean isAnnot(Object obj)

isCIDFont	back to summary
private boolean isCIDFont(COSDictionary dic)

isEncrypt	back to summary
private boolean isEncrypt(Object obj)

isFlagNode	back to summary
private boolean isFlagNode(Object selectedNode, Object parentNode)

isFont	back to summary
private boolean isFont(Object selectedNode)

isFontDescriptor	back to summary
private boolean isFontDescriptor(Object obj)

isOtherColorSpace	back to summary
private boolean isOtherColorSpace(Object selectedNode)

isPage	back to summary
private boolean isPage(Object selectedNode)

isSignature	back to summary
private boolean isSignature(Object selectedNode, Object parentNode)

isSpecialColorSpace	back to summary
private boolean isSpecialColorSpace(Object selectedNode)

isStream	back to summary
private boolean isStream(Object selectedNode)

isString	back to summary
private boolean isString(Object selectedNode)

jTree1ValueChanged	back to summary
private void jTree1ValueChanged(TreeSelectionEvent evt)

loadConfiguration	back to summary
private void loadConfiguration() Loads the local configuration file, if any.

main

back to summary

public static void main(String[] args)

Entry point.

Parameters

args:String[]: the command line arguments

openMenuItemActionPerformed	back to summary
private void openMenuItemActionPerformed(ActionEvent evt)

osxOpenFiles	back to summary
private void osxOpenFiles(String filename) This method is called via reflection on Mac OS X.

osxQuit	back to summary
private void osxQuit() This method is called via reflection on Mac OS X.

performApplicationExit

back to summary

protected void performApplicationExit()

Exit the application after the window is closed. This is protected to let subclasses override the behavior.

Annotations

@SuppressWarnings:WeakerAccess

printMenuItemActionPerformed	back to summary
private void printMenuItemActionPerformed(ActionEvent evt)

readPDFFile	back to summary
private void readPDFFile(String filePath, String password) throws IOException, URISyntaxException

readPDFFile	back to summary
private void readPDFFile(final File file, String password) throws IOException, URISyntaxException

readPDFurl	back to summary
private void readPDFurl(final String urlString, String password) throws IOException, URISyntaxException

replaceRightComponent	back to summary
private void replaceRightComponent(Component pane)

saveAsMenuItemActionPerformed	back to summary
private void saveAsMenuItemActionPerformed(ActionEvent evt)

setTreeViewMode back to summary

public void setTreeViewMode(String viewMode)

Set the current view mode of the tree view. see TreeViewMenu for valid values

Parameters

viewMode:String: the view mode to be set

showColorPane

back to summary

private void showColorPane(Object csNode) throws IOException

Show a Panel describing color spaces in more detail and interactive way.

Parameters

csNode:Object: the special color space containing node.

showFlagPane	back to summary
private void showFlagPane(Object parentNode, Object selectedNode)

showFont	back to summary
private void showFont(Object selectedNode, TreePath path)

showPage	back to summary
private void showPage(Object selectedNode)

showSignaturePane	back to summary
private void showSignaturePane(Object selectedNode)

showStream	back to summary
private void showStream(COSStream stream, TreePath path) throws IOException

showString	back to summary
private void showString(Object selectedNode)

textDialog	back to summary
private void textDialog(String title, URL resource)

org.apache.pdfbox.debugger back to summary

pack-priv abstract Class PDFDebugger.DocumentOpener

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.debugger.PDFDebugger.DocumentOpener

Internal class to avoid double code in password entry loop.

Field Summary

Modifier and Type	Field and Description
pack-priv String	password

Constructor Summary

Access	Constructor and Description
pack-priv	DocumentOpener(String password)

Method Summary

Modifier and Type	Method and Description
pack-priv abstract PDDocument	Returns: the PDDocument instance open() Override to load the actual input type (File, URL, stream), don't call it directly!
pack-priv final PDDocument	Returns: the PDDocument instance parse() Call this!

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

password	back to summary
pack-priv String password

Constructor Detail

DocumentOpener	back to summary
pack-priv DocumentOpener(String password)

Method Detail

open

back to summary

pack-priv abstract PDDocument open() throws IOException, URISyntaxException

Override to load the actual input type (File, URL, stream), don't call it directly!

Returns:PDDocument

the PDDocument instance

Exceptions

IOException:: Cannot read document

parse

back to summary

pack-priv final PDDocument parse() throws IOException, URISyntaxException

Call this!

Returns:PDDocument

the PDDocument instance

Exceptions

IOException:: Cannot read document

public Class PDFDebugger

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class PDFDebugger.DocumentOpener

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail