|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.doxia.siterenderer.SiteRenderingContext
public class SiteRenderingContext
Context for a site rendering.
Constructor Summary | |
---|---|
SiteRenderingContext()
|
Method Summary | |
---|---|
void |
addModuleDirectory(java.io.File moduleBasedir,
java.lang.String moduleParserId)
Add a module source directory. |
void |
addSiteDirectory(java.io.File file)
addSiteDirectory. |
void |
addSiteLocales(java.util.List<java.util.Locale> locales)
Adds passed locales to the list of site locales. |
DecorationModel |
getDecoration()
Getter for the field decoration . |
java.lang.String |
getDefaultWindowTitle()
Getter for the field defaultWindowTitle . |
java.lang.String |
getInputEncoding()
Getter for the field inputEncoding . |
java.util.Locale |
getLocale()
Getter for the field locale . |
java.util.Map<java.lang.String,java.lang.String> |
getModuleExcludes()
Getter for the field moduleExcludes . |
java.util.List<org.apache.maven.doxia.siterenderer.ModuleReference> |
getModules()
Getter for the field modules . |
java.lang.String |
getOutputEncoding()
Getter for the field outputEncoding . |
java.util.List<java.io.File> |
getSiteDirectories()
Getter for the field siteDirectories . |
java.util.List<java.util.Locale> |
getSiteLocales()
Getter for the field siteLocales -
a list of locales available for this site context. |
java.io.File |
getSkinJarFile()
Getter for the field skinJarFile . |
java.lang.ClassLoader |
getTemplateClassLoader()
Getter for the field templateClassLoader . |
java.lang.String |
getTemplateName()
Getter for the field templateName . |
java.util.Map<java.lang.String,?> |
getTemplateProperties()
Getter for the field templateProperties . |
boolean |
isUsingDefaultTemplate()
isUsingDefaultTemplate. |
boolean |
isValidate()
If input documents should be validated before parsing. |
void |
setDecoration(DecorationModel decoration)
Setter for the field decoration . |
void |
setDefaultWindowTitle(java.lang.String defaultWindowTitle)
Setter for the field defaultWindowTitle . |
void |
setInputEncoding(java.lang.String inputEncoding)
Setter for the field inputEncoding . |
void |
setLocale(java.util.Locale locale)
Setter for the field locale . |
void |
setModuleExcludes(java.util.Map<java.lang.String,java.lang.String> moduleExcludes)
Setter for the field moduleExcludes . |
void |
setOutputEncoding(java.lang.String outputEncoding)
Setter for the field outputEncoding . |
void |
setSkinJarFile(java.io.File skinJarFile)
Setter for the field skinJarFile . |
void |
setTemplateClassLoader(java.lang.ClassLoader templateClassLoader)
Setter for the field templateClassLoader . |
void |
setTemplateName(java.lang.String templateName)
Setter for the field templateName . |
void |
setTemplateProperties(java.util.Map<java.lang.String,?> templateProperties)
Setter for the field templateProperties . |
void |
setUsingDefaultTemplate(boolean usingDefaultTemplate)
Setter for the field usingDefaultTemplate . |
void |
setValidate(boolean validate)
Switch on/off validation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SiteRenderingContext()
Method Detail |
---|
public boolean isValidate()
public void setValidate(boolean validate)
validate
- true to switch on validation.public java.lang.String getTemplateName()
Getter for the field templateName
.
String
object.public java.lang.ClassLoader getTemplateClassLoader()
Getter for the field templateClassLoader
.
ClassLoader
object.public void setTemplateClassLoader(java.lang.ClassLoader templateClassLoader)
Setter for the field templateClassLoader
.
templateClassLoader
- a ClassLoader
object.public java.util.Map<java.lang.String,?> getTemplateProperties()
Getter for the field templateProperties
.
Map
object.public void setTemplateProperties(java.util.Map<java.lang.String,?> templateProperties)
Setter for the field templateProperties
.
templateProperties
- a Map
object.public java.util.Locale getLocale()
Getter for the field locale
.
Locale
object.public void setLocale(java.util.Locale locale)
Setter for the field locale
.
locale
- a Locale
object.public java.util.List<java.util.Locale> getSiteLocales()
Getter for the field siteLocales
-
a list of locales available for this site context.
List
object with Locale
objects.public void addSiteLocales(java.util.List<java.util.Locale> locales)
Adds passed locales to the list of site locales.
locales
- List of Locale
objects to add to the site locales list.public DecorationModel getDecoration()
Getter for the field decoration
.
DecorationModel
object.public void setDecoration(DecorationModel decoration)
Setter for the field decoration
.
decoration
- a DecorationModel
object.public void setDefaultWindowTitle(java.lang.String defaultWindowTitle)
Setter for the field defaultWindowTitle
.
defaultWindowTitle
- a String
object.public java.lang.String getDefaultWindowTitle()
Getter for the field defaultWindowTitle
.
String
object.public java.io.File getSkinJarFile()
Getter for the field skinJarFile
.
File
object.public void setSkinJarFile(java.io.File skinJarFile)
Setter for the field skinJarFile
.
skinJarFile
- a File
object.public void setTemplateName(java.lang.String templateName)
Setter for the field templateName
.
templateName
- a String
object.public void setUsingDefaultTemplate(boolean usingDefaultTemplate)
Setter for the field usingDefaultTemplate
.
usingDefaultTemplate
- a boolean.public boolean isUsingDefaultTemplate()
isUsingDefaultTemplate.
public void addSiteDirectory(java.io.File file)
addSiteDirectory.
file
- a File
object.public void addModuleDirectory(java.io.File moduleBasedir, java.lang.String moduleParserId)
moduleBasedir
- The base directory for module's source files.moduleParserId
- a String
object.public java.util.List<java.io.File> getSiteDirectories()
Getter for the field siteDirectories
.
public java.util.List<org.apache.maven.doxia.siterenderer.ModuleReference> getModules()
Getter for the field modules
.
List
object.public java.util.Map<java.lang.String,java.lang.String> getModuleExcludes()
Getter for the field moduleExcludes
.
public void setModuleExcludes(java.util.Map<java.lang.String,java.lang.String> moduleExcludes)
Setter for the field moduleExcludes
.
moduleExcludes
- a Map
object.public java.lang.String getInputEncoding()
Getter for the field inputEncoding
.
String
object.public void setInputEncoding(java.lang.String inputEncoding)
Setter for the field inputEncoding
.
inputEncoding
- a String
object.public java.lang.String getOutputEncoding()
Getter for the field outputEncoding
.
String
object.public void setOutputEncoding(java.lang.String outputEncoding)
Setter for the field outputEncoding
.
outputEncoding
- a String
object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |