org.docgene.help

Class JavaHelpFactory

java.lang.Object

org.docgene.help.JavaHelpFactory

public class JavaHelpFactory
extends java.lang.Object

The factory which parses a help file.

Usage

Here is an example with the Swing API:

 // get the zip file as an URL
 URL url = ...

 try {
   // create the Help factory
   JavaHelpFactory factory = new JavaHelpFactory(url);
   factory.create();
   ArticlesModel model = factory.getModel();

   // create the viewer component
   SwingHelpContentViewer viewer = new SwingHelpContentViewer();
   viewer.installModel(model);

   JComponent pane = viewer.getHelpComponent();
   // do whatever you want with the component
 } catch (IOException | SAXException ex) {
   ex.printStackTrace();
 }
 

Merging content

It is possible to merge several help content by using the merge(java.net.URL) method. For example:

 // get the zip file as an URL
 URL url = ...

 try {
   // create the Help factory
   JavaHelpFactory factory = new JavaHelpFactory(url);
   factory.create();

   // get the zip file of the content ot merge as an URL
   URL mergedURL = ...
   // merge the content
   factory.merge(mergedURL);

   // create the viewer component
   SwingHelpContentViewer viewer = new SwingHelpContentViewer();
   viewer.installModel(model);

   JComponent pane = viewer.getHelpComponent();
   // do whatever you want with the component
 } catch (IOException | SAXException ex) {
   ex.printStackTrace();
 }
 

Constructor Summary

Constructors

Constructor and Description
JavaHelpFactory(java.net.URL url) Constructor.
JavaHelpFactory(java.net.URL url, java.lang.String dataBasePath) Constructor.

Method Summary

Modifier and Type	Method and Description
ArticlesModel	create() Creates the ArticlesModel.
java.util.Locale	getLocale() Return the Locale to use for the GUI. it will be the English Locale by default.
ArticlesModel	getModel() The articles model.
void	install(HelpContentViewer<?,?> viewer) Install the Help content in the HelpContentViewer.
boolean	merge(java.net.URL url) Parse a help URL and merge the result with the existing ArticlesModel.
boolean	merge(java.net.URL url, java.lang.String databasePath) Parse a help URL and merge the result with the existing ArticlesModel.
void	setIndexPath(java.lang.String path) Set the path of the index article.
void	setLocale(java.util.Locale locale) Set the Locale to use for the GUI.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaHelpFactory

public JavaHelpFactory(java.net.URL url)

Constructor. By default the XML database path will be the "articles.xml" entry at the top-level of the archive.

Parameters:

url - the URL for the zip file containing the help content.

JavaHelpFactory

public JavaHelpFactory(java.net.URL url,
                       java.lang.String dataBasePath)

Constructor.

Parameters:

url - the URL for the zip file containing the help content.

dataBasePath - the path for the XML database entry

Method Detail

getModel

public ArticlesModel getModel()

The articles model.

Returns:

the model

setLocale

public void setLocale(java.util.Locale locale)

Set the Locale to use for the GUI.

Parameters:

locale - the Locale

getLocale

public java.util.Locale getLocale()

Return the Locale to use for the GUI. it will be the English Locale by default.

Returns:

the Locale

setIndexPath

public void setIndexPath(java.lang.String path)

Set the path of the index article.

Parameters:

path - the path of the index article

create

public ArticlesModel create()
                     throws java.io.IOException,
                            org.xml.sax.SAXException

Creates the ArticlesModel.

Returns:

the model

Throws:

java.io.IOException

org.xml.sax.SAXException

merge

public boolean merge(java.net.URL url)
              throws java.io.IOException,
                     org.xml.sax.SAXException

Parse a help URL and merge the result with the existing ArticlesModel. By default the XML database path will be the "articles.xml" entrye at the top-level of the archive.

Parameters:

url - the URL for the zip file containing the help content to merge

Returns:

true if the initial ArticlesModel exists

Throws:

java.io.IOException

org.xml.sax.SAXException

merge

public boolean merge(java.net.URL url,
                     java.lang.String databasePath)
              throws java.io.IOException,
                     org.xml.sax.SAXException

Parse a help URL and merge the result with the existing ArticlesModel.

Parameters:

url - the URL for the zip file containing the help content to merge

databasePath - the XML database path

Returns:

true if the initial ArticlesModel exists

Throws:

java.io.IOException

org.xml.sax.SAXException

install

public void install(HelpContentViewer<?,?> viewer)
             throws java.io.IOException

Install the Help content in the HelpContentViewer.

Parameters:

viewer - the HelpContentViewer

Throws:

java.io.IOException