- id - Variable in class org.docgene.model.OpaqueArticle
-
- id - Variable in class org.docgene.model.XMLArticle
-
The article ID.
- id - Variable in class org.docgene.model.XMLReference
-
The reference ID.
- idMayBeDesc - Variable in class org.docgene.model.XMLReference
-
True if the raw ID maybe a description.
- IMAGE_MAP - Static variable in class org.docgene.model.XMLExtendedImage
-
Tags an image Map extended image.
- imageFilter - Variable in class org.docgene.main.Configuration
-
- ImageHeightType - Interface in org.docgene.model
-
Represents the type of image height for an image.
- ImageMap - Class in org.docgene.model
-
Represents an Image map.
- ImageMap() - Constructor for class org.docgene.model.ImageMap
-
- ImageMap.Area - Class in org.docgene.model
-
Represents an active Area in an Image Map.
- ImageReference - Interface in org.docgene.model
-
Represents an ImageReference.
- ImportanceType - Interface in org.docgene.model
-
The enumeration for importance types used for comments and TODOs.
- IMPORTANT - Static variable in interface org.docgene.model.ImportanceType
-
Warning / Important comment or TODO.
- importArticle(URL) - Method in class org.docgene.api.DocGeneratorAPI
-
Import an article and add this article to the model.
- importArticle(File) - Method in class org.docgene.api.DocGeneratorAPI
-
Import an article and add this article to the model.
- importImageDefinition(URL) - Method in class org.docgene.api.DocGeneratorAPI
-
Import an Image definition XML url to the model.
- importImageDefinition(File) - Method in class org.docgene.api.DocGeneratorAPI
-
Import an Image definition XML file to the model.
- IN_WORK_NAME - Static variable in class org.docgene.model.XMLMessageBox
-
The name of the in work background for the Progress messageBox type.
- includeArticle(XMLArticle, URL, boolean) - Method in class org.docgene.api.DocGeneratorAPI
-
Include an article in another parent article.
- includeArticle(XMLArticle, File, boolean) - Method in class org.docgene.api.DocGeneratorAPI
-
Include an article in another parent article.
- includeArticle(XMLArticle, XMLArticle, boolean) - Method in class org.docgene.api.DocGeneratorAPI
-
Import an article and add this article to the model.
- includeComments(boolean) - Method in class org.docgene.main.Configuration
-
Set if comments are included.
- includeTODO(boolean) - Method in class org.docgene.main.Configuration
-
Set if TODOs are included.
- incrementSortableTables(int) - Method in class org.docgene.model.XMLArticle
-
Increment the number of sortable tables in the article.
- incrementSortableTables(int) - Method in interface org.docgene.model.XMLParentArticle
-
Increment the number of sortable tables in the article.
- INDEX - Static variable in interface org.docgene.model.Article
-
The ID of the index article.
- INDEX_CHAPTER - Static variable in class org.docgene.model.globals.Localization
-
"index": The title for the index chapter.
- INDEX_LC - Static variable in interface org.docgene.model.Article
-
The ID of the index article in lower case.
- INFO - Static variable in class org.docgene.model.XMLMessageBox
-
The Info messageBox type.
- initDefaultContent() - Method in class org.docgene.model.XMLMenu
-
Initialize the default content.
- INTERFACE - Static variable in class org.docgene.model.XMLIncludedAPI
-
interface.
- InternalMenuItem - Class in org.docgene.model.globals
-
Represent a Menu Item pointing to an internal link.
- InternalMenuItem(String) - Constructor for class org.docgene.model.globals.InternalMenuItem
-
Constructor.
- INTRO_CHAPTER - Static variable in class org.docgene.model.globals.Localization
-
"introduction": The title for the introduction chapter.
- INVALID - Static variable in interface org.docgene.model.globals.SearchOptions
-
Invalid option.
- isAbsolute - Variable in class org.docgene.model.AbstractLink
-
True if the link is absolute.
- isAbsolute() - Method in class org.docgene.model.AbstractLink
-
Return true if the link is absolute.
- isAbsolute() - Method in interface org.docgene.model.ExternalLink
-
Return true if the link is absolute.
- isAllowingHTMLEntities() - Method in class org.docgene.main.Configuration
-
Return true if HTML entities are allowed.
- isAllowingIdenticalTitleIDs() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if if the parser accept identical title IDs (default is true).
- isAllowingMarkdown() - Method in class org.docgene.main.Configuration
-
Return true if the Markdown format is accepted for articles.
- isAllowingMediawiki() - Method in class org.docgene.main.Configuration
-
Return true if the Wikipedia Mediawiki format is accepted for articles.
- isAnyJDKAPI() - Method in class org.docgene.model.XMLJavaAPI
-
Return true if the API is a JDK API for Java 8 (JavaSE or JavaFX).
- isAutoDesc() - Method in interface org.docgene.model.ArticleReference
-
Return true if the description has been set automatically.
- isAutoDesc() - Method in class org.docgene.model.XMLReference
-
Return true if the description has been set automatically.
- isBackgroundGlobal() - Method in class org.docgene.main.Configuration
-
Return true if the background is applied to all pages.
- isBareReference() - Method in interface org.docgene.model.ArticleReference
-
Return true for a bare reference pointing directly to a File.
- isBareReference() - Method in class org.docgene.model.XMLReference
-
Return true for a bare reference pointing directly to a File.
- isBound() - Method in interface org.docgene.model.ArticleReference
-
Return true if the reference is bound.
- isBound() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
-
Return true if the reference is bound.
- isBound() - Method in class org.docgene.model.XMLInclude
-
Return true if the reference is bound.
- isBound() - Method in class org.docgene.model.XMLRedirect
-
Return true if the reference is bound.
- isBound() - Method in class org.docgene.model.XMLReference
-
Return true if the reference is bound.
- isCheckingHTTPLinks() - Method in class org.docgene.main.Configuration
-
Return true if URLs http links are checked.
- isCheckingInternalJavaAPI() - Method in class org.docgene.main.Configuration
-
Return true if the internal Java APIs must be checked if necessary.
- isCheckingLinks() - Method in class org.docgene.main.Configuration
-
Return true if URLs links are checked.
- isCheckingLinksThreaded() - Method in class org.docgene.main.Configuration
-
Return true if URLs links are checked in a thread pool.
- isClassAPIType() - Method in class org.docgene.model.XMLJavaAPI
-
Return true if the API points to a class.
- isCleaning() - Method in class org.docgene.main.Configuration
-
Return true if the output directory is cleaned before the generation.
- isCompact() - Method in class org.docgene.model.XMLAPIDoc
-
Return true if the api should have a compact representation.
- isConcurrent() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true for concurrent parsing.
- isConstructor() - Method in class org.docgene.model.AbstractAPI
-
Return true if the API desgins a constructor.
- isCustomSearchType() - Method in class org.docgene.main.Configuration
-
Return true if the custom search is selected.
- isDefaultStyle() - Method in class org.docgene.api.SentenceStyle
-
Return true if the style is the default style.
- isDirect() - Method in interface org.docgene.model.Article
-
Return true if this article is direct.
- isDirect() - Method in class org.docgene.model.OpaqueArticle
-
Return true.
- isDirect() - Method in class org.docgene.model.XMLArticle
-
Return true.
- isDirect() - Method in class org.docgene.model.XMLDisambArticle
-
Return true.
- isDirect() - Method in class org.docgene.model.XMLRawHTMLArticle
-
Return true.
- isDirectXMLArticle() - Method in interface org.docgene.model.Article
-
Return true if this article is direct and is not a raw html article.
- isDirectXMLArticle() - Method in class org.docgene.model.OpaqueArticle
-
Return false.
- isDuplicate() - Method in interface org.docgene.model.TitledElement
-
Return true if the title element is a duplicate of another existing titl e.
- isDuplicate() - Method in class org.docgene.model.XMLChapter
-
Return true if the chapter is a duplicate of another existing title.
- isDuplicate() - Method in class org.docgene.model.XMLTitle
-
Return true if the title is a duplicate of another existing title.
- isDynamicMaps() - Method in class org.docgene.main.Configuration
-
Return true if the parser will use javascript dynamic maps (maps loaded by Javascript).
- isEmpty() - Method in class org.docgene.model.globals.ArticleCategory
-
Return true if this category is empty.
- isEmpty() - Method in interface org.docgene.model.HTMLRootElement
-
Return true if the list of roots is empty.
- isEmpty() - Method in interface org.docgene.model.ParagraphElementParent
-
Return true if the paragraph is empty.
- isEmpty() - Method in class org.docgene.model.XMLMenu
-
Return true if the menu is empty.
- isEmpty() - Method in class org.docgene.model.XMLSentence
-
Return true if the sentence is empty.
- isEmpty() - Method in class org.docgene.model.XMLSpan
-
Return true if the sentence is empty.
- isEnablingComments() - Method in class org.docgene.main.Configuration
-
Return true if comments are enabled.
- isEndingWithNewLine() - Method in interface org.docgene.model.SpanTextElement
-
Return true if the sentence ends with a new line.
- isEndingWithNewLine() - Method in class org.docgene.model.XMLSentence
-
Return true if the sentence ends with a new line.
- isEndingWithNewLine() - Method in class org.docgene.model.XMLSpan
-
Return true if the sentence ends with a new line.
- isEscapingContent() - Method in class org.docgene.main.Configuration
-
Return true if the parser should support escaping characters in the articles content.
- isEscapingNonUTF8() - Method in class org.docgene.main.Configuration
-
Return true if non UTF8 characters must be escaped.
- isExtendedImage() - Method in class org.docgene.model.XMLExtendedImage
-
Return true if the image is an extended image.
- isExtendedImage() - Method in class org.docgene.model.XMLImage
-
Return true if the image is an extended image.
- isFallback() - Method in class org.docgene.model.XMLFallbackArticle
-
Return true.
- isFirstInLine() - Method in class org.docgene.model.AbstractJustifiedElement
-
Return true if the image is the first element in its line.
- isFixedLayout() - Method in class org.docgene.model.XMLTable
-
Return true if the table has a fixed layout.
- isFloat() - Method in class org.docgene.model.XMLImage
-
Return true if the image element should have the "float" attribute.
- isFloat() - Method in class org.docgene.model.XMLMap
-
Return true if the map element should have the "float" attribute.
- isFloat() - Method in class org.docgene.model.XMLTable
-
Return true if the table element should have the "float" attribute.
- isForcingAbsoluteLinks() - Method in class org.docgene.model.globals.ArticlesModel
-
Return if relative links to files on the file system outside of the wiki will be converted to absolute links (default is false).
- isForkingParser() - Method in class org.docgene.main.Configuration
-
Return true if the parsing should use a fork-join pool to perform the parsing.
- isFound() - Method in class org.docgene.model.globals.ArticlesGlossary
-
Return true if the glossary description was found.
- isFullTextSearchCompressed() - Method in class org.docgene.main.Configuration
-
Return true if the full text search index must be compressed (the level is greater or equal to 2).
- isFullTextSearchRemovingAccents() - Method in class org.docgene.main.Configuration
-
Return true if the full text search remove accents.
- isFullTextSearchUseMetaphone() - Method in class org.docgene.main.Configuration
-
Return true if the full text search use the Metaphone algorithm.
- isGlobalIndex() - Method in class org.docgene.model.XMLIndex
-
Return true if the index is the global index.
- isGlobalIndex() - Method in interface org.docgene.model.XMLParentArticle
-
Return true if the article is the global index.
- isHeadless() - Method in class org.docgene.main.Configuration
-
Return true if the generator must work in an headless environment.
- isHelpOptimizedForSwing() - Method in class org.docgene.main.Configuration
-
Return true if the help result will be optimized for Swing.
- isHelpOutputType() - Method in class org.docgene.main.Configuration
-
Return true if the output type is the Help type.
- isHTML5Compatible() - Method in class org.docgene.main.Configuration
-
Return true if the HTML result is HTLM5-compatible.
- isHTMLOutputType() - Method in class org.docgene.main.Configuration
-
Return true if the output type is the Html type.
- isIncludingComments() - Method in class org.docgene.main.Configuration
-
Return true if comments are included.
- isIncludingElement(PackagedElement) - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if an element must be included in the wiki output.
- isIncludingPackage(String) - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if a package must be included in the wiki output.
- isIncludingTODO() - Method in class org.docgene.main.Configuration
-
Return true if TODOs are included.
- isIndex() - Method in interface org.docgene.model.Article
-
Return true if the article is an index.
- isIndex() - Method in class org.docgene.model.XMLArticle
-
Return false.
- isIndex() - Method in class org.docgene.model.XMLIndex
-
Return true.
- isInDictionary() - Method in class org.docgene.model.AlternateTitle
-
Return true if the alternate title must be added in the dictionary and categories.
- isInFrame() - Method in class org.docgene.model.XMLRawHTMLArticle
-
Return true if the article content is in a frame.
- isJDK8API() - Method in class org.docgene.model.XMLJavaAPI
-
Return true if the API is a JDK API for Java 8 (JavaSE or JavaFX).
- isKeepingCase() - Method in class org.docgene.model.AlternateTitle
-
Return true if the alternate title title should keep the description case.
- isKeepingCase() - Method in interface org.docgene.model.Article
-
Return true if the article title should keep the title description case.
- isKeepingCase() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
-
Return true if the word should keep its case.
- isKeepingCase() - Method in class org.docgene.model.OpaqueArticle
-
Return true if the article title should keep the title description case.
- isKeepingCase() - Method in interface org.docgene.model.TitledElement
-
Return trur if the TitledElement description should keep the title description case.
- isKeepingCase() - Method in class org.docgene.model.XMLArticle
-
Return true if the article title should keep the title description case.
- isKeepingCase() - Method in class org.docgene.model.XMLChapter
-
Return trur if the chapter description should keep the title description case.
- isKeepingCase() - Method in class org.docgene.model.XMLDisambArticle
-
Return true if the article title should keep the title description case.
- isKeepingCase() - Method in class org.docgene.model.XMLFallbackArticle
-
Return false.
- isKeepingCase() - Method in class org.docgene.model.XMLRawHTMLArticle
-
Return true if the article title should keep the title description case.
- isKeepingCase() - Method in class org.docgene.model.XMLRedirect
-
Return true if the article title should keep the title description case.
- isKeepingCase() - Method in class org.docgene.model.XMLTitle
-
Return true if the title description should keep the title description case.
- isKeepingNumbering() - Method in class org.docgene.model.XMLInclude
-
Return true if the titles numbering levels is kept.
- isManualPolicy() - Method in class org.docgene.model.globals.ArticlesGlossary
-
Return true if the policy of the glossary is manual.
- isNotesTwoColumns() - Method in class org.docgene.main.Configuration
-
Return true if the notes layout is on two columns.
- isNotesTwoColumns() - Method in class org.docgene.model.XMLArticle
-
Return true if the notes layout is on two columns.
- isNotesTwoColumns() - Method in interface org.docgene.model.XMLParentArticle
-
Return true if the notes layout is on two columns.
- isOnAnchor() - Method in class org.docgene.model.XMLWord
-
Return true if the word as being put on an existing anchor.
- isOnArticle() - Method in class org.docgene.model.XMLWord
-
Return true if the word anchor is on an article.
- isPresent() - Method in class org.docgene.model.AbstractXMLParentArticle
-
Return true if the article is present.
- isPreventingErrorWindowShow() - Method in class org.docgene.main.Configuration
-
Return true if if the error window must not be shown.
- isPruningAlternateTitlesInDico() - Method in class org.docgene.main.Configuration
-
Return true if alternate titles are automatically pruned in the dictionary if their content is sufficiently similar to the article title.
- isRawHTMLArticle() - Method in interface org.docgene.model.Article
-
Return true if this article represents a raw HTML file.
- isRawHTMLArticle() - Method in class org.docgene.model.XMLRawHTMLArticle
-
Return true.
- isReferingTo() - Method in class org.docgene.model.XMLIndex
-
Return true if the index is refering to an article.
- isRelativeHeight() - Method in class org.docgene.model.XMLImage
-
Return true if the image height is relative (in %).
- isRelativeWidth() - Method in class org.docgene.model.XMLBox
-
Return true if the box width is relative (in %).
- isRelativeWidth() - Method in class org.docgene.model.XMLImage
-
Return true if the image width is relative (in %).
- isRelativeWidth() - Method in class org.docgene.model.XMLMap
-
Return true if the image width is relative (in %).
- isRelativeWidth() - Method in class org.docgene.model.XMLSizedTableRow
-
Return true if the row widths are relative (in %).
- isRelativeWidth() - Method in class org.docgene.model.XMLTable
-
Return true if the table width is relative (in %).
- isRelativeWidth() - Method in class org.docgene.model.XMLTableColumn
-
Return true if the column width is relative (in %).
- isRelativeWidth() - Method in class org.docgene.model.XMLTableRow
-
Return true if the row widths are relative (in %).
- isRemovingH1Titles() - Method in class org.docgene.model.XMLRawHTMLArticle
-
Return true if H1 titles must be skipped.
- isRemovingNav() - Method in class org.docgene.model.XMLRawHTMLArticle
-
Return true if if the article nav content must be removed.
- isResolved - Variable in class org.docgene.model.AbstractAPI
-
True if the API is resolved.
- isResolved() - Method in class org.docgene.model.AbstractAPI
-
Return true if the API is resolved.
- isResolved() - Method in interface org.docgene.model.TitledElement
-
Return true if the title element has having been already resolved.
- isResolved() - Method in class org.docgene.model.XMLChapter
-
Return true if the title element has having been already resolved.
- isResolved() - Method in class org.docgene.model.XMLJavaAPI
-
Return true if the API is resolved.
- isResolved() - Method in class org.docgene.model.XMLTitle
-
Return true if the title element has having been already resolved.
- isResolvingAPILinks() - Method in class org.docgene.main.Configuration
-
Return true if API links are resolved for APIs which are defined internal to the wiki output.
- isSearchable() - Method in interface org.docgene.model.TitledElement
-
Return true if the title element is searchable.
- isSearchable() - Method in class org.docgene.model.XMLChapter
-
Return true if the chapter title is searchable.
- isSearchable() - Method in class org.docgene.model.XMLTitle
-
Return true if the title is searchable.
- isSeeAlso() - Method in interface org.docgene.model.TitledElement
-
Return true if the TitledElement correspond to a See Also title.
- isSeeAlso() - Method in class org.docgene.model.XMLTitle
-
Return true if the TitledElement correspond to a See Also title.
- isShowingErrorsFullPath() - Method in class org.docgene.main.Configuration
-
Return true if the full paths of files should be presented for errors.
- isShowingGlossaryErrors() - Method in class org.docgene.main.Configuration
-
Return true if the glossary errors are checked.
- isShowingWarnings() - Method in class org.docgene.main.Configuration
-
Return true if warnings should be presented.
- isShowingWikilinksTooltips() - Method in class org.docgene.main.Configuration
-
Return true if there are wiki links tooltips.
- isSortable() - Method in class org.docgene.model.XMLTable
-
Return true if the table has arrows to sort columns by their content.
- isSortable() - Method in class org.docgene.model.XMLTableHeader
-
Return true if the table parent is sortable.
- isSource() - Method in class org.docgene.model.XMLPre
-
Return true for a source tag.
- isStoringResources() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if resources must be stored.
- isSupportingEscaping() - Method in class org.docgene.main.Configuration
-
Return true if the parser supports escaping characters in the content of XML articles.
- isSupportingThemes() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if the model writer support themes.
- isTemplate() - Method in interface org.docgene.model.Article
-
Return true if this article is a template.
- isTemplate() - Method in class org.docgene.model.XMLArticle
-
Return true if this article is a template.
- isTitlesResolved() - Method in class org.docgene.model.XMLArticle
-
Return true if the titles has been resolved.
- isTrimmedLeft() - Method in class org.docgene.model.XMLPre
-
Return true if the text must be trimmed to the left.
- isUL() - Method in class org.docgene.model.XMLList
-
Return true for a ul list.
- isUsingMaximumSize() - Method in class org.docgene.model.XMLImage
-
Return true if the image must not have a size greater than the image
definition size.
- isValid - Variable in class org.docgene.model.AbstractLink
-
True if the link is valid.
- isValid() - Method in class org.docgene.model.AbstractLink
-
Return true if the link is valid.
- isValid() - Method in interface org.docgene.model.Article
-
Return true if the article is valid.
- isValid() - Method in interface org.docgene.model.ExternalLink
-
Return true if the link is valid.
- isValid() - Method in class org.docgene.model.XMLMailLink
-
Return true.
- isValid() - Method in class org.docgene.model.XMLMoreInfo
-
Return true if the moreInfo element is valid.
- isValid() - Method in class org.docgene.model.XMLRawHTMLArticle
-
Return true if the article is valid.
- isValid() - Method in class org.docgene.model.XMLRedirect
-
Return true if the redirect is valid.
- isVertical() - Method in class org.docgene.model.XMLTable
-
Return true if the table is vertical.
- isVertical() - Method in class org.docgene.model.XMLTableHeader
-
Return true if the table header is vertical.
- isWritingAnyScripts() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if allowing to write any scripts.
- isWritingArticlesHeaderFrame() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if articles header frame must be written (default is true).
- isWritingArticlesTOC() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if articles Table of content must be written (default is true)
- isWritingResources() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if allowing to write resources files.
- isWritingScripts() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if allowing to write scripts.
- isWritingSeeAlso() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if allowing to write the seeAlso elements(default is true).
- isWritingSubDirectories() - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if allowing to write articles, resources and images in sub-directories (default is true).
- isXMLArticle() - Method in class org.docgene.model.XMLArticle
-
Return true.
- isXMLArticle() - Method in interface org.docgene.model.XMLParentArticle
-
Return true if this is an XML article.
- ITALIAN - Static variable in interface org.docgene.model.globals.Locales
-
The Italian locale.
- ITALIC - Static variable in interface org.docgene.model.FontType
-
The type for italic fonts.