- GERMAN - Static variable in interface org.docgene.help.locale.Locales
-
The German locale.
- getAltTitles() - Method in class org.docgene.help.model.Article
-
Return the alternate titles.
- getAnchor() - Method in class org.docgene.help.utils.HistoryElement
-
Return the element anchor.
- getAnchors() - Method in class org.docgene.help.model.Article
-
Return the article anchors.
- getArticle() - Method in class org.docgene.help.gui.autocomplete.ArticleItem
-
- getArticle() - Method in class org.docgene.help.gui.autocomplete.TitleItem
-
- getArticle() - Method in class org.docgene.help.model.ArticleObject
-
Return the article.
- getArticle(String) - Method in class org.docgene.help.model.ArticlesModel
-
Return an article of a specified ID.
- getArticle(URL) - Method in class org.docgene.help.model.ArticlesModel
-
Return an article of a specified URL.
- getArticle() - Method in class org.docgene.help.model.HelpRef
-
Return the ref article.
- getArticles() - Method in class org.docgene.help.model.ArticlesModel
-
Return the articles.
- getArticles() - Method in class org.docgene.help.model.Chapter
-
Return the articles which are directly under this Chapter.
- getArticlesModel() - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Return the articles model.
- getArticlesModel() - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Return the articles model.
- getArticlesModel() - Method in interface org.docgene.help.HelpContentViewer
-
Return the articles model.
- getAutoComplete() - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Return the AutoComplete element.
- getAutoComplete() - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Return the AutoComplete element.
- getAutoComplete() - Method in interface org.docgene.help.HelpContentViewer
-
Return the AutoComplete element.
- getAutoCompleteListeners() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the list of JAutoComplete listeners.
- getBaseURL() - Method in class org.docgene.help.model.ArticlesModel
-
Return the base URL.
- getCategories() - Method in class org.docgene.help.gui.autocomplete.AutoCompleteDictionary
-
Return the map of categories.
- getChapters() - Method in class org.docgene.help.model.Chapter
-
Return the list of children Chapters.
- getChildURL(URL, String) - Static method in class org.docgene.help.utils.HelpUtilities
-
Return an URL by its relative path from a parent URL.
- getContainingTextListeners() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the list of containing text listeners.
- getCurrentArticle() - Method in class org.docgene.help.AbstractHelpContentViewer
-
Return the current article.
- getCurrentArticle() - Method in interface org.docgene.help.HelpContentViewer
-
Return the current article.
- getCurrentSize() - Method in class org.docgene.help.utils.NavigationHistory
-
Return the current size of the history.
- getCurrentStyleSheetTheme() - Method in class org.docgene.help.model.ArticlesModel
-
Return the current stylesheet theme.
- getCurrentTitle() - Method in class org.docgene.help.AbstractHelpContentViewer
-
Return the current title.
- getCurrentTitle() - Method in interface org.docgene.help.HelpContentViewer
-
Return the current title.
- getDescription() - Method in class org.docgene.help.model.Article
-
Return the article description.
- getDictionary() - Method in interface org.docgene.help.gui.autocomplete.AutoComplete
-
Return the dictionnary used for the Autocompletion.
- getDictionary() - Method in class org.docgene.help.gui.autocomplete.AutoCompleteDictionary
-
Return the dictionary.
- getDictionary() - Method in class org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete
-
Return the dictionnary used for the Autocompletion.
- getDictionary() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the dictionnary used for the Autocompletion.
- getDictionnary() - Method in class org.docgene.help.gui.autocomplete.AutoCompleteDictionary.Category
-
Return the dictionary for the category.
- getElementName(String) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Return the text name for an element in the GUI (depending on the Locale).
- getEngineManager() - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Return the engine manager.
- getEntryURL(URL, String) - Static method in class org.docgene.help.utils.HelpUtilities
-
Return an URL by its relative path from a parent URL.
- getEventType() - Method in class org.docgene.help.gui.jfx.autocomplete.AdditionalSearchEvent
-
- getEventType() - Method in class org.docgene.help.gui.jfx.autocomplete.AutoCompleteEvent
-
- getFileExtension(URL) - Static method in class org.docgene.help.utils.HelpUtilities
-
Return the extension of a URL.
- getFileNameWithExtension(URL) - Static method in class org.docgene.help.utils.HelpUtilities
-
Return the URL name without the path, nor the extension.
- getFullTextSearchURL() - Method in class org.docgene.help.model.ArticlesModel
-
Return the URL of the fullTextSearch json file.
- getGlossary() - Method in class org.docgene.help.model.ArticlesModel
-
Return the glossary (can be null).
- getHeader() - Method in class org.docgene.help.model.Article
-
Return the article header.
- getHelpComponent() - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Return the component which shows the help GUI.
- getHelpComponent() - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Return the component which shows the help GUI.
- getHelpComponent() - Method in interface org.docgene.help.HelpContentViewer
-
Return the component which shows the help GUI.
- getHelpFormat() - Method in class org.docgene.help.model.ArticlesModel
-
Return the help format.
- getHelpRef(String) - Method in class org.docgene.help.model.ArticlesModel
-
Return a HelpRef.
- getHelpRefs() - Method in class org.docgene.help.model.ArticlesModel
-
Return the HelpRef.
- getHelpWindow(Stage, String, int, int) - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Return the dialog window which shows the help GUI.
- getHelpWindow(Window, String, int, int) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Return the dialog window which shows the help GUI.
- getHelpWindow(W, String, int, int) - Method in interface org.docgene.help.HelpContentViewer
-
Return the dialog window which shows the help GUI.
- getHistory() - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
Return the navigation history.
- getHistory() - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Return the navigation history.
- getHistory() - Method in interface org.docgene.help.HelpContentViewer
-
Return the navigation history.
- getID() - Method in class org.docgene.help.gui.autocomplete.TitleItem
-
- getID() - Method in class org.docgene.help.model.HelpRef
-
Return the ref ID.
- getIndex() - Method in class org.docgene.help.model.ArticlesModel
-
Return the index article.
- getItem() - Method in class org.docgene.help.gui.jfx.autocomplete.AutoCompleteEvent
-
Return the selected item used for autoCompletion.
- getItem() - Method in class org.docgene.help.gui.swing.autocomplete.AutoCompleteEvent
-
Return the selected item used for autoCompletion.
- getLanguage() - Method in class org.docgene.help.locale.Localization
-
Return the Locale language.
- getLocale() - Method in class org.docgene.help.AbstractHelpContentViewer
-
Return the Locale to use for the GUI. it will be the English Locale by default.
- getLocale() - Method in interface org.docgene.help.HelpContentViewer
-
Return the Locale to use for the GUI.
- getLocale() - Method in class org.docgene.help.JavaHelpFactory
-
Return the Locale to use for the GUI. it will be the English Locale by
default.
- getLocale() - Method in class org.docgene.help.locale.Localization
-
Return the locale.
- getLocalization() - Method in class org.docgene.help.AbstractHelpContentViewer
-
Return the Localization to use for the GUI.
- getLocalization() - Method in interface org.docgene.help.HelpContentViewer
-
Return the Localization to use for the GUI.
- getModel() - Method in class org.docgene.help.JavaHelpFactory
-
The articles model.
- getName() - Method in class org.docgene.help.gui.autocomplete.AutoCompleteDictionary.Category
-
Return the name of the category.
- getName(String) - Method in class org.docgene.help.locale.Localization
-
Return the name for a key.
- getName() - Method in class org.docgene.help.model.Article
-
Return the article name.
- getName() - Method in class org.docgene.help.model.Chapter
-
Return the chapter name.
- getNavigationHistory() - Method in class org.docgene.help.AbstractHelpContentViewer
-
Return the navigation history.
- getOpacity() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the Popup Window opacity.
- getPage() - Method in interface org.docgene.help.gui.swing.EngineManager
-
Return the current page.
- getPage() - Method in class org.docgene.help.gui.swing.SwingJFXEngineManager
-
- getPage() - Method in class org.docgene.help.gui.swing.SwingSwingEngineManager
-
Return the current page.
- getParent() - Method in class org.docgene.help.model.Chapter
-
Return the parent chapter.
- getParentURL(URL) - Static method in class org.docgene.help.utils.HelpUtilities
-
Return the parent URL of a given URL.
- getPopUpBackgroundColor() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the background color of the suggested hits panel.
- getPopUpBorderColor() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the borded color of the suggested hits panel.
- getPreviousPage() - Method in class org.docgene.help.AbstractHelpContentViewer
-
Return the previous page in the history.
- getRelativePath(URL, URL) - Static method in class org.docgene.help.utils.HelpUtilities
-
Return the path of an URL relative to a directory.
- getResultsLimit() - Method in interface org.docgene.help.gui.autocomplete.AutoComplete
-
Return the results limits.
- getResultsLimit() - Method in class org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete
-
Return the results limits.
- getResultsLimit() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the results limits.
- getRootChapter() - Method in class org.docgene.help.model.ArticlesModel
-
Return the root chapter.
- getRootPane() - Method in interface org.docgene.help.gui.swing.ContentViewer
-
Return the root pane.
- getRootPane() - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Return the root pane.
- getScrollPane() - Method in interface org.docgene.help.gui.swing.ContentViewer
-
Return the scroll pane.
- getScrollPane() - Method in interface org.docgene.help.gui.swing.EngineManager
-
Return the scroll pane.
- getScrollPane() - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
Return the scroll pane.
- getScrollPane() - Method in class org.docgene.help.gui.swing.SwingJFXEngineManager
-
Return the scroll pane.
- getScrollPane() - Method in class org.docgene.help.gui.swing.SwingSwingEngineManager
-
Return the scroll pane.
- getSearchLimit() - Method in class org.docgene.help.model.ArticlesModel
-
Return the search limit.
- getSource() - Method in class org.docgene.help.gui.swing.autocomplete.AdditionalSearchEvent
-
Return the event source.
- getSource() - Method in class org.docgene.help.gui.swing.autocomplete.AutoCompleteEvent
-
Return the event source.
- getStartOffset() - Method in class org.docgene.help.gui.jfx.autocomplete.AutoCompleteEvent
-
Return the start offset of the text which was autoCompleted.
- getStartOffset() - Method in class org.docgene.help.gui.swing.autocomplete.AutoCompleteEvent
-
Return the start offset of the text which was autoCompleted.
- getStyleSheet() - Method in class org.docgene.help.model.ArticlesModel
-
Return the URL of the styleSheet.
- getStyleSheet(URL) - Static method in class org.docgene.help.utils.HelpUtilities
-
- getStyleSheetTheme() - Method in class org.docgene.help.model.ArticlesModel
-
Return the URL of the styleSheet theme.
- getStyleSheetThemes() - Method in interface org.docgene.help.HelpContentViewer
-
Return the set of styleSheet themes ids.
- getStyleSheetThemes() - Method in class org.docgene.help.model.ArticlesModel
-
Return the set of styleSheet themes ids.
- getSuggestedHitFocusedColor() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the background color of the focused suggested hit.
- getSuggestedHitTextColor() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the color of the suggested hits text.
- getText() - Method in class org.docgene.help.gui.autocomplete.ArticleItem
-
- getText() - Method in interface org.docgene.help.gui.autocomplete.AutoCompleteDictionary.Item
-
The item text.
- getText() - Method in class org.docgene.help.gui.autocomplete.TitleItem
-
- getText() - Method in class org.docgene.help.gui.jfx.autocomplete.AdditionalSearchEvent
-
Return the text to use for the full text search.
- getText() - Method in class org.docgene.help.gui.jfx.autocomplete.AutoCompleteEvent
-
Return the autoCompleted text.
- getText() - Method in class org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete
-
Return the text component text.
- getText() - Method in class org.docgene.help.gui.swing.autocomplete.AdditionalSearchEvent
-
Return the text.
- getText() - Method in class org.docgene.help.gui.swing.autocomplete.AutoCompleteEvent
-
Return the autoCompleted text.
- getText() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the text component text.
- getTextComponent() - Method in class org.docgene.help.gui.jfx.autocomplete.JFXAutoComplete
-
Return the text component.
- getTextComponent() - Method in class org.docgene.help.gui.swing.autocomplete.JAutoComplete
-
Return the text component.
- getTitle() - Method in class org.docgene.help.model.HelpRef
-
Return the ref title (can be null).
- getTitles() - Method in class org.docgene.help.model.Article
-
Return the article titles.
- getTreeCellRendererComponent(JTree, Object, boolean, boolean, boolean, int, boolean) - Method in class org.docgene.help.gui.swing.DefaultArticlesTreeCellRenderer
-
- getURL() - Method in class org.docgene.help.model.Article
-
Return the article URL.
- getURL() - Method in class org.docgene.help.utils.HistoryElement
-
Return the element URL.
- getURLAsString() - Method in class org.docgene.help.model.Article
-
Return the article URL as a String.
- glossaryIcon - Variable in class org.docgene.help.AbstractHelpContentViewer
-
The icon for the glossary.
- goTo(HistoryElement) - Method in class org.docgene.help.AbstractHelpContentViewer
-
Go to an element.
- goTo(HistoryElement) - Method in class org.docgene.help.gui.jfx.JFXHelpContentViewer
-
- goTo(Article, String) - Method in interface org.docgene.help.gui.swing.EngineManager
-
Go to an anchor in a specific article.
- goTo(Article, String, boolean) - Method in interface org.docgene.help.gui.swing.EngineManager
-
Go to an anchor in a specific article.
- goTo(URL, String) - Method in interface org.docgene.help.gui.swing.EngineManager
-
Go to an anchor in a specific URL.
- goTo(HistoryElement) - Method in class org.docgene.help.gui.swing.SwingHelpContentViewer
-
- goTo(Article, String, boolean) - Method in class org.docgene.help.gui.swing.SwingJFXEngineManager
-
- goTo(URL, String) - Method in class org.docgene.help.gui.swing.SwingJFXEngineManager
-
Go to an anchor in a specific URL.
- goTo(Article, String, boolean) - Method in class org.docgene.help.gui.swing.SwingSwingEngineManager
-
- goTo(URL, String) - Method in class org.docgene.help.gui.swing.SwingSwingEngineManager
-
Go to an anchor in a specific URL.