org.docgene.model

Class XMLFooter.XMLFooterPart

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.HeaderElement

org.docgene.model.XMLFooter.XMLFooterPart

All Implemented Interfaces:

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

Enclosing class:

XMLFooter

public static class XMLFooter.XMLFooterPart
extends org.docgene.model.HeaderElement

A left or right footer.

Since:

1.6.17

Field Summary

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
XMLFooterPart(XMLFooter footer, boolean isLeft) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	accept(org.docgene.model.HTMLOutput root) Return true if the footer part should be created for an element.
java.lang.String	getID()
java.util.Set<java.lang.Short>	getOnProperties() Return the set of properties which need to be defined for this part to be present (can be null).
short	getRootElementType() Return the RootElement.FOOTER type.
java.lang.String	getText() Return the footer part text.
boolean	hasOnProperties(short property) Return true if a property of a specified type needs to be defined for this part to be present.
boolean	hasText() Return true if the footer part has text.
boolean	isLeft() Return true if this is the left footer.
boolean	onProperty(short property) Add a property which needs to be defined for this part to be present.
void	setText(java.lang.String text) Set the footer part text.
java.lang.String	toString()

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

XMLFooterPart

public XMLFooterPart(XMLFooter footer,
                     boolean isLeft)

Constructor.

Parameters:

footer - the footer

isLeft - true if this is a left footer part

Method Detail

setText

public void setText(java.lang.String text)

Set the footer part text.

Parameters:

text - the text

hasText

public boolean hasText()

Return true if the footer part has text.

Returns:

true if the footer part has text

getText

public java.lang.String getText()

Return the footer part text.

Returns:

the text

accept

public boolean accept(org.docgene.model.HTMLOutput root)

Return true if the footer part should be created for an element.

Parameters:

root - the element

Returns:

true if the footer part should be created

onProperty

public boolean onProperty(short property)

Add a property which needs to be defined for this part to be present.

Parameters:

property - the property type

Returns:

true if the property type exists

getOnProperties

public java.util.Set<java.lang.Short> getOnProperties()

Return the set of properties which need to be defined for this part to be present (can be null).

Returns:

the set of properties

hasOnProperties

public boolean hasOnProperties(short property)

Return true if a property of a specified type needs to be defined for this part to be present.

Parameters:

property - the property type

Returns:

true if the property needs to be defined for this part to be present

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isLeft

public boolean isLeft()

Return true if this is the left footer.

Returns:

true if this is the left footer

getID

public java.lang.String getID()

getRootElementType

public short getRootElementType()

Return the RootElement.FOOTER type.

Returns:

the element type