com.partnersoft.help

Class HelpLib

java.lang.Object

com.partnersoft.help.HelpLib

All Implemented Interfaces:

Lib

public class HelpLib
extends java.lang.Object
implements Lib

Library class for help and troubleshooting functions.

Copyright 2011 Partner Software, Inc.

Author:

Paul Reavis

Method Summary

Methods

Modifier and Type	Method and Description
static VfsFile	createDocumentationPage(boolean includeMapViewerDocumentation, boolean includeWorkbenchDocumentation) Creates a table-of-contents in a temp file.
static VfsFile	createDocumentationPageIn(VfsFile file, boolean includeMapViewerDocumentation, boolean includeWorkbenchDocumentation) Creates a table-of-contents of all installed documentation page in the given file.
static Naming<VfsFile>	installedManuals()
static Naming<VfsFile>	installedMapsetManuals(MapApp app)
static Naming<VfsFile>	installedModuleDocumentation()
static Naming<VfsFile>	installedModuleManuals()
static Naming<VfsFile>	installedWorkbenchManuals()
static HelpApp	launchApp() Launches the Help application.
static void	openDocumentationPage() Creates a table-of-contents of installed documentation and opens it in a web browser.
static void	openDocumentationPage(boolean includeMapViewerDocumentation, boolean includeWorkbenchDocumentation) Creates a table-of-contents of installed documentation and opens it in a web browser.
static void	openTroubleReport() Opens the help app to the Trouble Report tab.

Methods inherited from class java.lang.Object

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

Method Detail

launchApp

public static HelpApp launchApp()

Launches the Help application.

openTroubleReport

public static void openTroubleReport()

Opens the help app to the Trouble Report tab.

openDocumentationPage

public static void openDocumentationPage()

Creates a table-of-contents of installed documentation and opens it in a web browser. Examines the currently running app context to see which documentation to include.

openDocumentationPage

public static void openDocumentationPage(boolean includeMapViewerDocumentation,
                         boolean includeWorkbenchDocumentation)

Creates a table-of-contents of installed documentation and opens it in a web browser.

createDocumentationPage

public static VfsFile createDocumentationPage(boolean includeMapViewerDocumentation,
                              boolean includeWorkbenchDocumentation)
                                       throws java.io.IOException

Creates a table-of-contents in a temp file. Returns the file handle.

Throws:

java.io.IOException

createDocumentationPageIn

public static VfsFile createDocumentationPageIn(VfsFile file,
                                boolean includeMapViewerDocumentation,
                                boolean includeWorkbenchDocumentation)
                                         throws java.io.IOException

Creates a table-of-contents of all installed documentation page in the given file. Returns the same file supplied.

Throws:

java.io.IOException

installedManuals

public static Naming<VfsFile> installedManuals()
                                        throws java.io.IOException

Throws:

java.io.IOException

installedMapsetManuals

public static Naming<VfsFile> installedMapsetManuals(MapApp app)
                                              throws java.io.IOException

Throws:

java.io.IOException

installedModuleManuals

public static Naming<VfsFile> installedModuleManuals()
                                              throws java.io.IOException

Throws:

java.io.IOException

installedWorkbenchManuals

public static Naming<VfsFile> installedWorkbenchManuals()
                                                 throws java.io.IOException

Throws:

java.io.IOException

installedModuleDocumentation

public static Naming<VfsFile> installedModuleDocumentation()
                                                    throws java.io.IOException

Throws:

java.io.IOException