Configuration (DocJGenerator API)

java.lang.Object
- org.docgene.main.Configuration

public class Configuration
extends java.lang.Object

Maintains the configuration of the application.

Field Summary

Fields
Modifier and Type	Field and Description
`org.mdiutil.swing.ExtensionFileFilter`	`allImageFilter`
`org.mdiutil.swing.ExtensionFileFilter`	`cssFilter`
`org.mdiutil.swing.ExtensionFileFilter`	`imageFilter`
`org.mdiutil.swing.ExtensionFileFilter`	`mdFilter`
`org.mdiutil.swing.ExtensionFileFilter`	`mdxmlFilter`
`org.mdiutil.swing.ExtensionFileFilter`	`propertiesFilter`
`org.mdiutil.swing.ExtensionFileFilter`	`xmlFilter`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`allowMarkdown(boolean allowMarkdown)` Set if the Markdown format is accepted for articles.
`void`	`allowMediawiki(boolean allowMediawiki)` Set if the Wikipedia Mediawiki format is accepted for articles.
`void`	`checkHTTPLinks(boolean checkHTTPLinks)` Set if URLs http links are checked.
`void`	`checkInternalJavaAPI(boolean checkInternalJavaAPI)` Set if the internal Java APIs must be checked if necessary.
`void`	`checkLinks(boolean checkLinks)` Set if URLs links are checked.
`void`	`checkLinksThreaded(boolean checkLinksThreaded)` Set if URLs links are checked in a thread pool.
`org.mdiutil.swing.ExtensionFileFilter`	`createFilter(java.lang.String extension)` Create a file filter.
`boolean`	`emptyLinesAsNewLines()` Return true if empty lines are dumped as new lines.
`java.net.URL`	`getAdditionalAPIDocsURL()` Return the URL specifying the additional APIs documentation specification.
`java.io.File`	`getAdditionalCSS()` Return the additional CSS file to use for the wiki.
`java.io.File`	`getAdditionalCSSOutput()` Return the additional CSS file to use for the wiki.
`java.io.File`	`getAdditionalFooter()` Return the additional content to use for the footer.
`java.io.File`	`getAdditionalScript()` Return the additional script to use for the header.
`char`	`getAlignment()` Return the alignment of the container elements.
`org.docgene.model.globals.apidocs.APIDocumentations`	`getAPIDocumentations()` Return the API documentations specification.
`java.net.URL`	`getAPIDocumentationSchema()` Return the API documentation Schema.
`java.io.File`	`getAPIsFile()` Return the XML file specifying the APIs.
`java.net.URL`	`getAPIsSchema()` Return the APIs Schema.
`org.mdiutil.swing.ExtensionFileFilter`	`getArticlesFilter()` Return the articles filter.
`ArticlesModel`	`getArticlesModel()` Return the articles model.
`int`	`getArticlesTOCThreshold()` Return the threshold for each article Table of contents.
`java.io.File`	`getBackground()` Return an image file to put in the background of the wiki.
`int`	`getBackgroundOpacity()` Return the background opacity.
`java.awt.Paint`	`getBackgroundPaint()` Return the Paint to put in the background of the wiki.
`java.io.File`	`getCommentsDatabaseScript()` Return the search Database script.
`java.io.File`	`getCommentsScript()` Return the comments script.
`org.docgene.main.props.CountProperty`	`getCount()` Return the number of articles.
`java.net.URL`	`getCustomSearchSchema()` Return the custom search Schema.
`java.net.URL`	`getCustomSearchSpec()` Return the specification used for the custom search option type.
`java.lang.String`	`getDate()` Returns the date of the distribution.
`java.net.URL`	`getDefaultAPIDocsURL()` Return the URL specifying the default APIs documentation specification.
`int`	`getDefaultHTTPLinksTimeOut()` Return the default timeout for accessing HTTP links.
`java.net.URL`	`getDefaultStyleSheetTheme()` Return the default StyleSheet theme.
`java.io.File`	`getDependenciesFile()` Return the package dependencies File.
`java.net.URL`	`getDependenciesSchema()` Return the package dependencies Schema.
`java.io.File`	`getElasticLunrScript()` Return the ElasticLunr script.
`short`	`getEmptyLinesType()` Return the way empty lines are dumped.
`org.docgene.parser.XMLErrorHandler`	`getErrorHandler()` Return the error handler which will be used to create and store errors or informations during the parsing.
`short`	`getErrorsViewerType()` Return the editor or browser to open error files.
`int`	`getForkParserSplit()` Return the number of files which should be used to split the parsing.
`int`	`getFullTextSearchCompressionLevel()` Return the full text search compression level (default is 1, to have an average size).
`java.io.File`	`getFullTextSearchDatabase()` Return the Full Text Search Database.
`java.io.File`	`getFullTextSearchDatabaseScript()` Return the full text search search Database Script.
`java.io.File`	`getFullTextSearchScript()` Return the Full Text Search Script.
`java.net.URL`	`getHelpContent()` Return the output directory for the wiki.
`org.docgene.model.help.HelpContentDeclaration`	`getHelpContentDeclaration()` Return the HelpContentDeclaration content.
`java.net.URL`	`getHelpContentSchema()` Return the help content definition Schema.
`java.io.File`	`getHelpFile()` Return the help file.
`java.lang.String`	`getHelpFileName()` Return the help file name.
`int`	`getHelpPageWidth()` Return the page width used for specifying the images width for the help content.
`org.docgene.model.help.HelpSystem`	`getHelpSystem()` Return the HelpSystem.
`java.io.File`	`getHighlightScript()` Return the highlight script.
`java.net.URL`	`getHighlightScriptURL()` Return the highlight script URL.
`int`	`getHTTPLinksThreadTimeOut()` Return the timeout for the background thread executor used for checking http links.
`int`	`getHTTPLinksThreadTimePool()` Return the size of the Thread pool used for checking http links.
`java.net.URL`	`getImageDefinitionSchema()` Return the images definitions Schema.
`java.io.File`	`getIncrementalGenerationFile()` Return the incremental generation state file.
`java.io.File`	`getIndex()` Return the alternate index File.
`char`	`getIndexGenerationType()` Return the index file generation type.
`java.net.URL`	`getInfoBoxDefinitionSchema()` Return the resources definitions Schema.
`java.net.URL`	`getInputCommentsScript()` Return the input comments script.
`java.io.File[]`	`getInputDirs()` Return the input directories for the wiki.
`java.net.URL`	`getInputFullTextSearchScript()` Return the full text search script.
`java.net.URL`	`getInputSearchScript()` Return the Search script.
`static Configuration`	`getInstance()` Return the unique instance.
`java.net.URL`	`getJavaAPILangClasses()` Return the list of classes in the API lang package for the javadoc api.
`java.io.File`	`getJQueryScript()` Return the jQuery script.
`java.io.File`	`getJQueryTableSorterScript()` Return the jQuery table sorter script.
`java.io.File`	`getJQueryUICSS()` Return the jQuery UI CSS.
`java.io.File`	`getJQueryUIScript()` Return the jQueryUI script.
`char`	`getJustification()` Return the justification of the elements.
`java.io.File`	`getLeaderLineScript()` Return the LeaderLine script.
`java.net.URL`	`getLeaderLineScriptURL()` Return the LeaderLine script URL.
`java.io.File`	`getLeftIndexMenu()` Return the additional left index menu for the wiki.
`java.net.URL`	`getLeftMenuSchema()` Return the left menu Schema.
`java.io.File`	`getLightboxScript()` Return the Lightbox script.
`java.net.URL`	`getLightboxScriptURL()` Return the Lightbox script URL.
`int`	`getLimit()` Return the maximum number of articles in the same directory.
`char`	`getLocalLinksOption()` Return the accept option for local links.
`java.net.URL`	`getLocationDir()` Return the location directory of the library.
`java.io.File`	`getMapResizerScript()` Return the map resizer script.
`java.net.URL`	`getMapResizerScriptURL()` Return the map resizer script URL.
`org.docgene.parser.XMLDocJHandler`	`getMathFormulaHandler()` Return the custom Math formula handler.
`java.net.URLClassLoader`	`getMathFormulaLoader()` Return the Classloader for the Math formula parser jar.
`int`	`getNotesTooltipsLength()` Return the text length of the notes tooltips.
`java.io.File`	`getOpenLayerScript()` Return the OpenLayer script.
`java.io.File`	`getOuputDirectory()` Return the output directory for the wiki.
`java.net.URL`	`getOuputDirectoryURL()` Return the output directory URL for the wiki.
`java.lang.String`	`getOutputType()` Return the output type.
`org.docgene.model.globals.PackagesDependencies`	`getPackageDependencies()` Return the package dependencies.
`java.net.URL`	`getPackageSchema()` Return the package Schema.
`int`	`getPageRankIterations()` Return the PageRank algorithm number of iterations.
`int`	`getPageRankMaxIterations()` Return the PageRank algorithm maximum number of iterations.
`char`	`getPageRankSearch()` Return the PageRank algorithm option.
`double`	`getPageRankSearchConvergeDelta()` Return the delta value for the PageRank algorithm convergence.
`char`	`getPreScrollingType()` Return the default scrolling type.
`char`	`getPreventExitType()` Return how the program must exit.
`org.docgene.main.ProxyConfiguration`	`getProxyConfiguration()` Return the Proxy configuration.
`java.net.URL`	`getResourceDefinitionSchema()` Return the resources definitions Schema.
`java.net.URL`	`getResourceDirectory()` Return the resource directory.
`char`	`getResourcesGenerationType()` Return the resources file generation type.
`java.io.File`	`getRightIndexMenu()` Return the additional right index menu for the wiki.
`java.net.URL`	`getSchema()` Return the articles Schema.
`java.io.File`	`getSearchDatabaseScript()` Return the search Database script.
`int`	`getSearchLimit()` Return the search limit.
`java.io.File`	`getSearchScript()` Return the Search script.
`short`	`getSearchType()` Return the search type.
`int`	`getStaticMapsTimeOut()` Return the timeout for static maps.
`java.net.URL`	`getStyleSheet()` Return the articles StyleSheet.
`java.net.URL`	`getStyleSheetTheme()` Return the articles StyleSheet theme.
`org.docgene.model.globals.TimeOuts`	`getTimeOuts()` Return the list of URLs with specific timeouts.
`java.io.File`	`getTimeOutsFile()` Return the XML file specifying the URLs TimeOuts.
`java.net.URL`	`getTimeOutsSchema()` Return the timeouts Schema.
`org.docgene.model.globals.SiteExceptionsList`	`getURLExceptions()` Return the list of URLs which will not be checked for their validity and existence.
`java.io.File`	`getURLExceptionsFile()` Return the XML file specifying the URLs which will not be checked for their validity and existence.
`java.net.URL`	`getURLExceptionsSchema()` Return the URLExceptions Schema.
`java.lang.String`	`getUserAgent()` Return the user agent to access external links.
`java.lang.String`	`getVersion()` Returns the version of the distribution.
`java.net.URL`	`getWikiStateSchema()` Return the wiki state Schema.
`java.lang.String`	`getWikiTitle()` Return the wiki title.
`java.lang.String`	`getWikiTitle(java.lang.String title)` Return the wiki title, which will be shown in non-article pages.
`java.lang.String`	`getWikiTitle(XMLParentArticle article)` Return the wiki title, which will be shown in the index page and the articles.
`boolean`	`hasAlternateIndex()` Return true if there is an alternate index file.
`boolean`	`hasArticlesTOC()` Return true if each article must have a Table of contents by default.
`boolean`	`hasBackground()` Return true if there is an image file or color to put in the background of the wiki.
`boolean`	`hasBackgroundOpacity()` Return true if there is a specified background opacity.
`boolean`	`hasCategories()` Return true if the wiki has categories.
`boolean`	`hasCodeBackground()` Return true if the "code" and "source" elements have a background.
`boolean`	`hasCommentsDatabaseScript()` Return true if there is a comments database.
`boolean`	`hasDictionary()` Return true if the wiki has a dictionary.
`boolean`	`hasElasticLunrScript()` Return true if there is an ElasticLunr script.
`boolean`	`hasFixedLeftMenuOptions()` Return true if the options in the left menu are always present (meaning that all options are present even for the page on which we are).
`boolean`	`hasFullTextSearch()` Return true if there is a full text search.
`boolean`	`hasHighlightScript()` Return true if there is a highlight script.
`boolean`	`hasIEHighestCompatibility()` Return true if the compatibility mode for Internet Explorer is set to the highest.
`boolean`	`hasIncrementalGeneration()` Return true if the incremental generation is set.
`boolean`	`hasJQueryScript()` Return true if there is a JQuery script.
`boolean`	`hasJQueryTableSorterScript()` Return true if there is a JQueryTableSorter script.
`boolean`	`hasJQueryUICSS()` Return true if there is a jQuery UI CSS.
`boolean`	`hasJQueryUIScript()` Return true if there is a jQueryUI script.
`boolean`	`hasLeaderLineScript()` Return true if there is a LeaderLine script.
`boolean`	`hasLightbox()` Return true if images have a lightbox effect.
`boolean`	`hasLimit()` Return true if the maximum number of articles in the same directory is limited.
`boolean`	`hasMapResizerScript()` Return true if the map resizer script exists.
`boolean`	`hasNotesTooltips()` Return true if the notes have a corresponding tooltip.
`boolean`	`hasOpenLayerScript()` Return true if there is an OpenLayer script.
`boolean`	`hasPageRankSearch()` Return true if the search uses the PageRank algorithm.
`boolean`	`hasPreBackground()` Return true if the "pre" elements have a background.
`boolean`	`hasRelaxedSyntax()` Return true if the syntax of the articles is relaxed.
`boolean`	`hasSearch()` Return true if the UI has a Search box.
`boolean`	`hasSearchLimit()` Return true if there is a search limit.
`boolean`	`hasSearchOnAnchors()` Return true if the search on anchors is selected.
`boolean`	`hasSearchOnTitles()` Return true if the search on titles or anchors is selected.
`boolean`	`hasSpecifiedWikiTitle()` Return true if the wiki title is specified.
`void`	`includeComments(boolean includeComments)` Set if comments are included.
`void`	`includeTODO(boolean includeTODO)` Set if TODOs are included.
`boolean`	`isAllowingHTMLEntities()` Return true if HTML entities are allowed.
`boolean`	`isAllowingMarkdown()` Return true if the Markdown format is accepted for articles.
`boolean`	`isAllowingMediawiki()` Return true if the Wikipedia Mediawiki format is accepted for articles.
`boolean`	`isBackgroundGlobal()` Return true if the background is applied to all pages.
`boolean`	`isCheckingHTTPLinks()` Return true if URLs http links are checked.
`boolean`	`isCheckingInternalJavaAPI()` Return true if the internal Java APIs must be checked if necessary.
`boolean`	`isCheckingLinks()` Return true if URLs links are checked.
`boolean`	`isCheckingLinksThreaded()` Return true if URLs links are checked in a thread pool.
`boolean`	`isCleaning()` Return true if the output directory is cleaned before the generation.
`boolean`	`isCustomSearchType()` Return true if the custom search is selected.
`boolean`	`isDynamicMaps()` Return true if the parser will use javascript dynamic maps (maps loaded by Javascript).
`boolean`	`isEnablingComments()` Return true if comments are enabled.
`boolean`	`isEscapingContent()` Return true if the parser should support escaping characters in the articles content.
`boolean`	`isEscapingNonUTF8()` Return true if non UTF8 characters must be escaped.
`boolean`	`isForkingParser()` Return true if the parsing should use a fork-join pool to perform the parsing.
`boolean`	`isFullTextSearchCompressed()` Return true if the full text search index must be compressed (the level is greater or equal to 2).
`boolean`	`isFullTextSearchRemovingAccents()` Return true if the full text search remove accents.
`boolean`	`isFullTextSearchUseMetaphone()` Return true if the full text search use the Metaphone algorithm.
`boolean`	`isHeadless()` Return true if the generator must work in an headless environment.
`boolean`	`isHelpOptimizedForSwing()` Return true if the help result will be optimized for Swing.
`boolean`	`isHelpOutputType()` Return true if the output type is the Help type.
`boolean`	`isHTML5Compatible()` Return true if the HTML result is HTLM5-compatible.
`boolean`	`isHTMLOutputType()` Return true if the output type is the Html type.
`boolean`	`isIncludingComments()` Return true if comments are included.
`boolean`	`isIncludingTODO()` Return true if TODOs are included.
`boolean`	`isNotesTwoColumns()` Return true if the notes layout is on two columns.
`boolean`	`isPreventingErrorWindowShow()` Return true if if the error window must not be shown.
`boolean`	`isPruningAlternateTitlesInDico()` Return true if alternate titles are automatically pruned in the dictionary if their content is sufficiently similar to the article title.
`boolean`	`isResolvingAPILinks()` Return true if API links are resolved for APIs which are defined internal to the wiki output.
`boolean`	`isShowingErrorsFullPath()` Return true if the full paths of files should be presented for errors.
`boolean`	`isShowingGlossaryErrors()` Return true if the glossary errors are checked.
`boolean`	`isShowingWarnings()` Return true if warnings should be presented.
`boolean`	`isShowingWikilinksTooltips()` Return true if there are wiki links tooltips.
`boolean`	`isSupportingEscaping()` Return true if the parser supports escaping characters in the content of XML articles.
`void`	`preventErrorWindowShow(boolean preventErrorWindowShow)` Set if the error window must not be shown.
`void`	`pruneAlternateTitlesInDico(boolean pruneAltTitlesInDico)` Set if alternate titles are automatically pruned in the dictionary if their content is sufficiently similar to the article title.
`void`	`reset()` Reset the properties key / value pairs.
`void`	`resolveAPILinks(boolean resolveAPILinks)` Set if API links are resolved for APIs which are defined internal to the wiki output.
`void`	`setAdditionalAPIDocs(java.io.File file)` Set the File specifying the additional APIs documentation specification.
`void`	`setAdditionalCSS(java.io.File css)` Set an additional CSS file to use for the wiki.
`void`	`setAdditionalCSSOutput(java.io.File css)` Set an additional CSS file to use for the wiki.
`void`	`setAdditionalFooter(java.io.File footer)` Set an additional content to use for the footer.
`void`	`setAdditionalScript(java.io.File script)` Set an additional script to use for the header.
`void`	`setAlignment(char alignment)` Set the alignment of the container elements.
`void`	`setAllowHTMLEntities(boolean allowHTMLEntities)` Set if HTML entities are allowed.
`void`	`setAPIsFile(java.io.File file)` Set the XML file specifying the APIs.
`void`	`setArticlesModel(ArticlesModel model)` Set the articles model.
`void`	`setArticlesTOC(boolean hasTOC)` Set if each article must have a Table of contents by default.
`void`	`setArticlesTOCThreshold(int tocThreshold)` Set the threshold for each article Table of contents.
`void`	`setBackground(java.io.File background)` Set an image file to put in the background of the wiki.
`void`	`setBackgroundGlobal(boolean isGlobal)` Set true if the background is applied to all pages.
`void`	`setBackgroundOpacity(int opacity)` Set the background opacity.
`void`	`setBackgroundPaint(java.awt.Paint paint)` Set the Paint to put in the background of the wiki.
`void`	`setClean(boolean clean)` Set if the output directory is cleaned before the generation.
`void`	`setCodeHasBackground(boolean codeHasBackground)` Set true if the "code" and "source" elements have a background.
`void`	`setCommentsDatabaseScript(java.io.File script)` Set the search Database Script.
`void`	`setCommentsScript(java.io.File script)` Set the comments Script.
`void`	`setCustomSearchSpec(java.net.URL customSearchSpec)` Set the specification used for the custom search option type.
`void`	`setDefaultHTTPLinksTimeOut(int defaultHTTPTimeout)` Set the default timeout for accessing HTTP links.
`void`	`setDependenciesFile(java.io.File dependencies)` Set the package dependencies.
`void`	`setDynamicMaps(boolean dynamicMaps)` Set if the parser will use javascript dynamic maps (maps loaded by Javascript), or if it will generate images with the maps.
`void`	`setElasticLunrScript(java.io.File elasticLunr)` Set the ElasticLunr Script.
`void`	`setEmptyLinesType(short emptyLinesType)` Set the way empty lines are dumped.
`void`	`setErrorHandler(org.docgene.parser.XMLErrorHandler errorHandler)` Set the error handler which will be used to create and store errors or informations during the parsing.
`void`	`setErrorsViewerType(short errorsViewerType)` Set the editor or browser to open error files.
`void`	`setEscapeNonUTF8(boolean escaped)` Set if non UTF8 characters must be escaped.
`void`	`setFixedLeftMenuOptions(boolean fixedLeftMenuOptions)` Set if the options in the left menu are always present (meaning that all options are present even for the page on which we are).
`void`	`setForkParser(boolean forkParser)` Set true if the parsing should use a fork-join pool to perform the parsing
`void`	`setForkParserSplit(int forkParserSplit)` Set the number of files which should be used to split the parsing
`boolean`	`setFullTextSearch(boolean fullTextSearch)` Set if there is a full text search.
`void`	`setFullTextSearchCompressionLevel(int compressionLevel)` Set the full text search compression level (default is 1, to have an average size).
`void`	`setFullTextSearchDatabase(java.io.File db)` Set the Full Text Search Database.
`void`	`setFullTextSearchDatabaseScript(java.io.File script)` Set the full text search search Database Script.
`void`	`setFullTextSearchRemoveAccents(boolean removeAccents)` Set if the full text search remove accents.
`void`	`setFullTextSearchScript(java.io.File script)` Set the Full Text Search Script.
`void`	`setFullTextSearchUseMetaphone(boolean useMetaphone)` Set if the full text use the Metaphone algorithm.
`void`	`setHasCategories(boolean hasCategories)` Set if the wiki has categories.
`void`	`setHasDictionary(boolean hasDictionary)` Set if the wiki has a dictionary.
`void`	`setHeadless(boolean isHeadless)` Set if the generator must work in an headless environment.
`void`	`setHelpContent(java.io.File content)` Set the help content definition.
`void`	`setHelpContentDeclaration(org.docgene.model.help.HelpContentDeclaration helpContentDecl)` Set the HelpContentDeclaration content.
`void`	`setHelpFile(java.io.File helpFile)` Set the help file.
`void`	`setHelpFileName(java.lang.String helpFileName)` Set the help file name.
`void`	`setHelpOptimizedForSwing(boolean helpOptimizedForSwing)` Set if the help result should be optimized for Swing.
`void`	`setHelpPageWidth(int pageWidth)` Set the page width used for specifying the images width for the help content.
`void`	`setHelpSystem(org.docgene.model.help.HelpSystem helpSystem)` Set the HelpSystem.
`void`	`setHighlightScript(java.io.File script)` Set the highlight Script.
`void`	`setHTTPLinksThreadPool(int poolSize)` Set the size of the Thread pool used for checking http links.
`void`	`setHTTPLinksThreadTimeOut(int httpLinksThreadTimeOut)` Set the timeout for the background thread executor used for checking http links.
`void`	`setIECompatibilityEdge(boolean compat)` Set if the compatibility mode for Internet Explorer is set to the highest value.
`void`	`setIncrementalGeneration(boolean hasIncrementalGeneration)` Set the incremental generation.
`void`	`setIncrementalGenerationFile(java.io.File file)` Set the incremental generation state file.
`void`	`setIndex(java.io.File indexFile)` Set the alternate index File.
`void`	`setIndexGenerationType(char type)` Set the index file generation type.
`void`	`setInputDirs(java.io.File[] dirs)` Set the input directories for the wiki.
`void`	`setInputsSubDirectories(boolean inputsSubDirectories)` Set if the inputs must be the sub-directories of the specified input files.
`void`	`setJQueryScripts(java.io.File jQuery, java.io.File jQuerytsorter, java.io.File jQueryUI)` Set the jQuery Scripts.
`void`	`setJQueryUI(java.io.File jQueryUI)` Set the jQuery Scripts.
`void`	`setJustification(char justification)` Set the justification of the elements.
`void`	`setLeaderLineScript(java.io.File script)` Set the LeaderLine Script.
`void`	`setLeftIndexMenu(java.io.File leftIndexMenu)` Set the additional left index menu for the wiki.
`void`	`setLightbox(boolean lightbox)` Set if images have a lightbox effect.
`void`	`setLightboxScript(java.io.File script)` Set the Lightbox Script.
`void`	`setLimit(int limit)` Set the maximum number of articles in the same directory.
`void`	`setLocalLinksOption(char acceptLocalLinks)` Set the accept option for local links.
`void`	`setMapResizerScript(java.io.File script)` Set the map resizer Script.
`void`	`setNotesTooltips(boolean hasTooltips)` Set if the notes have a corresponding tooltip.
`void`	`setNotesTooltipsLength(int length)` Set the text length of the notes tooltips.
`void`	`setNotesTwoColumns(boolean notesTwoColumns)` Set if the notes layout is on two columns.
`void`	`setOpenLayerScript(java.io.File openLayer)` Set the OpenLayer Scripts.
`void`	`setOuputDir(java.io.File dir)` Set the output directory for the wiki.
`void`	`setOutputType(java.lang.String outputType)` Set the output type.
`void`	`setPackageDependencies(org.docgene.model.globals.PackagesDependencies dependencies)` Set the package dependencies.
`void`	`setPageRankIterations(int pageRankIterations)` Set the PageRank algorithm number of iterations, used for the `PageRankOptions.PAGERANK_FIXED_ITERATIONS` type.
`void`	`setPageRankMaxIterations(int pageRankMaxIterations)` Set the PageRank algorithm maximum number of iterations, used for the `PageRankOptions.PAGERANK_CONVERGE_ITERATIONS` type.
`void`	`setPageRankSearch(char pageRank)` Set the PageRank algorithm option.
`void`	`setPageRankSearchConvergeDelta(double pageRankConvergeDelta)` Set the delta value for the PageRank algorithm convergences, used for the `PageRankOptions.PAGERANK_CONVERGE_ITERATIONS` type.
`void`	`setPreHasBackground(boolean preHasBackground)` Set true if the "pre" elements have a background.
`void`	`setPreScrollingType(char scrollingType)` Set the default scrolling type.
`void`	`setPreventExitType(char preventExit)` Set how the program must exit.
`void`	`setRelaxSyntax(boolean relaxedSyntax)` Set if the syntax of the articles is relaxed.
`void`	`setResourcesGenerationType(char type)` Set the resources generation type.
`void`	`setRightIndexMenu(java.io.File rightIndexMenu)` Set the additional right index menu for the wiki.
`void`	`setSearch(boolean search)` Set if the UI has a Search box.
`void`	`setSearchDatabaseScript(java.io.File script)` Set the search Database Script.
`void`	`setSearchLimit(int searchLimit)` Set the search limit.
`void`	`setSearchScript(java.io.File script)` Set the Search Script.
`void`	`setSearchType(short searchType)` Set if the UI will search on titles in addition for article description.
`void`	`setShowWarnings(boolean showWarnings)` Set if warnings should be presented.
`void`	`setStaticMapsTimeOut(int timeOut)` Set the timeout for static maps.
`void`	`setStyleSheetTheme(java.net.URL styleSheetTheme)` Set the articles StyleSheet theme.
`void`	`setSupportEscaping(boolean escaped)` Set if the parser supports escaping characters in the content of XML articles.
`void`	`setTimeOuts(org.docgene.model.globals.TimeOuts timeouts)` Set the list of URLs with specific timeouts.
`void`	`setTimeOutsFile(java.io.File file)` Set the XML file specifying the URLs TimeOuts.
`void`	`setURLExceptions(org.docgene.model.globals.SiteExceptionsList urlExceptions)` Set the list of URLs which will not be checked for their validity and existence.
`void`	`setURLExceptionsFile(java.io.File file)` Set the XML file specifying the URLs which will not be checked for their validity and existence.
`void`	`setUserAgent(java.lang.String userAgent)` Set the user agent to access external links.
`void`	`setWikiTitle(java.lang.String title)` Set the wiki title, which will be shown in the index page.
`void`	`showErrorsFullPath(boolean errorsFullPath)` Set if the full paths of files should be presented for errors.
`void`	`showGlossaryErrors(boolean showGlossaryErrors)` Set if the glossary errors are checked.
`void`	`showWikilinksTooltips(boolean show)` Set if there are wiki links tooltips.
`void`	`updateComments()` Set if comments are included.
`boolean`	`useInputsSubDirectories()` Return true if the inputs must be the sub-directories of the specified input files.

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

- Field Detail
  - xmlFilter
```
public org.mdiutil.swing.ExtensionFileFilter xmlFilter
```
  - cssFilter
```
public org.mdiutil.swing.ExtensionFileFilter cssFilter
```
  - imageFilter
```
public org.mdiutil.swing.ExtensionFileFilter imageFilter
```
  - allImageFilter
```
public org.mdiutil.swing.ExtensionFileFilter allImageFilter
```
  - mdFilter
```
public org.mdiutil.swing.ExtensionFileFilter mdFilter
```
  - mdxmlFilter
```
public org.mdiutil.swing.ExtensionFileFilter mdxmlFilter
```
  - propertiesFilter
```
public org.mdiutil.swing.ExtensionFileFilter propertiesFilter
```
- Method Detail
  - preventErrorWindowShow
```
public void preventErrorWindowShow(boolean preventErrorWindowShow)
```
    Set if the error window must not be shown. It is only useful in Unit tests.
    
    Parameters:
    
    preventErrorWindowShow - true if the error window must not be shown
  - isPreventingErrorWindowShow
```
public boolean isPreventingErrorWindowShow()
```
    Return true if if the error window must not be shown. It is only useful in Unit tests.
    
    Returns:
    
    true if if the error window must not be shown
  - createFilter
```
public org.mdiutil.swing.ExtensionFileFilter createFilter(java.lang.String extension)
```
    Create a file filter.
    
    Parameters:
    
    extension - the extension
    
    Returns:
    
    the file filter
  - setArticlesModel
```
public void setArticlesModel(ArticlesModel model)
```
    Set the articles model.
    
    Parameters:
    
    model - the model
  - getArticlesModel
```
public ArticlesModel getArticlesModel()
```
    Return the articles model.
    
    Returns:
    
    the model
  - getLocationDir
```
public java.net.URL getLocationDir()
```
    Return the location directory of the library.
    
    Returns:
    
    the location directory
  - getMathFormulaLoader
```
public java.net.URLClassLoader getMathFormulaLoader()
```
    Return the Classloader for the Math formula parser jar. Will return nul if it does not exist.
    
    Returns:
    
    the Classloader for the Math formula parser jar
  - getMathFormulaHandler
```
public org.docgene.parser.XMLDocJHandler getMathFormulaHandler()
```
    Return the custom Math formula handler.
    
    Returns:
    
    the custom Math formula handler
  - getInstance
```
public static Configuration getInstance()
```
    Return the unique instance.
    
    Returns:
    
    the unique instance
  - getVersion
```
public java.lang.String getVersion()
```
    Returns the version of the distribution.
    
    Returns:
    
    the version of the distribution
  - getDate
```
public java.lang.String getDate()
```
    Returns the date of the distribution.
    
    Returns:
    
    the date of the distribution
  - reset
```
public void reset()
```
    Reset the properties key / value pairs.
  - getProxyConfiguration
```
public org.docgene.main.ProxyConfiguration getProxyConfiguration()
```
    Return the Proxy configuration.
    
    Returns:
    
    the Proxy configuration
  - setOutputType
```
public void setOutputType(java.lang.String outputType)
```
    Set the output type.
    
    Parameters:
    
    outputType - the output type
  - getOutputType
```
public java.lang.String getOutputType()
```
    Return the output type.
    
    Returns:
    
    the output type
  - isHTMLOutputType
```
public boolean isHTMLOutputType()
```
    Return true if the output type is the Html type.
    
    Returns:
    
    true if the output type is the Html type
  - isHelpOutputType
```
public boolean isHelpOutputType()
```
    Return true if the output type is the Help type.
    
    Returns:
    
    true if the output type is the Help type
  - setInputDirs
```
public void setInputDirs(java.io.File[] dirs)
```
    Set the input directories for the wiki.
    
    Parameters:
    
    dirs - the input directories
  - getInputDirs
```
public java.io.File[] getInputDirs()
```
    Return the input directories for the wiki.
    
    Returns:
    
    the input directories
  - setInputsSubDirectories
```
public void setInputsSubDirectories(boolean inputsSubDirectories)
```
    Set if the inputs must be the sub-directories of the specified input files.
    
    Parameters:
    
    inputsSubDirectories - true if the inputs must be the sub-directories of the specified input files
  - useInputsSubDirectories
```
public boolean useInputsSubDirectories()
```
    Return true if the inputs must be the sub-directories of the specified input files.
    
    Returns:
    
    true if the inputs must be the sub-directories of the specified input files
  - setOuputDir
```
public void setOuputDir(java.io.File dir)
```
    Set the output directory for the wiki.
    
    Parameters:
    
    dir - the output directory
  - getOuputDirectory
```
public java.io.File getOuputDirectory()
```
    Return the output directory for the wiki.
    
    Returns:
    
    the output directory
  - getOuputDirectoryURL
```
public java.net.URL getOuputDirectoryURL()
```
    Return the output directory URL for the wiki.
    
    Returns:
    
    the output directory URL
  - setIndexGenerationType
```
public void setIndexGenerationType(char type)
```
    Set the index file generation type.
    
    Parameters:
    
    type - the generation type
    
    See Also:
    
    FileGenerationType
  - getIndexGenerationType
```
public char getIndexGenerationType()
```
    Return the index file generation type.
    
    Returns:
    
    the generation type
    
    See Also:
    
    FileGenerationType
  - setResourcesGenerationType
```
public void setResourcesGenerationType(char type)
```
    Set the resources generation type.
    
    Parameters:
    
    type - the generation type
    
    See Also:
    
    FileGenerationType
  - getResourcesGenerationType
```
public char getResourcesGenerationType()
```
    Return the resources file generation type.
    
    Returns:
    
    the generation type
    
    See Also:
    
    FileGenerationType
  - setUserAgent
```
public void setUserAgent(java.lang.String userAgent)
```
    Set the user agent to access external links.
    
    Parameters:
    
    userAgent - the user agent to access external links
  - getUserAgent
```
public java.lang.String getUserAgent()
```
    Return the user agent to access external links.
    
    Returns:
    
    the user agent to access external links
  - setAdditionalCSS
```
public void setAdditionalCSS(java.io.File css)
```
    Set an additional CSS file to use for the wiki.
    
    Parameters:
    
    css - the CSS file
  - getAdditionalCSS
```
public java.io.File getAdditionalCSS()
```
    Return the additional CSS file to use for the wiki.
    
    Returns:
    
    the additional CSS file to use for the wiki
  - setAdditionalCSSOutput
```
public void setAdditionalCSSOutput(java.io.File css)
```
    Set an additional CSS file to use for the wiki.
    
    Parameters:
    
    css - the CSS file
  - getAdditionalCSSOutput
```
public java.io.File getAdditionalCSSOutput()
```
    Return the additional CSS file to use for the wiki.
    
    Returns:
    
    the additional CSS file to use for the wiki
  - setBackgroundOpacity
```
public void setBackgroundOpacity(int opacity)
```
    Set the background opacity.
    
    Parameters:
    
    opacity - the opacity
  - getBackgroundOpacity
```
public int getBackgroundOpacity()
```
    Return the background opacity.
    
    Returns:
    
    the opacity
  - hasBackgroundOpacity
```
public boolean hasBackgroundOpacity()
```
    Return true if there is a specified background opacity.
    
    Returns:
    
    true if there is a specified background opacity
  - setBackgroundGlobal
```
public void setBackgroundGlobal(boolean isGlobal)
```
    Set true if the background is applied to all pages.
    
    Parameters:
    
    isGlobal - true if the background is applied to all pages
  - isBackgroundGlobal
```
public boolean isBackgroundGlobal()
```
    Return true if the background is applied to all pages.
    
    Returns:
    
    true if the background is applied to all pages
  - setBackground
```
public void setBackground(java.io.File background)
```
    Set an image file to put in the background of the wiki.
    
    Parameters:
    
    background - the image file
  - getBackground
```
public java.io.File getBackground()
```
    Return an image file to put in the background of the wiki.
    
    Returns:
    
    the image file
  - setBackgroundPaint
```
public void setBackgroundPaint(java.awt.Paint paint)
```
    Set the Paint to put in the background of the wiki.
    
    Parameters:
    
    paint - the Paint
  - getBackgroundPaint
```
public java.awt.Paint getBackgroundPaint()
```
    Return the Paint to put in the background of the wiki.
    
    Returns:
    
    the Paint
  - hasBackground
```
public boolean hasBackground()
```
    Return true if there is an image file or color to put in the background of the wiki.
    
    Returns:
    
    true if there is an image file or color to put in the background
  - setCodeHasBackground
```
public void setCodeHasBackground(boolean codeHasBackground)
```
    Set true if the "code" and "source" elements have a background.
    
    Parameters:
    
    codeHasBackground - true if the "code" and "source" elements have a background
  - hasCodeBackground
```
public boolean hasCodeBackground()
```
    Return true if the "code" and "source" elements have a background.
    
    Returns:
    
    true if the "code" and "source" elements have a background
  - setPreHasBackground
```
public void setPreHasBackground(boolean preHasBackground)
```
    Set true if the "pre" elements have a background.
    
    Parameters:
    
    preHasBackground - true if the "pre" elements have a background
  - hasPreBackground
```
public boolean hasPreBackground()
```
    Return true if the "pre" elements have a background.
    
    Returns:
    
    true if the "pre" elements have a background
  - setLeftIndexMenu
```
public void setLeftIndexMenu(java.io.File leftIndexMenu)
```
    Set the additional left index menu for the wiki.
    
    Parameters:
    
    leftIndexMenu - the additional left index menu for the wiki
  - getLeftIndexMenu
```
public java.io.File getLeftIndexMenu()
```
    Return the additional left index menu for the wiki.
    
    Returns:
    
    the additional left index menu for the wiki
  - setIndex
```
public void setIndex(java.io.File indexFile)
```
    Set the alternate index File.
    
    Parameters:
    
    indexFile - the index File
  - getIndex
```
public java.io.File getIndex()
```
    Return the alternate index File.
    
    Returns:
    
    the index File
  - hasAlternateIndex
```
public boolean hasAlternateIndex()
```
    Return true if there is an alternate index file.
    
    Returns:
    
    true if there is an alternate index file
  - setRightIndexMenu
```
public void setRightIndexMenu(java.io.File rightIndexMenu)
```
    Set the additional right index menu for the wiki.
    
    Parameters:
    
    rightIndexMenu - the additional right index menu for the wiki
  - getRightIndexMenu
```
public java.io.File getRightIndexMenu()
```
    Return the additional right index menu for the wiki.
    
    Returns:
    
    the additional right index menu for the wiki
  - setAdditionalFooter
```
public void setAdditionalFooter(java.io.File footer)
```
    Set an additional content to use for the footer.
    
    Parameters:
    
    footer - the additional footer content
  - getAdditionalFooter
```
public java.io.File getAdditionalFooter()
```
    Return the additional content to use for the footer.
    
    Returns:
    
    the additional content to use for the footer
  - getInputSearchScript
```
public java.net.URL getInputSearchScript()
```
    Return the Search script.
    
    Returns:
    
    the Search script
  - getInputFullTextSearchScript
```
public java.net.URL getInputFullTextSearchScript()
```
    Return the full text search script.
    
    Returns:
    
    the full text search script
  - setSearchDatabaseScript
```
public void setSearchDatabaseScript(java.io.File script)
```
    Set the search Database Script.
    
    Parameters:
    
    script - the Search Script
  - getSearchDatabaseScript
```
public java.io.File getSearchDatabaseScript()
```
    Return the search Database script.
    
    Returns:
    
    the search Database script
  - setSearchScript
```
public void setSearchScript(java.io.File script)
```
    Set the Search Script.
    
    Parameters:
    
    script - the Search Script
  - getSearchScript
```
public java.io.File getSearchScript()
```
    Return the Search script. The Search script will depend if the hasSearchOnTitles() is set to true or false.
    
    Returns:
    
    the Search script
  - setFullTextSearchDatabaseScript
```
public void setFullTextSearchDatabaseScript(java.io.File script)
```
    Set the full text search search Database Script.
    
    Parameters:
    
    script - the full text search search Database Script
  - getFullTextSearchDatabaseScript
```
public java.io.File getFullTextSearchDatabaseScript()
```
    Return the full text search search Database Script.
    
    Returns:
    
    the full text search search Database Script
  - setFullTextSearchScript
```
public void setFullTextSearchScript(java.io.File script)
```
    Set the Full Text Search Script.
    
    Parameters:
    
    script - the Full Text Search Script
  - getFullTextSearchScript
```
public java.io.File getFullTextSearchScript()
```
    Return the Full Text Search Script.
    
    Returns:
    
    the Full Text Search Script
  - setFullTextSearchDatabase
```
public void setFullTextSearchDatabase(java.io.File db)
```
    Set the Full Text Search Database.
    
    Parameters:
    
    db - the Full Text Search Database
  - getFullTextSearchDatabase
```
public java.io.File getFullTextSearchDatabase()
```
    Return the Full Text Search Database.
    
    Returns:
    
    the Full Text Search Database
  - getInputCommentsScript
```
public java.net.URL getInputCommentsScript()
```
    Return the input comments script.
    
    Returns:
    
    the input comments script
  - setCommentsScript
```
public void setCommentsScript(java.io.File script)
```
    Set the comments Script.
    
    Parameters:
    
    script - the comments Script
  - getCommentsScript
```
public java.io.File getCommentsScript()
```
    Return the comments script.
    
    Returns:
    
    the comments script
  - setCommentsDatabaseScript
```
public void setCommentsDatabaseScript(java.io.File script)
```
    Set the search Database Script.
    
    Parameters:
    
    script - the Search Script
  - getCommentsDatabaseScript
```
public java.io.File getCommentsDatabaseScript()
```
    Return the search Database script.
    
    Returns:
    
    the search Database script
  - hasCommentsDatabaseScript
```
public boolean hasCommentsDatabaseScript()
```
    Return true if there is a comments database.
    
    Returns:
    
    true if there is a comments database
  - setHighlightScript
```
public void setHighlightScript(java.io.File script)
```
    Set the highlight Script.
    
    Parameters:
    
    script - the highlight Script
  - getHighlightScript
```
public java.io.File getHighlightScript()
```
    Return the highlight script.
    
    Returns:
    
    the highlight script
  - hasHighlightScript
```
public boolean hasHighlightScript()
```
    Return true if there is a highlight script.
    
    Returns:
    
    true if there is a highlight script
  - getHighlightScriptURL
```
public java.net.URL getHighlightScriptURL()
```
    Return the highlight script URL.
    
    Returns:
    
    the highlight script URL
  - setLeaderLineScript
```
public void setLeaderLineScript(java.io.File script)
```
    Set the LeaderLine Script.
    
    Parameters:
    
    script - the LeaderLine Script
  - getLeaderLineScript
```
public java.io.File getLeaderLineScript()
```
    Return the LeaderLine script.
    
    Returns:
    
    the LeaderLine script
  - hasLeaderLineScript
```
public boolean hasLeaderLineScript()
```
    Return true if there is a LeaderLine script.
    
    Returns:
    
    true if there is a LeaderLine script
  - getLeaderLineScriptURL
```
public java.net.URL getLeaderLineScriptURL()
```
    Return the LeaderLine script URL.
    
    Returns:
    
    the LeaderLine script URL
  - setMapResizerScript
```
public void setMapResizerScript(java.io.File script)
```
    Set the map resizer Script.
    
    Parameters:
    
    script - the map resizer Script
  - getMapResizerScript
```
public java.io.File getMapResizerScript()
```
    Return the map resizer script.
    
    Returns:
    
    the map resizer script
  - hasMapResizerScript
```
public boolean hasMapResizerScript()
```
    Return true if the map resizer script exists.
    
    Returns:
    
    true if the map resizer script exists
  - getMapResizerScriptURL
```
public java.net.URL getMapResizerScriptURL()
```
    Return the map resizer script URL.
    
    Returns:
    
    the map resizer script URL
  - setLightboxScript
```
public void setLightboxScript(java.io.File script)
```
    Set the Lightbox Script.
    
    Parameters:
    
    script - the Lightbox Script
  - getLightboxScriptURL
```
public java.net.URL getLightboxScriptURL()
```
    Return the Lightbox script URL.
    
    Returns:
    
    the Lightbox script URL
  - getLightboxScript
```
public java.io.File getLightboxScript()
```
    Return the Lightbox script.
    
    Returns:
    
    the Lightbox script
  - setJQueryScripts
```
public void setJQueryScripts(java.io.File jQuery,
                             java.io.File jQuerytsorter,
                             java.io.File jQueryUI)
```
    Set the jQuery Scripts.
    
    Parameters:
    
    jQuery - the jQuery Script
    
    jQuerytsorter - the jQuery Table sorter Script
    
    jQueryUI - the jQueryUI Script
  - setJQueryUI
```
public void setJQueryUI(java.io.File jQueryUI)
```
    Set the jQuery Scripts.
    
    Parameters:
    
    jQueryUI - the jQuery UI CSS
  - getJQueryUICSS
```
public java.io.File getJQueryUICSS()
```
    Return the jQuery UI CSS.
    
    Returns:
    
    the jQuery UI CSS
  - hasJQueryUICSS
```
public boolean hasJQueryUICSS()
```
    Return true if there is a jQuery UI CSS.
    
    Returns:
    
    true if there is a jQuery UI CSS
  - getJQueryScript
```
public java.io.File getJQueryScript()
```
    Return the jQuery script.
    
    Returns:
    
    the jQuery script
  - hasJQueryScript
```
public boolean hasJQueryScript()
```
    Return true if there is a JQuery script.
    
    Returns:
    
    true if there is a JQuery script
  - getJQueryTableSorterScript
```
public java.io.File getJQueryTableSorterScript()
```
    Return the jQuery table sorter script.
    
    Returns:
    
    the jQuery sorter script
  - hasJQueryTableSorterScript
```
public boolean hasJQueryTableSorterScript()
```
    Return true if there is a JQueryTableSorter script.
    
    Returns:
    
    true if there is a JQueryTableSorter script
  - getJQueryUIScript
```
public java.io.File getJQueryUIScript()
```
    Return the jQueryUI script.
    
    Returns:
    
    the jQueryUI script
  - hasJQueryUIScript
```
public boolean hasJQueryUIScript()
```
    Return true if there is a jQueryUI script.
    
    Returns:
    
    true if there is a jQueryUI script
  - setElasticLunrScript
```
public void setElasticLunrScript(java.io.File elasticLunr)
```
    Set the ElasticLunr Script.
    
    Parameters:
    
    elasticLunr - the ElasticLunr script
  - getElasticLunrScript
```
public java.io.File getElasticLunrScript()
```
    Return the ElasticLunr script.
    
    Returns:
    
    the ElasticLunr script
  - hasElasticLunrScript
```
public boolean hasElasticLunrScript()
```
    Return true if there is an ElasticLunr script.
    
    Returns:
    
    true if there is an ElasticLunr script
  - setOpenLayerScript
```
public void setOpenLayerScript(java.io.File openLayer)
```
    Set the OpenLayer Scripts.
    
    Parameters:
    
    openLayer - the OpenLayer Script
  - getOpenLayerScript
```
public java.io.File getOpenLayerScript()
```
    Return the OpenLayer script.
    
    Returns:
    
    the OpenLayer script
  - hasOpenLayerScript
```
public boolean hasOpenLayerScript()
```
    Return true if there is an OpenLayer script.
    
    Returns:
    
    true if there is an OpenLayer script
  - getResourceDirectory
```
public java.net.URL getResourceDirectory()
```
    Return the resource directory.
    
    Returns:
    
    the resource directory
  - setIncrementalGenerationFile
```
public void setIncrementalGenerationFile(java.io.File file)
```
    Set the incremental generation state file.
    
    Parameters:
    
    file - the the incremental generation state file
  - getIncrementalGenerationFile
```
public java.io.File getIncrementalGenerationFile()
```
    Return the incremental generation state file.
    
    Returns:
    
    the ncremental generation state file
  - setIncrementalGeneration
```
public void setIncrementalGeneration(boolean hasIncrementalGeneration)
```
    Set the incremental generation.
    
    Parameters:
    
    hasIncrementalGeneration - true if the incremental generation is set
  - hasIncrementalGeneration
```
public boolean hasIncrementalGeneration()
```
    Return true if the incremental generation is set.
    
    Returns:
    
    true if the incremental generation is set
  - setAdditionalScript
```
public void setAdditionalScript(java.io.File script)
```
    Set an additional script to use for the header.
    
    Parameters:
    
    script - the additional script to use for the header
  - getAdditionalScript
```
public java.io.File getAdditionalScript()
```
    Return the additional script to use for the header.
    
    Returns:
    
    the additional script to use for the header
  - setClean
```
public void setClean(boolean clean)
```
    Set if the output directory is cleaned before the generation.
    
    Parameters:
    
    clean - true if the output directory is cleaned before the generation
  - isCleaning
```
public boolean isCleaning()
```
    Return true if the output directory is cleaned before the generation.
    
    Returns:
    
    true if the output directory is cleaned before the generation
  - setPreventExitType
```
public void setPreventExitType(char preventExit)
```
    Set how the program must exit. The valid values are:
    - PreventExitType.FALSE: the program must behave normally and execute a System.exist(0) at the end of the generation
    - PreventExitType.TRUE: the program must not do anything at the end of the generation
    - PreventExitType.RUNTIME_EXCEPTION: the program must throw a ExitRuntimeException at the end of the generation
    Parameters:
    
    preventExit - the preventExit Type
  - getPreventExitType
```
public char getPreventExitType()
```
    Return how the program must exit. The valid values are:
    - PreventExitType.FALSE: the program must behave normally and execute a System.exist(0) at the end of the generation
    - PreventExitType.TRUE: the program must not do anything at the end of the generation
    - PreventExitType.RUNTIME_EXCEPTION: the program must throw a ExitRuntimeException at the end of the generation
    Returns:
    
    the preventExit Type
  - setHeadless
```
public void setHeadless(boolean isHeadless)
```
    Set if the generator must work in an headless environment.
    
    Parameters:
    
    isHeadless - true if the generator must work in an headless environment
  - isHeadless
```
public boolean isHeadless()
```
    Return true if the generator must work in an headless environment.
    
    Returns:
    
    true if the generator must work in an headless environment
  - allowMediawiki
```
public void allowMediawiki(boolean allowMediawiki)
```
    Set if the Wikipedia Mediawiki format is accepted for articles.
    
    Parameters:
    
    allowMediawiki - true if the Wikipedia Mediawiki format is accepted for articles
  - isAllowingMediawiki
```
public boolean isAllowingMediawiki()
```
    Return true if the Wikipedia Mediawiki format is accepted for articles.
    
    Returns:
    
    true if the Wikipedia Mediawiki format is accepted for articles
  - allowMarkdown
```
public void allowMarkdown(boolean allowMarkdown)
```
    Set if the Markdown format is accepted for articles.
    
    Parameters:
    
    allowMarkdown - true if the Markdown format is accepted for articles
  - isAllowingMarkdown
```
public boolean isAllowingMarkdown()
```
    Return true if the Markdown format is accepted for articles.
    
    Returns:
    
    true if the Markdown format is accepted for articles
  - getArticlesFilter
```
public org.mdiutil.swing.ExtensionFileFilter getArticlesFilter()
```
    Return the articles filter. It will accept:
    - Both "xml" and "md" files if isAllowingMediawiki() or isAllowingMarkdown() are true
    - Only "xml" files if isAllowingMediawiki() and isAllowingMarkdown() are false
    Returns:
    
    the articles filter
  - setAllowHTMLEntities
```
public void setAllowHTMLEntities(boolean allowHTMLEntities)
```
    Set if HTML entities are allowed.
    
    Parameters:
    
    allowHTMLEntities - true if HTML entities are allowed
  - isAllowingHTMLEntities
```
public boolean isAllowingHTMLEntities()
```
    Return true if HTML entities are allowed.
    
    Returns:
    
    true if HTML entities are allowed
  - setEscapeNonUTF8
```
public void setEscapeNonUTF8(boolean escaped)
```
    Set if non UTF8 characters must be escaped.
    
    Parameters:
    
    escaped - true if non UTF8 characters must be escaped
  - isEscapingNonUTF8
```
public boolean isEscapingNonUTF8()
```
    Return true if non UTF8 characters must be escaped.
    
    Returns:
    
    true if non UTF8 characters must be escaped
  - isEscapingContent
```
public boolean isEscapingContent()
```
    Return true if the parser should support escaping characters in the articles content.
    
    Returns:
    
    true if the parser should support escaping characters in the articles content
  - showWikilinksTooltips
```
public void showWikilinksTooltips(boolean show)
```
    Set if there are wiki links tooltips.
    
    Parameters:
    
    show - true if there are wiki links tooltips
  - isShowingWikilinksTooltips
```
public boolean isShowingWikilinksTooltips()
```
    Return true if there are wiki links tooltips.
    
    Returns:
    
    true if there are wiki links tooltips
  - setLocalLinksOption
```
public void setLocalLinksOption(char acceptLocalLinks)
```
    Set the accept option for local links.
    
    Parameters:
    
    acceptLocalLinks - the option
    
    See Also:
    
    LocalLinksOptions
  - getLocalLinksOption
```
public char getLocalLinksOption()
```
    Return the accept option for local links.
    
    Returns:
    
    the option
  - setAlignment
```
public void setAlignment(char alignment)
```
    Set the alignment of the container elements.
    
    Parameters:
    
    alignment - the alignment type
    
    See Also:
    
    JustifiedElement
  - getAlignment
```
public char getAlignment()
```
    Return the alignment of the container elements.
    
    Returns:
    
    the alignment type
  - setJustification
```
public void setJustification(char justification)
```
    Set the justification of the elements.
    
    Parameters:
    
    justification - the justification type
    
    See Also:
    
    JustifiedElement
  - getJustification
```
public char getJustification()
```
    Return the justification of the elements.
    
    Returns:
    
    the justification type
  - setPreScrollingType
```
public void setPreScrollingType(char scrollingType)
```
    Set the default scrolling type.
    
    Parameters:
    
    scrollingType - the type
    
    See Also:
    
    PreScrollingType
  - getPreScrollingType
```
public char getPreScrollingType()
```
    Return the default scrolling type.
    
    Returns:
    
    the type
    
    See Also:
    
    PreScrollingType
  - setSupportEscaping
```
public void setSupportEscaping(boolean escaped)
```
    Set if the parser supports escaping characters in the content of XML articles.
    
    Parameters:
    
    escaped - true if the parser supports escaping characters in the content of XML articles
  - isSupportingEscaping
```
public boolean isSupportingEscaping()
```
    Return true if the parser supports escaping characters in the content of XML articles.
    
    Returns:
    
    true if the parser supports escaping characters in the content of XML articles
  - setDynamicMaps
```
public void setDynamicMaps(boolean dynamicMaps)
```
    Set if the parser will use javascript dynamic maps (maps loaded by Javascript), or if it will generate images with the maps.
    
    Parameters:
    
    dynamicMaps - true if the parser will use javascript dynamic maps (maps loaded by Javascript)
  - isDynamicMaps
```
public boolean isDynamicMaps()
```
    Return true if the parser will use javascript dynamic maps (maps loaded by Javascript).
    
    Returns:
    
    true if the parser will use javascript dynamic maps (maps loaded by Javascript)
  - setIECompatibilityEdge
```
public void setIECompatibilityEdge(boolean compat)
```
    Set if the compatibility mode for Internet Explorer is set to the highest value. This may be necessary to allow jQuery to work correctly with high-level versions of IE (used for the Search field).
    
    Parameters:
    
    compat - true if the compatibility mode for Internet Explorer is set to the highest value
  - hasIEHighestCompatibility
```
public boolean hasIEHighestCompatibility()
```
    Return true if the compatibility mode for Internet Explorer is set to the highest. This may be necessary to allow jQuery to work correctly with high-level versions of IE (used for the Search field).
    
    Returns:
    
    true if the compatibility mode for Internet Explorer is set to the highest value
  - setStaticMapsTimeOut
```
public void setStaticMapsTimeOut(int timeOut)
```
    Set the timeout for static maps.
    
    Parameters:
    
    timeOut - the timeout for static maps
  - getStaticMapsTimeOut
```
public int getStaticMapsTimeOut()
```
    Return the timeout for static maps.
    
    Returns:
    
    the timeout for static maps
  - setSearch
```
public void setSearch(boolean search)
```
    Set if the UI has a Search box.
    
    Parameters:
    
    search - true if the UI has a Search box
  - hasSearch
```
public boolean hasSearch()
```
    Return true if the UI has a Search box.
    
    Returns:
    
    true if the UI has a Search box
  - setPageRankSearch
```
public void setPageRankSearch(char pageRank)
```
    Set the PageRank algorithm option.
    
    Parameters:
    
    pageRank - the PageRank algorithm option
  - getPageRankSearch
```
public char getPageRankSearch()
```
    Return the PageRank algorithm option.
    
    Returns:
    
    the PageRank algorithm option
  - hasPageRankSearch
```
public boolean hasPageRankSearch()
```
    Return true if the search uses the PageRank algorithm.
    
    Returns:
    
    true if the search uses the PageRank algorithm
  - setPageRankIterations
```
public void setPageRankIterations(int pageRankIterations)
```
    Set the PageRank algorithm number of iterations, used for the PageRankOptions.PAGERANK_FIXED_ITERATIONS type.
    
    Parameters:
    
    pageRankIterations - the number of iterations
  - getPageRankIterations
```
public int getPageRankIterations()
```
    Return the PageRank algorithm number of iterations.
    
    Returns:
    
    the number of iterations
  - setPageRankMaxIterations
```
public void setPageRankMaxIterations(int pageRankMaxIterations)
```
    Set the PageRank algorithm maximum number of iterations, used for the PageRankOptions.PAGERANK_CONVERGE_ITERATIONS type.
    
    Parameters:
    
    pageRankMaxIterations - the maximumnumber of iterations
  - getPageRankMaxIterations
```
public int getPageRankMaxIterations()
```
    Return the PageRank algorithm maximum number of iterations.
    
    Returns:
    
    the number of iterations
  - setPageRankSearchConvergeDelta
```
public void setPageRankSearchConvergeDelta(double pageRankConvergeDelta)
```
    Set the delta value for the PageRank algorithm convergences, used for the PageRankOptions.PAGERANK_CONVERGE_ITERATIONS type.
    
    Parameters:
    
    pageRankConvergeDelta - the delta value for the PageRank algorithm convergence
  - getPageRankSearchConvergeDelta
```
public double getPageRankSearchConvergeDelta()
```
    Return the delta value for the PageRank algorithm convergence.
    
    Returns:
    
    the delta value for the PageRank algorithm convergence
  - 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 there is a search limit.
    
    Returns:
    
    true if there is a search limit
  - setLightbox
```
public void setLightbox(boolean lightbox)
```
    Set if images have a lightbox effect.
    
    Parameters:
    
    lightbox - true if images have a lightbox effect
  - hasLightbox
```
public boolean hasLightbox()
```
    Return true if images have a lightbox effect.
    
    Returns:
    
    true if images have a lightbox effect
  - includeComments
```
public void includeComments(boolean includeComments)
```
    Set if comments are included.
    
    Parameters:
    
    includeComments - true if comments are included
  - updateComments
```
public void updateComments()
```
    Set if comments are included.
  - isEnablingComments
```
public boolean isEnablingComments()
```
    Return true if comments are enabled.
    
    Returns:
    
    true if comments are enabled
  - isIncludingComments
```
public boolean isIncludingComments()
```
    Return true if comments are included.
    
    Returns:
    
    true if comments are included
  - includeTODO
```
public void includeTODO(boolean includeTODO)
```
    Set if TODOs are included.
    
    Parameters:
    
    includeTODO - true if TODOs are included
  - isIncludingTODO
```
public boolean isIncludingTODO()
```
    Return true if TODOs are included.
    
    Returns:
    
    true if TODOs are included
  - setShowWarnings
```
public void setShowWarnings(boolean showWarnings)
```
    Set if warnings should be presented.
    
    Parameters:
    
    showWarnings - true if warnings should be presented
  - isShowingWarnings
```
public boolean isShowingWarnings()
```
    Return true if warnings should be presented.
    
    Returns:
    
    true if warnings should be presented
  - checkLinks
```
public void checkLinks(boolean checkLinks)
```
    Set if URLs links are checked.
    
    Parameters:
    
    checkLinks - true if URLs links are checked
  - isCheckingLinks
```
public boolean isCheckingLinks()
```
    Return true if URLs links are checked.
    
    Returns:
    
    true if URLs links are checked
  - checkLinksThreaded
```
public void checkLinksThreaded(boolean checkLinksThreaded)
```
    Set if URLs links are checked in a thread pool.
    
    Parameters:
    
    checkLinksThreaded - true if URLs links are checked in a thread pool
  - isCheckingLinksThreaded
```
public boolean isCheckingLinksThreaded()
```
    Return true if URLs links are checked in a thread pool.
    
    Returns:
    
    true if URLs links are checked in a thread pool
  - resolveAPILinks
```
public void resolveAPILinks(boolean resolveAPILinks)
```
    Set if API links are resolved for APIs which are defined internal to the wiki output.
    
    Parameters:
    
    resolveAPILinks - true if API links are resolved for APIs which are defined internal to the wiki output
  - isResolvingAPILinks
```
public boolean isResolvingAPILinks()
```
    Return true if API links are resolved for APIs which are defined internal to the wiki output.
    
    Returns:
    
    true if API links are resolved for APIs which are defined internal to the wiki output
  - checkHTTPLinks
```
public void checkHTTPLinks(boolean checkHTTPLinks)
```
    Set if URLs http links are checked.
    
    Parameters:
    
    checkHTTPLinks - true if URLs http links are checked
  - isCheckingHTTPLinks
```
public boolean isCheckingHTTPLinks()
```
    Return true if URLs http links are checked.
    
    Returns:
    
    true if URLs http links are checked
  - checkInternalJavaAPI
```
public void checkInternalJavaAPI(boolean checkInternalJavaAPI)
```
    Set if the internal Java APIs must be checked if necessary.
    
    Parameters:
    
    checkInternalJavaAPI - true if the internal Java APIs must be checked if necessary
  - isCheckingInternalJavaAPI
```
public boolean isCheckingInternalJavaAPI()
```
    Return true if the internal Java APIs must be checked if necessary.
    
    Returns:
    
    true if the internal Java APIs must be checked if necessary
  - showGlossaryErrors
```
public void showGlossaryErrors(boolean showGlossaryErrors)
```
    Set if the glossary errors are checked.
    
    Parameters:
    
    showGlossaryErrors - true if the glossary errors are checked
  - isShowingGlossaryErrors
```
public boolean isShowingGlossaryErrors()
```
    Return true if the glossary errors are checked.
    
    Returns:
    
    true if the glossary errors are checked
  - showErrorsFullPath
```
public void showErrorsFullPath(boolean errorsFullPath)
```
    Set if the full paths of files should be presented for errors.
    
    Parameters:
    
    errorsFullPath - true if the full paths of files should be presented for errors
  - isShowingErrorsFullPath
```
public boolean isShowingErrorsFullPath()
```
    Return true if the full paths of files should be presented for errors.
    
    Returns:
    
    true if the full paths of files should be presented for errors
  - setErrorsViewerType
```
public void setErrorsViewerType(short errorsViewerType)
```
    Set the editor or browser to open error files.
    
    Parameters:
    
    errorsViewerType - the editor or browser to open error files
  - getErrorsViewerType
```
public short getErrorsViewerType()
```
    Return the editor or browser to open error files.
    
    Returns:
    
    the editor or browser to open error files
  - setEmptyLinesType
```
public void setEmptyLinesType(short emptyLinesType)
```
    Set the way empty lines are dumped.
    
    Parameters:
    
    emptyLinesType - the empty lines type
    
    See Also:
    
    EmptyLinesType
  - getEmptyLinesType
```
public short getEmptyLinesType()
```
    Return the way empty lines are dumped.
    
    Returns:
    
    the way empty lines are dumped
  - emptyLinesAsNewLines
```
public boolean emptyLinesAsNewLines()
```
    Return true if empty lines are dumped as new lines.
    
    Returns:
    
    true if empty lines are dumped as new lines
  - setDefaultHTTPLinksTimeOut
```
public void setDefaultHTTPLinksTimeOut(int defaultHTTPTimeout)
```
    Set the default timeout for accessing HTTP links.
    
    Parameters:
    
    defaultHTTPTimeout - the default timeout for accessing HTTP links
  - getDefaultHTTPLinksTimeOut
```
public int getDefaultHTTPLinksTimeOut()
```
    Return the default timeout for accessing HTTP links.
    
    Returns:
    
    the default timeout for accessing HTTP links
  - setHTTPLinksThreadTimeOut
```
public void setHTTPLinksThreadTimeOut(int httpLinksThreadTimeOut)
```
    Set the timeout for the background thread executor used for checking http links.
    
    Parameters:
    
    httpLinksThreadTimeOut - the timeout for the background thread executor used for checking http links
  - getHTTPLinksThreadTimeOut
```
public int getHTTPLinksThreadTimeOut()
```
    Return the timeout for the background thread executor used for checking http links.
    
    Returns:
    
    the timeout for the background thread executor used for checking http links
  - setHTTPLinksThreadPool
```
public void setHTTPLinksThreadPool(int poolSize)
```
    Set the size of the Thread pool used for checking http links.
    
    Parameters:
    
    poolSize - the size of the Thread pool used for checking http links
  - getHTTPLinksThreadTimePool
```
public int getHTTPLinksThreadTimePool()
```
    Return the size of the Thread pool used for checking http links.
    
    Returns:
    
    the size of the Thread pool used for checking http links
  - setForkParser
```
public void setForkParser(boolean forkParser)
```
    Set true if the parsing should use a fork-join pool to perform the parsing
    
    Parameters:
    
    forkParser - true if the parsing should use a fork-join pool to perform the parsing
  - isForkingParser
```
public boolean isForkingParser()
```
    Return true if the parsing should use a fork-join pool to perform the parsing.
    
    Returns:
    
    true if the parsing should use a fork-join pool to perform the parsing
  - setForkParserSplit
```
public void setForkParserSplit(int forkParserSplit)
```
    Set the number of files which should be used to split the parsing
    
    Parameters:
    
    forkParserSplit - the number of files which should be used to split the parsing
  - getForkParserSplit
```
public int getForkParserSplit()
```
    Return the number of files which should be used to split the parsing.
    
    Returns:
    
    the number of files which should be used to split the parsing
  - setSearchType
```
public void setSearchType(short searchType)
```
    Set if the UI will search on titles in addition for article description.
    
    Parameters:
    
    searchType - the search type
  - hasSearchOnTitles
```
public boolean hasSearchOnTitles()
```
    Return true if the search on titles or anchors is selected.
    
    Returns:
    
    true if the search on titles or anchors is selected
  - hasSearchOnAnchors
```
public boolean hasSearchOnAnchors()
```
    Return true if the search on anchors is selected.
    
    Returns:
    
    true if the search on anchors is selected
  - isCustomSearchType
```
public boolean isCustomSearchType()
```
    Return true if the custom search is selected.
    
    Returns:
    
    true if the custom search is selected
  - getSearchType
```
public short getSearchType()
```
    Return the search type.
    
    Returns:
    
    the search type
  - setFullTextSearchCompressionLevel
```
public void setFullTextSearchCompressionLevel(int compressionLevel)
```
    Set the full text search compression level (default is 1, to have an average size).
    
    Parameters:
    
    compressionLevel - the full text search compression level
  - getFullTextSearchCompressionLevel
```
public int getFullTextSearchCompressionLevel()
```
    Return the full text search compression level (default is 1, to have an average size).
    
    Returns:
    
    the full text search compression level
  - 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
  - setFullTextSearch
```
public boolean setFullTextSearch(boolean fullTextSearch)
```
    Set if there is a full text search.
    
    Parameters:
    
    fullTextSearch - true if there is a full text search
    
    Returns:
    
    true if this is possible to set the full text search
  - setFullTextSearchRemoveAccents
```
public void setFullTextSearchRemoveAccents(boolean removeAccents)
```
    Set if the full text search remove accents.
    
    Parameters:
    
    removeAccents - true if the full text search remove accents
  - isFullTextSearchRemovingAccents
```
public boolean isFullTextSearchRemovingAccents()
```
    Return true if the full text search remove accents.
    
    Returns:
    
    true if the full text search remove accents
  - setFullTextSearchUseMetaphone
```
public void setFullTextSearchUseMetaphone(boolean useMetaphone)
```
    Set if the full text use the Metaphone algorithm.
    
    Parameters:
    
    useMetaphone - true if the full text use the Metaphone algorithm
  - isFullTextSearchUseMetaphone
```
public boolean isFullTextSearchUseMetaphone()
```
    Return true if the full text search use the Metaphone algorithm.
    
    Returns:
    
    true if the full text search use the Metaphone algorithm
  - hasFullTextSearch
```
public boolean hasFullTextSearch()
```
    Return true if there is a full text search.
    
    Returns:
    
    true if there is a full text search
  - pruneAlternateTitlesInDico
```
public void pruneAlternateTitlesInDico(boolean pruneAltTitlesInDico)
```
    Set if alternate titles are automatically pruned in the dictionary if their content is sufficiently similar to the article title.
    
    Parameters:
    
    pruneAltTitlesInDico - true if alternate titles are automatically pruned in the dictionary
  - isPruningAlternateTitlesInDico
```
public boolean isPruningAlternateTitlesInDico()
```
    Return true if alternate titles are automatically pruned in the dictionary if their content is sufficiently similar to the article title.
    
    Returns:
    
    true if alternate titles are automatically pruned in the dictionary
  - setNotesTooltips
```
public void setNotesTooltips(boolean hasTooltips)
```
    Set if the notes have a corresponding tooltip.
    
    Parameters:
    
    hasTooltips - true if the notes have a corresponding tooltip
  - hasNotesTooltips
```
public boolean hasNotesTooltips()
```
    Return true if the notes have a corresponding tooltip.
    
    Returns:
    
    true if the notes have a corresponding tooltip
  - setNotesTooltipsLength
```
public void setNotesTooltipsLength(int length)
```
    Set the text length of the notes tooltips.
    
    Parameters:
    
    length - the text length of the notes tooltips
  - getNotesTooltipsLength
```
public int getNotesTooltipsLength()
```
    Return the text length of the notes tooltips.
    
    Returns:
    
    the text length of the notes tooltips
  - setNotesTwoColumns
```
public void setNotesTwoColumns(boolean notesTwoColumns)
```
    Set if the notes layout is on two columns.
    
    Parameters:
    
    notesTwoColumns - true if the notes layout is on two columns
  - isNotesTwoColumns
```
public boolean isNotesTwoColumns()
```
    Return true if the notes layout is on two columns.
    
    Returns:
    
    true if the notes layout is on two columns
  - setWikiTitle
```
public void setWikiTitle(java.lang.String title)
```
    Set the wiki title, which will be shown in the index page.
    
    Parameters:
    
    title - the wiki title
  - hasSpecifiedWikiTitle
```
public boolean hasSpecifiedWikiTitle()
```
    Return true if the wiki title is specified.
    
    Returns:
    
    true if the wiki title is specified
  - getWikiTitle
```
public java.lang.String getWikiTitle()
```
    Return the wiki title.
    
    Returns:
    
    the wiki title
  - getWikiTitle
```
public java.lang.String getWikiTitle(XMLParentArticle article)
```
    Return the wiki title, which will be shown in the index page and the articles.
    
    Parameters:
    
    article - the article
    
    Returns:
    
    the wiki title
  - getWikiTitle
```
public java.lang.String getWikiTitle(java.lang.String title)
```
    Return the wiki title, which will be shown in non-article pages.
    
    Parameters:
    
    title - the element title
    
    Returns:
    
    the wiki title
  - setLimit
```
public void setLimit(int limit)
```
    Set the maximum number of articles in the same directory.
    
    Parameters:
    
    limit - the maximum number of articles in the same directory
  - getLimit
```
public int getLimit()
```
    Return the maximum number of articles in the same directory.
    
    Returns:
    
    the maximum number of articles in the same directory
  - hasLimit
```
public boolean hasLimit()
```
    Return true if the maximum number of articles in the same directory is limited.
    
    Returns:
    
    true if the maximum number of articles in the same directory is limited
  - setFixedLeftMenuOptions
```
public void setFixedLeftMenuOptions(boolean fixedLeftMenuOptions)
```
    Set if the options in the left menu are always present (meaning that all options are present even for the page on which we are).
    
    Parameters:
    
    fixedLeftMenuOptions - true if the options in the left menu are always present
  - hasFixedLeftMenuOptions
```
public boolean hasFixedLeftMenuOptions()
```
    Return true if the options in the left menu are always present (meaning that all options are present even for the page on which we are).
    
    Returns:
    
    true if the options in the left menu are always present
  - setArticlesTOC
```
public void setArticlesTOC(boolean hasTOC)
```
    Set if each article must have a Table of contents by default.
    
    Parameters:
    
    hasTOC - true if each article must have a Table of contents by default
  - hasArticlesTOC
```
public boolean hasArticlesTOC()
```
    Return true if each article must have a Table of contents by default.
    
    Returns:
    
    true if each article must have a Table of contents by default
  - setArticlesTOCThreshold
```
public void setArticlesTOCThreshold(int tocThreshold)
```
    Set the threshold for each article Table of contents.
    
    Parameters:
    
    tocThreshold - the threshold for each article Table of contents
  - getArticlesTOCThreshold
```
public int getArticlesTOCThreshold()
```
    Return the threshold for each article Table of contents.
    
    Returns:
    
    the threshold for each article Table of contents
  - setHasDictionary
```
public void setHasDictionary(boolean hasDictionary)
```
    Set if the wiki has a dictionary.
    
    Parameters:
    
    hasDictionary - true if the wiki has a dictionary
  - hasDictionary
```
public boolean hasDictionary()
```
    Return true if the wiki has a dictionary.
    
    Returns:
    
    if the wiki has a dictionary
  - setHasCategories
```
public void setHasCategories(boolean hasCategories)
```
    Set if the wiki has categories.
    
    Parameters:
    
    hasCategories - true if the wiki has a categories
  - hasCategories
```
public boolean hasCategories()
```
    Return true if the wiki has categories.
    
    Returns:
    
    if the wiki has categories
  - setRelaxSyntax
```
public void setRelaxSyntax(boolean relaxedSyntax)
```
    Set if the syntax of the articles is relaxed. For the moment the only consequence is that content of "pre" elements can contain any XML content without having to espace the XML tags.
    
    Parameters:
    
    relaxedSyntax - if the syntax of the articles is relaxed
  - hasRelaxedSyntax
```
public boolean hasRelaxedSyntax()
```
    Return true if the syntax of the articles is relaxed.
    
    Returns:
    
    true if the syntax of the articles is relaxed
  - getStyleSheet
```
public java.net.URL getStyleSheet()
```
    Return the articles StyleSheet.
    
    Returns:
    
    the articles StyleSheet
  - setStyleSheetTheme
```
public void setStyleSheetTheme(java.net.URL styleSheetTheme)
```
    Set the articles StyleSheet theme.
    
    Parameters:
    
    styleSheetTheme - the articles StyleSheet theme
  - getDefaultStyleSheetTheme
```
public java.net.URL getDefaultStyleSheetTheme()
```
    Return the default StyleSheet theme.
    
    Returns:
    
    the default StyleSheet theme
  - getStyleSheetTheme
```
public java.net.URL getStyleSheetTheme()
```
    Return the articles StyleSheet theme.
    
    Returns:
    
    the articles StyleSheet theme
  - getSchema
```
public java.net.URL getSchema()
```
    Return the articles Schema.
    
    Returns:
    
    the articles Schema
  - getLeftMenuSchema
```
public java.net.URL getLeftMenuSchema()
```
    Return the left menu Schema.
    
    Returns:
    
    the left menu Schema
  - getImageDefinitionSchema
```
public java.net.URL getImageDefinitionSchema()
```
    Return the images definitions Schema.
    
    Returns:
    
    the images definitions Schema
  - getResourceDefinitionSchema
```
public java.net.URL getResourceDefinitionSchema()
```
    Return the resources definitions Schema.
    
    Returns:
    
    the resources definitions Schema
  - getInfoBoxDefinitionSchema
```
public java.net.URL getInfoBoxDefinitionSchema()
```
    Return the resources definitions Schema.
    
    Returns:
    
    the resources definitions Schema
  - getURLExceptionsSchema
```
public java.net.URL getURLExceptionsSchema()
```
    Return the URLExceptions Schema.
    
    Returns:
    
    the URLExceptions Schema
  - getWikiStateSchema
```
public java.net.URL getWikiStateSchema()
```
    Return the wiki state Schema.
    
    Returns:
    
    the wiki state Schema
  - getTimeOutsSchema
```
public java.net.URL getTimeOutsSchema()
```
    Return the timeouts Schema.
    
    Returns:
    
    the timeouts Schema
  - getPackageSchema
```
public java.net.URL getPackageSchema()
```
    Return the package Schema.
    
    Returns:
    
    the package Schema
  - getDependenciesSchema
```
public java.net.URL getDependenciesSchema()
```
    Return the package dependencies Schema.
    
    Returns:
    
    the package dependencies Schema
  - getHelpContentSchema
```
public java.net.URL getHelpContentSchema()
```
    Return the help content definition Schema.
    
    Returns:
    
    the help content definition Schema
  - getAPIDocumentationSchema
```
public java.net.URL getAPIDocumentationSchema()
```
    Return the API documentation Schema.
    
    Returns:
    
    the API documentation Schema
  - getCustomSearchSchema
```
public java.net.URL getCustomSearchSchema()
```
    Return the custom search Schema.
    
    Returns:
    
    the custom search Schema
  - setURLExceptionsFile
```
public void setURLExceptionsFile(java.io.File file)
```
    Set the XML file specifying the URLs which will not be checked for their validity and existence.
    
    Parameters:
    
    file - the XML file specifying the URLs which will not be checked for their validity and existence
  - getURLExceptionsFile
```
public java.io.File getURLExceptionsFile()
```
    Return the XML file specifying the URLs which will not be checked for their validity and existence.
    
    Returns:
    
    the XML file specifying the URLs which will not be checked for their validity and existence
  - setTimeOutsFile
```
public void setTimeOutsFile(java.io.File file)
```
    Set the XML file specifying the URLs TimeOuts.
    
    Parameters:
    
    file - the XML file specifying the URLs TimeOuts
  - getTimeOutsFile
```
public java.io.File getTimeOutsFile()
```
    Return the XML file specifying the URLs TimeOuts.
    
    Returns:
    
    the XML file specifying the URLs TimeOuts
  - setDependenciesFile
```
public void setDependenciesFile(java.io.File dependencies)
```
    Set the package dependencies.
    
    Parameters:
    
    dependencies - the package dependencies
  - getDependenciesFile
```
public java.io.File getDependenciesFile()
```
    Return the package dependencies File.
    
    Returns:
    
    the package dependencies File
  - setPackageDependencies
```
public void setPackageDependencies(org.docgene.model.globals.PackagesDependencies dependencies)
```
    Set the package dependencies.
    
    Parameters:
    
    dependencies - the package dependencies
  - getPackageDependencies
```
public org.docgene.model.globals.PackagesDependencies getPackageDependencies()
```
    Return the package dependencies.
    
    Returns:
    
    the package dependencies
  - getAPIsSchema
```
public java.net.URL getAPIsSchema()
```
    Return the APIs Schema.
    
    Returns:
    
    the APIs Schema
  - getJavaAPILangClasses
```
public java.net.URL getJavaAPILangClasses()
```
    Return the list of classes in the API lang package for the javadoc api.
    
    Returns:
    
    the list of classes in the API lang package
  - setAPIsFile
```
public void setAPIsFile(java.io.File file)
```
    Set the XML file specifying the APIs.
    
    Parameters:
    
    file - the XML file specifying the APIs
  - getAPIsFile
```
public java.io.File getAPIsFile()
```
    Return the XML file specifying the APIs.
    
    Returns:
    
    the XML file specifying the APIs
  - setAdditionalAPIDocs
```
public void setAdditionalAPIDocs(java.io.File file)
```
    Set the File specifying the additional APIs documentation specification.
    
    Parameters:
    
    file - the File specifying the additional APIs documentation specification
  - getDefaultAPIDocsURL
```
public java.net.URL getDefaultAPIDocsURL()
```
    Return the URL specifying the default APIs documentation specification.
    
    Returns:
    
    the URL specifying the default APIs documentation specification
  - getAdditionalAPIDocsURL
```
public java.net.URL getAdditionalAPIDocsURL()
```
    Return the URL specifying the additional APIs documentation specification.
    
    Returns:
    
    the URL specifying the additional APIs documentation specification
  - setHelpFileName
```
public void setHelpFileName(java.lang.String helpFileName)
```
    Set the help file name.
    
    Parameters:
    
    helpFileName - the help file name
  - getHelpFileName
```
public java.lang.String getHelpFileName()
```
    Return the help file name.
    
    Returns:
    
    the help file name
  - setHelpFile
```
public void setHelpFile(java.io.File helpFile)
```
    Set the help file.
    
    Parameters:
    
    helpFile - the help file
  - getHelpFile
```
public java.io.File getHelpFile()
```
    Return the help file.
    
    Returns:
    
    the help file
  - setHelpOptimizedForSwing
```
public void setHelpOptimizedForSwing(boolean helpOptimizedForSwing)
```
    Set if the help result should be optimized for Swing.
    
    Parameters:
    
    helpOptimizedForSwing - true if the help result should be optimized for Swing
  - isHelpOptimizedForSwing
```
public boolean isHelpOptimizedForSwing()
```
    Return true if the help result will be optimized for Swing.
    
    Returns:
    
    true if the help result will be optimized for Swing
  - isHTML5Compatible
```
public boolean isHTML5Compatible()
```
    Return true if the HTML result is HTLM5-compatible.
    
    Returns:
    
    true if the HTML result is HTLM5-compatible
  - setHelpPageWidth
```
public void setHelpPageWidth(int pageWidth)
```
    Set the page width used for specifying the images width for the help content. Using a percentage width for images would not work for the help content, so the generator will compute the image width in this case by using this value for the overall "page width". The page width will be set by default to 600 if not specified.
    
    Parameters:
    
    pageWidth - the help page width
  - getHelpPageWidth
```
public int getHelpPageWidth()
```
    Return the page width used for specifying the images width for the help content.
    
    Returns:
    
    the help page width
  - setHelpContent
```
public void setHelpContent(java.io.File content)
```
    Set the help content definition.
    
    Parameters:
    
    content - the help content definition
  - getHelpContent
```
public java.net.URL getHelpContent()
```
    Return the output directory for the wiki.
    
    Returns:
    
    the output directory
  - setCustomSearchSpec
```
public void setCustomSearchSpec(java.net.URL customSearchSpec)
```
    Set the specification used for the custom search option type.
    
    Parameters:
    
    customSearchSpec - the URL for the specification.
  - getCustomSearchSpec
```
public java.net.URL getCustomSearchSpec()
```
    Return the specification used for the custom search option type.
    
    Returns:
    
    the URL for the specification.
  - setURLExceptions
```
public void setURLExceptions(org.docgene.model.globals.SiteExceptionsList urlExceptions)
```
    Set the list of URLs which will not be checked for their validity and existence.
    
    Parameters:
    
    urlExceptions - the list of URLs which will not be checked for their validity and existence
  - getURLExceptions
```
public org.docgene.model.globals.SiteExceptionsList getURLExceptions()
```
    Return the list of URLs which will not be checked for their validity and existence.
    
    Returns:
    
    the list of URLs which will not be checked for their validity and existence
  - setTimeOuts
```
public void setTimeOuts(org.docgene.model.globals.TimeOuts timeouts)
```
    Set the list of URLs with specific timeouts.
    
    Parameters:
    
    timeouts - the URLs of URLs with specific timeouts
  - getTimeOuts
```
public org.docgene.model.globals.TimeOuts getTimeOuts()
```
    Return the list of URLs with specific timeouts.
    
    Returns:
    
    the list of URLs with specific timeouts.
  - setErrorHandler
```
public void setErrorHandler(org.docgene.parser.XMLErrorHandler errorHandler)
```
    Set the error handler which will be used to create and store errors or informations during the parsing.
    
    Parameters:
    
    errorHandler - the error handler
  - getErrorHandler
```
public org.docgene.parser.XMLErrorHandler getErrorHandler()
```
    Return the error handler which will be used to create and store errors or informations during the parsing.
    
    Returns:
    
    the error handler
  - setHelpContentDeclaration
```
public void setHelpContentDeclaration(org.docgene.model.help.HelpContentDeclaration helpContentDecl)
```
    Set the HelpContentDeclaration content.
    
    Parameters:
    
    helpContentDecl - the HelpContentDeclaration content
  - getHelpContentDeclaration
```
public org.docgene.model.help.HelpContentDeclaration getHelpContentDeclaration()
```
    Return the HelpContentDeclaration content.
    
    Returns:
    
    the HelpContentDeclaration content
  - setHelpSystem
```
public void setHelpSystem(org.docgene.model.help.HelpSystem helpSystem)
```
    Set the HelpSystem.
    
    Parameters:
    
    helpSystem - the HelpSystem
  - getHelpSystem
```
public org.docgene.model.help.HelpSystem getHelpSystem()
```
    Return the HelpSystem.
    
    Returns:
    
    the HelpSystem
  - getAPIDocumentations
```
public org.docgene.model.globals.apidocs.APIDocumentations getAPIDocumentations()
```
    Return the API documentations specification.
    
    Returns:
    
    the API documentations specification
  - getCount
```
public org.docgene.main.props.CountProperty getCount()
```
    Return the number of articles. Defer to Properties.getCount().
    
    Returns:
    
    the number of articles

Class Configuration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

xmlFilter

cssFilter

imageFilter

allImageFilter

mdFilter

mdxmlFilter

propertiesFilter

Method Detail

preventErrorWindowShow

isPreventingErrorWindowShow

createFilter

setArticlesModel

getArticlesModel

getLocationDir

getMathFormulaLoader

getMathFormulaHandler

getInstance

getVersion

getDate

reset

getProxyConfiguration

setOutputType

getOutputType

isHTMLOutputType

isHelpOutputType

setInputDirs

getInputDirs

setInputsSubDirectories

useInputsSubDirectories

setOuputDir

getOuputDirectory

getOuputDirectoryURL

setIndexGenerationType

getIndexGenerationType

setResourcesGenerationType

getResourcesGenerationType

setUserAgent

getUserAgent

setAdditionalCSS

getAdditionalCSS

setAdditionalCSSOutput

getAdditionalCSSOutput

setBackgroundOpacity

getBackgroundOpacity

hasBackgroundOpacity

setBackgroundGlobal

isBackgroundGlobal

setBackground

getBackground

setBackgroundPaint

getBackgroundPaint

hasBackground

setCodeHasBackground

hasCodeBackground

setPreHasBackground

hasPreBackground

setLeftIndexMenu

getLeftIndexMenu

setIndex

getIndex

hasAlternateIndex

setRightIndexMenu

getRightIndexMenu

setAdditionalFooter

getAdditionalFooter

getInputSearchScript

getInputFullTextSearchScript

setSearchDatabaseScript

getSearchDatabaseScript

setSearchScript

getSearchScript

setFullTextSearchDatabaseScript

getFullTextSearchDatabaseScript

setFullTextSearchScript

getFullTextSearchScript