Package | Description |
---|---|
org.docgene.help |
Contains the root classes of the docJGenerator help API.
|
org.docgene.help.gui.autocomplete |
This package contains the GUI-independant classes for the AutoComplete.
|
org.docgene.help.gui.swing |
This package contains the Swing classes for the help system.
|
org.docgene.help.model |
Contains the model classes of the docJGenerator help API.
|
Modifier and Type | Field and Description |
---|---|
protected Article |
AbstractHelpContentViewer.currentArticle
The current article.
|
Modifier and Type | Method and Description |
---|---|
Article |
AbstractHelpContentViewer.getCurrentArticle()
Return the current article.
|
Article |
HelpContentViewer.getCurrentArticle()
Return the current article.
|
Modifier and Type | Method and Description |
---|---|
Article |
ArticleItem.getArticle() |
Article |
TitleItem.getArticle() |
Constructor and Description |
---|
ArticleItem(Article article) |
TitleItem(Article article,
java.lang.String titleName,
java.lang.String titleID) |
Modifier and Type | Method and Description |
---|---|
void |
EngineManager.applyAutocomplete(Article article,
java.lang.String title,
boolean isDifferentArticle) |
void |
SwingJFXEngineManager.applyAutocomplete(Article article,
java.lang.String title,
boolean isDifferentArticle) |
void |
SwingSwingEngineManager.applyAutocomplete(Article article,
java.lang.String title,
boolean isDifferentArticle) |
void |
ContentViewer.applyLink(Article article,
java.net.URL url,
java.lang.String anchor)
Apply a link.
|
void |
SwingHelpContentViewer.applyLink(Article article,
java.net.URL url,
java.lang.String anchor)
Apply a link.
|
default boolean |
EngineManager.goTo(Article article,
java.lang.String anchor)
Go to an anchor in a specific article.
|
boolean |
EngineManager.goTo(Article article,
java.lang.String anchor,
boolean allowReload)
Go to an anchor in a specific article.
|
boolean |
SwingJFXEngineManager.goTo(Article article,
java.lang.String anchor,
boolean allowReload) |
boolean |
SwingSwingEngineManager.goTo(Article article,
java.lang.String anchor,
boolean allowReload) |
void |
ContentViewer.selectInTree(Article article)
Select an article in the tree.
|
void |
SwingHelpContentViewer.selectInTree(Article article) |
void |
ContentViewer.setCurrentArticle(Article article)
Set the current article.
|
void |
SwingHelpContentViewer.setCurrentArticle(Article article) |
Modifier and Type | Method and Description |
---|---|
Article |
ArticleObject.getArticle()
Return the article.
|
Article |
HelpRef.getArticle()
Return the ref article.
|
Article |
ArticlesModel.getArticle(java.lang.String id)
Return an article of a specified ID.
|
Article |
ArticlesModel.getArticle(java.net.URL url)
Return an article of a specified URL.
|
Article |
ArticlesModel.getGlossary()
Return the glossary (can be null).
|
Article |
ArticlesModel.getIndex()
Return the index article.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,Article> |
ArticlesModel.getArticles()
Return the articles.
|
java.util.List<Article> |
Chapter.getArticles()
Return the articles which are directly under this Chapter.
|
java.util.List<Article> |
ArticlesModel.search(java.lang.String term)
Search for the list of articles containing a search term.
|
java.util.List<Article> |
FullTextSearch.search(java.lang.String term)
Search a term in the index and return the associated list of articles which have this term.
|
Modifier and Type | Method and Description |
---|---|
void |
ArticlesModel.addArticle(Article article)
Add an article.
|
void |
Chapter.addArticle(Article article)
Add an article in this Chapter.
|
void |
ArticlesModel.addHelpRef(java.lang.String helpID,
Article article,
java.lang.String title)
Add a HelpRef.
|
void |
ArticlesModel.setGlossary(Article glossary)
Set the glossary.
|
void |
ArticlesModel.setIndex(Article article)
Set the index article.
|
Constructor and Description |
---|
ArticleObject(Article article)
Constructor.
|
HelpRef(java.lang.String id,
Article article,
java.lang.String title)
Constructor.
|
Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence