- acceptArguments() - Method in class org.docgene.model.XMLIncludedAPIMember
-
Return true if the member accept arguments declaration.
- acceptExtension() - Method in class org.docgene.model.XMLExtendedImage
-
Return true if the image accept an extension (whichc an be an ImageMap, a reference, or an external link).
- acceptExtension() - Method in class org.docgene.model.XMLImage
-
Return true if the image accept an extension (which an be an ImageMap, a
reference, or an external link).
- addAlternateTitle(String, boolean, boolean) - Method in class org.docgene.model.XMLArticle
-
Add an alternate title to the article.
- addAlternateTitle(String, boolean, boolean) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Add an alternate title to the article.
- addAlternateTitle(String, boolean, boolean) - Method in class org.docgene.model.XMLRedirect
-
Add an alternate title to the article.
- addAnchor(AnchorElement) - Method in class org.docgene.model.XMLArticle
-
Add an Anchor to the article.
- addArea(ImageMap.Area) - Method in class org.docgene.model.XMLExtendedImage
-
Add an active area in the image.
- addArea(ImageMap.Area) - Method in class org.docgene.model.XMLImage
-
Do nothing.
- addArticleParent(XMLParentArticle) - Method in interface org.docgene.model.XMLParentArticle
-
Add an article which include this article.
- addArticleParent(XMLParentArticle) - Method in class org.docgene.model.XMLRawHTMLArticle
-
- addCategory(String) - Method in class org.docgene.model.XMLArticle
-
Add a category on which this article belongs.
- addCategoryReference(XMLCategoryReference) - Method in class org.docgene.model.XMLExtendedImage
-
Add a category reference on the image.
- addCategoryReference(XMLCategoryReference) - Method in class org.docgene.model.XMLImage
-
Do nothing.
- addCell(XMLTableCell) - Method in class org.docgene.model.XMLTableRow
-
Add a cell to the table row.
- addChapter(XMLChapter) - Method in class org.docgene.model.XMLArticle
-
Add a chapter to the article.
- addChapter(XMLChapter, boolean, boolean) - Method in class org.docgene.model.XMLArticle
-
Add a resolved chapter to the article.
- addChapter(XMLChapter) - Method in class org.docgene.model.XMLDiv
-
Do nothing.
- addChapter(XMLChapter) - Method in interface org.docgene.model.XMLParent
-
Add a chapter.
- addChapter(XMLChapter) - Method in class org.docgene.model.XMLRawHTMLArticle
-
- addColumn(XMLTableColumn) - Method in class org.docgene.model.XMLTableHeader
-
Add a column to the header.
- addComment(XMLComment) - Method in class org.docgene.model.XMLArticle
-
Add a comment.
- addComment(XMLArticle, XMLComment) - Method in class org.docgene.model.XMLCommentList
-
Add a comment reference.
- addConditionElement(ConditionElement<ListElement>) - Method in class org.docgene.model.XMLList
-
Add a condition element to the list.
- addConditionElement(ConditionElement<XMLTableRow>) - Method in class org.docgene.model.XMLTable
-
Add a condition element to the list.
- addConditionElement(ConditionElement<XMLTreeItem>) - Method in class org.docgene.model.XMLTree
-
Add a condition element to the list.
- addDefaultMenuItem(short) - Method in class org.docgene.model.XMLMenu
-
Add a default menu item to the menu.
- addDisambArticle(Article) - Method in class org.docgene.model.XMLDisambArticle
-
Add an article to the disambiguation list.
- addDisambElement(ArticleRef) - Method in class org.docgene.model.XMLDisambArticle
-
Add a disambiguation element.
- addElement(ParagraphElement) - Method in interface org.docgene.model.ParagraphElementParent
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLBox
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLChapter
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLCode
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLIfCondition
-
Add an element.
- addElement(E) - Method in class org.docgene.model.XMLIfListCondition
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLIncludedAPI
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLIncludedAPIArgument
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLIncludedAPIMember
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLInfobox
-
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLInfobox.BaseProperty
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLList
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLListItem
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLPre
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLTable
-
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLTableCell
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLTerm
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLTextStyle
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLTree
-
Add an element.
- addElement(ParagraphElement) - Method in class org.docgene.model.XMLTreeItem
-
Add an element.
- addEmptyCell() - Method in class org.docgene.model.XMLTableRow
-
Add an empty cell to the table row.
- addEnumProperty(String, String) - Method in class org.docgene.model.XMLInfobox
-
Create an enum property of a specified key and adds it to the infobox.
- addExternalLink(XMLExternalLink) - Method in class org.docgene.model.XMLExtendedImage
-
Add an external link on the image.
- addExternalLink(XMLExternalLink) - Method in class org.docgene.model.XMLImage
-
Do nothing.
- addInclude(XMLInclude) - Method in class org.docgene.model.XMLArticle
-
Add an included article or template.
- addInfo(XMLMoreInfoRef) - Method in class org.docgene.model.XMLMoreInfo
-
Add a child reference.
- addInfobox(XMLInfobox) - Method in class org.docgene.model.XMLArticle
-
Add an infobox.
- addItem(ListElement) - Method in class org.docgene.model.XMLList
-
Add a list element to the list.
- addItem() - Method in class org.docgene.model.XMLList
-
Add a new item in this list.
- addItem(XMLTreeItem) - Method in class org.docgene.model.XMLTree
-
Add a list element to the list.
- addItem(XMLTreeItem) - Method in class org.docgene.model.XMLTreeItem
-
Add a tree element to the tree.
- addLinkFromArticle(XMLParentArticle) - Method in interface org.docgene.model.XMLParentArticle
-
Add an article from which there is a reference to this article.
- addLinkFromArticle(XMLParentArticle) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Add an article from which there is a reference to this article.
- addMap(XMLMap) - Method in class org.docgene.model.XMLArticle
-
Add a Map.
- addMenuItem(AbstractMenuItem) - Method in class org.docgene.model.XMLMenu
-
Add a menu item to the menu.
- addMessageBox(XMLMessageBox) - Method in class org.docgene.model.XMLArticle
-
Add a message box.
- addNote(NoteContent) - Method in class org.docgene.model.XMLArticle
-
Add a note.
- addParagraph(AbstractParagraph) - Method in class org.docgene.model.XMLChapter
-
Add a paragraph.
- addParagraph(AbstractParagraph) - Method in class org.docgene.model.XMLDiv
-
Do nothing.
- addParagraph(AbstractParagraph) - Method in interface org.docgene.model.XMLParent
-
Add a paragraph.
- addParagraph(AbstractParagraph) - Method in class org.docgene.model.XMLRawHTMLArticle
-
- addParagraph(XMLArticle) - Method in class org.docgene.scripts.DocJScriptContext
-
Add a paragraph to an arricle.
- addProperty(String) - Method in class org.docgene.model.XMLInfobox
-
Create a property of a specified key and adds it to the infobox.
- addReference(XMLReference) - Method in class org.docgene.model.XMLExtendedImage
-
Add a reference on the image.
- addReference(XMLReference) - Method in class org.docgene.model.XMLImage
-
Do nothing.
- addResolvedChapter(XMLChapter, boolean) - Method in class org.docgene.model.XMLArticle
-
Add a resolved chapter to the article.
- addResolvedTitle(XMLTitle, boolean) - Method in class org.docgene.model.XMLArticle
-
Add a resolved title to the article.
- addRow(XMLTableRow) - Method in class org.docgene.model.XMLTable
-
Add a row to the table.
- addSeeAlsoReference(XMLSeeAlso) - Method in class org.docgene.model.XMLArticle
-
Add a SeeAlso reference.
- addSubListItem(boolean) - Method in class org.docgene.model.XMLList
-
Add a new list as an item of this list.
- addTextAfter(String) - Method in class org.docgene.model.XMLSentence
-
Add characters after the sentence text.
- addTextAfter(String) - Method in class org.docgene.model.XMLSpan
-
Add characters after the sentence text.
- addTextBefore(String) - Method in class org.docgene.model.XMLSentence
-
Add characters before the sentence text.
- addTextBefore(String) - Method in class org.docgene.model.XMLSpan
-
Add characters before the sentence text.
- addTitle(TitledElement, boolean) - Method in class org.docgene.model.XMLArticle
-
Add a title to the article.
- addTitle(XMLTitle, boolean, boolean) - Method in class org.docgene.model.XMLArticle
-
Add a resolved title to the article.
- addTitle(XMLTitle) - Method in class org.docgene.model.XMLRawHTMLArticle
-
Add a resolved title to the article.
- addTodo(TodoElement) - Method in class org.docgene.model.XMLArticle
-
Add a todo.
- addTODO(XMLArticle, TodoElement) - Method in class org.docgene.model.XMLCommentList
-
Add a comment reference.
- addTodo(XMLArticle, TodoElement) - Method in class org.docgene.model.XMLTodoList
-
Add a TODO reference.
- ALIGNMENT_CENTER - Static variable in interface org.docgene.model.JustifiedElement
-
The value for elements which are aligned on the center.
- ALIGNMENT_INHERIT - Static variable in interface org.docgene.model.JustifiedElement
-
The value for elements where the alignment inherits from the parent
- ALIGNMENT_JUSTIFIED - Static variable in interface org.docgene.model.JustifiedElement
-
The value for elements which are justified.
- ALIGNMENT_LEFT - Static variable in interface org.docgene.model.JustifiedElement
-
The value for elements which are aligned on the left.
- ALIGNMENT_NONE - Static variable in interface org.docgene.model.JustifiedElement
-
The value for elements which have no alignment.
- ALIGNMENT_RIGHT - Static variable in interface org.docgene.model.JustifiedElement
-
The value for elements which are aligned on the right.
- allowInvisibleChars() - Method in class org.docgene.model.XMLPre
-
Return true if the invisible char character is supported.
- api - Variable in class org.docgene.model.XMLIncludedAPI
-
The API.
- API_ATTRIBUTE - Static variable in class org.docgene.model.XMLDoxygenAPI
-
A link to an attribute.
- API_CLASS - Static variable in class org.docgene.model.XMLDotNetAPI
-
A link to a class.
- API_CLASS - Static variable in class org.docgene.model.XMLDoxygenAPI
-
A link to a class.
- API_CLASS - Static variable in class org.docgene.model.XMLPythonAPI
-
A link to a class.
- API_CLASS - Static variable in class org.docgene.model.XMLQtAPI
-
A link to a class.
- API_DELEGATE - Static variable in class org.docgene.model.XMLDotNetAPI
-
A link to a delegate.
- API_ENUM - Static variable in class org.docgene.model.XMLDotNetAPI
-
A link to an enum.
- API_ENUM - Static variable in class org.docgene.model.XMLQtAPI
-
A link to an enum.
- API_METHOD - Static variable in class org.docgene.model.XMLDotNetAPI
-
A link to a method.
- API_METHOD - Static variable in class org.docgene.model.XMLDoxygenAPI
-
A link to a method.
- API_METHOD - Static variable in class org.docgene.model.XMLPythonAPI
-
A link to a method.
- API_METHOD - Static variable in class org.docgene.model.XMLQtAPI
-
A link to a method.
- API_MODULE - Static variable in class org.docgene.model.XMLPythonAPI
-
A link to a module.
- API_PATH_CLASS - Static variable in class org.docgene.model.XMLJavaAPI
-
The default value, only the class name is presented.
- API_PATH_FULL - Static variable in class org.docgene.model.XMLJavaAPI
-
The full class path is presented.
- API_PATH_MEMBER - Static variable in class org.docgene.model.XMLJavaAPI
-
Only the member is presented.
- API_PROPERTY - Static variable in class org.docgene.model.XMLDotNetAPI
-
A link to a property.
- API_PROPERTY - Static variable in class org.docgene.model.XMLQtAPI
-
A link to a property.
- API_STRUCT - Static variable in class org.docgene.model.XMLDoxygenAPI
-
A link to a struct.
- API_STRUCTURE - Static variable in class org.docgene.model.XMLDotNetAPI
-
A link to a structure.
- argument - Variable in class org.docgene.model.XMLIncludedAPIArgument
-
The argument.
- articleNameAlreadyTaken() - Method in class org.docgene.model.XMLArticle
-
Return true if the article name was already taken, and the article was not added in the model.
- articleNameAlreadyTaken() - Method in class org.docgene.model.XMLRawHTMLArticle
-
Return true if the article name was already taken, and the article was not added in the model.
- ArticleRef - Class in org.docgene.model
-
Represent the reference of an article.
- ArticleRef(Article) - Constructor for class org.docgene.model.ArticleRef
-
Constructor.
- ArticleRef(String) - Constructor for class org.docgene.model.ArticleRef
-
Constructor.
- ArticleRef(String, String) - Constructor for class org.docgene.model.ArticleRef
-
Constructor.