org.docgene.model

Interface ParagraphElementParent

All Known Implementing Classes:

AbstractParagraph, AbstractXMLAPIDoc, XMLAPIDoc, XMLAPIDocElement, XMLBasicNote, XMLBlock, XMLBlockquote, XMLBox, XMLChapter, XMLCode, XMLDiv, XMLIfCondition, XMLIncludedAPI, XMLIncludedAPIArgument, XMLIncludedAPIMember, XMLInfobox, XMLInfobox.BaseProperty, XMLList, XMLListItem, XMLMessageBox, XMLParagraph, XMLPre, XMLTable, XMLTableCell, XMLTableColumn, XMLTerm, XMLTextStyle, XMLTree, XMLTreeItem

public interface ParagraphElementParent

Represent a parent which can contain Paragraph Elements.

Method Summary

Modifier and Type	Method and Description
void	addElement(ParagraphElement element) Add an element.
default int	countElements() Count the number of children elements.
default ParagraphElement	getElement(int index) Return the nth of child element.
java.util.List<ParagraphElement>	getElements() Return the list of children elements.
default ParagraphElement	getFirstElement() Return the first element of null if there are no children elements.
default ParagraphElement	getLastElement() Return the last element of null if there are no children elements.
default boolean	hasElements() Return true if there are children elements.
default boolean	isEmpty() Return true if the paragraph is empty.
void	setElements(java.util.List<ParagraphElement> elements) Set the list of elements.

Method Detail

addElement

void addElement(ParagraphElement element)

Add an element.

Parameters:

element - the element

getElements

java.util.List<ParagraphElement> getElements()

Return the list of children elements.

Returns:

the list of children elements

hasElements

default boolean hasElements()

Return true if there are children elements.

Returns:

true if there are children element

getElement

default ParagraphElement getElement(int index)

Return the nth of child element. Return null if there is none.

Parameters:

index - the element index

Returns:

the nth of child element

countElements

default int countElements()

Count the number of children elements.

Returns:

the number of children elements

setElements

void setElements(java.util.List<ParagraphElement> elements)

Set the list of elements.

Parameters:

elements - the list of elements

isEmpty

default boolean isEmpty()

Return true if the paragraph is empty.

Returns:

true if the paragraph is empty

getFirstElement

default ParagraphElement getFirstElement()

Return the first element of null if there are no children elements.

Returns:

the first element of null if there are no children elements

getLastElement

default ParagraphElement getLastElement()

Return the last element of null if there are no children elements.

Returns:

the last element of null if there are no children elements