org.docgene.model

Class XMLHeader

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.HeaderElement

org.docgene.model.XMLHeader

All Implemented Interfaces:

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

public class XMLHeader
extends HeaderElement
implements HTMLOutput

Represent the text to be added in the articles header.

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
XMLHeader() Constructor.
XMLHeader(java.lang.String rightText) Constructor.

Method Summary

Modifier and Type	Method and Description
java.io.File	getFile() Return the additional header output file.
java.lang.String	getID()
java.lang.String	getLeftText() Return the header left Text.
java.io.File	getOutputFile() Return the HTML root element output file.
java.lang.String	getRightText() Return the header right text.
short	getRootElementType() Return the RootElement.HEADER type.
boolean	hasLeftText() Return true if the header has a left text.
boolean	hasRightText() Return true if the header has a right text.
void	setFile(java.io.File file) Set the additional header file.
void	setLeftText(java.lang.String leftText) Set the header leftText.

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

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.HTMLOutput

hasOutputFile

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

XMLHeader

public XMLHeader(java.lang.String rightText)

Constructor.

Parameters:

rightText - the header right text

XMLHeader

public XMLHeader()

Constructor.

Method Detail

setLeftText

public void setLeftText(java.lang.String leftText)

Set the header leftText.

Parameters:

leftText - the header left text

getOutputFile

public java.io.File getOutputFile()

Return the HTML root element output file.

Specified by:

getOutputFile in interface HTMLOutput

Returns:

the HTML root element output file

setFile

public void setFile(java.io.File file)

Set the additional header file.

Parameters:

file - the additional header file.

getFile

public java.io.File getFile()

Return the additional header output file.

Returns:

the additional header output file.

getLeftText

public java.lang.String getLeftText()

Return the header left Text.

Returns:

the header left Text

hasLeftText

public boolean hasLeftText()

Return true if the header has a left text.

Returns:

true if the header has a left text

getRightText

public java.lang.String getRightText()

Return the header right text.

Returns:

the header right text

hasRightText

public boolean hasRightText()

Return true if the header has a right text.

Returns:

true if the header has a right text

getRootElementType

public short getRootElementType()

Return the RootElement.HEADER type.

Specified by:

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

Returns:

the element type

getID

public java.lang.String getID()

Specified by:

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