- SCROLLED - Static variable in interface org.docgene.model.PreScrollingType
-
The scrolled scrolling type.
- SEARCH - Static variable in class org.docgene.model.globals.Localization
-
"search": The name for the "Search..." text.
- SEARCH_CUSTOM - Static variable in interface org.docgene.model.globals.SearchOptions
-
The option for custom search categories.
- SEARCH_ON_ANCHORS - Static variable in interface org.docgene.model.globals.SearchOptions
-
The option for searching on articles and titles.
- SEARCH_ON_ARTICLES - Static variable in interface org.docgene.model.globals.SearchOptions
-
The option for searching only on articles.
- SEARCH_ON_TITLES - Static variable in interface org.docgene.model.globals.SearchOptions
-
The option for searching on articles and titles.
- SearchOptions - Interface in org.docgene.model.globals
-
The Search options.
- SEE - Static variable in class org.docgene.model.globals.Localization
-
"see": The name for the "For ..., see" text.
- SEEALSO - Static variable in class org.docgene.model.globals.Localization
-
"seealso": The name for the See Also chapter.
- SentenceStyle - Class in org.docgene.api
-
Represents a sentence style.
- SentenceStyle() - Constructor for class org.docgene.api.SentenceStyle
-
- setAbsoluteWidth(int) - Method in class org.docgene.model.XMLImage
-
Set the image absolute width.
- setAdditionalAPIDocs(File) - Method in class org.docgene.main.Configuration
-
Set the File specifying the additional APIs documentation specification.
- setAdditionalContent(List<String>) - Method in class org.docgene.model.XMLFooter
-
Set the optional footer additional content.
- setAdditionalCSS(File) - Method in class org.docgene.main.Configuration
-
Set an additional CSS file to use for the wiki.
- setAdditionalCSSOutput(File) - Method in class org.docgene.main.Configuration
-
Set an additional CSS file to use for the wiki.
- setAdditionalFooter(File) - Method in class org.docgene.main.Configuration
-
Set an additional content to use for the footer.
- setAdditionalScript(File) - Method in class org.docgene.main.Configuration
-
Set an additional script to use for the header.
- setAlignment(char) - Method in class org.docgene.main.Configuration
-
Set the alignment of the container elements.
- setAlignment(char) - Method in interface org.docgene.model.Alignment
-
Set the alignment.
- setAlignment(char) - Method in interface org.docgene.model.JustifiedElement
-
Set the alignment of the element.
- setAlignment(char) - Method in class org.docgene.model.XMLBox
-
Set the alignment of the box.
- setAlignment(char) - Method in class org.docgene.model.XMLChapter
-
Set the alignment of the element.
- setAlignment(char) - Method in class org.docgene.model.XMLDiv
-
Set the alignment of the element.
- setAlignment(char) - Method in class org.docgene.model.XMLImage
-
Set the alignment of the image.
- setAlignment(char) - Method in class org.docgene.model.XMLMap
-
Set the alignment of the Map.
- setAlignment(char) - Method in class org.docgene.model.XMLParagraph
-
Set the alignment of the element.
- setAlignment(char) - Method in class org.docgene.model.XMLTable
-
Set the alignment of the table.
- setAlignment(char) - Method in class org.docgene.model.XMLTableCell
-
Set the alignment of the cell.
- setAlignment(char) - Method in class org.docgene.model.XMLVideo
-
Set the alignment of the video.
- setAllowHTMLEntities(boolean) - Method in class org.docgene.main.Configuration
-
Set if HTML entities are allowed.
- setAltPath(String) - Method in class org.docgene.model.AbstractAPI
-
Set the API alternate path.
- setAPIPathType(short) - Method in class org.docgene.model.XMLJavaAPI
-
Set if the API link path type presentation.
- setAPIsFile(File) - Method in class org.docgene.main.Configuration
-
Set the XML file specifying the APIs.
- setAPIType(short) - Method in class org.docgene.model.XMLDotNetAPI
-
Set the API type.
- setAPIType(short) - Method in class org.docgene.model.XMLDoxygenAPI
-
Set the API type.
- setAPIType(short) - Method in class org.docgene.model.XMLJavaAPI
-
Set the type of the API.
- setAPIType(short) - Method in class org.docgene.model.XMLPythonAPI
-
Set the API type.
- setAPIType(short) - Method in class org.docgene.model.XMLQtAPI
-
Set the API type.
- setArgument(String) - Method in class org.docgene.model.XMLIncludedAPIArgument
-
Set the argument.
- setArticleNameAlreadyTaken(boolean) - Method in interface org.docgene.model.Article
-
Set if the article name was already taken, and the article was not added in the model.
- setArticleNameAlreadyTaken(boolean) - Method in class org.docgene.model.XMLArticle
-
Set if the article name was already taken, and the article was not added in the model.
- setArticleNameAlreadyTaken(boolean) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set if the article name was already taken, and the article was not added in the model.
- setArticlesModel(ArticlesModel) - Method in class org.docgene.main.Configuration
-
Set the articles model.
- setArticlesTOC(boolean) - Method in class org.docgene.main.Configuration
-
Set if each article must have a Table of contents by default.
- setArticlesTOCThreshold(int) - Method in class org.docgene.main.Configuration
-
Set the threshold for each article Table of contents.
- setAuthor(String) - Method in class org.docgene.model.XMLCitation
-
Set the link reference author.
- setAuthor(String) - Method in class org.docgene.model.XMLComment
-
Set the author.
- setAuthor(String) - Method in class org.docgene.model.XMLTodo
-
Set the author.
- setBackground(String) - Method in class org.docgene.api.SentenceStyle
-
Set the background color of the font.
- setBackground(File) - Method in class org.docgene.main.Configuration
-
Set an image file to put in the background of the wiki.
- setBackgroundColor(String) - Method in class org.docgene.model.AbstractStylableText
-
Set the html background color of the text.
- setBackgroundColor(String) - Method in class org.docgene.model.XMLSpan
-
Set the html background color of the text.
- setBackgroundColor(String) - Method in class org.docgene.model.XMLTextStyle
-
Set the html background color of the text.
- setBackgroundGlobal(boolean) - Method in class org.docgene.main.Configuration
-
Set true if the background is applied to all pages.
- setBackgroundOpacity(int) - Method in class org.docgene.main.Configuration
-
Set the background opacity.
- setBackgroundPaint(Paint) - Method in class org.docgene.main.Configuration
-
Set the Paint to put in the background of the wiki.
- setBorderColor(String) - Method in class org.docgene.model.XMLTree
-
Set the tree border color.
- setBorderColor(String) - Method in class org.docgene.model.XMLTreeItem
-
Set the item border color.
- setBorders(boolean) - Method in class org.docgene.model.XMLTable
-
Set if the table has borders.
- setBorders(boolean) - Method in class org.docgene.model.XMLTableRow
-
Set if the table cells of the row have borders.
- setBorderType(short) - Method in class org.docgene.model.XMLBlock
-
Set if the block border type.
- setBorderType(short) - Method in class org.docgene.model.XMLImage
-
Set if the image border type.
- setBorderType(short) - Method in class org.docgene.model.XMLPre
-
Set if the pre block border type.
- setBorderType(short) - Method in class org.docgene.model.XMLTree
-
Set if the block border type.
- setBorderType(short) - Method in class org.docgene.model.XMLTreeItem
-
Set if the block border type.
- setBottomBorderType(short) - Method in class org.docgene.model.XMLTableRow
-
Set the bottom border type.
- setBounds(double, double, int) - Method in class org.docgene.model.XMLMap
-
Set the map bounds.
- setBulletStyle(short) - Method in class org.docgene.model.XMLList
-
Set the bullet style.
- setCaption(String) - Method in class org.docgene.model.XMLImage
-
Set the image caption.
- setCaption(String, short) - Method in class org.docgene.model.XMLMessageBox
-
Set the message box caption.
- setCaption(String) - Method in class org.docgene.model.XMLTable
-
Set the table caption.
- setCategories(XMLArticle, String...) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the categories for an article.
- setCategories(Set<String>) - Method in class org.docgene.model.OpaqueArticle
-
Set the categories on which this article belongs.
- setCategories(Set<String>) - Method in class org.docgene.model.XMLArticle
-
Set the categories on which this article belongs.
- setCategories(Set<String>) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the categories on which this article belongs.
- setClassName(String) - Method in class org.docgene.model.XMLPythonAPI
-
Set the API class name.
- setClean(boolean) - Method in class org.docgene.main.Configuration
-
Set if the output directory is cleaned before the generation.
- setCodeHasBackground(boolean) - Method in class org.docgene.main.Configuration
-
Set true if the "code" and "source" elements have a background.
- setColor(String) - Method in class org.docgene.api.SentenceStyle
-
Set the color of the font.
- setColor(String) - Method in class org.docgene.model.AbstractStylableText
-
Set the html color of the text.
- setColor(String) - Method in class org.docgene.model.XMLMessageBox
-
Set the message box background color.
- setColor(String) - Method in class org.docgene.model.XMLSpan
-
Set the html color of the text.
- setColor(String) - Method in class org.docgene.model.XMLTableCell
-
Set the cell background color.
- setColor(String) - Method in class org.docgene.model.XMLTableRow
-
Set the row background color.
- setColor(String) - Method in class org.docgene.model.XMLTextStyle
-
Set the html color of the text.
- setColSpan(int) - Method in class org.docgene.model.XMLTableCell
-
Set the cell column span.
- setComment(String) - Method in class org.docgene.model.XMLComment
-
Set the comment.
- setCommentsDatabaseScript(File) - Method in class org.docgene.main.Configuration
-
Set the search Database Script.
- setCommentsScript(File) - Method in class org.docgene.main.Configuration
-
Set the comments Script.
- setCompact(boolean) - Method in class org.docgene.model.XMLAPIDoc
-
Set if the api should have a compact representation.
- setCondition(DefaultCondition) - Method in class org.docgene.model.AbstractXMLParentArticle
-
Set the condition for the article.
- setConstructor(boolean) - Method in class org.docgene.model.AbstractAPI
-
Set if the API desgins a constructor.
- setCustomMenu(List<String>) - Method in class org.docgene.model.XMLMenu
-
Set an additional custom HTML menu.
- setCustomSearchSpec(URL) - Method in class org.docgene.main.Configuration
-
Set the specification used for the custom search option type.
- setCustomStyles(StyledElement, String, String) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the custom styles for an element.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.AbstractLink
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.AbstractStyledElement
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.AbstractXMLAPIDoc
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in interface org.docgene.model.StyledElement
-
Set the element custom classes.
- setCustomStyles(String) - Method in interface org.docgene.model.StyledElement
-
Set the element custom styles.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLBlock
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLBlockquote
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLChapter
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLIncludedAPI
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLList
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLListItem
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLReference
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLTable
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLTree
-
Set the element custom classes.
- setCustomStyles(Set<String>) - Method in class org.docgene.model.XMLTreeItem
-
Set the element custom classes.
- setDate(String) - Method in class org.docgene.model.XMLCitation
-
Set the link reference date.
- setDate(String) - Method in class org.docgene.model.XMLComment
-
Set the date.
- setDate(Date) - Method in class org.docgene.model.XMLDate
-
Set the date.
- setDate(String) - Method in class org.docgene.model.XMLTodo
-
Set the date.
- setDate2(Date) - Method in class org.docgene.model.XMLDate
-
Set the second date.
- setDefaultContent(String) - Method in class org.docgene.model.OpaqueArticle
-
Set a default content for the opaque article.
- setDefaultContent(boolean) - Method in class org.docgene.model.XMLMenu
-
Set if the menu must have a default content.
- setDefaultFontFace(String) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the default font face for sentences.
- setDefaultFontSize(int) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the default font size for sentences.
- setDefaultHTTPLinksTimeOut(int) - Method in class org.docgene.main.Configuration
-
Set the default timeout for accessing HTTP links.
- setDependenciesFile(File) - Method in class org.docgene.main.Configuration
-
Set the package dependencies.
- setDesc(String) - Method in interface org.docgene.model.ArticleReference
-
Set the reference text.
- setDesc(String) - Method in class org.docgene.model.XMLCategoryReference
-
Set the reference text.
- setDesc(String) - Method in class org.docgene.model.XMLGlossaryReference
-
Set the reference text.
- setDesc(String) - Method in class org.docgene.model.XMLReference
-
Set the reference text.
- setDescription(String, String, boolean) - Method in interface org.docgene.model.Article
-
Set the article description.
- setDescription(String) - Method in class org.docgene.model.globals.ArticleCategory
-
Set the category description.
- setDescription(String, String, boolean) - Method in class org.docgene.model.OpaqueArticle
-
Set the article description.
- setDescription(String, String, boolean) - Method in class org.docgene.model.XMLArticle
-
Set the article description.
- setDescription(String, String, boolean) - Method in class org.docgene.model.XMLDisambArticle
-
Set the article description.
- setDescription(String, String, boolean) - Method in class org.docgene.model.XMLFallbackArticle
-
Set the article description.
- setDescription(String, String, boolean) - Method in class org.docgene.model.XMLIndex
-
Do nothing.
- setDescription(String, String, boolean) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the article description.
- setDescription(String, String, boolean) - Method in class org.docgene.model.XMLRedirect
-
Set the article description.
- setDictionaryFile(DictionaryFile) - Method in class org.docgene.model.globals.ArticlesModel
-
- setDocument(Document) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the document.
- setDuplicate(boolean) - Method in class org.docgene.model.XMLChapter
-
Set if the chapter is a duplicate of another existing title.
- setDuplicate(boolean) - Method in class org.docgene.model.XMLTitle
-
Set if the title is a duplicate of another existing title.
- setDynamicMaps(boolean) - Method in class org.docgene.main.Configuration
-
Set if the parser will use javascript dynamic maps (maps loaded by Javascript), or if it will generate images with the maps.
- setEffectiveWidth(String) - Method in class org.docgene.model.XMLTableColumn
-
Set the column effective width, if the width is specified for a column element.
- setElasticLunrScript(File) - Method in class org.docgene.main.Configuration
-
Set the ElasticLunr Script.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.AbstractParagraph
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.AbstractXMLAPIDoc
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in interface org.docgene.model.ParagraphElementParent
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLBox
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLChapter
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLCode
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLIncludedAPI
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLIncludedAPIArgument
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLIncludedAPIMember
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLInfobox.BaseProperty
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLInfobox
-
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLList
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLListItem
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLPre
-
Set the pre elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLTable
-
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLTableCell
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLTerm
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLTextStyle
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLTree
-
Set the list of elements.
- setElements(List<ParagraphElement>) - Method in class org.docgene.model.XMLTreeItem
-
Set the list of elements.
- setElseCondition(XMLIfCondition) - Method in class org.docgene.model.XMLCondition
-
Set the else condition.
- setEmptyDefaultContent() - Method in class org.docgene.model.OpaqueArticle
-
Set an empty default content for the opaque article.
- setEmptyLinesType(short) - Method in class org.docgene.main.Configuration
-
Set the way empty lines are dumped.
- setErrorHandler(XMLErrorHandler) - Method in class org.docgene.main.Configuration
-
Set the error handler which will be used to create and store errors or informations during the parsing.
- setErrorsViewerType(short) - Method in class org.docgene.main.Configuration
-
Set the editor or browser to open error files.
- setEscapeNonUTF8(boolean) - Method in class org.docgene.main.Configuration
-
Set if non UTF8 characters must be escaped.
- setFallbackArticle(XMLFallbackArticle) - Method in class org.docgene.model.globals.ArticlesModel
-
Set a fallback article.
- setFile(File) - Method in class org.docgene.model.XMLHeader
-
Set the additional header file.
- setFillColor(String) - Method in class org.docgene.model.XMLTree
-
Set the tree background color.
- setFillColor(String) - Method in class org.docgene.model.XMLTreeItem
-
Set the item background color.
- setFirstInLine(boolean) - Method in class org.docgene.model.AbstractJustifiedElement
-
Set if the image is the first element in its line.
- setFirstInLine(boolean) - Method in class org.docgene.model.XMLImage
-
Set if the image is the first element in its line.
- setFixedLayout(boolean) - Method in class org.docgene.model.XMLTable
-
Set if the table has a fixed layout.
- setFixedLeftMenuOptions(boolean) - Method in class org.docgene.main.Configuration
-
Set if the options in the left menu are always present (meaning that all options are present even for the page on which we are).
- setFixedMenuOptions(boolean) - Method in class org.docgene.model.XMLMenu
-
Set if the options in the menu are always present.
- setFloat(boolean) - Method in class org.docgene.model.XMLImage
-
Set if the image element should have the "float" attribute.
- setFloat(boolean) - Method in class org.docgene.model.XMLMap
-
Set if the map element should have the "float" attribute.
- setFloat(boolean) - Method in class org.docgene.model.XMLTable
-
Set if the table element should have the "float" attribute.
- setFontFace(String) - Method in class org.docgene.model.AbstractStylableText
-
Set the font face of the text.
- setFontFace(String) - Method in class org.docgene.model.XMLSpan
-
Set the font face of the text.
- setFontFace(String) - Method in class org.docgene.model.XMLTextStyle
-
Set the font face of the text.
- setFontFamily(String) - Method in class org.docgene.api.SentenceStyle
-
Set the family of the font.
- setFooter(String) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the footer of the wiki.
- setFooter(XMLFooter) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the articles footer.
- setForkParser(boolean) - Method in class org.docgene.main.Configuration
-
Set true if the parsing should use a fork-join pool to perform the parsing
- setForkParserSplit(int) - Method in class org.docgene.main.Configuration
-
Set the number of files which should be used to split the parsing
- setFound(boolean) - Method in class org.docgene.model.globals.ArticlesGlossary
-
Set if the glossary description was found.
- setFullTextSearch(boolean, int) - Method in class org.docgene.api.DocGeneratorAPI
-
Configure the full text search.
- setFullTextSearch(boolean) - Method in class org.docgene.main.Configuration
-
Set if there is a full text search.
- setFulltextSearch(FullTextSearch) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the full text search manager.
- setFullTextSearchCompressionLevel(int) - Method in class org.docgene.main.Configuration
-
Set the full text search compression level (default is 1, to have an average size).
- setFullTextSearchDatabase(File) - Method in class org.docgene.main.Configuration
-
Set the Full Text Search Database.
- setFullTextSearchDatabaseScript(File) - Method in class org.docgene.main.Configuration
-
Set the full text search search Database Script.
- setFullTextSearchRemoveAccents(boolean) - Method in class org.docgene.main.Configuration
-
Set if the full text search remove accents.
- setFullTextSearchScript(File) - Method in class org.docgene.main.Configuration
-
Set the Full Text Search Script.
- setFullTextSearchUseMetaphone(boolean) - Method in class org.docgene.main.Configuration
-
Set if the full text use the Metaphone algorithm.
- setGlobalIndex(boolean) - Method in class org.docgene.model.XMLIndex
-
Set if the index is the global index.
- setGlossary(ArticlesGlossary) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the articles glossary.
- setHasBackground(boolean) - Method in class org.docgene.model.XMLCode
-
Set if the code element has a background.
- setHasBackground(boolean) - Method in class org.docgene.model.XMLPre
-
Set if the pre element has a background.
- setHasCategories(boolean) - Method in class org.docgene.main.Configuration
-
Set if the wiki has categories.
- setHasColor(boolean) - Method in class org.docgene.model.XMLPre
-
Set if the pre has a specified background color.
- setHasDictionary(boolean) - Method in class org.docgene.main.Configuration
-
Set if the wiki has a dictionary.
- setHasImageMaps(boolean) - Method in class org.docgene.model.XMLArticle
-
Set if the article has image maps.
- setHasTitles() - Method in class org.docgene.model.globals.ArticlesModel
-
Set that the model has titles.
- setHeader(String) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the header of the wiki.
- setHeader(XMLHeader) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the articles header.
- setHeadless(boolean) - Method in class org.docgene.main.Configuration
-
Set if the generator must work in an headless environment.
- setHeight(int, boolean) - Method in class org.docgene.model.XMLImage
-
Set the image height.
- setHeight(int) - Method in class org.docgene.model.XMLMap
-
Set the Map height.
- setHeight(int) - Method in class org.docgene.model.XMLVideo
-
Set the video height.
- setHeightAsText() - Method in class org.docgene.model.XMLImage
-
Set the image height as the same height as the text.
- setHelpContent(File) - Method in class org.docgene.main.Configuration
-
Set the help content definition.
- setHelpContentDeclaration(HelpContentDeclaration) - Method in class org.docgene.main.Configuration
-
Set the HelpContentDeclaration content.
- setHelpFile(File) - Method in class org.docgene.main.Configuration
-
Set the help file.
- setHelpFileName(String) - Method in class org.docgene.main.Configuration
-
Set the help file name.
- setHelpOptimizedForSwing(boolean) - Method in class org.docgene.main.Configuration
-
Set if the help result should be optimized for Swing.
- setHelpPageWidth(int) - Method in class org.docgene.main.Configuration
-
Set the page width used for specifying the images width for the help content.
- setHelpSystem(HelpSystem) - Method in class org.docgene.main.Configuration
-
Set the HelpSystem.
- setHighlightScript(File) - Method in class org.docgene.main.Configuration
-
Set the highlight Script.
- setHorizontalBorders(boolean) - Method in class org.docgene.model.XMLTableRow
-
Set if the table cells of the row have horizontal borders.
- setHTTPLinksThreadPool(int) - Method in class org.docgene.main.Configuration
-
Set the size of the Thread pool used for checking http links.
- setHTTPLinksThreadTimeOut(int) - Method in class org.docgene.main.Configuration
-
Set the timeout for the background thread executor used for checking http links.
- setID(String) - Method in interface org.docgene.model.AnchorElement
-
Set the anchored element ID.
- setID(String) - Method in interface org.docgene.model.Article
-
Set the article ID.
- setID(String) - Method in class org.docgene.model.globals.ArticlesGlossary.Word
-
Set the word reference ID.
- setID(String) - Method in class org.docgene.model.globals.InternalMenuItem
-
Set the referenced article ID.
- setID(String) - Method in class org.docgene.model.OpaqueArticle
-
Set the article ID.
- setID(String) - Method in class org.docgene.model.XMLAnchor
-
Set the ID of the anchor.
- setID(String) - Method in class org.docgene.model.XMLArticle
-
Set the article ID.
- setID(String) - Method in class org.docgene.model.XMLBasicNote
-
Set the node ID
- setID(String) - Method in class org.docgene.model.XMLChapter
-
Set the chapter id.
- setID(String) - Method in class org.docgene.model.XMLCitation
-
Set the node ID
- setID(String) - Method in class org.docgene.model.XMLDisambArticle
-
Set the article ID.
- setID(String) - Method in class org.docgene.model.XMLFallbackArticle
-
Do nothing.
- setID(String) - Method in class org.docgene.model.XMLImage
-
Set the image ID.
- setID(String) - Method in class org.docgene.model.XMLListItem
-
Set the optional "li" element ID.
- setID(String) - Method in class org.docgene.model.XMLNoteRef
-
Do nothing.
- setID(String) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the article ID.
- setID(String) - Method in class org.docgene.model.XMLRedirect
-
Set the article ID.
- setID(String) - Method in class org.docgene.model.XMLTerm
-
Do nothing.
- setID(String) - Method in class org.docgene.model.XMLTitle
-
Set the title id.
- setID(String) - Method in class org.docgene.model.XMLWord
-
Set the ID of the anchor.
- setIECompatibilityEdge(boolean) - Method in class org.docgene.main.Configuration
-
Set if the compatibility mode for Internet Explorer is set to the highest value.
- setIfCondition(XMLIfCondition) - Method in class org.docgene.model.XMLCondition
-
Set the if condition.
- setImages() - Method in class org.docgene.model.AbstractXMLParentArticle
-
Set that this article has at least one image.
- setImages() - Method in interface org.docgene.model.Article
-
Set that this article has at least one image.
- setIncrementalGeneration(boolean) - Method in class org.docgene.main.Configuration
-
Set the incremental generation.
- setIncrementalGenerationFile(File) - Method in class org.docgene.main.Configuration
-
Set the incremental generation state file.
- setIndex(File) - Method in class org.docgene.main.Configuration
-
Set the alternate index File.
- setIndex(XMLIndex, String, boolean) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the model index.
- setIndex(XMLIndex, String) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the model index.
- setIndex(int) - Method in interface org.docgene.model.NoteContent
-
Set the node index.
- setIndex(int) - Method in class org.docgene.model.XMLBasicNote
-
Set the node index.
- setIndex(int) - Method in class org.docgene.model.XMLCitation
-
Set the node index.
- setIndex(int) - Method in class org.docgene.model.XMLComment
-
Set the comment index.
- setIndex(int) - Method in class org.docgene.model.XMLMessageBox
-
Set the todo index.
- setIndex(int) - Method in class org.docgene.model.XMLTodo
-
Set the todo index.
- setIndexGenerationType(char) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the index generation type.
- setIndexGenerationType(char) - Method in class org.docgene.main.Configuration
-
Set the index file generation type.
- setInFrame(boolean) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set if the article content is in a frame.
- setInlinedStyle(String) - Method in class org.docgene.model.AbstractStyledElement
-
Set the element custom inline style.
- setInlinedStyle(String) - Method in interface org.docgene.model.StyledElement
-
Set the element custom inline style.
- setInlinedStyle(String) - Method in class org.docgene.model.XMLReference
-
Set the element custom inline style.
- setInlinedStyle(String) - Method in class org.docgene.model.XMLTable
-
Set the element custom inline style.
- setInputDirs(File[]) - Method in class org.docgene.main.Configuration
-
Set the input directories for the wiki.
- setInputFile(File) - Method in class org.docgene.model.globals.ArticleCategory
-
Set the category input XML file.
- setInputFile(File) - Method in class org.docgene.model.globals.ArticlesCategories
-
Do nothing.
- setInputFile(File) - Method in class org.docgene.model.globals.ArticlesDictionary
-
Set the dictionnary input XML file.
- setInputFile(File) - Method in class org.docgene.model.globals.ArticlesGlossary
-
Set the glossary input XML file.
- setInputFile(File) - Method in class org.docgene.model.HeaderElement
-
Set the element input XML file.
- setInputFile(File) - Method in class org.docgene.model.OpaqueArticle
-
Set the article input XML file.
- setInputFile(File) - Method in class org.docgene.model.XMLArticle
-
Set the article input XML file.
- setInputFile(File) - Method in class org.docgene.model.XMLDisambArticle
-
Set the article input XML file.
- setInputFile(File) - Method in class org.docgene.model.XMLFallbackArticle
-
Set the article input XML file.
- setInputFile(File) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the article input XML file.
- setInputFile(File) - Method in class org.docgene.model.XMLRedirect
-
Set the article input XML file.
- setInputsSubDirectories(boolean) - Method in class org.docgene.main.Configuration
-
Set if the inputs must be the sub-directories of the specified input files.
- setInvisibleChars(boolean) - Method in class org.docgene.model.XMLPre
-
Set if the invisible char character is supported.
- setJQueryScripts(File, File, File) - Method in class org.docgene.main.Configuration
-
Set the jQuery Scripts.
- setJQueryUI(File) - Method in class org.docgene.main.Configuration
-
Set the jQuery Scripts.
- setJustification(char) - Method in class org.docgene.main.Configuration
-
Set the justification of the elements.
- setJustification(char) - Method in interface org.docgene.model.JustifiedElement
-
Set the justification of the element.
- setJustification(char) - Method in class org.docgene.model.XMLArticle
-
Set the justification of the article.
- setJustification(char) - Method in class org.docgene.model.XMLChapter
-
Set the justification of the element.
- setJustification(char) - Method in class org.docgene.model.XMLDiv
-
Set the justification of the element.
- setJustification(char) - Method in class org.docgene.model.XMLParagraph
-
Set the justification of the element.
- setKeepCase(boolean) - Method in class org.docgene.model.OpaqueArticle
-
Set if the article title should keep the title description case.
- setKeepCase(boolean) - Method in class org.docgene.model.XMLArticle
-
Set if the article title should keep the title description case.
- setKeepCase(boolean) - Method in class org.docgene.model.XMLChapter
-
Set if the chapter description should keep the title description case.
- setKeepCase(boolean) - Method in class org.docgene.model.XMLDisambArticle
-
Set if the article title should keep the title description case.
- setKeepCase(boolean) - Method in class org.docgene.model.XMLRedirect
-
Set if the article title should keep the title description case.
- setKeepCase(boolean) - Method in class org.docgene.model.XMLTitle
-
Set if the title description should keep the title description case.
- setKeepNumbering(boolean) - Method in class org.docgene.model.XMLInclude
-
Set if the titles numbering levels is kept.
- setLang(String) - Method in class org.docgene.model.XMLWikipediaLink
-
Set the link lang.
- setLeaderLineScript(File) - Method in class org.docgene.main.Configuration
-
Set the LeaderLine Script.
- setLeftImage(XMLImage) - Method in class org.docgene.model.HeaderElement
-
Set the associated left image.
- setLeftIndexMenu(File) - Method in class org.docgene.main.Configuration
-
Set the additional left index menu for the wiki.
- setLeftText(String) - Method in class org.docgene.model.XMLHeader
-
Set the header leftText.
- setLevel(int) - Method in interface org.docgene.model.TitledElement
-
Set the title level.
- setLevel(int) - Method in class org.docgene.model.XMLTitle
-
Set the title level.
- setLightbox(boolean) - Method in class org.docgene.main.Configuration
-
Set if images have a lightbox effect.
- setLightboxScript(File) - Method in class org.docgene.main.Configuration
-
Set the Lightbox Script.
- setLimit(int) - Method in class org.docgene.main.Configuration
-
Set the maximum number of articles in the same directory.
- setLineNumber(int) - Method in class org.docgene.model.AbstractLink
-
Set the line number where the reference appear.
- setLineNumber(int) - Method in class org.docgene.model.XMLCategoryReference
-
Set the line number where the reference appear.
- setLineNumber(int) - Method in class org.docgene.model.XMLImage
-
Set the line number where the reference appear.
- setLineNumber(int) - Method in class org.docgene.model.XMLInclude
-
Set the line number where the reference appear.
- setLineNumber(int) - Method in class org.docgene.model.XMLMailLink
-
Set the line number where the reference appear.
- setLineNumber(int) - Method in class org.docgene.model.XMLMessageBox
-
Set the line number where the reference appear.
- setLineNumber(int) - Method in class org.docgene.model.XMLRedirect
-
Set the line number where the reference appear.
- setLineNumber(int) - Method in class org.docgene.model.XMLReference
-
Set the line number where the reference appear.
- setLineNumber(int) - Method in class org.docgene.model.XMLResource
-
Set the line number where the reference appear.
- setLinkFromArticles(SortedMap<String, XMLParentArticle>) - Method in class org.docgene.model.AbstractXMLParentArticle
-
Set the articles from which there is a reference to this article.
- setLinkFromArticles(SortedMap<String, XMLParentArticle>) - Method in class org.docgene.model.OpaqueArticle
-
- setLinkFromArticles(SortedMap<String, XMLParentArticle>) - Method in interface org.docgene.model.XMLParentArticle
-
Set the articles from which there is a reference to this article.
- setLinkFromArticles(SortedMap<String, XMLParentArticle>) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the articles from which there is a reference to this article.
- setLinksFromFile(File) - Method in class org.docgene.model.OpaqueArticle
-
Set the article links from XML file.
- setLinksFromFile(File) - Method in class org.docgene.model.XMLArticle
-
Set the article links from XML file.
- setLinksFromFile(File) - Method in class org.docgene.model.XMLDisambArticle
-
Set the article links from XML file.
- setLinksFromFile(File) - Method in class org.docgene.model.XMLFallbackArticle
-
Do nothing.
- setLinksFromFile(File) - Method in interface org.docgene.model.XMLParentArticle
-
Set the article links from XML file.
- setLinksFromFile(File) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the article links from XML file.
- setLocale(String) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the localization.
- setLocalization(String, Map<String, String>) - Method in class org.docgene.model.globals.Localization
-
Set the properties-values for the Localization.
- setLocalization(String) - Method in class org.docgene.model.globals.Localization
-
Set the Localization for one of the built-in locale.
- setLocalLinksOption(char) - Method in class org.docgene.main.Configuration
-
Set the accept option for local links.
- setLowerCase(boolean) - Method in class org.docgene.model.XMLReference
-
Set that the first character of the reference should be kept in lower case.
- setMail(String) - Method in class org.docgene.model.XMLMailLink
-
Set the email.
- setManualPolicy(boolean) - Method in class org.docgene.model.globals.ArticlesGlossary
-
Set if the policy of the glossary is manual.
- setMapResizerScript(File) - Method in class org.docgene.main.Configuration
-
Set the map resizer Script.
- setMargin(char) - Method in class org.docgene.model.XMLImage
-
Set the image margin.
- setMember(APIMember) - Method in class org.docgene.model.AbstractAPI
-
Set the API member.
- setMember(String) - Method in class org.docgene.model.AbstractAPI
-
Set the API member.
- setMember(String) - Method in class org.docgene.model.APIMember
-
Set the member.
- setMeta(XMLArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the meta of an article.
- setMeta(String) - Method in class org.docgene.model.OpaqueArticle
-
Set the meta description to be used for the article for the dictionnary or categories.
- setMeta(String) - Method in class org.docgene.model.XMLArticle
-
Set the meta description to be used for the article for the dictionnary or categories.
- setMeta(String) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the meta description to be used for the article for the dictionnary or categories.
- setMeta(String) - Method in class org.docgene.model.XMLRedirect
-
Set the meta description to be used for the article for the dictionnary or categories.
- setModifiers(String) - Method in class org.docgene.model.AbstractXMLAPIDoc
-
Set the modifiers.
- setModifiers(String) - Method in class org.docgene.model.XMLIncludedAPI
-
Set the modifiers.
- setModifiers(String) - Method in class org.docgene.model.XMLIncludedAPIMember
-
Set the modifiers.
- setModule(String) - Method in class org.docgene.model.XMLJavaAPI
-
Set the module.
- setNote(NoteContent) - Method in class org.docgene.model.XMLNoteRef
-
Set the note.
- setNotesTooltips(boolean) - Method in class org.docgene.main.Configuration
-
Set if the notes have a corresponding tooltip.
- setNotesTooltipsLength(int) - Method in class org.docgene.main.Configuration
-
Set the text length of the notes tooltips.
- setNotesTwoColumns(boolean) - Method in class org.docgene.main.Configuration
-
Set if the notes layout is on two columns.
- setNotesTwoColumns(boolean) - Method in class org.docgene.model.XMLArticle
-
Set if the notes layout is on two columns.
- setOnAnchor(boolean) - Method in class org.docgene.model.XMLWord
-
Set the word as being put on an existing anchor.
- setOpenLayerScript(File) - Method in class org.docgene.main.Configuration
-
Set the OpenLayer Scripts.
- setOriginalLink(String) - Method in class org.docgene.model.XMLArchiveURL
-
Set the original article link.
- setOtherText(String) - Method in class org.docgene.model.XMLSeeAlsoHeading
-
Set the SeeAlso associated text for the destination article.
- setOuputDir(File) - Method in class org.docgene.main.Configuration
-
Set the output directory for the wiki.
- setOutputDirectory(URL) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the output directory.
- setOutputDirectory(File) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the output directory.
- setOutputFile(File) - Method in class org.docgene.model.globals.ArticleCategory
-
Set the category description output file.
- setOutputFile(File) - Method in class org.docgene.model.globals.ArticlesCategories
-
Set the categories output file.
- setOutputFile(File) - Method in class org.docgene.model.globals.ArticlesDictionary
-
Set the dictionnary output file.
- setOutputFile(File) - Method in class org.docgene.model.OpaqueArticle
-
Set the article output XML file.
- setOutputFile(File) - Method in class org.docgene.model.XMLArticle
-
Set the article output XML file.
- setOutputFile(File) - Method in class org.docgene.model.XMLDisambArticle
-
Set the article output XML file.
- setOutputFile(File) - Method in class org.docgene.model.XMLFallbackArticle
-
Set the article output XML file.
- setOutputFile(File) - Method in interface org.docgene.model.XMLParentArticle
-
Set the article output XML file.
- setOutputFile(File, File) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the article output XML file.
- setOutputFile(File) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the article output XML file.
- setOutputPath(String) - Method in class org.docgene.model.XMLResource
-
Set the resource output path.
- setOutputType(String) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the output type of the wiki.
- setOutputType(String) - Method in class org.docgene.main.Configuration
-
Set the output type.
- setPackage(String) - Method in class org.docgene.model.globals.InternalMenuItem
-
Set the package ID of the referenced article.
- setPackage(String) - Method in class org.docgene.model.HeaderElement
-
Set the package ID of the article.
- setPackage(String) - Method in class org.docgene.model.OpaqueArticle
-
Set the package ID of the article.
- setPackage(String) - Method in class org.docgene.model.XMLArticle
-
Set the package ID of the article.
- setPackage(String) - Method in class org.docgene.model.XMLFallbackArticle
-
Set the package ID of the article.
- setPackage(String) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the package ID of the article.
- setPackage(String) - Method in class org.docgene.model.XMLRedirect
-
Set the package ID of the article.
- setPackageDependencies(PackagesDependencies) - Method in class org.docgene.main.Configuration
-
Set the package dependencies.
- setPackagesDependencies(PackagesDependencies) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the Packages Dependencies.
- setPadding(char) - Method in class org.docgene.model.XMLTable
-
Set the padding of the table rows.
- setPageRankIterations(int) - Method in class org.docgene.main.Configuration
-
Set the PageRank algorithm number of iterations, used for the PageRankOptions.PAGERANK_FIXED_ITERATIONS
type.
- setPageRankMaxIterations(int) - Method in class org.docgene.main.Configuration
-
Set the PageRank algorithm maximum number of iterations, used for the PageRankOptions.PAGERANK_CONVERGE_ITERATIONS
type.
- setPageRanks(PageRanks) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the computed PageRanks.
- setPageRankSearch(char) - Method in class org.docgene.main.Configuration
-
Set the PageRank algorithm option.
- setPageRankSearchConvergeDelta(double) - Method in class org.docgene.main.Configuration
-
Set the delta value for the PageRank algorithm convergences, used for the PageRankOptions.PAGERANK_CONVERGE_ITERATIONS
type.
- setParent(TreeElement) - Method in class org.docgene.model.XMLTreeItem
-
- setParentAPI(XMLIncludedAPI) - Method in class org.docgene.model.XMLIncludedAPIMember
-
Set the parent API.
- setParentList(XMLList) - Method in interface org.docgene.model.ListElement
-
Set the parent list.
- setParentList(XMLList) - Method in class org.docgene.model.XMLList
-
Set the parent list.
- setParentList(XMLList) - Method in class org.docgene.model.XMLListItem
-
Set the parent list.
- setParentStyle(XMLTextStyle) - Method in class org.docgene.model.AbstractStylableText
-
Set the parent text style.
- setParentStyle(XMLTextStyle) - Method in interface org.docgene.model.StylableText
-
Set the parent text style.
- setParentStyle(XMLTextStyle) - Method in class org.docgene.model.XMLSpan
-
Do nothing.
- setPath(String) - Method in class org.docgene.model.AbstractAPI
-
Set the API path.
- setPath(String) - Method in class org.docgene.model.AbstractWikiLink
-
Set the link path.
- setPath(String) - Method in class org.docgene.model.AbstractXMLAPIDoc
-
Set the path.
- setPath(String) - Method in class org.docgene.model.XMLIncludedAPI
-
Set the path.
- setPath(String) - Method in class org.docgene.model.XMLIncludedAPIMember
-
Set the path.
- setPath(String) - Method in class org.docgene.model.XMLVideo
-
Set the video path
- setPreFile(File) - Method in class org.docgene.model.XMLPre
-
Set the File associated with the pre element.
- setPreHasBackground(boolean) - Method in class org.docgene.main.Configuration
-
Set true if the "pre" elements have a background.
- setPreScrollingType(char) - Method in class org.docgene.main.Configuration
-
Set the default scrolling type.
- setPreventExitType(char) - Method in class org.docgene.main.Configuration
-
Set how the program must exit.
- setPreviousTitleIndex(int) - Method in class org.docgene.model.XMLInclude
-
Set the index of the title or chapter preceding the include element (0 means that there is no title or chapter before the include
element).
- setProjection(String) - Method in class org.docgene.model.XMLMap
-
Set the map projection.
- setPublisher(String) - Method in class org.docgene.model.XMLCitation
-
Set the link reference publisher.
- setQuote(String) - Method in class org.docgene.model.XMLCitation
-
Set the noteRef associated quote.
- setReason(String) - Method in class org.docgene.model.XMLMessageBox
-
Set the reason of the TODO.
- setReason(String) - Method in class org.docgene.model.XMLTodo
-
Set the reason of the TODO.
- setReferTo(String) - Method in class org.docgene.model.XMLIndex
-
Set the article id on which the index is referring to.
- setReferTo(XMLParentArticle) - Method in class org.docgene.model.XMLIndex
-
Set the article on which the index is referring to.
- setRefID(String) - Method in class org.docgene.model.XMLRedirect
-
Set the referenced article ID.
- setRelativePath(String) - Method in class org.docgene.model.OpaqueArticle
-
Set the relative path of the article XML file, from the associated root.
- setRelativePath(String) - Method in class org.docgene.model.XMLArticle
-
Set the relative path of the article XML file, from the associated root.
- setRelativeWidth(int) - Method in class org.docgene.model.XMLImage
-
Set the image relative width.
- setRelaxSyntax(boolean) - Method in class org.docgene.main.Configuration
-
Set if the syntax of the articles is relaxed.
- setResolved() - Method in interface org.docgene.model.TitledElement
-
Set the titled element as being resolved.
- setResolved() - Method in class org.docgene.model.XMLChapter
-
Set the titled element as being resolved.
- setResolved() - Method in class org.docgene.model.XMLTitle
-
Set the titled element as being resolved.
- setResourcesGenerationType(char) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the resources generation type.
- setResourcesGenerationType(char) - Method in class org.docgene.main.Configuration
-
Set the resources generation type.
- setRightIndexMenu(File) - Method in class org.docgene.main.Configuration
-
Set the additional right index menu for the wiki.
- setRoot(RootDirectory) - Method in class org.docgene.model.AbstractXMLParentArticle
-
Set the root directory.
- setRoot(RootDirectory) - Method in interface org.docgene.model.Article
-
Set the root directory.
- setRoot(RootDirectory) - Method in class org.docgene.model.globals.ArticleCategory
-
Set the root directory.
- setRoot(RootDirectory) - Method in class org.docgene.model.globals.ArticlesDictionary
-
Set the root directory.
- setRoot(RootDirectory) - Method in class org.docgene.model.HeaderElement
-
Set the root directory.
- setRoot(RootDirectory) - Method in class org.docgene.model.OpaqueArticle
-
Set the root directory.
- setRoot(RootDirectory) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the root directory.
- setRoot(RootDirectory) - Method in class org.docgene.model.XMLRedirect
-
Set the root directory.
- setRowSpan(int) - Method in class org.docgene.model.XMLTableCell
-
Set the cell row span.
- setScrollingType(char) - Method in class org.docgene.model.XMLPre
-
Set the scrolling type.
- setSearch(short) - Method in class org.docgene.api.DocGeneratorAPI
-
Set the search type.
- setSearch(boolean) - Method in class org.docgene.main.Configuration
-
Set if the UI has a Search box.
- setSearchable(boolean) - Method in class org.docgene.model.XMLChapter
-
Set if the chapter title is searchable
- setSearchable(boolean) - Method in class org.docgene.model.XMLTitle
-
Set if the title is searchable
- setSearchDatabaseScript(File) - Method in class org.docgene.main.Configuration
-
Set the search Database Script.
- setSearchLimit(int) - Method in class org.docgene.main.Configuration
-
Set the search limit.
- setSearchScript(File) - Method in class org.docgene.main.Configuration
-
Set the Search Script.
- setSearchType(short) - Method in class org.docgene.main.Configuration
-
Set if the UI will search on titles in addition for article description.
- setSeeAlsoHeading(XMLSeeAlsoHeading) - Method in class org.docgene.model.XMLArticle
-
Set the "seeAlso" element in the heading.
- setSeq(String) - Method in interface org.docgene.model.TitledElement
-
Set the titled element sequence id.
- setSeq(String) - Method in class org.docgene.model.XMLChapter
-
Set the title sequence id.
- setSeq(String) - Method in class org.docgene.model.XMLTitle
-
Set the title sequence id.
- setShowWarnings(boolean) - Method in class org.docgene.main.Configuration
-
Set if warnings should be presented.
- setSimpleMember(String) - Method in class org.docgene.model.APIMember
-
Set the simple representation of the member.
- setSize(int) - Method in class org.docgene.api.SentenceStyle
-
Set the specified size of the font.
- setSize(String) - Method in class org.docgene.api.SentenceStyle
-
Set the specified named size of the font.
- setSize(String) - Method in class org.docgene.model.AbstractStylableText
-
Set the HTML named size of the text.
- setSize(int) - Method in class org.docgene.model.AbstractStylableText
-
Set the size of the text.
- setSize(String) - Method in class org.docgene.model.XMLSpan
-
Set the HTML named size of the text.
- setSize(int) - Method in class org.docgene.model.XMLSpan
-
Set the size of the text.
- setSize(String) - Method in class org.docgene.model.XMLTextStyle
-
Set the HTML named size of the text.
- setSize(int) - Method in class org.docgene.model.XMLTextStyle
-
Set the size of the text.
- setSortable(boolean) - Method in class org.docgene.model.XMLTable
-
Set if the table has arrows to sort columns by their content.
- setStartItem(int) - Method in class org.docgene.model.XMLList
-
Set the start item of an ordered (ol) list.
- setStaticMapsTimeOut(int) - Method in class org.docgene.main.Configuration
-
Set the timeout for static maps.
- setStyle(String) - Method in class org.docgene.model.XMLReference
-
Set the style class of the reference.
- setStyle(String) - Method in class org.docgene.model.XMLSentence
-
Set the style class of the element.
- setStyle(String) - Method in class org.docgene.model.XMLSpan
-
Set the style class of the element.
- setStyleSheet(File) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the output StyleSheet file.
- setStyleSheetTheme(URL) - Method in class org.docgene.main.Configuration
-
Set the articles StyleSheet theme.
- setStyleSheetTheme(File) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the StyleSheet theme file.
- setSuffix(int) - Method in interface org.docgene.model.Article
-
Set the article name suffix.
- setSuffix(int) - Method in class org.docgene.model.OpaqueArticle
-
Set the article name suffix.
- setSuffix(int) - Method in class org.docgene.model.XMLArticle
-
Set the article name suffix.
- setSuffix(int) - Method in class org.docgene.model.XMLRedirect
-
Set the article name suffix.
- setSupportEscaping(boolean) - Method in class org.docgene.main.Configuration
-
Set if the parser supports escaping characters in the content of XML articles.
- setSyntax(String) - Method in class org.docgene.model.XMLPre
-
Set the pre syntax.
- setSyntaxType(short) - Method in class org.docgene.model.XMLArticle
-
Set the article syntax type.
- setTableHeader(XMLTable, boolean) - Method in class org.docgene.api.DocGeneratorAPI
-
Set a table header.
- setTableHeader(XMLTableHeader) - Method in class org.docgene.model.XMLTable
-
Set the table header.
- setTemplate(boolean) - Method in class org.docgene.model.XMLArticle
-
Set if this article is a template.
- setText(String) - Method in class org.docgene.model.AbstractWikiLink
-
Set the link description text.
- setText(String) - Method in class org.docgene.model.XMLAnchor
-
Set the anchor text.
- setText(String) - Method in class org.docgene.model.XMLCitation
-
Set the link text.
- setText(String) - Method in class org.docgene.model.XMLExternalLink
-
Set the link description text.
- setText(String) - Method in class org.docgene.model.XMLFooter
-
Set the footer text.
- setText(String) - Method in class org.docgene.model.XMLMailLink
-
Set the mail description text.
- setText(String) - Method in class org.docgene.model.XMLResource
-
Set the resource text.
- setText(String) - Method in class org.docgene.model.XMLSeeAlso
-
Set the SeeAlso associated text
- setText(String) - Method in class org.docgene.model.XMLSentence
-
Set the text.
- setText(String) - Method in class org.docgene.model.XMLSpan
-
Set the text.
- setText(String) - Method in class org.docgene.model.XMLTodo
-
Set the text of the TODO.
- setText(String) - Method in class org.docgene.model.XMLWord
-
Set the text.
- setThematicBreak(boolean) - Method in class org.docgene.model.XMLAPIDoc
-
Set if the api has thematic breaks("hr").
- setThematicBreak(boolean) - Method in class org.docgene.model.XMLIncludedAPI
-
Set if the api has thematic breaks("hr").
- setThematicBreak(boolean) - Method in class org.docgene.model.XMLTitle
-
Set if the title has a thematic break ("hr") before the title.
- setThisText(String) - Method in class org.docgene.model.XMLSeeAlsoHeading
-
Set the SeeAlso associated text for the origin article.
- setTimeOuts(TimeOuts) - Method in class org.docgene.main.Configuration
-
Set the list of URLs with specific timeouts.
- setTimeOutsFile(File) - Method in class org.docgene.main.Configuration
-
Set the XML file specifying the URLs TimeOuts.
- setTitle(String) - Method in class org.docgene.model.globals.ArticlesGlossary.Word
-
Set the word title.
- setTitle(String) - Method in interface org.docgene.model.TitledElement
-
Set the title.
- setTitle(String) - Method in class org.docgene.model.XMLChapter
-
Set the title.
- setTitle(String) - Method in class org.docgene.model.XMLTitle
-
Set the title.
- setTitledElementsList(List<TitledElement>) - Method in class org.docgene.model.XMLArticle
-
Set the ordered list of titled elements (chapters or titles).
- setTOC(boolean) - Method in class org.docgene.model.XMLArticle
-
Set if the article should have a Table of content.
- setTopBorderType(short) - Method in class org.docgene.model.XMLTableRow
-
Set the top border type.
- setTrimLeft(boolean) - Method in class org.docgene.model.XMLPre
-
Set if the text must be trimmed to the left.
- setTrimmedLeftLength(int) - Method in class org.docgene.model.XMLPre
-
Set the length of the spaces before the pre on the same line.
- setType(int) - Method in class org.docgene.api.SentenceStyle
-
Set the specified type of the font.
- setType(int) - Method in class org.docgene.model.AbstractStylableText
-
Set the font type of the text.
- setType(String) - Method in class org.docgene.model.XMLAudio
-
Set the audio type.
- setType(short) - Method in class org.docgene.model.XMLComment
-
Set the type of the comment.
- setType(short) - Method in class org.docgene.model.XMLDate
-
Set the type.
- setType(short) - Method in class org.docgene.model.XMLMessageBox
-
Set the message box type.
- setType(int) - Method in class org.docgene.model.XMLSpan
-
Set the font type of the text.
- setType(int) - Method in class org.docgene.model.XMLTextStyle
-
Set the font type of the text.
- setType(short) - Method in class org.docgene.model.XMLTodo
-
Set the type of the TODO.
- setupElementDefinitions() - Method in class org.docgene.model.globals.ArticlesModel
-
Setup element definitions to be sure that we don't have more than once the same path name.
- setURL(URL) - Method in class org.docgene.model.XMLExternalLink
-
Set the link URL.
- setURL(URL) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Set the URL.
- setURLExceptions(SiteExceptionsList) - Method in class org.docgene.main.Configuration
-
Set the list of URLs which will not be checked for their validity and existence.
- setURLExceptionsFile(File) - Method in class org.docgene.main.Configuration
-
Set the XML file specifying the URLs which will not be checked for their validity and existence.
- setUserAgent(String) - Method in class org.docgene.main.Configuration
-
Set the user agent to access external links.
- setValid(boolean) - Method in class org.docgene.model.AbstractLink
-
Set if the link is valid.
- setValid(boolean) - Method in interface org.docgene.model.ExternalLink
-
Set if the link is valid.
- setValue(String) - Method in class org.docgene.model.XMLInfobox.Property
-
Set the property value.
- setVertical(boolean) - Method in class org.docgene.model.XMLTable
-
Set if the table is horizontal or vertical.
- setVertical(boolean) - Method in class org.docgene.model.XMLTableHeader
-
Set if the table header is horizontal or vertical.
- setVerticalAlignment(char) - Method in class org.docgene.model.XMLImage
-
Set the vertical alignment of the image.
- setVerticalBorders(boolean) - Method in class org.docgene.model.XMLTableRow
-
Set if the table cells of the row have vertical borders.
- setWidth(int, boolean) - Method in class org.docgene.model.XMLBox
-
Set the box width.
- setWidth(int, boolean) - Method in class org.docgene.model.XMLImage
-
Set the image width.
- setWidth(int, boolean) - Method in class org.docgene.model.XMLMap
-
Set the Map width.
- setWidth(int, boolean) - Method in class org.docgene.model.XMLTable
-
Set the table width.
- setWidth(int, boolean) - Method in class org.docgene.model.XMLTableColumn
-
Set the column width.
- setWidth(int) - Method in class org.docgene.model.XMLVideo
-
Set the video width.
- setWidths(List<Integer>, boolean) - Method in class org.docgene.model.XMLSizedTableRow
-
Set the row widths.
- setWidths(boolean, int...) - Method in class org.docgene.model.XMLSizedTableRow
-
Set the row widths.
- setWikiState(IncrementalGenerationState) - Method in class org.docgene.model.globals.ArticlesModel
-
Set the object which hold the current state of the wiki
- setWikiTitle(String) - Method in class org.docgene.main.Configuration
-
Set the wiki title, which will be shown in the index page.
- setWriteInstruction(boolean) - Method in class org.docgene.model.XMLWord
-
Set the write instruction for the the word.
- showElementErrors(PackagedElement) - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if errors on an element must be emitted.
- showErrorsFullPath(boolean) - Method in class org.docgene.main.Configuration
-
Set if the full paths of files should be presented for errors.
- showGenerationExceptions() - Method in class org.docgene.api.DocGeneratorAPI
-
Show the parsing or consistency exceptions.
- showGlossaryErrors(boolean) - Method in class org.docgene.main.Configuration
-
Set if the glossary errors are checked.
- showPackageErrors(String) - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if a package must be included in the wiki output.
- showUnresolvedImages(String, String) - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if unresolved images between between two packages must emit an error.
- showUnresolvedInfoboxes(String, String) - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if unresolved infoboxes between between two packages must emit an error.
- showUnresolvedReferences(String, String) - Method in class org.docgene.model.globals.ArticlesModel
-
Return true if unresolved references between between two packages must emit an error.
- showWikilinksTooltips(boolean) - Method in class org.docgene.main.Configuration
-
Set if there are wiki links tooltips.
- size - Variable in class org.docgene.api.SentenceStyle
-
The sentence numeric size value.
- SMALL - Static variable in interface org.docgene.api.FontSize
-
"small".
- SMALL - Static variable in interface org.docgene.model.FontNamedSizeType
-
The small size.
- SMALLER - Static variable in interface org.docgene.model.FontNamedSizeType
-
The smaller size.
- SOFT_SHADOW - Static variable in interface org.docgene.model.BorderType
-
The type with a soft shadowed border.
- SOLID - Static variable in interface org.docgene.model.RowBorderType
-
The type with a simple line for the border.
- SPANISH - Static variable in interface org.docgene.model.globals.Locales
-
The Spanish locale.
- SpanTextElement - Interface in org.docgene.model
-
- START_REVIEW - Static variable in class org.docgene.model.globals.Localization
-
"startReview": The name for the the start review button in review.
- STRICT - Static variable in interface org.docgene.model.SyntaxType
-
The strict syntax type.
- STRIKETHROUGH - Static variable in interface org.docgene.model.FontType
-
The type for crossed fonts.
- STRONG_SHADOW - Static variable in interface org.docgene.model.BorderType
-
The type with a strong shadowed border.
- StylableText - Interface in org.docgene.model
-
A text which may have a decoration.
- STYLE_CIRCLE - Static variable in interface org.docgene.model.BulletStyle
-
The circle bullet style.
- STYLE_DECIMAL - Static variable in interface org.docgene.model.BulletStyle
-
The decimal bullet style.
- STYLE_DEFAULT - Static variable in interface org.docgene.model.BulletStyle
-
The default bullet style.
- STYLE_INHERIT - Static variable in interface org.docgene.model.BulletStyle
-
The bullet style which ingerit from the parent.
- STYLE_LOWER_ALPHA - Static variable in interface org.docgene.model.BulletStyle
-
The lower alpha bullet style.
- STYLE_LOWER_GREEK - Static variable in interface org.docgene.model.BulletStyle
-
The lower greek bullet style.
- STYLE_LOWER_ROMAN - Static variable in interface org.docgene.model.BulletStyle
-
The lower roman bullet style.
- STYLE_NONE - Static variable in interface org.docgene.model.BulletStyle
-
The bullet style without any bullet.
- STYLE_SQUARE - Static variable in interface org.docgene.model.BulletStyle
-
The square bullet style.
- STYLE_UPPER_ALPHA - Static variable in interface org.docgene.model.BulletStyle
-
The upper alpha bullet style.
- STYLE_UPPER_GREEK - Static variable in interface org.docgene.model.BulletStyle
-
The upper greek bullet style.
- STYLE_UPPER_ROMAN - Static variable in interface org.docgene.model.BulletStyle
-
The upper roman bullet style.
- StyledElement - Interface in org.docgene.model
-
Represent an element which can be included in a paragraph.
- SUBSCRIPT - Static variable in interface org.docgene.model.FontType
-
The type for subscript fonts.
- SUCCESS - Static variable in class org.docgene.model.XMLMessageBox
-
The Success messageBox type.
- SUPERSCRIPT - Static variable in interface org.docgene.model.FontType
-
The type for superscript fonts.
- supportThemes(boolean) - Method in class org.docgene.model.globals.ArticlesModel
-
Set if the model writer support themes.
- supportType(short) - Static method in class org.docgene.model.globals.DefaultMenuItem
-
Return true if a item type is supported.
- SyntaxType - Interface in org.docgene.model
-
The syntax types for articles.