org.docgene.help

Class AbstractHelpContentViewer<C,W>

java.lang.Object

org.docgene.help.AbstractHelpContentViewer<C,W>

Type Parameters:

C - the help component Class

W - the help dialog window Class

All Implemented Interfaces:

HelpContentViewer<C,W>

Direct Known Subclasses:

JFXHelpContentViewer, SwingHelpContentViewer

public abstract class AbstractHelpContentViewer<C,W>
extends java.lang.Object
implements HelpContentViewer<C,W>

The abstract class for the HelpContentViewer. The HelpContentViewer allows to show the content of a help system. The steps to use to use the HelpContentViewer are:

• Install the ArticlesModel by calling the HelpContentViewer.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 HelpContentViewer component: HelpContentViewer.getHelpComponent() and add it in your GUI
• Or alternatively get the HelpContentViewer dialog window: HelpContentViewer.getHelpWindow(java.lang.Object, java.lang.String, int, int) and add it in your GUI

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.URL	articleIcon The icon for articles.
protected java.net.URL	backwardIcon The icon for the backward button.
protected java.net.URL	closedChapterIcon The icon for closed chapters.
protected Article	currentArticle The current article.
protected java.lang.String	currentTitle The current title.
protected java.net.URL	forwardIcon The icon for the forward button.
protected java.lang.String	fullTextSearchText The full text search text.
protected java.net.URL	glossaryIcon The icon for the glossary.
protected java.lang.String	hintText The search hint text.
protected NavigationHistory	history The navigation history.
protected java.net.URL	homeIcon The icon for the home page.
protected Localization	localization The Locale.
protected double	location The splitpane location of the separator between the tree and the content of the pages.
protected ArticlesModel	model The articles model.
protected java.net.URL	openChapterIcon The icon for opened chapters.
protected HistoryElement	previousPage The previous page.
protected java.net.URL	searchIcon The icon for the Search.

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
AbstractHelpContentViewer()

Method Summary

Modifier and Type	Method and Description
abstract HistoryElement	back() Perform a back action in the history.
abstract HistoryElement	forward() Perform a forward action in the history.
Article	getCurrentArticle() Return the current article.
java.lang.String	getCurrentTitle() Return the current title.
protected java.lang.String	getElementName(java.lang.String key) Return the text name for an element in the GUI (depending on the Locale).
java.util.Locale	getLocale() Return the Locale to use for the GUI. it will be the English Locale by default.
Localization	getLocalization() Return the Localization to use for the GUI.
NavigationHistory	getNavigationHistory() Return the navigation history.
HistoryElement	getPreviousPage() Return the previous page in the history.
abstract void	goTo(HistoryElement element) Go to an element.
void	setArticleIcon(java.net.URL url) Set the URL for the icon specifying the image for articles in the tree..
void	setClosedChapterIcon(java.net.URL url) Set the URL for the icon specifying the image for closed chapters.
void	setDividerLocation(double location) Set the divider location between the articles tree and the articles content.
void	setExpandedChapterIcon(java.net.URL url) Set the URL for the icon specifying the image for expanded chapters.
void	setFullSearchText(java.lang.String text) Set the full text search text.
void	setIcon(java.lang.String buttonID, java.net.URL url) Set the URL for the icon for a button.
void	setLocale(java.util.Locale locale) Set the Locale to use for the GUI.
void	setSearchTextHint(java.lang.String hintText) Set the text hint to show in the search box.
void	setSearchTextIcon(java.net.URL url) Set the URL for the icon used in the search text field.

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

createContextHelpButton, getArticlesModel, getAutoComplete, getHelpComponent, getHelpWindow, getHistory, getStyleSheetThemes, hasStyleSheetTheme, installModel, registerContextHelp, registerContextHelpWindow, reloadPage, resetStyleSheetTheme, setContextHelpIcon, setContextHelpPointerImage, setLocale, setStyleSheetTheme, showHelpDialog, showHelpDialog, showHelpTopic

Field Detail

model

protected ArticlesModel model

The articles model.

currentArticle

protected Article currentArticle

The current article.

currentTitle

protected java.lang.String currentTitle

The current title.

hintText

protected java.lang.String hintText

The search hint text.

fullTextSearchText

protected java.lang.String fullTextSearchText

The full text search text.

location

protected double location

The splitpane location of the separator between the tree and the content of the pages.

history

protected final NavigationHistory history

The navigation history.

previousPage

protected HistoryElement previousPage

The previous page.

localization

protected Localization localization

The Locale.

openChapterIcon

protected java.net.URL openChapterIcon

The icon for opened chapters.

closedChapterIcon

protected java.net.URL closedChapterIcon

The icon for closed chapters.

articleIcon

protected java.net.URL articleIcon

The icon for articles.

searchIcon

protected java.net.URL searchIcon

The icon for the Search.

glossaryIcon

protected java.net.URL glossaryIcon

The icon for the glossary.

homeIcon

protected java.net.URL homeIcon

The icon for the home page.

forwardIcon

protected java.net.URL forwardIcon

The icon for the forward button.

backwardIcon

protected java.net.URL backwardIcon

The icon for the backward button.

Constructor Detail

AbstractHelpContentViewer

public AbstractHelpContentViewer()

Method Detail

getCurrentArticle

public Article getCurrentArticle()

Return the current article.

Specified by:

getCurrentArticle in interface HelpContentViewer<C,W>

Returns:

the current article

getCurrentTitle

public java.lang.String getCurrentTitle()

Return the current title.

Specified by:

getCurrentTitle in interface HelpContentViewer<C,W>

Returns:

the current title

setDividerLocation

public void setDividerLocation(double location)

Set the divider location between the articles tree and the articles content.

Specified by:

setDividerLocation in interface HelpContentViewer<C,W>

Parameters:

location - the location

setArticleIcon

public void setArticleIcon(java.net.URL url)

Set the URL for the icon specifying the image for articles in the tree..

Specified by:

setArticleIcon in interface HelpContentViewer<C,W>

Parameters:

url - the URL

setExpandedChapterIcon

public void setExpandedChapterIcon(java.net.URL url)

Set the URL for the icon specifying the image for expanded chapters.

Specified by:

setExpandedChapterIcon in interface HelpContentViewer<C,W>

Parameters:

url - the URL

setClosedChapterIcon

public void setClosedChapterIcon(java.net.URL url)

Set the URL for the icon specifying the image for closed chapters.

Specified by:

setClosedChapterIcon in interface HelpContentViewer<C,W>

Parameters:

url - the URL

setIcon

public void setIcon(java.lang.String buttonID,
                    java.net.URL url)

Set the URL for the icon for a button. The button id can be:

• HelpContentViewer.ICON_HOME for the home button
• HelpContentViewer.ICON_FORWARD for the forward button
• HelpContentViewer.ICON_BACKWARD for the backward button
• HelpContentViewer.ICON_GLOSSARY for the glossary button

Specified by:

setIcon in interface HelpContentViewer<C,W>

Parameters:

buttonID - the button id

url - the URL

setSearchTextIcon

public void setSearchTextIcon(java.net.URL url)

Set the URL for the icon used in the search text field.

Specified by:

setSearchTextIcon in interface HelpContentViewer<C,W>

Parameters:

url - the URL

setSearchTextHint

public void setSearchTextHint(java.lang.String hintText)

Set the text hint to show in the search box.

Specified by:

setSearchTextHint in interface HelpContentViewer<C,W>

Parameters:

hintText - the text hint

setFullSearchText

public void setFullSearchText(java.lang.String text)

Set the full text search text.

Specified by:

setFullSearchText in interface HelpContentViewer<C,W>

Parameters:

text - the full text search text

getNavigationHistory

public NavigationHistory getNavigationHistory()

Return the navigation history.

Returns:

the navigation history

getPreviousPage

public HistoryElement getPreviousPage()

Return the previous page in the history.

Returns:

the previous page

back

public abstract HistoryElement back()

Perform a back action in the history.

Returns:

the back element

forward

public abstract HistoryElement forward()

Perform a forward action in the history.

Returns:

the forward element

goTo

public abstract void goTo(HistoryElement element)

Go to an element.

Parameters:

element - the element

setLocale

public void setLocale(java.util.Locale locale)

Set the Locale to use for the GUI.

Specified by:

setLocale in interface HelpContentViewer<C,W>

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.

Specified by:

getLocale in interface HelpContentViewer<C,W>

Returns:

the Locale

getLocalization

public Localization getLocalization()

Return the Localization to use for the GUI.

Specified by:

getLocalization in interface HelpContentViewer<C,W>

Returns:

the Localization

getElementName

protected java.lang.String getElementName(java.lang.String key)

Return the text name for an element in the GUI (depending on the Locale).

Parameters:

key - the element key

Returns:

the name