Skip navigation links
A B C D E F G H I J L M N O P R S T U V W X Y 

G

GARAMOND - Static variable in interface org.docgene.api.FontFace
"Garamond".
GENERATE_ALWAYS - Static variable in interface org.docgene.main.FileGenerationType
Always generate the file.
GENERATE_IF_NOT_EXIST - Static variable in interface org.docgene.main.FileGenerationType
Only generate the file if it does not exist.
GENERATE_NEVER - Static variable in interface org.docgene.main.FileGenerationType
Never generate the file.
GEORGIA - Static variable in interface org.docgene.api.FontFace
"Georgia".
GERMAN - Static variable in interface org.docgene.model.globals.Locales
The German locale.
getAdditionalAPIDocsURL() - Method in class org.docgene.main.Configuration
Return the URL specifying the additional APIs documentation specification.
getAdditionalContent() - Method in class org.docgene.model.XMLFooter
Return the optional footer additional content.
getAdditionalCSS() - Method in class org.docgene.main.Configuration
Return the additional CSS file to use for the wiki.
getAdditionalCSSOutput() - Method in class org.docgene.main.Configuration
Return the additional CSS file to use for the wiki.
getAdditionalFooter() - Method in class org.docgene.main.Configuration
Return the additional content to use for the footer.
getAdditionalScript() - Method in class org.docgene.main.Configuration
Return the additional script to use for the header.
getAlignment() - Method in class org.docgene.main.Configuration
Return the alignment of the container elements.
getAlignment() - Method in interface org.docgene.model.Alignment
Return the alignment.
getAlignment() - Method in interface org.docgene.model.JustifiedElement
Return the alignment of the element.
getAlignment() - Method in class org.docgene.model.XMLBox
Return the alignment of the box.
getAlignment() - Method in class org.docgene.model.XMLChapter
Return the alignment of the element.
getAlignment() - Method in class org.docgene.model.XMLDiv
Return the alignment of the element.
getAlignment() - Method in class org.docgene.model.XMLImage
Return the alignment of the image.
getAlignment() - Method in class org.docgene.model.XMLMap
Return the alignment of the Map.
getAlignment() - Method in class org.docgene.model.XMLParagraph
Return the alignment of the element.
getAlignment() - Method in class org.docgene.model.XMLTable
Return the alignment of the table.
getAlignment(XMLTableCell) - Method in class org.docgene.model.XMLTable
Return the alignment of the cell in the table.
getAlignment() - Method in class org.docgene.model.XMLTableCell
Return the alignment of the cell.
getAlignment() - Method in class org.docgene.model.XMLVideo
Return the alignment of the video.
getAllArticles() - Method in class org.docgene.model.globals.ArticlesModel
Return all the articles including those from the packages.
getAllElements() - Method in class org.docgene.model.XMLList
 
getAllElements() - Method in class org.docgene.model.XMLTable
 
getAllElements() - Method in class org.docgene.model.XMLTree
 
getAllImages() - Method in class org.docgene.model.globals.ArticlesModel
Return all the images including those from the packages.
getAllInfoboxes() - Method in class org.docgene.model.globals.ArticlesModel
Return all the infobox definitions including those from the packages.
getAllResources() - Method in class org.docgene.model.globals.ArticlesModel
Return all the resources including those from the packages.
getAlternateTerms() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the alternate terms fo the Word.
getAlternateTitles() - Method in interface org.docgene.model.Article
Return the article alternate titles.
getAlternateTitles() - Method in class org.docgene.model.XMLArticle
Return the article alternate titles.
getAlternateTitles() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article alternate titles.
getAlternateTitles() - Method in class org.docgene.model.XMLRedirect
Return the article alternate titles.
getAlternateTitlesMap() - Method in interface org.docgene.model.Article
Return the article alternate titles to the raw titles Map.
getAlternateTitlesMap() - Method in class org.docgene.model.XMLArticle
Return the article alternate titles to the raw titles Map.
getAlternateTitlesMap() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article alternate titles to the raw titles Map.
getAltPath() - Method in class org.docgene.model.AbstractAPI
Return the API alternate path.
getAltText() - Method in class org.docgene.model.AbstractAPI
Return the link description alternate text.
getAnchor(String) - Method in class org.docgene.model.XMLArticle
Return the AnchorElement of a specified id (including the included articles or templates).
getAnchor(String) - Method in interface org.docgene.model.XMLParentArticle
Return the AnchorElement of a specified id (including the included articles or templates).
getAnchorElement() - Method in interface org.docgene.model.ArticleReference
Return the referenced anchor element.
getAnchorElement() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the referenced anchor element.
getAnchorElement() - Method in class org.docgene.model.XMLRedirect
Return the referenced anchor element.
getAnchorElement() - Method in class org.docgene.model.XMLReference
Return the referenced anchor element.
getAnchorElements() - Method in class org.docgene.model.XMLArticle
Return all the anchor elements of the articles sorted by their title.
getAnchorElements() - Method in interface org.docgene.model.XMLParentArticle
Return all the anchor elements of the articles sorted by their title. return null by default.
getAnchors() - Method in class org.docgene.model.XMLArticle
Return all the "anchor" elements of the articles sorted by their title.
getAnchors() - Method in interface org.docgene.model.XMLParentArticle
Return all the "anchor" elements of the articles sorted by their title.
getAPI() - Method in class org.docgene.model.AbstractAPI
Return the API name.May be null if AbstractAPI.getAPILocation() is not null.
getAPI() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the associated parent API specification.
getAPI() - Method in class org.docgene.model.XMLIncludedAPI
Return the API name.
getAPIDocumentations() - Method in class org.docgene.main.Configuration
Return the API documentations specification.
getAPIDocumentationSchema() - Method in class org.docgene.main.Configuration
Return the API documentation Schema.
getAPIID() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the API ID.
getAPILocation() - Method in class org.docgene.model.AbstractAPI
Return the API location.
getAPIPathType() - Method in class org.docgene.model.XMLJavaAPI
Return the API link path type presentation.
getAPIsFile() - Method in class org.docgene.main.Configuration
Return the XML file specifying the APIs.
getAPIsSchema() - Method in class org.docgene.main.Configuration
Return the APIs Schema.
getAPIType() - Method in class org.docgene.model.XMLDotNetAPI
Return the API type.
getAPIType() - Method in class org.docgene.model.XMLDoxygenAPI
Return the API type.
getAPIType() - Method in class org.docgene.model.XMLJavaAPI
Return the type of the API.
getAPIType() - Method in class org.docgene.model.XMLPythonAPI
Return the API type.
getAPIType() - Method in class org.docgene.model.XMLQtAPI
Return the API type.
getAreas() - Method in class org.docgene.model.ImageMap
Return the list of active areas on the map.
getArgument() - Method in class org.docgene.model.XMLIncludedAPIArgument
Return the argument.
getArguments() - Method in class org.docgene.model.APIMember
Return the list of arguments.
getArguments() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the list of arguments.
getArticle(String) - Method in class org.docgene.api.DocGeneratorAPI
Return the article of a specified description.
getArticle() - Method in interface org.docgene.model.Article
Return the XMLArticle which is really accessed through this Article.
getArticle(ArticleRef) - Method in class org.docgene.model.globals.ArticlesModel
Return an article specified by its reference.
getArticle(String, String) - Method in class org.docgene.model.globals.ArticlesModel
Return an article specified by its reference.
getArticle(String) - Method in class org.docgene.model.globals.ArticlesModel
Return an article specified by its reference.
getArticle(String, String, String) - Method in class org.docgene.model.globals.ArticlesModel
Return an article specified by its reference.
getArticle(File) - Method in class org.docgene.model.globals.ArticlesModel
Return the article coresponding to a specified input file.
getArticle() - Method in class org.docgene.model.globals.InternalMenuItem
Return the referenced article.
getArticle() - Method in class org.docgene.model.OpaqueArticle
Return itself.
getArticle() - Method in class org.docgene.model.XMLArticle
Return itself.
getArticle() - Method in class org.docgene.model.XMLCommentList.ArticleComments
Return the article.
getArticle() - Method in class org.docgene.model.XMLDisambArticle
Return this.
getArticle() - Method in class org.docgene.model.XMLFallbackArticle
Return this.
getArticle() - Method in class org.docgene.model.XMLMap
Return the article in which this Map is used.
getArticle() - Method in class org.docgene.model.XMLMessageBox
Return the article in which this message box is used.
getArticle() - Method in class org.docgene.model.XMLRawHTMLArticle
Return itself.
getArticle() - Method in class org.docgene.model.XMLRedirect
Return the XMLArticle which is really accessed through this Article.
getArticle() - Method in class org.docgene.model.XMLResource
Return the article in which this resource reference is used.
getArticle() - Method in class org.docgene.model.XMLTodoList.ArticleTodos
Return the article.
getArticle() - Method in class org.docgene.model.XMLWord
Return the article.
getArticleParents() - Method in class org.docgene.model.AbstractXMLParentArticle
Return the articles which include this article.
getArticleParents() - Method in class org.docgene.model.OpaqueArticle
 
getArticleParents() - Method in interface org.docgene.model.XMLParentArticle
Return the articles which include this article.
getArticleParents() - Method in class org.docgene.model.XMLRawHTMLArticle
 
getArticleRef() - Method in interface org.docgene.model.ArticleReference
Return the associated reference.
getArticleRef() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the associated reference.
getArticleRef() - Method in class org.docgene.model.XMLArticle
Return the article ref.
getArticleRef() - Method in class org.docgene.model.XMLInclude
Return the associated reference.
getArticleRef() - Method in class org.docgene.model.XMLRedirect
Return the associated reference.
getArticleRef() - Method in class org.docgene.model.XMLReference
Return the associated reference.
getArticleRef() - Method in class org.docgene.model.XMLWord
Return the article ref.
getArticles() - Method in class org.docgene.model.globals.ArticleCategory
Return the articles in this category.
getArticles() - Method in class org.docgene.model.globals.ArticlesDictionary.Letter
Return the Map of articles for the letter.
getArticles() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the Map of articles for the letter.
getArticles() - Method in class org.docgene.model.globals.ArticlesModel
Return the articles without packages.
getArticlesByRef() - Method in class org.docgene.model.globals.ArticleCategory
Return the articles in this category, mapped by their ref.
getArticlesFilter() - Method in class org.docgene.main.Configuration
Return the articles filter.
getArticlesForFiles() - Method in class org.docgene.model.globals.ArticlesModel
Return the map from input file to article.
getArticlesIterator() - Method in class org.docgene.model.globals.ArticlesModel
Return an iterator on all the articles, including packages.
getArticlesMap() - Method in class org.docgene.model.globals.ArticlesModel
Return the Map of articles for each name, for all packages.
getArticlesMapByRef() - Method in class org.docgene.model.globals.ArticlesModel
Return the Map of articles for each article reference, for all packages.
getArticlesModel() - Method in class org.docgene.main.Configuration
Return the articles model.
getArticlesPerAllNames() - Method in class org.docgene.model.globals.ArticlesModel
Return the articles without packages.
getArticlesTOCThreshold() - Method in class org.docgene.main.Configuration
Return the threshold for each article Table of contents.
getArticlesToResolve() - Method in class org.docgene.model.globals.ArticlesCategories
Return the list of articles to resolve (may be null).
getArticleType() - Method in interface org.docgene.model.Article
Return the article type.
getArticleType() - Method in class org.docgene.model.OpaqueArticle
Return the article type.
getArticleType() - Method in class org.docgene.model.XMLArticle
Return the article type.
getArticleType() - Method in class org.docgene.model.XMLDisambArticle
Return the article type.
getArticleType() - Method in class org.docgene.model.XMLFallbackArticle
Return the article type.
getArticleType() - Method in class org.docgene.model.XMLIndex
Return the article type.
getArticleType() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article type.
getArticleType() - Method in class org.docgene.model.XMLRedirect
Return the article type.
getAttributes() - Method in class org.docgene.model.HTMLNode.Default
Return the attributes of the HTML node.
getAttributes() - Method in class org.docgene.model.HTMLNode.Empty
 
getAttributes() - Method in interface org.docgene.model.HTMLNode
Return the attributes of the HTML node.
getAuthor() - Method in class org.docgene.model.XMLCitation
Return the link reference author.
getAuthor() - Method in class org.docgene.model.XMLComment
Return the author.
getBackground() - Method in class org.docgene.main.Configuration
Return an image file to put in the background of the wiki.
getBackgroundColor() - Method in class org.docgene.model.AbstractStylableText
Return the html background color of the text.
getBackgroundColor() - Method in interface org.docgene.model.StylableText
Return the html background color of the text.
getBackgroundColor() - Method in class org.docgene.model.XMLSpan
Return the html background color of the text.
getBackgroundColor() - Method in class org.docgene.model.XMLTextStyle
Return the html background color of the text.
getBackgroundImage() - Method in class org.docgene.model.XMLMessageBox
Return the optional background imageDef.
getBackgroundOpacity() - Method in class org.docgene.main.Configuration
Return the background opacity.
getBackgroundPaint() - Method in class org.docgene.main.Configuration
Return the Paint to put in the background of the wiki.
getBorderColor() - Method in class org.docgene.model.XMLTree
Return the tree border color.
getBorderColor() - Method in class org.docgene.model.XMLTreeItem
Return the item border color.
getBorderType() - Method in interface org.docgene.model.BorderedElement
Return the element border type.
getBorderType() - Method in class org.docgene.model.XMLBlock
Return the block border type.
getBorderType() - Method in class org.docgene.model.XMLImage
Return the image border type.
getBorderType() - Method in class org.docgene.model.XMLPre
Return the pre block border type.
getBorderType() - Method in class org.docgene.model.XMLTree
Return the block border type.
getBorderType() - Method in class org.docgene.model.XMLTreeItem
Return the block border type.
getBottomBorderType() - Method in class org.docgene.model.XMLTableRow
Return the bottom border type.
getBulletStyle() - Method in class org.docgene.model.XMLList
Return the bullet style.
getCaption() - Method in class org.docgene.model.XMLImage
Return the image caption.
getCaption() - Method in class org.docgene.model.XMLInfobox
Return the infobox caption.
getCaption() - Method in class org.docgene.model.XMLMessageBox
Return the caption of the box (may be null if there is no caption).
getCaption() - Method in class org.docgene.model.XMLTable
Return the table caption.
getCaptionPositionType() - Method in class org.docgene.model.XMLMessageBox
Return the type of the positioning for the box caption.
getCategories() - Method in interface org.docgene.model.Article
Return the categories on which this article belongs.
getCategories() - Method in class org.docgene.model.globals.ArticlesCategories
Return the categories.
getCategories() - Method in class org.docgene.model.globals.ArticlesModel
Return the categories.
getCategories() - Method in class org.docgene.model.OpaqueArticle
Return the categories on which this article belongs.
getCategories() - Method in class org.docgene.model.XMLArticle
Return the categories on which this article belongs.
getCategories() - Method in class org.docgene.model.XMLDisambArticle
Return the categories on which this article belongs.
getCategories() - Method in class org.docgene.model.XMLFallbackArticle
Return null.
getCategories() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the categories on which this article belongs.
getCategories() - Method in class org.docgene.model.XMLRedirect
Return the categories on which this article belongs.
getCategoriesFiles() - Method in class org.docgene.model.globals.ArticlesModel
Return the categories Files.
getCategory(String) - Method in class org.docgene.model.globals.ArticlesCategories
Return the category with a specified ID.
getCategory(String) - Method in class org.docgene.model.globals.ArticlesModel
Return the category with a specified ID.
getCategory() - Method in class org.docgene.model.XMLCategoryReference
Return the referenced article.
getCategoryReference() - Method in class org.docgene.model.XMLExtendedImage
Return the category reference on the image.
getCategoryReference() - Method in class org.docgene.model.XMLImage
Return the category reference on the image.
getCell(int) - Method in class org.docgene.model.XMLTableRow
Return the cell at a specified index.
getCells() - Method in class org.docgene.model.XMLTableRow
Return the cells in the table row.
getChapters() - Method in class org.docgene.model.AbstractXMLParent
Return the element children chapters.
getChapters() - Method in class org.docgene.model.OpaqueArticle
 
getChapters() - Method in class org.docgene.model.XMLDiv
Return null.
getChapters() - Method in interface org.docgene.model.XMLParent
Return the element children chapters.
getChapters() - Method in class org.docgene.model.XMLRawHTMLArticle
 
getChildren() - Method in class org.docgene.model.HTMLNode.Default
Return the chidren elements, which can be children nodes or HTML character content.
getChildren() - Method in class org.docgene.model.HTMLNode.Empty
 
getChildren() - Method in interface org.docgene.model.HTMLNode
Return the chidren elements, which can be children nodes or HTML character content.
getClassName() - Method in class org.docgene.model.XMLPythonAPI
Return the API class name.
getColor() - Method in class org.docgene.model.AbstractStylableText
Return the html color of the text.
getColor() - Method in interface org.docgene.model.StylableText
Return the html color of the text.
getColor() - Method in class org.docgene.model.XMLMessageBox
Return the message box background color.
getColor() - Method in class org.docgene.model.XMLSpan
Return the html color of the text.
getColor() - Method in class org.docgene.model.XMLTableCell
Return the cell background color.
getColor() - Method in class org.docgene.model.XMLTableRow
Return the row background color.
getColor() - Method in class org.docgene.model.XMLTextStyle
Return the html color of the text.
getColSpan() - Method in class org.docgene.model.XMLTableCell
Return the cell column span.
getColumn(XMLTableCell) - Method in class org.docgene.model.XMLTable
Return the column associated with a cell.
getColumns() - Method in class org.docgene.model.XMLTableHeader
Return the columns in the header.
getColumnWidth() - Method in class org.docgene.model.XMLTableColumn
Return the column width (-1 is the width is not fixed)
getComment() - Method in class org.docgene.model.XMLComment
Return the comment.
getCommentList() - Method in class org.docgene.model.globals.ArticlesModel
Return the comment list.
getComments() - Method in class org.docgene.model.XMLCommentList
Return the comments sorted by article id.
getComments() - Method in class org.docgene.model.XMLTodoList.ArticleTodos
Return the comments.
getCommentsDatabaseScript() - Method in class org.docgene.main.Configuration
Return the search Database script.
getCommentsScript() - Method in class org.docgene.main.Configuration
Return the comments script.
getConcreteImage() - Method in class org.docgene.model.XMLImage
Return the associated concrete Image.
getCondition() - Method in class org.docgene.model.AbstractXMLParentArticle
Return the condition for the article.
getConditionElementsList() - Method in interface org.docgene.model.ListElement
Return the list of elements for a condition.
getConditionElementsList() - Method in interface org.docgene.model.TreeElement
Return the list of elements for a condition.
getConditionElementsList() - Method in class org.docgene.model.XMLTableRow
Return the list of elements for a condition.
getConditionUniqueElement() - Method in interface org.docgene.model.ListElement
Return the unique element for a condition.
getConditionUniqueElement() - Method in class org.docgene.model.XMLTableRow
Return the unique element for a condition.
getConditionUniqueElement() - Method in class org.docgene.model.XMLTree
Return the unique element for a condition.
getConditionUniqueElement() - Method in class org.docgene.model.XMLTreeItem
Return the unique element for a condition.
getConfiguration() - Method in class org.docgene.api.DocGeneratorAPI
Return the configuration.
getConstructors() - Method in class org.docgene.model.XMLIncludedAPI
Return the list of constructors.
getContent() - Method in class org.docgene.model.HTMLCharacters
Return the character content.
getContext(String) - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the word context for an article.
getCoords() - Method in class org.docgene.model.ImageMap.Area
Return the coordinates of the area.
getCoordsAsString() - Method in class org.docgene.model.ImageMap.Area
Return the coordinates as a String.
getCount() - Method in class org.docgene.main.Configuration
Return the number of articles.
getCount() - Method in class org.docgene.model.globals.ArticleCategory
Return the number of articles in the category.
getCustomMenu() - Method in class org.docgene.model.XMLMenu
Return the additional custom HTML menu.
getCustomSearchCategories() - Method in class org.docgene.api.DocGeneratorAPI
Return the custom search categories.
getCustomSearchSchema() - Method in class org.docgene.main.Configuration
Return the custom search Schema.
getCustomSearchSpec() - Method in class org.docgene.main.Configuration
Return the specification used for the custom search option type.
getCustomStyles() - Method in class org.docgene.model.AbstractLink
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.AbstractStyledElement
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the element custom classes.
getCustomStyles() - Method in interface org.docgene.model.StyledElement
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLBlock
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLBlockquote
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLChapter
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLIncludedAPI
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLList
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLListItem
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLReference
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLTable
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLTree
Return the element custom classes.
getCustomStyles() - Method in class org.docgene.model.XMLTreeItem
Return the element custom classes.
getDate() - Method in class org.docgene.main.Configuration
Returns the date of the distribution.
getDate() - Method in class org.docgene.model.XMLCitation
Return the link reference date.
getDate() - Method in class org.docgene.model.XMLComment
Return the date.
getDate() - Method in class org.docgene.model.XMLDate
Return the date.
getDate2() - Method in class org.docgene.model.XMLDate
Return the second date.
getDateAndTime() - Method in class org.docgene.model.XMLDate
Return a localized version of the delta between the two dates.
getDeclaration() - Method in interface org.docgene.model.StyledElement
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLAnchor
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLAPIDoc
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLAPIDocElement
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLArchiveURL
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLAudio
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLBasicNote
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLBlock
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLBlockquote
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLBox
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLBreak
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLChapter
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLCitation
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLCode
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLComment
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLCommentList
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLCondition
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLDate
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLDiv
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLDotNetAPI
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLDoxygenAPI
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLEmptyLine
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLExternalLink
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLHR
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLHTMLElement
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLImage
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLInclude
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLIncludedAPI
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLJavaAPI
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLList
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLListItem
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLMailLink
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLMap
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLMediawikiLink
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLMessageBox
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLMoreInfo
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLMoreInfoRef
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLParagraph
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLPre
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLPythonAPI
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLQtAPI
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLReference
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLResource
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLSeeAlso
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLSeeAlsoHeading
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLSeeArticle
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLSentence
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLSpan
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTab
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTable
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTableCell
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTableColumn
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTableHeader
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTableRow
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTerm
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTitle
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTodo
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTodoList
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTree
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLTreeItem
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLVideo
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLWikipediaLink
Return the declaration ID of the element.
getDeclaration() - Method in class org.docgene.model.XMLWord
Return the declaration ID of the element.
getDefaultAPIDocsURL() - Method in class org.docgene.main.Configuration
Return the URL specifying the default APIs documentation specification.
getDefaultCategory() - Method in class org.docgene.model.globals.ArticlesCategories
The default category is the category of articles which belong to no category.
getDefaultCategory() - Method in class org.docgene.model.globals.ArticlesModel
The default category is the category of articles which belong to no category.
getDefaultContent() - Method in class org.docgene.model.OpaqueArticle
Return the default content for the opaque article.
getDefaultFontFace() - Method in class org.docgene.api.DocGeneratorAPI
Return the default font face for sentences.
getDefaultFontSize() - Method in class org.docgene.api.DocGeneratorAPI
Return the default font size for sentences.
getDefaultHTTPLinksTimeOut() - Method in class org.docgene.main.Configuration
Return the default timeout for accessing HTTP links.
getDefaultStyleSheetTheme() - Method in class org.docgene.main.Configuration
Return the default StyleSheet theme.
getDefinition() - Method in class org.docgene.model.XMLInfobox
Return the infobox associated definition.
getDependenciesFile() - Method in class org.docgene.main.Configuration
Return the package dependencies File.
getDependenciesSchema() - Method in class org.docgene.main.Configuration
Return the package dependencies Schema.
getDesc() - Method in interface org.docgene.model.ArticleReference
Return the reference text.
getDesc() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the word.
getDesc() - Method in class org.docgene.model.XMLCategoryReference
Return the reference text.
getDesc() - Method in class org.docgene.model.XMLGlossaryReference
Return the reference text.
getDesc() - Method in class org.docgene.model.XMLInclude
Return the reference text.
getDesc() - Method in class org.docgene.model.XMLRedirect
Return the reference text.
getDesc() - Method in class org.docgene.model.XMLReference
Return the reference text.
getDescription(XMLParentArticle, String) - Method in class org.docgene.model.AbstractMoreInfoRef
Return the description associated to an ID and an article.
getDescription() - Method in class org.docgene.model.AlternateTitle
Return the title description.
getDescription() - Method in interface org.docgene.model.Article
Return the article description.
getDescription() - Method in class org.docgene.model.globals.AbstractMenuItem
Return the menu item description.
getDescription() - Method in class org.docgene.model.globals.ArticleCategory
Return the category description.
getDescription() - Method in class org.docgene.model.OpaqueArticle
Return the article description.
getDescription() - Method in class org.docgene.model.XMLArticle
Return the article description.
getDescription() - Method in class org.docgene.model.XMLDisambArticle
Return the article description.
getDescription() - Method in class org.docgene.model.XMLFallbackArticle
Return the article title.
getDescription() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article description.
getDescription() - Method in class org.docgene.model.XMLRedirect
Return the article description.
getDescription(XMLParentArticle, String) - Method in class org.docgene.model.XMLReference
Return the description associated to an ID and an article.
getDescription(XMLParentArticle, String) - Method in class org.docgene.model.XMLSeeArticle
Return the description associated to an ID and an article.
getDictionary() - Method in class org.docgene.model.globals.ArticlesDictionary
Return the Map of articles sorted by their first letter.
getDictionary() - Method in class org.docgene.model.globals.ArticlesModel
Return the articles glossary.
getDictionaryFile() - Method in class org.docgene.model.globals.ArticlesModel
Return the dictionary File.
getDisambArticle(ArticleRef) - Method in class org.docgene.model.globals.ArticlesModel
Return the disambiguation article corresponding to an article reference.
getDisambArticle(String) - Method in class org.docgene.model.globals.ArticlesModel
Return the disambiguation article for a specified description.
getDisambArticles() - Method in class org.docgene.model.globals.ArticlesModel
Add the Map of disambiguation articles.
getDisambArticles() - Method in class org.docgene.model.XMLDisambArticle
Return the disambiguated articles.
getDisambElements() - Method in class org.docgene.model.XMLDisambArticle
Return a disambiguation elements.
getDocElements(String) - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the map of API doc elements of a specified name.
getDocElementsAsList(String) - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the list of API doc elements of a specified name.
getDocElementsList() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the ordered list of API elements specifications, including only those which are present.
getDocument() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the document.
getEffectiveWidth() - Method in class org.docgene.model.XMLTableColumn
Return the column effective width, if the width is specified for a column element.
getElasticLunrScript() - Method in class org.docgene.main.Configuration
Return the ElasticLunr script.
getElement(int) - Method in interface org.docgene.model.ParagraphElementParent
Return the nth of child element.
getElement() - Method in class org.docgene.model.XMLImage
Return the element in which this image reference is used.
getElementDefinitionFiles() - Method in class org.docgene.model.globals.ArticlesModel
Return the elements definition Files.
getElements() - Method in class org.docgene.model.AbstractParagraph
Return the list of elements.
getElements() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the list of elements.
getElements() - Method in interface org.docgene.model.ParagraphElementParent
Return the list of children elements.
getElements() - Method in class org.docgene.model.XMLBox
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLChapter
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLCode
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLIfCondition
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLIfListCondition
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLIncludedAPI
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLIncludedAPIArgument
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLInfobox.BaseProperty
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLInfobox
 
getElements() - Method in class org.docgene.model.XMLList
Return the list of children elements.
getElements() - Method in class org.docgene.model.XMLListItem
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLPre
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLTable
 
getElements() - Method in class org.docgene.model.XMLTableCell
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLTerm
Return the list of elements.
getElements() - Method in class org.docgene.model.XMLTextStyle
Return the list of children elements.
getElements() - Method in class org.docgene.model.XMLTree
Return the list of children elements.
getElements() - Method in class org.docgene.model.XMLTreeItem
Return the list of elements.
getElementsList() - Method in interface org.docgene.model.TreeElement
Return the list of elements.
getElementSpecification() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the element specification.
getElementType() - Method in class org.docgene.model.XMLIncludedAPI
Return the element type as a String.
getElementTypeName() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the element type name.
getElseCondition() - Method in class org.docgene.model.XMLCondition
Return the else condition.
getEmptyLinesType() - Method in class org.docgene.main.Configuration
Return the way empty lines are dumped.
getErrorHandler() - Method in class org.docgene.main.Configuration
Return the error handler which will be used to create and store errors or informations during the parsing.
getErrorsViewerType() - Method in class org.docgene.main.Configuration
Return the editor or browser to open error files.
getExtensionType() - Method in class org.docgene.model.XMLExtendedImage
Return the extension type.
getExtensionType() - Method in class org.docgene.model.XMLImage
Return the extension type.
getExternalLink() - Method in class org.docgene.model.XMLExtendedImage
Return the external link on the image.
getExternalLink() - Method in class org.docgene.model.XMLImage
Return the external link on the image.
getExternalLink() - Method in class org.docgene.model.XMLInfobox.BaseProperty
 
getFallbackArticle(char) - Method in class org.docgene.model.globals.ArticlesModel
Return a fallback article.
getFields() - Method in class org.docgene.model.XMLIncludedAPI
Return the map of fields.
getFieldsAsList() - Method in class org.docgene.model.XMLIncludedAPI
Return the map of fields as a map of lists.
getFile() - Method in class org.docgene.model.XMLHeader
Return the additional header output file.
getFillColor() - Method in class org.docgene.model.XMLTree
Return the tree background color.
getFillColor() - Method in class org.docgene.model.XMLTreeItem
Return the item background color.
getFirstArticle(String, boolean) - Method in class org.docgene.model.globals.ArticlesModel
Return the first article specified by its reference, regardless of the package in which the article is defined.
getFirstArticle(String) - Method in class org.docgene.model.globals.ArticlesModel
Return the first article specified by its reference, regardless of the package in which the article is defined.
getFirstElement() - Method in interface org.docgene.model.ParagraphElementParent
Return the first element of null if there are no children elements.
getFirstRow(ArticlesModel) - Method in class org.docgene.model.XMLTable
Return the first row.
getFontFace() - Method in class org.docgene.model.AbstractStylableText
Return the font face of the text.
getFontFace() - Method in interface org.docgene.model.StylableText
Return the font face of the text.
getFontFace() - Method in class org.docgene.model.XMLSpan
Return the font face of the text.
getFontFace() - Method in class org.docgene.model.XMLTextStyle
Return the font face of the text.
getFooter() - Method in class org.docgene.model.globals.ArticlesModel
Return the articles footer.
getForkParserSplit() - Method in class org.docgene.main.Configuration
Return the number of files which should be used to split the parsing.
getFrameFile() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article frame HTML file.
getFullTextSearch() - Method in class org.docgene.model.globals.ArticlesModel
Return the articles full text search.
getFullTextSearchCompressionLevel() - Method in class org.docgene.main.Configuration
Return the full text search compression level (default is 1, to have an average size).
getFullTextSearchDatabase() - Method in class org.docgene.main.Configuration
Return the Full Text Search Database.
getFullTextSearchDatabaseScript() - Method in class org.docgene.main.Configuration
Return the full text search search Database Script.
getFullTextSearchScript() - Method in class org.docgene.main.Configuration
Return the Full Text Search Script.
getGenerationExceptions() - Method in class org.docgene.api.DocGeneratorAPI
Return the parsing or consistency exceptions.
getGlossary() - Method in class org.docgene.model.globals.ArticlesGlossary
Return the Map of letters.
getGlossary() - Method in class org.docgene.model.globals.ArticlesModel
Return the articles glossary.
getHeader() - Method in interface org.docgene.model.Article
Construct the header text for the article.
getHeader(boolean) - Method in interface org.docgene.model.Article
Construct the header text for the article.
getHeader() - Method in class org.docgene.model.globals.ArticlesModel
Return the articles header.
getHeader(boolean) - Method in class org.docgene.model.OpaqueArticle
Construct the header text for the article.
getHeader() - Method in class org.docgene.model.OpaqueArticle
Construct the header text for the article.
getHeader(boolean) - Method in class org.docgene.model.XMLArticle
Construct the header text for the article.
getHeader() - Method in class org.docgene.model.XMLArticle
Construct the header text for the article.
getHeader(boolean) - Method in class org.docgene.model.XMLDisambArticle
Construct the header text for the redirect article.
getHeader(boolean) - Method in class org.docgene.model.XMLFallbackArticle
Construct the header text for the article.
getHeader(boolean) - Method in class org.docgene.model.XMLRawHTMLArticle
Construct the header text for the article.
getHeader() - Method in class org.docgene.model.XMLRawHTMLArticle
Construct the header text for the article.
getHeader(boolean) - Method in class org.docgene.model.XMLRedirect
Construct the header text for the redirect article.
getHeight() - Method in class org.docgene.model.XMLImage
Return the image height.
getHeight() - Method in class org.docgene.model.XMLMap
Return the Map height.
getHeight() - Method in class org.docgene.model.XMLVideo
Return the image height.
getHeightType() - Method in class org.docgene.model.XMLImage
Return the image height type.
getHelpContent() - Method in class org.docgene.main.Configuration
Return the output directory for the wiki.
getHelpContentDeclaration() - Method in class org.docgene.main.Configuration
Return the HelpContentDeclaration content.
getHelpContentSchema() - Method in class org.docgene.main.Configuration
Return the help content definition Schema.
getHelpFile() - Method in class org.docgene.main.Configuration
Return the help file.
getHelpFileName() - Method in class org.docgene.main.Configuration
Return the help file name.
getHelpPageWidth() - Method in class org.docgene.main.Configuration
Return the page width used for specifying the images width for the help content.
getHelpSystem() - Method in class org.docgene.main.Configuration
Return the HelpSystem.
getHighlightScript() - Method in class org.docgene.main.Configuration
Return the highlight script.
getHighlightScriptURL() - Method in class org.docgene.main.Configuration
Return the highlight script URL.
getHRef() - Method in interface org.docgene.model.ImageReference
Return the image href File.
getHRef() - Method in class org.docgene.model.XMLImage
Return the image path.
getHRef() - Method in class org.docgene.model.XMLMessageBox
Return the image path.
getHTTPLinksThreadTimeOut() - Method in class org.docgene.main.Configuration
Return the timeout for the background thread executor used for checking http links.
getHTTPLinksThreadTimePool() - Method in class org.docgene.main.Configuration
Return the size of the Thread pool used for checking http links.
getID() - Method in interface org.docgene.model.AnchorElement
Return the anchored element ID.
getID() - Method in interface org.docgene.model.Article
Return the article ID.
getID() - Method in class org.docgene.model.ArticleRef
Return the article id.
getID() - Method in class org.docgene.model.globals.ArticleCategory
Return the category ID.
getID() - Method in class org.docgene.model.globals.ArticlesCategories
 
getID() - Method in class org.docgene.model.globals.ArticlesDictionary
 
getID() - Method in class org.docgene.model.globals.ArticlesGlossary
 
getID() - Method in class org.docgene.model.globals.InternalMenuItem
Return the other article reference ID.
getID() - Method in interface org.docgene.model.NoteContent
Return the node ID.
getID() - Method in class org.docgene.model.OpaqueArticle
Return the article ID.
getID() - Method in class org.docgene.model.XMLAnchor
Return the ID of the anchor.
getID() - Method in class org.docgene.model.XMLArticle
Return the article ID.
getID() - Method in class org.docgene.model.XMLBasicNote
Return the node ID.
getID() - Method in class org.docgene.model.XMLCategoryReference
Return the referenced category ID.
getID() - Method in class org.docgene.model.XMLChapter
Return the chapter id.
getID() - Method in class org.docgene.model.XMLCitation
Return the node ID.
getID() - Method in class org.docgene.model.XMLDisambArticle
Return the article ID.
getID() - Method in class org.docgene.model.XMLFallbackArticle
 
getID() - Method in class org.docgene.model.XMLFooter
 
getID() - Method in class org.docgene.model.XMLHeader
 
getID() - Method in class org.docgene.model.XMLInfobox
Return the infobox ID.
getID() - Method in class org.docgene.model.XMLListItem
Return the optional "li" element ID.
getID() - Method in class org.docgene.model.XMLNoteRef
Return the anchored element ID.
getID() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article ID.
getID() - Method in class org.docgene.model.XMLRedirect
Return the article ID.
getID() - Method in class org.docgene.model.XMLResource
Return the referenced resource ID.
getID() - Method in class org.docgene.model.XMLTerm
Return the anchored element ID.
getID() - Method in class org.docgene.model.XMLTitle
Return the title id.
getID() - Method in class org.docgene.model.XMLWord
Return the ID of the anchor.
getIfCondition() - Method in class org.docgene.model.XMLCondition
Return the if condition.
getImage(String) - Method in class org.docgene.model.globals.ArticlesModel
Return the image of a specified id.
getImage(String, String, String) - Method in class org.docgene.model.globals.ArticlesModel
Return the image of a specified id and package.
getImage() - Method in interface org.docgene.model.ImageReference
Return the associated image definition.
getImage() - Method in class org.docgene.model.XMLImage
Return the associated image definition.
getImage() - Method in class org.docgene.model.XMLMessageBox
Return the associated imageDef definition.
getImageDefinitionSchema() - Method in class org.docgene.main.Configuration
Return the images definitions Schema.
getImageDimension() - Method in class org.docgene.model.XMLImage
Return the underlying image dimension (ie the width and height).
getImageForAllPackages(String) - Method in class org.docgene.model.globals.ArticlesModel
Return the image of a specified id (for all packages).
getImageID() - Method in interface org.docgene.model.ImageReference
Return the image reference ID.
getImageID() - Method in class org.docgene.model.XMLImage
Return the image reference ID.
getImageID() - Method in class org.docgene.model.XMLMessageBox
Return the imageDef reference ID.
getImageMap() - Method in class org.docgene.model.XMLExtendedImage
Return the image image Map (can be null).
getImageMap() - Method in class org.docgene.model.XMLImage
Return null.
getImageReferenceDimension() - Method in class org.docgene.model.XMLImage
Return the underlying image reference dimension (ie the width and height).
getImages() - Method in class org.docgene.model.globals.ArticlesModel
Return the image resources.
getIncludes() - Method in class org.docgene.model.XMLArticle
Return the list of included articles or templates.
getIncludes() - Method in interface org.docgene.model.XMLParentArticle
Return the list of included articles or templates.
getIncrementalGenerationFile() - Method in class org.docgene.main.Configuration
Return the incremental generation state file.
getIndex() - Method in class org.docgene.api.DocGeneratorAPI
Return the index.
getIndex() - Method in class org.docgene.main.Configuration
Return the alternate index File.
getIndex() - Method in class org.docgene.model.globals.ArticlesModel
Return the index article.
getIndex() - Method in interface org.docgene.model.NoteContent
Return the node index.
getIndex() - Method in interface org.docgene.model.ReviewElement
Return the element index.
getIndex() - Method in class org.docgene.model.XMLBasicNote
Return the node index.
getIndex() - Method in class org.docgene.model.XMLCitation
Return the node index.
getIndex() - Method in class org.docgene.model.XMLComment
Return the comment index.
getIndex() - Method in class org.docgene.model.XMLMessageBox
Return the todo index.
getIndex() - Method in class org.docgene.model.XMLTodo
Return the todo index.
getIndexGenerationType() - Method in class org.docgene.main.Configuration
Return the index file generation type.
getInfobox(String) - Method in class org.docgene.model.globals.ArticlesModel
Return the infobox definition of a specified id and package.
getInfobox(String, String, String) - Method in class org.docgene.model.globals.ArticlesModel
Return the infobox definition of a specified id and package.
getInfoBoxDefinitionSchema() - Method in class org.docgene.main.Configuration
Return the resources definitions Schema.
getInfoboxes() - Method in class org.docgene.model.globals.ArticlesModel
Return the infobox definitions.
getInfoboxes() - Method in class org.docgene.model.XMLArticle
Return the list of infoboxes.
getInfoboxes() - Method in interface org.docgene.model.XMLParentArticle
Return the list of infoboxes.
getInfos() - Method in class org.docgene.model.XMLMoreInfo
Return the children references.
getInlinedStyle() - Method in class org.docgene.model.AbstractStyledElement
Return the element custom inline style.
getInlinedStyle() - Method in interface org.docgene.model.StyledElement
Return the element custom inline style.
getInlinedStyle() - Method in class org.docgene.model.XMLReference
Return the element custom inline style.
getInlinedStyle() - Method in class org.docgene.model.XMLTable
Return the element custom inline style.
getInputCommentsScript() - Method in class org.docgene.main.Configuration
Return the input comments script.
getInputDirs() - Method in class org.docgene.main.Configuration
Return the input directories for the wiki.
getInputFile() - Method in class org.docgene.model.globals.ArticleCategory
Return the category input XML file.
getInputFile() - Method in class org.docgene.model.globals.ArticlesCategories
 
getInputFile() - Method in class org.docgene.model.globals.ArticlesDictionary
Return the dictionnary input XML file.
getInputFile() - Method in class org.docgene.model.globals.ArticlesGlossary
Return the glossary input XML file.
getInputFile() - Method in class org.docgene.model.HeaderElement
Return the element input XML file.
getInputFile() - Method in class org.docgene.model.OpaqueArticle
Return the article input XML file.
getInputFile() - Method in class org.docgene.model.XMLArticle
Return the article input XML file.
getInputFile() - Method in class org.docgene.model.XMLDisambArticle
Return the article input XML file.
getInputFile() - Method in class org.docgene.model.XMLFallbackArticle
Return the article input XML file.
getInputFile() - Method in class org.docgene.model.XMLImage
Return the input File for the image.
getInputFile() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article input XML file.
getInputFile() - Method in class org.docgene.model.XMLRedirect
Return the article input XML file.
getInputFile() - Method in class org.docgene.model.XMLResource
Return the input File for the resource.
getInputFullTextSearchScript() - Method in class org.docgene.main.Configuration
Return the full text search script.
getInputSearchScript() - Method in class org.docgene.main.Configuration
Return the Search script.
getInputURL() - Method in class org.docgene.model.XMLImage
Return the input URL for the image.
getInstance() - Static method in class org.docgene.main.Configuration
Return the unique instance.
getInstance() - Static method in class org.docgene.model.globals.Localization
Return the unique instance.
getInstance() - Static method in class org.docgene.model.HTMLNode.Empty
 
getInstance() - Static method in class org.docgene.model.XMLCommentList
 
getInstance() - Static method in class org.docgene.model.XMLTodoList
 
getItems(ArticlesModel) - Method in class org.docgene.model.XMLList
Return the list elements in the list.
getItems(ArticlesModel) - Method in class org.docgene.model.XMLTree
Return the tree elements in the list.
getItems() - Method in class org.docgene.model.XMLTreeItem
Return the list elements in the tree.
getJavaAPILangClasses() - Method in class org.docgene.main.Configuration
Return the list of classes in the API lang package for the javadoc api.
getJQueryScript() - Method in class org.docgene.main.Configuration
Return the jQuery script.
getJQueryTableSorterScript() - Method in class org.docgene.main.Configuration
Return the jQuery table sorter script.
getJQueryUICSS() - Method in class org.docgene.main.Configuration
Return the jQuery UI CSS.
getJQueryUIScript() - Method in class org.docgene.main.Configuration
Return the jQueryUI script.
getJustification() - Method in class org.docgene.main.Configuration
Return the justification of the elements.
getJustification() - Method in interface org.docgene.model.JustifiedElement
Return the justification of the element.
getJustification() - Method in class org.docgene.model.XMLArticle
Return the justification of the article.
getJustification() - Method in class org.docgene.model.XMLChapter
Return the justification of the element.
getJustification() - Method in class org.docgene.model.XMLDiv
Return the justification of the element.
getJustification() - Method in class org.docgene.model.XMLParagraph
Return the justification of the element.
getKey() - Method in class org.docgene.model.XMLInfobox.Property
Return the property key.
getLang() - Method in class org.docgene.model.XMLWikipediaLink
Return the link lang.
getLanguage() - Method in class org.docgene.model.XMLIncludedAPI
Return the API language.
getLastElement() - Method in interface org.docgene.model.ParagraphElementParent
Return the last element of null if there are no children elements.
getLastParagraph(XMLParent) - Method in class org.docgene.api.DocGeneratorAPI
Return the ladt paragraph of an elemen, or creates one paragraph if it does not exist.
getLastTextElement() - Method in class org.docgene.model.XMLTextStyle
Return the last text element.
getLatitudeCenter() - Method in class org.docgene.model.XMLMap
Return the map center latitude.
getLeaderLineScript() - Method in class org.docgene.main.Configuration
Return the LeaderLine script.
getLeaderLineScriptURL() - Method in class org.docgene.main.Configuration
Return the LeaderLine script URL.
getLeftImage() - Method in class org.docgene.model.HeaderElement
Return the associated left image.
getLeftIndexMenu() - Method in class org.docgene.main.Configuration
Return the additional left index menu for the wiki.
getLeftMenuSchema() - Method in class org.docgene.main.Configuration
Return the left menu Schema.
getLeftText() - Method in class org.docgene.model.XMLHeader
Return the header left Text.
getLevel() - Method in interface org.docgene.model.TitledElement
Return the titled element level.
getLevel() - Method in class org.docgene.model.XMLBlockquote
Return the blockquote level.
getLevel() - Method in class org.docgene.model.XMLChapter
Return the chapter level.
getLevel() - Method in class org.docgene.model.XMLTitle
Return the title level.
getLightboxScript() - Method in class org.docgene.main.Configuration
Return the Lightbox script.
getLightboxScriptURL() - Method in class org.docgene.main.Configuration
Return the Lightbox script URL.
getLimit() - Method in class org.docgene.main.Configuration
Return the maximum number of articles in the same directory.
getLineNumber() - Method in class org.docgene.model.AbstractLink
Return the line where the reference appear.
getLineNumber() - Method in interface org.docgene.model.ElementReference
Return the line where the reference appear.
getLineNumber() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return -1.
getLineNumber() - Method in class org.docgene.model.XMLCategoryReference
Return the line where the reference appear.
getLineNumber() - Method in class org.docgene.model.XMLImage
Return the line where the reference appear.
getLineNumber() - Method in class org.docgene.model.XMLInclude
Return the line where the reference appear.
getLineNumber() - Method in class org.docgene.model.XMLMailLink
Return the line where the reference appear.
getLineNumber() - Method in class org.docgene.model.XMLMessageBox
Return the line where the reference appear.
getLineNumber() - Method in class org.docgene.model.XMLRedirect
Return the line where the reference appear.
getLineNumber() - Method in class org.docgene.model.XMLReference
Return the line where the reference appear.
getLineNumber() - Method in class org.docgene.model.XMLResource
Return the line where the reference appear.
getLinksFrom() - Method in class org.docgene.model.AbstractXMLParentArticle
Return the articles from which there is a reference to this article.
getLinksFrom() - Method in class org.docgene.model.OpaqueArticle
 
getLinksFrom() - Method in interface org.docgene.model.XMLParentArticle
Return the articles from which there is a reference to this article.
getLinksFrom() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the articles from which there is a reference to this article.
getLinksFromFile() - Method in class org.docgene.model.OpaqueArticle
Return the article links from HTML file.
getLinksFromFile() - Method in class org.docgene.model.XMLArticle
Return the article links from HTML file.
getLinksFromFile() - Method in class org.docgene.model.XMLDisambArticle
Return the article links from HTML file.
getLinksFromFile() - Method in class org.docgene.model.XMLFallbackArticle
Return null.
getLinksFromFile() - Method in interface org.docgene.model.XMLParentArticle
Return the article links from HTML file.
getLinksFromFile() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article links from HTML file.
getList() - Method in class org.docgene.model.XMLCommentList
Return the comment list as a "ol" element.
getList() - Method in class org.docgene.model.XMLTodoList
Return the todo list as a "ol" element.
getLocale() - Method in class org.docgene.model.globals.Localization
Return the Localization associated Locale.
getLocalization() - Method in class org.docgene.model.globals.Localization
Return the Localization.
getLocalLinksOption() - Method in class org.docgene.main.Configuration
Return the accept option for local links.
getLocationDir() - Method in class org.docgene.main.Configuration
Return the location directory of the library.
getLongitudeCenter() - Method in class org.docgene.model.XMLMap
Return the map center lontitude.
getMail() - Method in class org.docgene.model.XMLMailLink
Return the mail.
getMapID() - Method in class org.docgene.model.XMLMap
Return the ID of the Map in its article.
getMapResizerScript() - Method in class org.docgene.main.Configuration
Return the map resizer script.
getMapResizerScriptURL() - Method in class org.docgene.main.Configuration
Return the map resizer script URL.
getMaps() - Method in interface org.docgene.model.Article
Return the list of maps in the article.
getMaps() - Method in class org.docgene.model.XMLArticle
Return the list of maps in the article.
getMargin() - Method in class org.docgene.model.XMLImage
Return the associated Image margin.
getMathFormulaHandler() - Method in class org.docgene.main.Configuration
Return the custom Math formula handler.
getMathFormulaLoader() - Method in class org.docgene.main.Configuration
Return the Classloader for the Math formula parser jar.
getMaxIndex() - Method in class org.docgene.model.XMLDisambArticle
Return the maximum index of articles which have the name of this disambiguation article.
getMember() - Method in class org.docgene.model.AbstractAPI
Return the API member.
getMember() - Method in class org.docgene.model.APIMember
Return the member.
getMemberDeclaration() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the member method declaration.
getMemberPath() - Method in class org.docgene.model.AbstractAPI
Return the API member.
getMenuItems() - Method in class org.docgene.model.XMLMenu
Return the menu items.
getMenus() - Method in class org.docgene.api.DocGeneratorAPI
Return the articles menus.
getMenus() - Method in class org.docgene.model.globals.ArticlesModel
Return the articles menus.
getMessageBoxes() - Method in class org.docgene.model.XMLArticle
Return the message boxes.
getMessageBoxes() - Method in interface org.docgene.model.XMLParentArticle
Return the message boxes.
getMeta() - Method in interface org.docgene.model.Article
Return the meta description to be used for the article for the dictionnary or categories.
getMeta() - Method in class org.docgene.model.OpaqueArticle
Return the meta description to be used for the article for the dictionnary or categories.
getMeta() - Method in class org.docgene.model.XMLArticle
Return the meta description to be used for the article for the dictionnary or categories.
getMeta() - Method in class org.docgene.model.XMLDisambArticle
Return the meta description to be used for the article for the dictionnary or categories.
getMeta() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the meta description to be used for the article for the dictionnary or categories.
getMeta() - Method in class org.docgene.model.XMLRedirect
Return the meta description to be used for the article for the dictionnary or categories.
getMethods() - Method in class org.docgene.model.XMLIncludedAPI
Return the map of methods.
getModel() - Method in class org.docgene.api.DocGeneratorAPI
Return the model.
getModel() - Method in class org.docgene.model.globals.ArticleCategory
Return the articles model.
getModel() - Method in class org.docgene.model.globals.ArticlesDictionary
Return the articles model.
getModel() - Method in class org.docgene.model.globals.ArticlesGlossary
Return the articles model.
getModifierAndType() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the member modifier and type.
getModifiers() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the modifiers.
getModifiers() - Method in class org.docgene.model.XMLAPIDoc
Return the modifiers.
getModifiers() - Method in class org.docgene.model.XMLAPIDocElement
Return the modifiers.
getModifiers() - Method in class org.docgene.model.XMLIncludedAPI
Return the modifiers.
getModifiers() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the modifiers.
getModule() - Method in class org.docgene.model.XMLJavaAPI
Return the module.
getName() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the member name.
getName() - Method in class org.docgene.model.APIMember.Argument
 
getName(String) - Method in class org.docgene.model.globals.Localization
Return the name for a key.
getName() - Method in class org.docgene.model.HTMLNode.Default
Return the Node name.
getName() - Method in class org.docgene.model.HTMLNode.Empty
 
getName() - Method in interface org.docgene.model.HTMLNode
Return the Node name.
getName() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the member name.
getNamedSize() - Method in class org.docgene.model.AbstractStylableText
Return the HTML named size of the text.
getNamedSize() - Method in interface org.docgene.model.StylableText
Return the HTML named size of the text.
getNamedSize() - Method in class org.docgene.model.XMLSpan
Return the HTML named size of the text.
getNamedSize() - Method in class org.docgene.model.XMLTextStyle
Return the HTML named size of the text.
getNonExistingDesc(Article) - Method in class org.docgene.model.globals.ArticlesModel
Return a description which is not used for an article.
getNormalizedAlternateTitles() - Method in interface org.docgene.model.Article
Return the normalized article alternate titles.
getNote(String) - Method in class org.docgene.model.XMLArticle
Return the note of a specified ID.
getNote() - Method in class org.docgene.model.XMLNoteRef
Return the note.
getNoteID() - Method in class org.docgene.model.XMLNoteRef
Return the id of the note reference.
getNoteIndex() - Method in class org.docgene.model.XMLNoteRef
Return the index of the note reference.
getNoteReferences() - Method in interface org.docgene.model.NoteContent
Return the list of note references which refer to this note.
getNoteReferences() - Method in class org.docgene.model.XMLBasicNote
 
getNoteReferences() - Method in class org.docgene.model.XMLCitation
 
getNotes() - Method in interface org.docgene.model.Article
Return the notes.
getNotes() - Method in class org.docgene.model.XMLArticle
Return the notes.
getNotes() - Method in interface org.docgene.model.XMLParentArticle
Return the notes.
getNotesByID() - Method in class org.docgene.model.XMLArticle
Return the notes sorted by their ID.
getNotesTooltipsLength() - Method in class org.docgene.main.Configuration
Return the text length of the notes tooltips.
getNotNullURL() - Method in interface org.docgene.model.ExternalLink
Return a not null link URL.
getNotNullURL() - Method in class org.docgene.model.XMLArchiveURL
Return a not null link URL.
getNumericSize() - Method in class org.docgene.model.AbstractStylableText
Return the numeric size of the text.
getNumericSize() - Method in interface org.docgene.model.StylableText
Return the numeric size of the text.
getNumericSize() - Method in class org.docgene.model.XMLSpan
Return the numeric size of the text.
getNumericSize() - Method in class org.docgene.model.XMLTextStyle
Return the numeric size of the text.
getOpaqueArticle(String) - Method in class org.docgene.api.DocGeneratorAPI
Return the opaque article of a specified description.
getOpenLayerScript() - Method in class org.docgene.main.Configuration
Return the OpenLayer script.
getOrCreateLastParagraphParent(XMLArticle) - Method in class org.docgene.api.DocGeneratorAPI
Return the last paragraph parent for an article, or create one if it does not exist.
getOriginalLink(String) - Method in class org.docgene.model.XMLArchiveURL
Return the original article link.
getOriginalLink() - Method in class org.docgene.model.XMLArchiveURL
Return the original article link.
getOriginArticle() - Method in class org.docgene.model.XMLCategoryReference
Return the article which emit the reference.
getOriginArticle() - Method in class org.docgene.model.XMLGlossaryReference
Return the article which emit the reference.
getOriginArticle() - Method in class org.docgene.model.XMLInclude
Return the article which emit the reference.
getOriginArticle() - Method in class org.docgene.model.XMLReference
Return the article which emit the reference.
getOtherText() - Method in class org.docgene.model.XMLSeeAlsoHeading
Return the SeeAlso associated text for the destination article.
getOuputDirectory() - Method in class org.docgene.main.Configuration
Return the output directory for the wiki.
getOuputDirectoryURL() - Method in class org.docgene.main.Configuration
Return the output directory URL for the wiki.
getOutputDirectory() - Method in class org.docgene.api.DocGeneratorAPI
Return the output directory.
getOutputFile() - Method in class org.docgene.model.globals.ArticleCategory
Return the category description output file.
getOutputFile() - Method in class org.docgene.model.globals.ArticlesCategories
 
getOutputFile() - Method in class org.docgene.model.globals.ArticlesDictionary
Return the dictionnary output file.
getOutputFile() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the HTML root element output file.
getOutputFile() - Method in interface org.docgene.model.HTMLOutput
Return the HTML root element output file.
getOutputFile() - Method in class org.docgene.model.OpaqueArticle
Return the article output HTML file.
getOutputFile() - Method in class org.docgene.model.XMLArticle
Return the article output HTML file.
getOutputFile() - Method in class org.docgene.model.XMLDisambArticle
Return the article output HTML file.
getOutputFile() - Method in class org.docgene.model.XMLFallbackArticle
Return the article output HTML file.
getOutputFile() - Method in class org.docgene.model.XMLHeader
Return the HTML root element output file.
getOutputFile() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article output HTML file.
getOutputPath() - Method in class org.docgene.model.XMLResource
Return the resource output path.
getOutputType() - Method in class org.docgene.main.Configuration
Return the output type.
getPackage() - Method in interface org.docgene.model.Article
Return the article package.
getPackage() - Method in class org.docgene.model.ArticleRef
Return the article package.
getPackage(String) - Method in class org.docgene.model.globals.ArticlesModel
Return the package of a specified name.
getPackage() - Method in class org.docgene.model.globals.InternalMenuItem
Return the article reference package.
getPackage() - Method in class org.docgene.model.HeaderElement
Return the article package.
getPackage() - Method in interface org.docgene.model.ImageReference
Return the image reference package.
getPackage() - Method in class org.docgene.model.OpaqueArticle
Return the article package.
getPackage() - Method in class org.docgene.model.XMLArticle
Return the article package.
getPackage() - Method in class org.docgene.model.XMLDisambArticle
Return null.
getPackage() - Method in class org.docgene.model.XMLFallbackArticle
Return the article package.
getPackage() - Method in class org.docgene.model.XMLImage
Return the image reference package.
getPackage() - Method in class org.docgene.model.XMLInclude
Return the included article package.
getPackage() - Method in class org.docgene.model.XMLInfobox
Return the infobox reference package.
getPackage() - Method in class org.docgene.model.XMLMessageBox
Return the imageDef reference package.
getPackage() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article package.
getPackage() - Method in class org.docgene.model.XMLRedirect
Return the article package.
getPackage() - Method in class org.docgene.model.XMLResource
Return the resource reference package.
getPackageDependencies() - Method in class org.docgene.main.Configuration
Return the package dependencies.
getPackages() - Method in class org.docgene.model.globals.ArticlesModel
Return the packages.
getPackageSchema() - Method in class org.docgene.main.Configuration
Return the package Schema.
getPackagesDependencies() - Method in class org.docgene.model.globals.ArticlesModel
Return the Packages Dependencies.
getPadding() - Method in class org.docgene.model.XMLTable
Return the padding of the table rows.
getPageRankIterations() - Method in class org.docgene.main.Configuration
Return the PageRank algorithm number of iterations.
getPageRankMaxIterations() - Method in class org.docgene.main.Configuration
Return the PageRank algorithm maximum number of iterations.
getPageRanks() - Method in class org.docgene.model.globals.ArticlesModel
Return the computed PageRanks.
getPageRankSearch() - Method in class org.docgene.main.Configuration
Return the PageRank algorithm option.
getPageRankSearchConvergeDelta() - Method in class org.docgene.main.Configuration
Return the delta value for the PageRank algorithm convergence.
getParagraphs() - Method in class org.docgene.model.AbstractXMLParent
Return the element children paragraphs.
getParagraphs() - Method in class org.docgene.model.OpaqueArticle
 
getParagraphs() - Method in class org.docgene.model.XMLDiv
Return null.
getParagraphs() - Method in interface org.docgene.model.XMLParent
Return the element children paragraphs.
getParagraphs() - Method in class org.docgene.model.XMLRawHTMLArticle
 
getParent() - Method in class org.docgene.model.globals.ArticleCategory
Return null.
getParent() - Method in class org.docgene.model.globals.ArticlesDictionary
Return null.
getParent() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return null.
getParent() - Method in class org.docgene.model.HeaderElement
Return null.
getParent() - Method in class org.docgene.model.OpaqueArticle
Return null.
getParent() - Method in interface org.docgene.model.TreeElement
Return the parent.
getParent() - Method in class org.docgene.model.XMLAPIDocElement
Return the parent element.
getParent() - Method in class org.docgene.model.XMLArticle
Return null.
getParent() - Method in class org.docgene.model.XMLChapter
Return the chapter parent.
getParent() - Method in class org.docgene.model.XMLDisambArticle
Return null.
getParent() - Method in class org.docgene.model.XMLDiv
Return null.
getParent() - Method in class org.docgene.model.XMLFallbackArticle
Return null.
getParent() - Method in interface org.docgene.model.XMLParent
Return the element parent.
getParent() - Method in class org.docgene.model.XMLRawHTMLArticle
 
getParent() - Method in class org.docgene.model.XMLTree
 
getParent() - Method in class org.docgene.model.XMLTreeItem
 
getParentAPI() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the parent API.
getParentList() - Method in interface org.docgene.model.ListElement
Return the parent list.
getParentList() - Method in class org.docgene.model.XMLList
Return the parent list.
getParentList() - Method in class org.docgene.model.XMLListItem
Return the parent list.
getParentStyle() - Method in class org.docgene.model.AbstractStylableText
Return the parent style.
getParentStyle() - Method in interface org.docgene.model.StylableText
Return the parent style.
getParentStyle() - Method in class org.docgene.model.XMLSpan
Return null.
getParentTree() - Method in interface org.docgene.model.TreeElement
Return the parent tree.
getParentTree() - Method in class org.docgene.model.XMLTree
 
getParentTree() - Method in class org.docgene.model.XMLTreeItem
 
getParentType() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the element parent type.
getParsedArticles() - Method in class org.docgene.model.globals.ArticlesModel
Return the parsed articles.
getPath() - Method in class org.docgene.model.AbstractAPI
Return the API link path.
getPath() - Method in class org.docgene.model.AbstractWikiLink
Return the link path.
getPath() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the path.
getPath() - Method in interface org.docgene.model.ExternalLink
Return the link path.
getPath() - Method in class org.docgene.model.XMLAudio
Return the link path.
getPath() - Method in class org.docgene.model.XMLExternalLink
Return the link path.
getPath() - Method in class org.docgene.model.XMLIncludedAPI
Return the path.
getPath() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the path.
getPath() - Method in class org.docgene.model.XMLResource
Return the resource path.
getPath() - Method in class org.docgene.model.XMLVideo
Return the link path.
getPreFile() - Method in class org.docgene.model.XMLPre
Return the File associated with the pre element.
getPreScrollingType() - Method in class org.docgene.main.Configuration
Return the default scrolling type.
getPreventExitType() - Method in class org.docgene.main.Configuration
Return how the program must exit.
getPreviousTitleIndex() - Method in class org.docgene.model.XMLInclude
Return the index of the title or chapter preceding the include element (0 means that there is no title or chapter before the include element).
getProjection() - Method in class org.docgene.model.XMLMap
Return the map projection.
getProperties() - Method in class org.docgene.model.XMLInfobox
Return the infobox properties.
getProperty(String) - Method in class org.docgene.model.XMLInfobox
Return the property of a specified key.
getProxyConfiguration() - Method in class org.docgene.main.Configuration
Return the Proxy configuration.
getPublisher() - Method in class org.docgene.model.XMLCitation
Return the link reference publisher.
getQuote() - Method in class org.docgene.model.XMLCitation
Return the noteRef associated quote.
getRankedArticles() - Method in class org.docgene.model.globals.ArticlesModel
Return all the articles including those from the packages, possibly takning the page ranks into accounts.
getRawHTMLContent() - Method in interface org.docgene.model.HTMLRootElement
Return the raw HTML content.
getRawHTMLFile() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the article raw HTML file.
getReason() - Method in interface org.docgene.model.TodoElement
Return the reason of the TODO.
getReason() - Method in class org.docgene.model.XMLMessageBox
Return the reason of the TODO.
getReason() - Method in class org.docgene.model.XMLTodo
Return the reason of the TODO.
getRef() - Method in interface org.docgene.model.Article
Return the article ref.
getRef() - Method in interface org.docgene.model.NoteContent
Return the node reference composed using the node index.
getRef() - Method in class org.docgene.model.OpaqueArticle
Return the article ref.
getRef() - Method in interface org.docgene.model.ReviewElement
Return the element reference.
getRef() - Method in class org.docgene.model.XMLComment
Return the comment reference composed using the comment index.
getRef() - Method in class org.docgene.model.XMLMessageBox
Return the todo reference composed using the todo index.
getRef() - Method in class org.docgene.model.XMLTodo
Return the todo reference composed using the todo index.
getReference() - Method in class org.docgene.model.ImageMap.Area
Return the reference.
getReference() - Method in class org.docgene.model.XMLExtendedImage
Return the reference on the image.
getReference() - Method in class org.docgene.model.XMLImage
Return the reference on the image.
getReferencedArticle() - Method in interface org.docgene.model.ArticleReference
Return the referenced article.
getReferencedArticle() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the referenced article.
getReferencedArticle() - Method in class org.docgene.model.XMLInclude
Return the referenced article.
getReferencedArticle() - Method in class org.docgene.model.XMLRedirect
Return the XMLArticle which is really accessed through this Article.
getReferencedArticle() - Method in class org.docgene.model.XMLReference
Return the referenced article.
getReferences() - Method in class org.docgene.model.AbstractXMLParentArticle
Return the references used in the article.
getReferences() - Method in interface org.docgene.model.Article
Return the references used in the article.
getReferences() - Method in class org.docgene.model.OpaqueArticle
Return the references used in the article.
getReferences() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the references used in the article.
getReferences() - Method in class org.docgene.model.XMLRedirect
Return the references used in the article.
getReferenceToDisambArticles() - Method in class org.docgene.model.globals.ArticlesModel
Return the map from article reference to the associated disambiguation article.
getReferTo() - Method in class org.docgene.model.XMLIndex
Return the article id on which the index is referring to.
getReferToArticle() - Method in class org.docgene.model.XMLIndex
Set the article on which the index is referring to.
getRefID() - Method in interface org.docgene.model.ArticleReference
Return the other article reference ID.
getRefID() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the other article reference ID.
getRefID() - Method in class org.docgene.model.XMLInclude
Return the other article reference ID.
getRefID() - Method in class org.docgene.model.XMLRedirect
Return the referenced article ID.
getRefID() - Method in class org.docgene.model.XMLReference
Return the other article reference ID.
getRefPackage() - Method in interface org.docgene.model.ArticleReference
Return the article reference package.
getRefPackage() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return null.
getRefPackage() - Method in class org.docgene.model.XMLRedirect
Return the referenced article package.
getRefPackage() - Method in class org.docgene.model.XMLReference
Return the article reference package.
getRelativePath() - Method in class org.docgene.model.OpaqueArticle
Return the relative path of the article XML file, from the associated root.
getRelativePath() - Method in class org.docgene.model.XMLArticle
Return the relative path of the article XML file, from the associated root.
getRepresentation() - Method in class org.docgene.model.APIMember.Argument
 
getResource(String, String, String) - Method in class org.docgene.model.globals.ArticlesModel
Return the resource of a specified id and package.
getResource() - Method in class org.docgene.model.XMLResource
Return the associated resource definition.
getResourceDefinitionSchema() - Method in class org.docgene.main.Configuration
Return the resources definitions Schema.
getResourceDirectory() - Method in class org.docgene.main.Configuration
Return the resource directory.
getResources() - Method in class org.docgene.model.globals.ArticlesModel
Return the resources.
getResourcesGenerationType() - Method in class org.docgene.main.Configuration
Return the resources file generation type.
getReviewElements() - Method in class org.docgene.model.XMLArticle
Return the review elements.
getReviewElements() - Method in class org.docgene.model.XMLCommentList.ArticleComments
Return the review elements.
getReviewElements() - Method in interface org.docgene.model.XMLParentArticle
Return the review elements.
getRightIndexMenu() - Method in class org.docgene.main.Configuration
Return the additional right index menu for the wiki.
getRightText() - Method in class org.docgene.model.XMLHeader
Return the header right text.
getRoot() - Method in class org.docgene.model.AbstractXMLParentArticle
Return the root directory.
getRoot() - Method in class org.docgene.model.globals.ArticleCategory
Return the root directory.
getRoot() - Method in class org.docgene.model.globals.ArticlesCategories
Return null.
getRoot() - Method in class org.docgene.model.globals.ArticlesDictionary
Return the root directory.
getRoot() - Method in class org.docgene.model.HeaderElement
Return the root directory.
getRoot() - Method in class org.docgene.model.OpaqueArticle
Return the root directory.
getRoot() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the root directory.
getRoot() - Method in class org.docgene.model.XMLRedirect
Return the root directory.
getRootElementType() - Method in interface org.docgene.model.Article
Return the RootElement.ARTICLE type.
getRootElementType() - Method in class org.docgene.model.globals.ArticleCategory
Return the RootElement.CATEGORY type.
getRootElementType() - Method in class org.docgene.model.globals.ArticlesCategories
Return the RootElement.CATEGORIES type.
getRootElementType() - Method in class org.docgene.model.globals.ArticlesDictionary
Return the RootElement.DICTIONARY type.
getRootElementType() - Method in class org.docgene.model.globals.ArticlesGlossary
Return the RootElement.GLOSSARY type.
getRootElementType() - Method in class org.docgene.model.XMLFooter
Return the RootElement.FOOTER type.
getRootElementType() - Method in class org.docgene.model.XMLHeader
Return the RootElement.HEADER type.
getRoots() - Method in interface org.docgene.model.HTMLRootElement
Return the root Nodes.
getRoots() - Method in class org.docgene.model.XMLHTMLElement
Return the root Nodes.
getRowIndex() - Method in class org.docgene.model.XMLTableCell
Return the index of the cell in the row.
getRows(ArticlesModel) - Method in class org.docgene.model.XMLTable
Return the rows in the table.
getRowSpan() - Method in class org.docgene.model.XMLTableCell
Return the cell row span.
getSchema() - Method in class org.docgene.main.Configuration
Return the articles Schema.
getScrollingType() - Method in class org.docgene.model.XMLPre
Return the scrolling type.
getSearchableTitles() - Method in class org.docgene.model.XMLArticle
Return the map of Searchable titles.
getSearchableTitles() - Method in interface org.docgene.model.XMLParentArticle
Return the map of Searchable titles.
getSearchableTitles() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the map of Searchable titles.
getSearchDatabaseScript() - Method in class org.docgene.main.Configuration
Return the search Database script.
getSearchLimit() - Method in class org.docgene.main.Configuration
Return the search limit.
getSearchScript() - Method in class org.docgene.main.Configuration
Return the Search script.
getSearchType() - Method in class org.docgene.main.Configuration
Return the search type.
getSeeAlso() - Method in class org.docgene.model.XMLArticle
Return the list of SeeAlso references.
getSeeAlso() - Method in interface org.docgene.model.XMLParentArticle
Return the list of SeeAlso references.
getSeeAlsoHeading() - Method in class org.docgene.model.XMLArticle
Return the SeeAlso in the heading if its exists.
getSeeAlsoHeading() - Method in interface org.docgene.model.XMLParentArticle
Return the SeeAlso in the heading if its exists.
getSeq() - Method in interface org.docgene.model.TitledElement
Return the titled element sequence id.
getSeq() - Method in class org.docgene.model.XMLChapter
Return the title sequence id.
getSeq() - Method in class org.docgene.model.XMLTitle
Return the title sequence id.
getShownPath() - Method in class org.docgene.model.AbstractAPI
Return the API shown path.
getSimpleMember() - Method in class org.docgene.model.APIMember
Return the member simple representation.
getSize() - Method in class org.docgene.model.AbstractStylableText
Return the size of the text.
getSize() - Method in interface org.docgene.model.StylableText
Return the size of the text.
getSize() - Method in class org.docgene.model.XMLSpan
Return the size of the text.
getSize() - Method in class org.docgene.model.XMLTextStyle
Return the size of the text.
getStartItem() - Method in class org.docgene.model.XMLList
Return the start item of an ordered (ol) list.
getState() - Method in class org.docgene.model.XMLInfobox.EnumProperty
Return the property state.
getStaticMapsTimeOut() - Method in class org.docgene.main.Configuration
Return the timeout for static maps.
getStringValue() - Method in class org.docgene.model.XMLDate
Return a localized version of the date or time.
getStyle() - Method in interface org.docgene.model.StylableText
Return the style class of the element.
getStyle() - Method in interface org.docgene.model.StyledElement
Return the style class of the element.
getStyle() - Method in class org.docgene.model.XMLAnchor
Return the style class of the element.
getStyle() - Method in class org.docgene.model.XMLReference
Return the style class of the element.
getStyle() - Method in class org.docgene.model.XMLSentence
Return the style class of the element.
getStyle() - Method in class org.docgene.model.XMLSpan
Return the style class of the element.
getStyleSheet() - Method in class org.docgene.main.Configuration
Return the articles StyleSheet.
getStyleSheet() - Method in class org.docgene.model.globals.ArticlesModel
Return the output StyleSheet file.
getStyleSheetTheme() - Method in class org.docgene.main.Configuration
Return the articles StyleSheet theme.
getStyleSheetTheme() - Method in class org.docgene.model.globals.ArticlesModel
Return the output StyleSheet theme file..
getSuffix() - Method in interface org.docgene.model.Article
Return the article name suffix (used for articles which have the name of an already existing article).
getSuffix() - Method in class org.docgene.model.OpaqueArticle
Return the article name suffix (used for articles which have the name of an already existing article).
getSuffix() - Method in class org.docgene.model.XMLArticle
Return the article name suffix (used for articles which have the name of an already existing article).
getSuffix() - Method in class org.docgene.model.XMLRedirect
Return the article name suffix (used for articles which have the name of an already existing article).
getSyntax() - Method in class org.docgene.model.XMLPre
Return the pre syntax.
getSyntaxType() - Method in class org.docgene.model.XMLArticle
Return the article syntax type.
getTableHeader() - Method in class org.docgene.model.XMLTable
Return the table header.
getTerm() - Method in class org.docgene.model.XMLTerm
 
getText() - Method in class org.docgene.model.AbstractAPI
Return the link description text.
getText() - Method in class org.docgene.model.AbstractWikiLink
Return the link description text.
getText() - Method in interface org.docgene.model.ExternalLink
Return the link description text.
getText() - Method in interface org.docgene.model.ReviewElement
Return the text of the element.
getText() - Method in interface org.docgene.model.StylableText
Return the text.
getText() - Method in interface org.docgene.model.TodoElement
Return the text of the TODO.
getText() - Method in class org.docgene.model.XMLAnchor
Return the anchor text.
getText() - Method in class org.docgene.model.XMLAudio
Return null.
getText() - Method in class org.docgene.model.XMLCitation
Return the link description text.
getText() - Method in class org.docgene.model.XMLComment
Return the text of the comment.
getText() - Method in class org.docgene.model.XMLExternalLink
Return the link description text.
getText() - Method in class org.docgene.model.XMLFooter
Return the footer text.
getText() - Method in class org.docgene.model.XMLJavaAPI
Return the link description text.
getText() - Method in class org.docgene.model.XMLMailLink
Return the mail description text.
getText() - Method in class org.docgene.model.XMLResource
Return the resource text.
getText() - Method in class org.docgene.model.XMLSeeAlso
Return the SeeAlso associated text
getText() - Method in class org.docgene.model.XMLSentence
Return the text.
getText() - Method in class org.docgene.model.XMLSpan
Return the text.
getText() - Method in class org.docgene.model.XMLVideo
Return null.
getText() - Method in class org.docgene.model.XMLWord
Return the text.
getThisText() - Method in class org.docgene.model.XMLSeeAlsoHeading
Return the SeeAlso associated text for the origin article.
getTime() - Method in class org.docgene.model.XMLDate
Return a localized version of the delta between the two dates.
getTimeOuts() - Method in class org.docgene.main.Configuration
Return the list of URLs with specific timeouts.
getTimeOutsFile() - Method in class org.docgene.main.Configuration
Return the XML file specifying the URLs TimeOuts.
getTimeOutsSchema() - Method in class org.docgene.main.Configuration
Return the timeouts Schema.
getTimestamp() - Method in class org.docgene.model.XMLArchiveURL
Return the time stamp.
getTitle() - Method in interface org.docgene.model.AnchorElement
Return the titled element title.
getTitle() - Method in interface org.docgene.model.Article
Return the article description by default.
getTitle() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the word title.
getTitle() - Method in interface org.docgene.model.TitledElement
Return the title.
getTitle() - Method in class org.docgene.model.XMLChapter
Return the chapter title.
getTitle() - Method in class org.docgene.model.XMLDisambArticle
Return the article title.
getTitle() - Method in class org.docgene.model.XMLTitle
Return the title title.
getTitledElementsList() - Method in class org.docgene.model.XMLArticle
Return the ordered list of titled elements (chapters or titles).
getTitledElementsList() - Method in interface org.docgene.model.XMLParentArticle
Return the ordered list of titled elements (chapters or titles).
getTitlesOrIncludes() - Method in class org.docgene.model.XMLArticle
Return the list of titles and XMLInclude elements.
getTitleWithSequence() - Method in interface org.docgene.model.TitledElement
Return the title, possibly associated with the title forced sequence.
getTodoList() - Method in class org.docgene.model.globals.ArticlesModel
Return the TODO list.
getTodos() - Method in class org.docgene.model.XMLTodoList
Return the non empty todos sorted by article id.
getTopBorderType() - Method in class org.docgene.model.XMLTableRow
Return the top border type.
getTransitiveArticle(String, String, String) - Method in class org.docgene.model.globals.ArticlesModel
Return the concrete article for a specified id and package.
getTrimmedLeftLength() - Method in class org.docgene.model.XMLPre
Return the length of the spaces before the pre on the same line.
getType() - Method in class org.docgene.model.AbstractStylableText
Return the font type of the text.
getType() - Method in class org.docgene.model.AbstractXMLAPIDoc
Return the element type.
getType() - Method in class org.docgene.model.globals.DefaultMenuItem
Return the menu item type.
getType() - Method in class org.docgene.model.ImageMap.Area
Return the type of the area.
getType() - Method in interface org.docgene.model.StylableText
Return the font type of the text.
getType() - Method in class org.docgene.model.XMLAudio
Return the audio type.
getType() - Method in class org.docgene.model.XMLComment
Return the type of the comment.
getType() - Method in class org.docgene.model.XMLDate
Return the type.
getType() - Method in class org.docgene.model.XMLFallbackArticle
Return the fallback article type.
getType() - Method in class org.docgene.model.XMLIncludedAPI
Return the element type.
getType() - Method in class org.docgene.model.XMLIncludedAPIMember
Return the element type.
getType() - Method in class org.docgene.model.XMLMessageBox
Return the message box type.
getType() - Method in class org.docgene.model.XMLSpan
Return the font type of the text.
getType() - Method in class org.docgene.model.XMLTextStyle
Return the font type of the text.
getType() - Method in class org.docgene.model.XMLVideo
Return the video type.
getUnparsableFiles() - Method in class org.docgene.model.globals.ArticlesModel
Return the unparsable files.
getURL() - Method in class org.docgene.model.AbstractAPI
Return the link URL.
getURL() - Method in class org.docgene.model.AbstractWikiLink
Return the link URL.
getURL() - Method in interface org.docgene.model.ExternalLink
Return the link URL.
getURL() - Method in class org.docgene.model.globals.ExternalMenuItem
Return the external link URL.
getURL() - Method in interface org.docgene.model.URLLinkElement
Return the link URL.
getURL() - Method in class org.docgene.model.XMLAudio
Return the link URL.
getURL() - Method in class org.docgene.model.XMLCitation
Return the link URL.
getURL() - Method in class org.docgene.model.XMLExternalLink
Return the link URL.
getURL() - Method in class org.docgene.model.XMLRawHTMLArticle
Return the URL.
getURL() - Method in class org.docgene.model.XMLVideo
Return the link URL.
getURLAsString(URL) - Method in interface org.docgene.model.ExternalLink
Return the link relative to a base URL.
getURLAsString(XMLParentArticle) - Method in interface org.docgene.model.ExternalLink
Return the path of the link relative to its article.
getURLAsString() - Method in interface org.docgene.model.ExternalLink
Return the complete link URL as a String.
getURLAsString() - Method in class org.docgene.model.XMLExternalLink
Return the complete link URL as a String.
getURLAsString() - Method in class org.docgene.model.XMLWikipediaLink
Return the complete link URL as a String.
getURLExceptions() - Method in class org.docgene.main.Configuration
Return the list of URLs which will not be checked for their validity and existence.
getURLExceptionsFile() - Method in class org.docgene.main.Configuration
Return the XML file specifying the URLs which will not be checked for their validity and existence.
getURLExceptionsSchema() - Method in class org.docgene.main.Configuration
Return the URLExceptions Schema.
getUserAgent() - Method in class org.docgene.main.Configuration
Return the user agent to access external links.
getValue() - Method in class org.docgene.model.XMLInfobox.Property
Return the property value.
getVersion() - Method in class org.docgene.main.Configuration
Returns the version of the distribution.
getVerticalAlignment() - Method in class org.docgene.model.XMLImage
Return the vertical alignment of the image.
getVideoURL() - Method in class org.docgene.model.XMLVideo
Return the link to the video.
getWidth() - Method in class org.docgene.model.XMLBox
Return the box width.
getWidth() - Method in class org.docgene.model.XMLImage
Return the image width.
getWidth() - Method in class org.docgene.model.XMLMap
Return the Map width.
getWidth(int) - Method in class org.docgene.model.XMLSizedTableRow
Return the specified width for one cell.
getWidth() - Method in class org.docgene.model.XMLTable
Return the table width.
getWidth(int) - Method in class org.docgene.model.XMLTableRow
Return the specified width for one cell.
getWidth() - Method in class org.docgene.model.XMLVideo
Return the image width.
getWidths() - Method in class org.docgene.model.XMLSizedTableRow
Return the row specified widths for its cells.
getWidths() - Method in class org.docgene.model.XMLTableRow
Return the row specified widths for its cells.
getWidthType() - Method in class org.docgene.model.XMLBox
Return true if the box width is limited to the content width.
getWiki() - Method in class org.docgene.model.XMLMediawikiLink
Return the mediawiki reference.
getWikiState() - Method in class org.docgene.model.globals.ArticlesModel
Return the object which hold the current state of the wiki
getWikiStateSchema() - Method in class org.docgene.main.Configuration
Return the wiki state Schema.
getWikiTitle() - Method in class org.docgene.main.Configuration
Return the wiki title.
getWikiTitle(XMLParentArticle) - Method in class org.docgene.main.Configuration
Return the wiki title, which will be shown in the index page and the articles.
getWikiTitle(String) - Method in class org.docgene.main.Configuration
Return the wiki title, which will be shown in non-article pages.
getWord(String) - Method in class org.docgene.model.globals.ArticlesGlossary.Letter
Return the word for a specified definition.
getWord() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return the word.
getWord() - Method in class org.docgene.model.XMLWord
Return the associated word.
getWordAnchors() - Method in class org.docgene.model.globals.ArticlesGlossary
Return the word anchors.
getWordAnchors() - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Return ther word anchors associated with the word.
getWords() - Method in class org.docgene.model.globals.ArticlesGlossary
Return the map of Words.
getWords() - Method in class org.docgene.model.globals.ArticlesGlossary.Letter
Return the Map of words for the letter.
getWriteInstruction() - Method in class org.docgene.model.XMLWord
Return the write instruction for the the word.
getXMLArticle(String) - Method in class org.docgene.api.DocGeneratorAPI
Return the article of a specified description.
getZoomLevel() - Method in class org.docgene.model.XMLMap
Return the map zoom level.
GLOSSARY - Static variable in class org.docgene.model.globals.DefaultMenuItem
The type for the GLOSSARY menu item.
GLOSSARY - Static variable in class org.docgene.model.globals.Localization
"glossary": The name for the glossary.
A B C D E F G H I J L M N O P R S T U V W X Y 
Skip navigation links

Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence