org.apache.maven.doxia.siterenderer
Class SiteRenderingContext

java.lang.Object
  org.apache.maven.doxia.siterenderer.SiteRenderingContext

public class SiteRenderingContext

extends Object

SiteRenderingContext class.

Version:

$Id: SiteRenderingContext.java 785531 2009-06-17 09:47:59Z ltheussl $

Author:

Brett Porter

Constructor Summary

SiteRenderingContext()

Method Summary

void	addModuleDirectory(File file, String moduleParserId) addModuleDirectory.
void	addSiteDirectory(File file) addSiteDirectory.
DecorationModel	getDecoration() Getter for the field decoration.
String	getDefaultWindowTitle() Getter for the field defaultWindowTitle.
String	getInputEncoding() Getter for the field inputEncoding.
Locale	getLocale() Getter for the field locale.
Map	getModuleExcludes() Getter for the field moduleExcludes.
List	getModules() Getter for the field modules.
String	getOutputEncoding() Getter for the field outputEncoding.
List	getSiteDirectories() Getter for the field siteDirectories.
File	getSkinJarFile() Getter for the field skinJarFile.
ClassLoader	getTemplateClassLoader() Getter for the field templateClassLoader.
String	getTemplateName() Getter for the field templateName.
Map	getTemplateProperties() Getter for the field templateProperties.
boolean	isUsingDefaultTemplate() isUsingDefaultTemplate.
void	setDecoration(DecorationModel decoration) Setter for the field decoration.
void	setDefaultWindowTitle(String defaultWindowTitle) Setter for the field defaultWindowTitle.
void	setInputEncoding(String inputEncoding) Setter for the field inputEncoding.
void	setLocale(Locale locale) Setter for the field locale.
void	setModuleExcludes(Map moduleExcludes) Setter for the field moduleExcludes.
void	setOutputEncoding(String outputEncoding) Setter for the field outputEncoding.
void	setSkinJarFile(File skinJarFile) Setter for the field skinJarFile.
void	setTemplateClassLoader(ClassLoader templateClassLoader) Setter for the field templateClassLoader.
void	setTemplateName(String templateName) Setter for the field templateName.
void	setTemplateProperties(Map templateProperties) Setter for the field templateProperties.
void	setUsingDefaultTemplate(boolean usingDefaultTemplate) Setter for the field usingDefaultTemplate.

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteRenderingContext

public SiteRenderingContext()

Method Detail

getTemplateName

public String getTemplateName()

Getter for the field templateName.

Returns:

a String object.

getTemplateClassLoader

public ClassLoader getTemplateClassLoader()

Getter for the field templateClassLoader.

Returns:

a ClassLoader object.

setTemplateClassLoader

public void setTemplateClassLoader(ClassLoader templateClassLoader)

Setter for the field templateClassLoader.

Parameters:

templateClassLoader - a ClassLoader object.

getTemplateProperties

public Map getTemplateProperties()

Getter for the field templateProperties.

Returns:

a Map object.

setTemplateProperties

public void setTemplateProperties(Map templateProperties)

Setter for the field templateProperties.

Parameters:

templateProperties - a Map object.

getLocale

public Locale getLocale()

Getter for the field locale.

Returns:

a Locale object.

setLocale

public void setLocale(Locale locale)

Setter for the field locale.

Parameters:

locale - a Locale object.

getDecoration

public DecorationModel getDecoration()

Getter for the field decoration.

Returns:

a DecorationModel object.

setDecoration

public void setDecoration(DecorationModel decoration)

Setter for the field decoration.

Parameters:

decoration - a DecorationModel object.

setDefaultWindowTitle

public void setDefaultWindowTitle(String defaultWindowTitle)

Setter for the field defaultWindowTitle.

Parameters:

defaultWindowTitle - a String object.

getDefaultWindowTitle

public String getDefaultWindowTitle()

Getter for the field defaultWindowTitle.

Returns:

a String object.

getSkinJarFile

public File getSkinJarFile()

Getter for the field skinJarFile.

Returns:

a File object.

setSkinJarFile

public void setSkinJarFile(File skinJarFile)

Setter for the field skinJarFile.

Parameters:

skinJarFile - a File object.

setTemplateName

public void setTemplateName(String templateName)

Setter for the field templateName.

Parameters:

templateName - a String object.

setUsingDefaultTemplate

public void setUsingDefaultTemplate(boolean usingDefaultTemplate)

Setter for the field usingDefaultTemplate.

Parameters:

usingDefaultTemplate - a boolean.

isUsingDefaultTemplate

public boolean isUsingDefaultTemplate()

isUsingDefaultTemplate.

Returns:

a boolean.

addSiteDirectory

public void addSiteDirectory(File file)

addSiteDirectory.

Parameters:

file - a File object.

addModuleDirectory

public void addModuleDirectory(File file,
                               String moduleParserId)

addModuleDirectory.

Parameters:

file - a File object.

moduleParserId - a String object.

getSiteDirectories

public List getSiteDirectories()

Getter for the field siteDirectories.

Returns:

a List object.

getModules

public List getModules()

Getter for the field modules.

Returns:

a List object.

getModuleExcludes

public Map getModuleExcludes()

Getter for the field moduleExcludes.

Returns:

a Map object.

setModuleExcludes

public void setModuleExcludes(Map moduleExcludes)

Setter for the field moduleExcludes.

Parameters:

moduleExcludes - a Map object.

getInputEncoding

public String getInputEncoding()

Getter for the field inputEncoding.

Returns:

a String object.

setInputEncoding

public void setInputEncoding(String inputEncoding)

Setter for the field inputEncoding.

Parameters:

inputEncoding - a String object.

getOutputEncoding

public String getOutputEncoding()

Getter for the field outputEncoding.

Returns:

a String object.

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

Setter for the field outputEncoding.

Parameters:

outputEncoding - a String object.