org.docgene.help

Interface HelpContentViewer<C,W>

Type Parameters:

C - the help component Class

W - the help dialog window Class

All Known Subinterfaces:

ContentViewer

All Known Implementing Classes:

AbstractHelpContentViewer, JFXHelpContentViewer, SwingHelpContentViewer

public interface HelpContentViewer<C,W>

The interface 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 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: getHelpComponent() and add it in your GUI
• Or alternatively get the HelpContentViewer dialog window: 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 registerContextHelp(java.lang.String, java.lang.Object) method.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HELP_CLIENT_PROPERTY The docGenerator Help client property, used for the context sensitive Help.
static java.lang.String	ICON_BACKWARD "backward": The key for the backward icon.
static java.lang.String	ICON_FORWARD "forward": The key for the forward icon.
static java.lang.String	ICON_GLOSSARY "glossary": The key for the glossary icon.
static java.lang.String	ICON_HOME "home": The key for the home icon.

Method Summary

Modifier and Type	Method and Description
C	createContextHelpButton() Create a button to start a context senstive help.
ArticlesModel	getArticlesModel() Return the articles model.
AutoComplete	getAutoComplete() Return the AutoComplete element.
Article	getCurrentArticle() Return the current article.
java.lang.String	getCurrentTitle() Return the current title.
C	getHelpComponent() Return the component which shows the help GUI.
W	getHelpWindow(W owner, java.lang.String title, int width, int height) Return the dialog window which shows the help GUI.
NavigationHistory	getHistory() Return the navigation history.
java.util.Locale	getLocale() Return the Locale to use for the GUI.
Localization	getLocalization() Return the Localization to use for the GUI.
default java.util.Set<java.lang.String>	getStyleSheetThemes() Return the set of styleSheet themes ids.
default boolean	hasStyleSheetTheme() Return true if there is a stylesheet theme.
void	installModel(ArticlesModel model) Install the Help content in the HelpContentViewer.
boolean	registerContextHelp(java.lang.String helpID, C component) Add a context sensitive help to a component.
void	registerContextHelpWindow(W window) Add a window managed by the context help.
void	reloadPage() Reload the current page.
default void	resetStyleSheetTheme() Reset the stylesheet theme.
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	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	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.
default void	setLocale(java.lang.String 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.
default boolean	setStyleSheetTheme(java.lang.String id) Set the current stylesheet theme to a specified theme id.
void	showHelpDialog(C relativeTo) Show the help dialog relative to a component.
void	showHelpDialog(int x, int y) Show the help dialog.
void	showHelpTopic(java.lang.String helpID, C relativeTo) Show the help topic for a specified id.

Field Detail

HELP_CLIENT_PROPERTY

static final java.lang.String HELP_CLIENT_PROPERTY

The docGenerator Help client property, used for the context sensitive Help.

See Also:

Constant Field Values

ICON_GLOSSARY

static final java.lang.String ICON_GLOSSARY

"glossary": The key for the glossary icon.

See Also:

Constant Field Values

ICON_HOME

static final java.lang.String ICON_HOME

"home": The key for the home icon.

See Also:

Constant Field Values

ICON_FORWARD

static final java.lang.String ICON_FORWARD

"forward": The key for the forward icon.

See Also:

Constant Field Values

ICON_BACKWARD

static final java.lang.String ICON_BACKWARD

"backward": The key for the backward icon.

See Also:

Constant Field Values

Method Detail

installModel

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

Install the Help content in the HelpContentViewer.

Parameters:

model - the ArticlesModel

Throws:

java.io.IOException

getArticlesModel

ArticlesModel getArticlesModel()

Return the articles model.

Returns:

the model

getCurrentArticle

Article getCurrentArticle()

Return the current article.

Returns:

the current article

getCurrentTitle

java.lang.String getCurrentTitle()

Return the current title.

Returns:

the current title

setDividerLocation

void setDividerLocation(double location)

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

Parameters:

location - the location

setSearchTextHint

void setSearchTextHint(java.lang.String hintText)

Set the text hint to show in the search box.

Parameters:

hintText - the text hint

setFullSearchText

void setFullSearchText(java.lang.String text)

Set the full text search text.

Parameters:

text - the full text search text

setSearchTextIcon

void setSearchTextIcon(java.net.URL url)

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

Parameters:

url - the URL

setExpandedChapterIcon

void setExpandedChapterIcon(java.net.URL url)

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

Parameters:

url - the URL

setClosedChapterIcon

void setClosedChapterIcon(java.net.URL url)

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

Parameters:

url - the URL

setContextHelpIcon

void setContextHelpIcon(java.net.URL url)

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

Parameters:

url - the URL

setContextHelpPointerImage

void setContextHelpPointerImage(java.net.URL url)

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

Parameters:

url - the URL

setArticleIcon

void setArticleIcon(java.net.URL url)

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

Parameters:

url - the URL

setIcon

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

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

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

Parameters:

buttonID - the button id

url - the URL

getHistory

NavigationHistory getHistory()

Return the navigation history.

Returns:

the navigation history

getHelpComponent

C getHelpComponent()

Return the component which shows the help GUI.

Returns:

the component which shows the help GUI

getHelpWindow

W getHelpWindow(W owner,
                java.lang.String title,
                int width,
                int height)

Return the dialog window which shows the help GUI.

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

getAutoComplete

AutoComplete getAutoComplete()

Return the AutoComplete element.

Returns:

the AutoComplete element

registerContextHelp

boolean registerContextHelp(java.lang.String helpID,
                            C component)

Add a context sensitive help to a component.

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

createContextHelpButton

C createContextHelpButton()

Create a button to start a context senstive help.

Returns:

the button component

registerContextHelpWindow

void registerContextHelpWindow(W window)

Add a window managed by the context help.

Parameters:

window - the window

showHelpDialog

void showHelpDialog(C relativeTo)

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

Parameters:

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

showHelpDialog

void showHelpDialog(int x,
                    int y)

Show the help dialog.

Parameters:

x - the x position on screen

y - the y position on screen

showHelpTopic

void showHelpTopic(java.lang.String helpID,
                   C relativeTo)

Show the help topic for a specified id.

Parameters:

helpID - the help id

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

setLocale

void setLocale(java.util.Locale locale)

Set the Locale to use for the GUI.

Parameters:

locale - the Locale

setLocale

default void setLocale(java.lang.String locale)

Set the Locale to use for the GUI.

Parameters:

locale - the Locale

getLocalization

Localization getLocalization()

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

Returns:

the Localization

getLocale

java.util.Locale getLocale()

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

Returns:

the Locale

reloadPage

void reloadPage()

Reload the current page.

hasStyleSheetTheme

default boolean hasStyleSheetTheme()

Return true if there is a stylesheet theme.

Returns:

true if there is a stylesheet theme

getStyleSheetThemes

default java.util.Set<java.lang.String> getStyleSheetThemes()

Return the set of styleSheet themes ids.

Returns:

the set of styleSheet themes ids

resetStyleSheetTheme

default void resetStyleSheetTheme()

Reset the stylesheet theme.

setStyleSheetTheme

default boolean setStyleSheetTheme(java.lang.String id)

Set the current stylesheet theme to a specified theme id.

Parameters:

id - the theme id

Returns:

true if the stylesheet theme could be set