public class JFXHelpContentViewer extends AbstractHelpContentViewer<javafx.scene.Node,javafx.stage.Stage>
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)
methodgetHelpComponent()
and add it in your GUIgetHelpWindow(javafx.stage.Stage, java.lang.String, int, int)
and add it in
your GUIregisterContextHelp(java.lang.String, javafx.scene.Node)
method.articleIcon, backwardIcon, closedChapterIcon, currentArticle, currentTitle, forwardIcon, fullTextSearchText, glossaryIcon, hintText, history, homeIcon, localization, location, model, openChapterIcon, previousPage, searchIcon
HELP_CLIENT_PROPERTY, ICON_BACKWARD, ICON_FORWARD, ICON_GLOSSARY, ICON_HOME
Constructor and Description |
---|
JFXHelpContentViewer() |
Modifier and Type | Method and Description |
---|---|
HistoryElement |
back()
Perform a back action in the history.
|
javafx.scene.control.Button |
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.
|
javafx.scene.Node |
getHelpComponent()
Return the component which shows the help GUI.
|
javafx.stage.Stage |
getHelpWindow(javafx.stage.Stage owner,
java.lang.String title,
int width,
int height)
Return the dialog window which shows the help GUI.
|
NavigationHistory |
getHistory()
Return the navigation history.
|
void |
goTo(HistoryElement element)
Go to an element.
|
void |
installModel(ArticlesModel model)
Install the Help content in the HelpContentViewer.
|
boolean |
registerContextHelp(java.lang.String helpID,
javafx.scene.control.MenuItem item)
Add a context sensitive help to a MenuItem.
|
boolean |
registerContextHelp(java.lang.String helpID,
javafx.scene.Node node)
Add a context sensitive help to a Node.
|
void |
registerContextHelpScene(javafx.scene.Scene scene)
Add a Scene managed by the context help.
|
void |
registerContextHelpWindow(javafx.stage.Stage stage)
Add a Stage managed by the context help.
|
void |
reloadPage()
Reload the current page.
|
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 |
showHelpDialog(int x,
int y)
Show the help dialog.
|
void |
showHelpDialog(javafx.scene.Node relativeTo)
Show the help dialog relative to a Node.
|
void |
showHelpTopic(java.lang.String helpID,
javafx.scene.Node relativeTo)
Show the help topic for a specified id.
|
getCurrentArticle, getCurrentTitle, getElementName, getLocale, getLocalization, getNavigationHistory, getPreviousPage, setArticleIcon, setClosedChapterIcon, setDividerLocation, setExpandedChapterIcon, setFullSearchText, setIcon, setLocale, setSearchTextHint, setSearchTextIcon
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getStyleSheetThemes, hasStyleSheetTheme, resetStyleSheetTheme, setLocale, setStyleSheetTheme
public void installModel(ArticlesModel model) throws java.io.IOException
model
- the ArticlesModeljava.io.IOException
public ArticlesModel getArticlesModel()
public void setContextHelpIcon(java.net.URL url)
url
- the URLpublic void setContextHelpPointerImage(java.net.URL url)
url
- the URLpublic HistoryElement back()
AbstractHelpContentViewer
back
in class AbstractHelpContentViewer<javafx.scene.Node,javafx.stage.Stage>
public HistoryElement forward()
AbstractHelpContentViewer
forward
in class AbstractHelpContentViewer<javafx.scene.Node,javafx.stage.Stage>
public void reloadPage()
public void goTo(HistoryElement element)
AbstractHelpContentViewer
goTo
in class AbstractHelpContentViewer<javafx.scene.Node,javafx.stage.Stage>
element
- the elementpublic NavigationHistory getHistory()
public AutoComplete getAutoComplete()
public javafx.scene.Node getHelpComponent()
public javafx.stage.Stage getHelpWindow(javafx.stage.Stage owner, java.lang.String title, int width, int height)
owner
- the owner windowtitle
- the dialog window titlewidth
- the dialog widthheight
- the dialog heightpublic boolean registerContextHelp(java.lang.String helpID, javafx.scene.Node node)
helpID
- the helpRef idnode
- the Nodepublic boolean registerContextHelp(java.lang.String helpID, javafx.scene.control.MenuItem item)
helpID
- the helpRef iditem
- the MenuItempublic void registerContextHelpScene(javafx.scene.Scene scene)
scene
- the Scenepublic void registerContextHelpWindow(javafx.stage.Stage stage)
registerContextHelpScene(javafx.scene.Scene)
method.stage
- the Stagepublic javafx.scene.control.Button createContextHelpButton()
public void showHelpDialog(javafx.scene.Node relativeTo)
relativeTo
- the Node from which the help Window must be relative to (can be null)public void showHelpDialog(int x, int y)
x
- the x position on screeny
- the y position on screenpublic void showHelpTopic(java.lang.String helpID, javafx.scene.Node relativeTo)
helpID
- the help idrelativeTo
- the Node from which the help Window must be relative to (can be null)Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence