- scroll(String, boolean) - Method in interface org.docgene.help.gui.swing.EngineManager
-
Scroll to a reference on a page.
- scroll(String, boolean) - Method in class org.docgene.help.gui.swing.SwingJFXEngineManager
-
- scroll(String, boolean) - Method in class org.docgene.help.gui.swing.SwingSwingEngineManager
-
- search(String) - Method in class org.docgene.help.model.ArticlesModel
-
Search for the list of articles containing a search term.
- search(String) - Method in class org.docgene.help.model.FullTextSearch
-
Search a term in the index and return the associated list of articles which have this term.
- searchIcon - Variable in class org.docgene.help.AbstractHelpContentViewer
-
The icon for the Search.
- searchTextPerformed(AdditionalSearchEvent) - Method in interface org.docgene.help.gui.swing.autocomplete.AdditionalSearchListener
-
Fired for an search text Event.
- selectInTree(Article) - Method in interface org.docgene.help.gui.swing.ContentViewer
-
Select an article in the tree.
- selectInTree(Article) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
- setArticleIcon(URL) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Set the URL for the icon specifying the image for articles in the tree..
- setArticleIcon(URL) - Method in interface org.docgene.help.gui.swing.ArticlesTreeCellRenderer
-
Set the URL for the icon specifying the image for articles.
- setArticleIcon(URL) - Method in class org.docgene.help.gui.swing.DefaultArticlesTreeCellRenderer
-
Set the URL for the icon specifying the image for articles.
- setArticleIcon(URL) - Method in interface org.docgene.help.HelpContentViewer
-
Set the URL for the icon specifying the image for articles in the tree..
- setArticlesTreeCellRenderer(ArticlesTreeCellRenderer) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Set the TreeCellRenderer for the articles.
- setAutoComplete(AutoComplete) - Method in interface org.docgene.help.gui.autocomplete.AutoCompleteEngine
-
Set the AutoComplete which will be used with the Engine.
- setAutoComplete(AutoComplete) - Method in class org.docgene.help.gui.autocomplete.DefaultPopupEngine
-
Set the AutoComplete which will be used with the Engine.
- setClosedChapterIcon(URL) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Set the URL for the icon specifying the image for closed chapters.
- setClosedChapterIcon(URL) - Method in interface org.docgene.help.gui.swing.ArticlesTreeCellRenderer
-
Set the URL for the icon specifying the image for closed chapters.
- setClosedChapterIcon(URL) - Method in class org.docgene.help.gui.swing.DefaultArticlesTreeCellRenderer
-
Set the URL for the icon specifying the image for closed chapters.
- setClosedChapterIcon(URL) - Method in interface org.docgene.help.HelpContentViewer
-
Set the URL for the icon specifying the image for closed chapters.
- setContentViewer(ContentViewer) - Method in class org.docgene.help.gui.swing.AbstractSwingEngineManager
-
Set the ContentViewer
- setContentViewer(ContentViewer) - Method in interface org.docgene.help.gui.swing.EngineManager
-
Set the ContentViewer
- setContextHelpIcon(URL) - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Set the URL for the icon specifying the image for the context sensitive help.
- setContextHelpIcon(URL) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Set the URL for the icon specifying the image for the context sensitive help.
- setContextHelpIcon(URL) - Method in interface org.docgene.help.HelpContentViewer
-
Set the URL for the icon specifying the image for the context sensitive help.
- setContextHelpPointerImage(URL) - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Set the URL for the image for the context sensitive pointer shape.
- setContextHelpPointerImage(URL) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Set the URL for the image for the context sensitive pointer shape.
- setContextHelpPointerImage(URL) - Method in interface org.docgene.help.HelpContentViewer
-
Set the URL for the image for the context sensitive pointer shape.
- setCurrentArticle(Article) - Method in interface org.docgene.help.gui.swing.ContentViewer
-
Set the current article.
- setCurrentArticle(Article) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
- setCurrentTitle(String) - Method in interface org.docgene.help.gui.swing.ContentViewer
-
Set the current title.
- setCurrentTitle(String) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
- setDictionnary(AutoCompleteDictionary) - Method in interface org.docgene.help.gui.autocomplete.AutoComplete
-
Set the dictionnary used for the Autocompletion.
- setDictionnary(AutoCompleteDictionary) - Method in class org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete
-
Set the dictionnary used for the Autocompletion.
- setDictionnary(AutoCompleteDictionary) - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Set the dictionnary used for the Autocompletion.
- setDividerLocation(double) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Set the divider location between the articles tree and the articles content.
- setDividerLocation(double) - Method in interface org.docgene.help.HelpContentViewer
-
Set the divider location between the articles tree and the articles content.
- setExpandedChapterIcon(URL) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Set the URL for the icon specifying the image for expanded chapters.
- setExpandedChapterIcon(URL) - Method in interface org.docgene.help.gui.swing.ArticlesTreeCellRenderer
-
Set the URL for the icon specifying the image for expanded chapters.
- setExpandedChapterIcon(URL) - Method in class org.docgene.help.gui.swing.DefaultArticlesTreeCellRenderer
-
Set the URL for the icon specifying the image for expanded chapters.
- setExpandedChapterIcon(URL) - Method in interface org.docgene.help.HelpContentViewer
-
Set the URL for the icon specifying the image for expanded chapters.
- setFullSearchText(String) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Set the full text search text.
- setFullSearchText(String) - Method in interface org.docgene.help.HelpContentViewer
-
Set the full text search text.
- setFullTextSearch(URL) - Method in class org.docgene.help.model.ArticlesModel
-
Set the URL of the fullTextSearch json file.
- setFullTextSearchCompressed(boolean) - Method in class org.docgene.help.model.ArticlesModel
-
Return true if the full text search index must be compressed (the level is greater or equal to 2).
- setGlossary(Article) - Method in class org.docgene.help.model.ArticlesModel
-
Set the glossary.
- setHeader(String) - Method in class org.docgene.help.model.Article
-
Set the article header.
- setHelpFormat(short) - Method in class org.docgene.help.model.ArticlesModel
-
Set the help format.
- setIcon(String, URL) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Set the URL for the icon for a button.
- setIcon(String, URL) - Method in interface org.docgene.help.HelpContentViewer
-
Set the URL for the icon for a button.
- setIndex(Article) - Method in class org.docgene.help.model.ArticlesModel
-
Set the index article.
- setIndexPath(String) - Method in class org.docgene.help.JavaHelpFactory
-
Set the path of the index article.
- setLoadHTMLInSwing(boolean) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Set if html pages in help content (not articles) will be shown in Swing.
- setLocale(Locale) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Set the Locale to use for the GUI.
- setLocale(Locale) - Method in interface org.docgene.help.HelpContentViewer
-
Set the Locale to use for the GUI.
- setLocale(String) - Method in interface org.docgene.help.HelpContentViewer
-
Set the Locale to use for the GUI.
- setLocale(Locale) - Method in class org.docgene.help.JavaHelpFactory
-
Set the Locale to use for the GUI.
- setLocale(Locale) - Method in class org.docgene.help.locale.Localization
-
Set the Locale to use for the GUI.
- setLocale(String) - Method in class org.docgene.help.locale.Localization
-
Set the Locale to use for the GUI.
- setMaximumPopupSize(int, int) - Method in interface org.docgene.help.gui.autocomplete.AutoComplete
-
Set the maximum width and height of the Popup.
- setMaximumPopupSize(int, int) - Method in class org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete
-
Set the maximum width and height of the Popup.
- setMaximumPopupSize(int, int) - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Set the maximum width and height of the Popup.
- setMaxSize(int) - Method in class org.docgene.help.utils.NavigationHistory
-
Set the maximum size of the history.
- setOpacity(float) - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Set the Popup Window opacity.
- setPage(URL) - Method in interface org.docgene.help.gui.swing.EngineManager
-
Set the current page.
- setPage(URL) - Method in class org.docgene.help.gui.swing.SwingJFXEngineManager
-
Follow a hyperlink
- setPage(URL) - Method in class org.docgene.help.gui.swing.SwingSwingEngineManager
-
- setPreviousPage(URL, String) - Method in interface org.docgene.help.gui.swing.ContentViewer
-
Set the previous page.
- setPreviousPage(URL, String) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
- setResultsLimit(int) - Method in class org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete
-
Set the results limits.
- setResultsLimit(int) - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Set the results limits.
- setSearchLimit(int) - Method in class org.docgene.help.model.ArticlesModel
-
Set the search limit.
- setSearchTextHint(String) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Set the text hint to show in the search box.
- setSearchTextHint(String) - Method in interface org.docgene.help.HelpContentViewer
-
Set the text hint to show in the search box.
- setSearchTextIcon(URL) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Set the URL for the icon used in the search text field.
- setSearchTextIcon(URL) - Method in interface org.docgene.help.HelpContentViewer
-
Set the URL for the icon used in the search text field.
- setStyleSheet(URL) - Method in class org.docgene.help.model.ArticlesModel
-
Set the URL of the styleSheet.
- setStyleSheetTheme(String) - Method in interface org.docgene.help.HelpContentViewer
-
Set the current stylesheet theme to a specified theme id.
- setStyleSheetTheme(String) - Method in class org.docgene.help.model.ArticlesModel
-
Set the current stylesheet theme to a specified theme id.
- setStyleSheetThemeURL(URL) - Method in class org.docgene.help.model.ArticlesModel
-
Set the URL of the styleSheet theme.
- setup(URL, ArticlesModel) - Method in class org.docgene.help.model.FullTextSearch
-
Setup the full text search Elastic index.
- show() - Method in class org.docgene.help.gui.jfx.JFXSearchPane
-
Show the Search panel.
- show() - Method in class org.docgene.help.gui.swing.JFXSearchPane
-
Show the Search panel.
- showHelpDialog(Node) - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Show the help dialog relative to a Node.
- showHelpDialog(int, int) - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Show the help dialog.
- showHelpDialog(JComponent) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Show the help dialog relative to a component.
- showHelpDialog(int, int) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Show the help dialog.
- showHelpDialog(C) - Method in interface org.docgene.help.HelpContentViewer
-
Show the help dialog relative to a component.
- showHelpDialog(int, int) - Method in interface org.docgene.help.HelpContentViewer
-
Show the help dialog.
- showHelpTopic(String, Node) - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Show the help topic for a specified id.
- showHelpTopic(String, JComponent) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Show the help topic for a specified id.
- showHelpTopic(String, C) - Method in interface org.docgene.help.HelpContentViewer
-
Show the help topic for a specified id.
- SPANISH - Static variable in interface org.docgene.help.locale.Locales
-
The Spanish locale.
- SuggestedHit(AutoCompleteDictionary.Item) - Constructor for class org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete.SuggestedHit
-
Constructor.
- SuggestedHit(String, String) - Constructor for class org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete.SuggestedHit
-
Constructor.
- SuggestedHit(AutoCompleteDictionary.Item) - Constructor for class org.docgene.help.gui.swing.autocomplete.JAutoComplete.SuggestedHit
-
Constructor.
- SuggestedHit(String, String) - Constructor for class org.docgene.help.gui.swing.autocomplete.JAutoComplete.SuggestedHit
-
Constructor.
- SwingHelpContentViewer - Class in org.docgene.help.gui.swing
-
The Swing HelpContentViewer.
- SwingHelpContentViewer() - Constructor for class org.docgene.help.gui.swing.SwingHelpContentViewer
-
- SwingJFXEngineManager - Class in org.docgene.help.gui.swing
-
The JavaFX engine manager for the Swing help viewer.
- SwingJFXEngineManager() - Constructor for class org.docgene.help.gui.swing.SwingJFXEngineManager
-
- SwingSwingEngineManager - Class in org.docgene.help.gui.swing
-
The Swing engine manager for the Swing help viewer.
- SwingSwingEngineManager() - Constructor for class org.docgene.help.gui.swing.SwingSwingEngineManager
-