ArticlesModel (DocJGenerator Help API)

java.lang.Object
- org.docgene.help.model.ArticlesModel

public class ArticlesModel
extends java.lang.Object

Represents the articles model.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`HELPFORMAT_JAVAFX` The JavaFX help format.
`static short`	`HELPFORMAT_SWING` The Swing help format.
`static short`	`HELPFORMAT_UNDEFINED` The undefined help format.

Constructor Summary

Constructors
Constructor and Description

ArticlesModel(java.net.URL baseURL)
Constructor.

Constructors
Constructor and Description
`ArticlesModel(java.net.URL baseURL)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addArticle(Article article)` Add an article.
`void`	`addHelpRef(java.lang.String helpID, Article article, java.lang.String title)` Add a HelpRef.
`void`	`addStyleSheetTheme(java.lang.String id, java.net.URL styleSheetTheme)` Add a styleSheet theme.
`Chapter`	`createRootChapter(Localization localization)` Create a root chapter for the model.
`Article`	`getArticle(java.lang.String id)` Return an article of a specified ID.
`Article`	`getArticle(java.net.URL url)` Return an article of a specified URL.
`java.util.Map<java.lang.String,Article>`	`getArticles()` Return the articles.
`java.net.URL`	`getBaseURL()` Return the base URL.
`java.net.URL`	`getCurrentStyleSheetTheme()` Return the current stylesheet theme.
`java.net.URL`	`getFullTextSearchURL()` Return the URL of the fullTextSearch json file.
`Article`	`getGlossary()` Return the glossary (can be null).
`short`	`getHelpFormat()` Return the help format.
`HelpRef`	`getHelpRef(java.lang.String helpID)` Return a HelpRef.
`java.util.Map<java.lang.String,HelpRef>`	`getHelpRefs()` Return the HelpRef.
`Article`	`getIndex()` Return the index article.
`Chapter`	`getRootChapter()` Return the root chapter.
`int`	`getSearchLimit()` Return the search limit.
`java.net.URL`	`getStyleSheet()` Return the URL of the styleSheet.
`java.net.URL`	`getStyleSheetTheme()` Return the URL of the styleSheet theme.
`java.util.Set<java.lang.String>`	`getStyleSheetThemes()` Return the set of styleSheet themes ids.
`boolean`	`hasArticle(java.lang.String id)` Return true if there is an article of a specified ID.
`boolean`	`hasChapters()` Return true if the model has chapters.
`boolean`	`hasFullTextSearch()` Return true if there is a fullTextSearch json file.
`boolean`	`hasGlossary()` Return true if there is a glossary.
`boolean`	`hasHelpRef(java.lang.String helpID)` Return true if there is a HelpRef for a specified id.
`boolean`	`hasSearchLimit()` Return true if the search is limited.
`boolean`	`hasStyleSheetTheme()` Return true if there is a stylesheet theme.
`boolean`	`isArticle(java.net.URL url)` Return true if an URL correspond to an article.
`boolean`	`isFullTextSearchCompressed()` Return true if the full text search index must be compressed (the level is greater or equal to 2).
`java.net.URL`	`resetStyleSheetTheme()` Reset the stylesheet theme.
`java.util.List<Article>`	`search(java.lang.String term)` Search for the list of articles containing a search term.
`void`	`setFullTextSearch(java.net.URL url)` Set the URL of the fullTextSearch json file.
`void`	`setFullTextSearchCompressed(boolean compressed)` Return true if the full text search index must be compressed (the level is greater or equal to 2).
`void`	`setGlossary(Article glossary)` Set the glossary.
`void`	`setHelpFormat(short helpFormat)` Set the help format.
`void`	`setIndex(Article article)` Set the index article.
`void`	`setSearchLimit(int searchLimit)` Set the search limit.
`void`	`setStyleSheet(java.net.URL styleSheet)` Set the URL of the styleSheet.
`boolean`	`setStyleSheetTheme(java.lang.String id)` Set the current stylesheet theme to a specified theme id.
`void`	`setStyleSheetThemeURL(java.net.URL styleSheetTheme)` Set the URL of the styleSheet theme.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HELPFORMAT_UNDEFINED
```
public static final short HELPFORMAT_UNDEFINED
```
    The undefined help format.
    
    See Also:
    
    Constant Field Values
  - HELPFORMAT_SWING
```
public static final short HELPFORMAT_SWING
```
    The Swing help format.
    
    See Also:
    
    Constant Field Values
  - HELPFORMAT_JAVAFX
```
public static final short HELPFORMAT_JAVAFX
```
    The JavaFX help format.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ArticlesModel
```
public ArticlesModel(java.net.URL baseURL)
```
    Constructor.
    
    Parameters:
    
    baseURL - the base URL (represents the URL for the zip file which contains the help content)
- Method Detail
  - createRootChapter
```
public Chapter createRootChapter(Localization localization)
```
    Create a root chapter for the model.
    
    Parameters:
    
    localization - the localization
    
    Returns:
    
    the root chapter
  - hasChapters
```
public boolean hasChapters()
```
    Return true if the model has chapters.
    
    Returns:
    
    true if the model has chapters
  - getRootChapter
```
public Chapter getRootChapter()
```
    Return the root chapter.
    
    Returns:
    
    the root chapter
  - getBaseURL
```
public java.net.URL getBaseURL()
```
    Return the base URL.
    
    Returns:
    
    the base URL
  - setStyleSheet
```
public void setStyleSheet(java.net.URL styleSheet)
```
    Set the URL of the styleSheet.
    
    Parameters:
    
    styleSheet - the URL of the styleSheet
  - setStyleSheetThemeURL
```
public void setStyleSheetThemeURL(java.net.URL styleSheetTheme)
```
    Set the URL of the styleSheet theme.
    
    Parameters:
    
    styleSheetTheme - the URL of the styleSheet theme
  - hasStyleSheetTheme
```
public boolean hasStyleSheetTheme()
```
    Return true if there is a stylesheet theme.
    
    Returns:
    
    true if there is a stylesheet theme
  - addStyleSheetTheme
```
public void addStyleSheetTheme(java.lang.String id,
                               java.net.URL styleSheetTheme)
```
    Add a styleSheet theme.
    
    Parameters:
    
    id - the theme id
    
    styleSheetTheme - the URL of the styleSheet theme
  - getStyleSheetThemes
```
public java.util.Set<java.lang.String> getStyleSheetThemes()
```
    Return the set of styleSheet themes ids.
    
    Returns:
    
    the set of styleSheet themes ids
  - resetStyleSheetTheme
```
public java.net.URL resetStyleSheetTheme()
```
    Reset the stylesheet theme.
    
    Returns:
    
    the current stylesheet theme
  - getCurrentStyleSheetTheme
```
public java.net.URL getCurrentStyleSheetTheme()
```
    Return the current stylesheet theme.
    
    Returns:
    
    the current stylesheet theme
  - setStyleSheetTheme
```
public 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
  - setFullTextSearch
```
public void setFullTextSearch(java.net.URL url)
```
    Set the URL of the fullTextSearch json file.
    
    Parameters:
    
    url - the URL of the fullTextSearch json file
  - setHelpFormat
```
public void setHelpFormat(short helpFormat)
```
    Set the help format. It can be:
    - HELPFORMAT_UNDEFINED for an undefined help content format
    - HELPFORMAT_SWING for a help content optimized for Swing
    - HELPFORMAT_JAVAFX for a help content optimized for JavaFX
    A help format optimized for one UI framework and viewer on another will not be viewer correctly for images.
    Parameters:
    
    helpFormat - the help format
  - getHelpFormat
```
public short getHelpFormat()
```
    Return the help format.
    
    Returns:
    
    the help format
  - setSearchLimit
```
public void setSearchLimit(int searchLimit)
```
    Set the search limit.
    
    Parameters:
    
    searchLimit - the search limit
  - getSearchLimit
```
public int getSearchLimit()
```
    Return the search limit.
    
    Returns:
    
    the search limit
  - hasSearchLimit
```
public boolean hasSearchLimit()
```
    Return true if the search is limited.
    
    Returns:
    
    true if the search is limited
  - search
```
public java.util.List<Article> search(java.lang.String term)
```
    Search for the list of articles containing a search term.
    
    Parameters:
    
    term - the search term
    
    Returns:
    
    the list of articles containing the search term
  - setIndex
```
public void setIndex(Article article)
```
    Set the index article.
    
    Parameters:
    
    article - the index article
  - setGlossary
```
public void setGlossary(Article glossary)
```
    Set the glossary.
    
    Parameters:
    
    glossary - the glossary
  - hasGlossary
```
public boolean hasGlossary()
```
    Return true if there is a glossary.
    
    Returns:
    
    true if there is a glossary
  - getGlossary
```
public Article getGlossary()
```
    Return the glossary (can be null).
    
    Returns:
    
    the glossary
  - getIndex
```
public Article getIndex()
```
    Return the index article.
    
    Returns:
    
    the index article
  - getStyleSheet
```
public java.net.URL getStyleSheet()
```
    Return the URL of the styleSheet.
    
    Returns:
    
    the URL of the styleSheet
  - getStyleSheetTheme
```
public java.net.URL getStyleSheetTheme()
```
    Return the URL of the styleSheet theme.
    
    Returns:
    
    the URL of the styleSheet theme
  - hasFullTextSearch
```
public boolean hasFullTextSearch()
```
    Return true if there is a fullTextSearch json file.
    
    Returns:
    
    true if there is a fullTextSearch json file
  - setFullTextSearchCompressed
```
public void setFullTextSearchCompressed(boolean compressed)
```
    Return true if the full text search index must be compressed (the level is greater or equal to 2).
    
    Parameters:
    
    compressed - true if the full text search index must be compressed
  - isFullTextSearchCompressed
```
public boolean isFullTextSearchCompressed()
```
    Return true if the full text search index must be compressed (the level is greater or equal to 2).
    
    Returns:
    
    true if the full text search index must be compressed
  - getFullTextSearchURL
```
public java.net.URL getFullTextSearchURL()
```
    Return the URL of the fullTextSearch json file.
    
    Returns:
    
    the URL of the fullTextSearch json file
  - getArticles
```
public java.util.Map<java.lang.String,Article> getArticles()
```
    Return the articles.
    
    Returns:
    
    the articles
  - getArticle
```
public Article getArticle(java.lang.String id)
```
    Return an article of a specified ID.
    
    Parameters:
    
    id - the article ID
    
    Returns:
    
    the article
  - hasArticle
```
public boolean hasArticle(java.lang.String id)
```
    Return true if there is an article of a specified ID.
    
    Parameters:
    
    id - the article ID
    
    Returns:
    
    true if there is an article of the specified ID
  - isArticle
```
public boolean isArticle(java.net.URL url)
```
    Return true if an URL correspond to an article.
    
    Parameters:
    
    url - the url
    
    Returns:
    
    true if the URL correspond to an article
  - getArticle
```
public Article getArticle(java.net.URL url)
```
    Return an article of a specified URL.
    
    Parameters:
    
    url - the article URL
    
    Returns:
    
    the article
  - addArticle
```
public void addArticle(Article article)
```
    Add an article.
    
    Parameters:
    
    article - the article
  - addHelpRef
```
public void addHelpRef(java.lang.String helpID,
                       Article article,
                       java.lang.String title)
```
    Add a HelpRef.
    
    Parameters:
    
    helpID - the HelpRef id
    
    article - the article
    
    title - the title (can be null)
  - hasHelpRef
```
public boolean hasHelpRef(java.lang.String helpID)
```
    Return true if there is a HelpRef for a specified id.
    
    Parameters:
    
    helpID - the HelpRef id
    
    Returns:
    
    true if there is a HelpRef for the specified id
  - getHelpRef
```
public HelpRef getHelpRef(java.lang.String helpID)
```
    Return a HelpRef.
    
    Parameters:
    
    helpID - the HelpRef id
    
    Returns:
    
    the HelpRef
  - getHelpRefs
```
public java.util.Map<java.lang.String,HelpRef> getHelpRefs()
```
    Return the HelpRef.
    
    Returns:
    
    the HelpRef

Class ArticlesModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HELPFORMAT_UNDEFINED

HELPFORMAT_SWING

HELPFORMAT_JAVAFX

Constructor Detail

ArticlesModel

Method Detail

createRootChapter

hasChapters

getRootChapter

getBaseURL

setStyleSheet

setStyleSheetThemeURL

hasStyleSheetTheme

addStyleSheetTheme

getStyleSheetThemes

resetStyleSheetTheme

getCurrentStyleSheetTheme

setStyleSheetTheme

setFullTextSearch

setHelpFormat

getHelpFormat

setSearchLimit

getSearchLimit

hasSearchLimit

search

setIndex

setGlossary

hasGlossary

getGlossary

getIndex

getStyleSheet

getStyleSheetTheme

hasFullTextSearch

setFullTextSearchCompressed

isFullTextSearchCompressed

getFullTextSearchURL

getArticles

getArticle

hasArticle

isArticle

getArticle

addArticle

addHelpRef

hasHelpRef

getHelpRef

getHelpRefs