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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLFooter.XMLFooterPart A left or right footer.

Field Summary

Fields

Modifier and Type	Field and Description
static short	ARTICLE_VERSION The articleVersion property.
static short	ERRORS The errors property.
static short	PACKAGE_PROPERTY The package property.
static short	VERSION The version property.

Fields inherited from class org.docgene.model.AbstractXMLParent

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
XMLFooter.XMLFooterPart	addFooterPart(boolean isLeft) Add a footer left or right part.
java.util.List<java.lang.String>	getAdditionalContent() Return the optional footer additional content.
XMLFooter.XMLFooterPart	getFooterPart(boolean isLeft) Return the left or right footer part.
java.lang.String	getID()
short	getRootElementType() Return the RootElement.FOOTER type.
java.lang.String	getText() Return the footer text.
boolean	hasFooterPart(boolean isLeft) Return true if there is a left or right footer part.
boolean	hasFooterParts() Return true if there is a left or right footer part.
boolean	hasLocalMacros() Return true if the footer has local macros.
boolean	hasText() Return true if the footer has text.
void	setAdditionalContent(java.util.List<java.lang.String> content) Set the optional footer additional content.
void	setHasLocalMacros(boolean hasLocalMacros) Set if the footer has local macros.
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

addParagraph, 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

Field Detail

VERSION

public static final short VERSION

The version property.

See Also:

Constant Field Values

ARTICLE_VERSION

public static final short ARTICLE_VERSION

The articleVersion property.

See Also:

Constant Field Values

PACKAGE_PROPERTY

public static final short PACKAGE_PROPERTY

The package property.

See Also:

Constant Field Values

ERRORS

public static final short ERRORS

The errors property.

See Also:

Constant Field Values

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

hasText

public boolean hasText()

Return true if the footer has text.

Returns:

true if the footer has text

setHasLocalMacros

public void setHasLocalMacros(boolean hasLocalMacros)

Set if the footer has local macros.

Parameters:

hasLocalMacros - true if the footer has local macros

hasLocalMacros

public boolean hasLocalMacros()

Return true if the footer has local macros.

Returns:

true if the footer has local macros

getFooterPart

public XMLFooter.XMLFooterPart getFooterPart(boolean isLeft)

Return the left or right footer part.

Parameters:

isLeft - true for the left footer part

Returns:

the left footer part (or right footer part is isLeft is false)

hasFooterParts

public boolean hasFooterParts()

Return true if there is a left or right footer part.

Returns:

true if there is a left or right footer part

hasFooterPart

public boolean hasFooterPart(boolean isLeft)

Return true if there is a left or right footer part.

Parameters:

isLeft - true for the left footer part

Returns:

true if there is a left footer part (or right footer part is isLeft is false)

addFooterPart

public XMLFooter.XMLFooterPart addFooterPart(boolean isLeft)

Add a footer left or right part.

Parameters:

isLeft - true for the left footer part

Returns:

the footer part

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()