org.docgene.model

Class XMLFooter

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.HeaderElement

org.docgene.model.XMLFooter

All Implemented Interfaces:

org.docgene.model.globals.PackagedElement, org.docgene.model.globals.RootElement, org.docgene.model.globals.XMLRootElement, XMLParent

public class XMLFooter
extends HeaderElement

Represent the text to be added in the articles footer.

Field Summary

Fields inherited from class org.docgene.model.AbstractXMLParent

chapters, paragraphs

Fields inherited from interface org.docgene.model.globals.RootElement

ARTICLE, CATEGORIES, CATEGORY, DICTIONARY, FOOTER, FULL_TEXT_SEARCH, GLOSSARY, HEADER, IMAGE_DEFINITION, IMAGES_DEFINITION, INFOBOX_DEFINITION, INFOBOX_PROPERTY, MENUS, PACKAGE, RESOURCE_DEFINITION, RESOURCES_DEFINITION, UNDEFINED

Constructor Summary

Constructors

Constructor and Description
XMLFooter() Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAdditionalContent() Return the optional footer additional content.
java.lang.String	getID()
short	getRootElementType() Return the RootElement.FOOTER type.
java.lang.String	getText() Return the footer text.
void	setAdditionalContent(java.util.List<java.lang.String> content) Set the optional footer additional content.
void	setText(java.lang.String text) Set the footer text.

Methods inherited from class org.docgene.model.HeaderElement

getInputFile, getLeftImage, getPackage, getParent, getRoot, hasLeftImage, hasPackage, setInputFile, setLeftImage, setPackage, setRoot

Methods inherited from class org.docgene.model.AbstractXMLParent

addChapter, addParagraph, getChapters, getParagraphs, isEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.docgene.model.globals.XMLRootElement

getAbsolutePath, getRelativePath, hasInputFile, isParsable

Methods inherited from interface org.docgene.model.globals.RootElement

hasRoot, isArticle, isFallback, notExistingInputFile

Constructor Detail

XMLFooter

public XMLFooter()

Constructor.

Method Detail

setText

public void setText(java.lang.String text)

Set the footer text.

Parameters:

text - the text

getText

public java.lang.String getText()

Return the footer text.

Returns:

the footer text

setAdditionalContent

public void setAdditionalContent(java.util.List<java.lang.String> content)

Set the optional footer additional content.

Parameters:

content - the content lines of text

getAdditionalContent

public java.util.List<java.lang.String> getAdditionalContent()

Return the optional footer additional content.

Returns:

the content lines of text

getRootElementType

public short getRootElementType()

Return the RootElement.FOOTER type.

Returns:

the element type

getID

public java.lang.String getID()