org.docgene.help.gui.swing

Class SwingHelpContentViewer

java.lang.Object

org.docgene.help.AbstractHelpContentViewer<javax.swing.JComponent,java.awt.Window>

org.docgene.help.gui.swing.SwingHelpContentViewer

All Implemented Interfaces:

ContentViewer, HelpContentViewer<javax.swing.JComponent,java.awt.Window>

public class SwingHelpContentViewer
extends AbstractHelpContentViewer<javax.swing.JComponent,java.awt.Window>
implements ContentViewer

The Swing HelpContentViewer. The SwingHelpContentViewer allows to show the content of a help system in a Swing GUI. The steps to use to use the HelpContentViewer are:

• Install the ArticlesModel by calling the installModel(org.docgene.help.model.ArticlesModel) method. Note that this can also be performed directly through the JavaHelpFactory by the JavaHelpFactory.install(org.docgene.help.HelpContentViewer) method
• Get the SwingHelpContentViewer component: getHelpComponent() and add it in your GUI
• Or alternatively get the HelpContentViewer dialog window: getHelpWindow(java.awt.Window, java.lang.String, int, int) and add it in your GUI

Adding context-sensitive help on components is performed through the registerContextHelp(java.lang.String, javax.swing.JComponent) method.

Field Summary

Fields inherited from class org.docgene.help.AbstractHelpContentViewer

articleIcon, backwardIcon, closedChapterIcon, currentArticle, currentTitle, forwardIcon, fullTextSearchText, glossaryIcon, hintText, history, homeIcon, localization, location, model, openChapterIcon, previousPage, searchIcon

Fields inherited from interface org.docgene.help.HelpContentViewer

HELP_CLIENT_PROPERTY, ICON_BACKWARD, ICON_FORWARD, ICON_GLOSSARY, ICON_HOME

Constructor Summary

Constructors

Constructor and Description
SwingHelpContentViewer()

Method Summary

Modifier and Type	Method and Description
void	applyLink(Article article, java.net.URL url, java.lang.String anchor) Apply a link.
HistoryElement	back() Perform a back action in the history.
javax.swing.JButton	createContextHelpButton() Create a button to start a context sensitive help.
HistoryElement	forward() Perform a forward action in the history.
ArticlesModel	getArticlesModel() Return the articles model.
AutoComplete	getAutoComplete() Return the AutoComplete element.
EngineManager	getEngineManager() Return the engine manager.
javax.swing.JComponent	getHelpComponent() Return the component which shows the help GUI.
javax.swing.JDialog	getHelpWindow(java.awt.Window owner, java.lang.String title, int width, int height) Return the dialog window which shows the help GUI.
NavigationHistory	getHistory() Return the navigation history.
javax.swing.JPanel	getRootPane() Return the root pane.
javax.swing.JComponent	getScrollPane() Return the scroll pane.
void	goTo(HistoryElement element) Go to an element.
void	installModel(ArticlesModel model) Install the Help content in the HelpContentViewer.
void	pageLoaded(java.net.URL url) Fired when a page is loaded.
boolean	registerContextHelp(java.lang.String helpID, javax.swing.JComponent component) Add a context sensitive help to a component.
void	registerContextHelpWindow(java.awt.Window window) Add a Window managed by the context help.
void	reloadPage() Reload the current page.
void	selectInTree(Article article) Select an article in the tree.
void	setArticlesTreeCellRenderer(ArticlesTreeCellRenderer treeRenderer) Set the TreeCellRenderer for the articles.
void	setContextHelpIcon(java.net.URL url) Set the URL for the icon specifying the image for the context sensitive help.
void	setContextHelpPointerImage(java.net.URL url) Set the URL for the image for the context sensitive pointer shape.
void	setCurrentArticle(Article article) Set the current article.
void	setCurrentTitle(java.lang.String title) Set the current title.
void	setLoadHTMLInSwing(boolean htmlInSwing) Set if html pages in help content (not articles) will be shown in Swing.
void	setPreviousPage(java.net.URL url, java.lang.String anchor) Set the previous page.
void	showHelpDialog(int x, int y) Show the help dialog.
void	showHelpDialog(javax.swing.JComponent relativeTo) Show the help dialog relative to a component.
void	showHelpTopic(java.lang.String helpID, javax.swing.JComponent relativeTo) Show the help topic for a specified id.
void	updateUI() Update the UI of the viewer.

Methods inherited from class org.docgene.help.AbstractHelpContentViewer

getCurrentArticle, getCurrentTitle, getElementName, getLocale, getLocalization, getNavigationHistory, getPreviousPage, isShowingSearchExceptions, setArticleIcon, setClosedChapterIcon, setDividerLocation, setExpandedChapterIcon, setFullSearchText, setIcon, setLocale, setSearchTextHint, setSearchTextIcon, showSearchExceptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.help.HelpContentViewer

getCurrentArticle, getCurrentTitle, getLocale, getLocalization, getStyleSheetThemes, hasStyleSheetTheme, isShowingSearchExceptions, resetStyleSheetTheme, setArticleIcon, setClosedChapterIcon, setDividerLocation, setExpandedChapterIcon, setFullSearchText, setIcon, setLocale, setLocale, setSearchTextHint, setSearchTextIcon, setStyleSheetTheme, showSearchExceptions

Constructor Detail

SwingHelpContentViewer

public SwingHelpContentViewer()

Method Detail

getRootPane

public javax.swing.JPanel getRootPane()

Return the root pane.

Specified by:

getRootPane in interface ContentViewer

Returns:

the root pane

getScrollPane

public javax.swing.JComponent getScrollPane()

Return the scroll pane.

Specified by:

getScrollPane in interface ContentViewer

Returns:

the scroll pane

getArticlesModel

public ArticlesModel getArticlesModel()

Return the articles model.

Specified by:

getArticlesModel in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Returns:

the model

installModel

public void installModel(ArticlesModel model)
                  throws java.io.IOException

Install the Help content in the HelpContentViewer.

Specified by:

installModel in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

model - the ArticlesModel

Throws:

java.io.IOException

updateUI

public void updateUI()

Update the UI of the viewer.

Specified by:

updateUI in interface ContentViewer

setLoadHTMLInSwing

public void setLoadHTMLInSwing(boolean htmlInSwing)

Set if html pages in help content (not articles) will be shown in Swing. Note that it concerns html pages different from the articles themselves. By default these pages are shown using the JavaFX Web engine.

Parameters:

htmlInSwing - true if html pages in help content (not articles) will be shown in Swing.

getEngineManager

public EngineManager getEngineManager()

Return the engine manager.

Returns:

the engine manager

setContextHelpIcon

public void setContextHelpIcon(java.net.URL url)

Set the URL for the icon specifying the image for the context sensitive help.

Specified by:

setContextHelpIcon in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

url - the URL

setContextHelpPointerImage

public void setContextHelpPointerImage(java.net.URL url)

Set the URL for the image for the context sensitive pointer shape.

Specified by:

setContextHelpPointerImage in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

url - the URL

setArticlesTreeCellRenderer

public void setArticlesTreeCellRenderer(ArticlesTreeCellRenderer treeRenderer)

Set the TreeCellRenderer for the articles.

Parameters:

treeRenderer -

back

public HistoryElement back()

Description copied from class: AbstractHelpContentViewer

Perform a back action in the history.

Specified by:

back in class AbstractHelpContentViewer<javax.swing.JComponent,java.awt.Window>

Returns:

the back element

forward

public HistoryElement forward()

Description copied from class: AbstractHelpContentViewer

Perform a forward action in the history.

Specified by:

forward in class AbstractHelpContentViewer<javax.swing.JComponent,java.awt.Window>

Returns:

the forward element

selectInTree

public void selectInTree(Article article)

Description copied from interface: ContentViewer

Select an article in the tree.

Specified by:

selectInTree in interface ContentViewer

Parameters:

article - the article

showHelpTopic

public void showHelpTopic(java.lang.String helpID,
                          javax.swing.JComponent relativeTo)

Show the help topic for a specified id.

Specified by:

showHelpTopic in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

helpID - the help id

relativeTo - the component from which the help Window must be relative to (can be null)

applyLink

public void applyLink(Article article,
                      java.net.URL url,
                      java.lang.String anchor)

Apply a link.

Specified by:

applyLink in interface ContentViewer

Parameters:

article - the article (may be null)

url - the URL

anchor - the anchoe (may be null)

goTo

public void goTo(HistoryElement element)

Description copied from class: AbstractHelpContentViewer

Go to an element.

Specified by:

goTo in class AbstractHelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

element - the element

setCurrentArticle

public void setCurrentArticle(Article article)

Description copied from interface: ContentViewer

Set the current article.

Specified by:

setCurrentArticle in interface ContentViewer

Parameters:

article - the current article

setCurrentTitle

public void setCurrentTitle(java.lang.String title)

Description copied from interface: ContentViewer

Set the current title.

Specified by:

setCurrentTitle in interface ContentViewer

Parameters:

title - the title

setPreviousPage

public void setPreviousPage(java.net.URL url,
                            java.lang.String anchor)

Description copied from interface: ContentViewer

Set the previous page.

Specified by:

setPreviousPage in interface ContentViewer

Parameters:

url - the previous page URL

anchor - the previous page anchoe( may be null)

reloadPage

public void reloadPage()

Reload the current page.

Specified by:

reloadPage in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

pageLoaded

public void pageLoaded(java.net.URL url)

Fired when a page is loaded.

Specified by:

pageLoaded in interface ContentViewer

Parameters:

url - the page URL

getHistory

public NavigationHistory getHistory()

Return the navigation history.

Specified by:

getHistory in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Returns:

the navigation history

getAutoComplete

public AutoComplete getAutoComplete()

Return the AutoComplete element.

Specified by:

getAutoComplete in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Returns:

the AutoComplete element

getHelpComponent

public javax.swing.JComponent getHelpComponent()

Return the component which shows the help GUI.

Specified by:

getHelpComponent in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Returns:

the component which shows the help GUI

getHelpWindow

public javax.swing.JDialog getHelpWindow(java.awt.Window owner,
                                         java.lang.String title,
                                         int width,
                                         int height)

Return the dialog window which shows the help GUI.

Specified by:

getHelpWindow in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

owner - the owner window

title - the dialog window title

width - the dialog width

height - the dialog height

Returns:

the JDialog window which shows the help GUI

registerContextHelp

public boolean registerContextHelp(java.lang.String helpID,
                                   javax.swing.JComponent component)

Add a context sensitive help to a component.

Specified by:

registerContextHelp in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

helpID - the helpRef id

component - the component

Returns:

true if the context sensitive help could be added. It will return false if no helpRef of the specified id exists

registerContextHelpWindow

public void registerContextHelpWindow(java.awt.Window window)

Add a Window managed by the context help.

Specified by:

registerContextHelpWindow in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

window - the Window

createContextHelpButton

public javax.swing.JButton createContextHelpButton()

Create a button to start a context sensitive help.

Specified by:

createContextHelpButton in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Returns:

the button component

showHelpDialog

public void showHelpDialog(javax.swing.JComponent relativeTo)

Show the help dialog relative to a component. This method is protected against cases where the component is not showing.

Specified by:

showHelpDialog in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

relativeTo - the component from which the help Window must be relative to (can be null)

showHelpDialog

public void showHelpDialog(int x,
                           int y)

Show the help dialog.

Specified by:

showHelpDialog in interface HelpContentViewer<javax.swing.JComponent,java.awt.Window>

Parameters:

x - the x position on screen

y - the y position on screen