org.docgene.model

Class HeaderElement

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.HeaderElement

All Implemented Interfaces:

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

Direct Known Subclasses:

XMLFooter, XMLHeader

public abstract class HeaderElement
extends AbstractXMLParent
implements org.docgene.model.globals.XMLRootElement

An abstract class for headers and footers.

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

Method Summary

Modifier and Type	Method and Description
java.io.File	getInputFile() Return the element input XML file.
XMLImage	getLeftImage() Return the associated left image.
java.lang.String	getPackage() Return the article package.
XMLParent	getParent() Return null.
org.docgene.model.globals.RootDirectory	getRoot() Return the root directory.
boolean	hasLeftImage() Return true if there is an associated left image.
boolean	hasPackage() Return true if the article has a package.
void	setInputFile(java.io.File file) Set the element input XML file.
void	setLeftImage(XMLImage image) Set the associated left image.
void	setPackage(java.lang.String pack) Set the package ID of the article.
void	setRoot(org.docgene.model.globals.RootDirectory root) Set the root directory.

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

getID, getRootElementType, hasRoot, isArticle, isFallback, notExistingInputFile

Constructor Detail

HeaderElement

public HeaderElement()

Method Detail

getParent

public XMLParent getParent()

Return null.

Specified by:

getParent in interface XMLParent

Returns:

null

setRoot

public void setRoot(org.docgene.model.globals.RootDirectory root)

Set the root directory.

Parameters:

root - the root

getRoot

public org.docgene.model.globals.RootDirectory getRoot()

Return the root directory.

Specified by:

getRoot in interface org.docgene.model.globals.RootElement

Returns:

the root

setPackage

public void setPackage(java.lang.String pack)

Set the package ID of the article.

Specified by:

setPackage in interface org.docgene.model.globals.XMLRootElement

Parameters:

pack - the package ID of the article

getPackage

public java.lang.String getPackage()

Return the article package.

Specified by:

getPackage in interface org.docgene.model.globals.PackagedElement

Specified by:

getPackage in interface org.docgene.model.globals.XMLRootElement

Returns:

the article package

hasPackage

public boolean hasPackage()

Return true if the article has a package.

Specified by:

hasPackage in interface org.docgene.model.globals.PackagedElement

Specified by:

hasPackage in interface org.docgene.model.globals.XMLRootElement

Returns:

true if the article has a package

setLeftImage

public void setLeftImage(XMLImage image)

Set the associated left image.

Parameters:

image - the image

getLeftImage

public XMLImage getLeftImage()

Return the associated left image.

Returns:

the image

hasLeftImage

public boolean hasLeftImage()

Return true if there is an associated left image.

Returns:

true if there is an associated left image

setInputFile

public void setInputFile(java.io.File file)

Set the element input XML file.

Specified by:

setInputFile in interface org.docgene.model.globals.XMLRootElement

Parameters:

file - the element input XML file

getInputFile

public java.io.File getInputFile()

Return the element input XML file.

Specified by:

getInputFile in interface org.docgene.model.globals.RootElement

Returns:

the element input XML file.