public class SiteRenderingContext
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private DecorationModel |
decoration |
private java.lang.String |
defaultWindowTitle |
private java.lang.String |
inputEncoding |
private java.util.Locale |
locale |
private java.util.Map<java.lang.String,java.lang.String> |
moduleExcludes |
private java.util.List<ExtraDoxiaModuleReference> |
modules |
private java.lang.String |
outputEncoding |
private java.io.File |
processedContentOutput |
private java.util.Date |
publishDate |
private java.util.List<java.io.File> |
siteDirectories |
private java.util.List<java.util.Locale> |
siteLocales |
private org.apache.maven.artifact.Artifact |
skin |
private SkinModel |
skinModel |
private java.lang.ClassLoader |
templateClassLoader |
private java.lang.String |
templateName |
private java.util.Map<java.lang.String,?> |
templateProperties |
private boolean |
usingDefaultTemplate |
private boolean |
validate |
Constructor and Description |
---|
SiteRenderingContext() |
Modifier and Type | Method and Description |
---|---|
void |
addModuleDirectory(java.io.File moduleBasedir,
java.lang.String moduleParserId)
Add a extra-module source directory: used for Maven 1.x
${basedir}/xdocs layout, which contains
xdoc and fml . |
void |
addSiteDirectory(java.io.File siteDirectory)
Add a site directory, expected to have a Doxia Site layout, ie one directory per Doxia parser module containing
files with parser extension.
|
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<ExtraDoxiaModuleReference> |
getModules()
Getter for the field
modules . |
java.lang.String |
getOutputEncoding()
Getter for the field
outputEncoding . |
java.io.File |
getProcessedContentOutput()
Directory where to save content after Velocity processing (
*.vm ), but before parsing it with Doxia. |
java.util.Date |
getPublishDate()
If you want to specify a specific publish date instead of the current date.
|
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. |
org.apache.maven.artifact.Artifact |
getSkin()
Getter for the field
skin . |
SkinModel |
getSkinModel()
Getter for the field
skinModel . |
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 |
setProcessedContentOutput(java.io.File processedContentOutput)
Where to (eventually) save content after Velocity processing (
*.vm ), but before parsing it with
Doxia? |
void |
setPublishDate(java.util.Date publishDate)
Specify a specific publish date instead of the current date.
|
void |
setSkin(org.apache.maven.artifact.Artifact skin)
Setter for the field
skinJarFile . |
void |
setSkinModel(SkinModel skinModel)
Setter for the field
skinModel . |
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.
|
private java.lang.String inputEncoding
private java.lang.String outputEncoding
private java.lang.String templateName
private java.lang.ClassLoader templateClassLoader
private java.util.Map<java.lang.String,?> templateProperties
private java.util.Locale locale
private java.util.List<java.util.Locale> siteLocales
private DecorationModel decoration
private java.lang.String defaultWindowTitle
private org.apache.maven.artifact.Artifact skin
private SkinModel skinModel
private boolean usingDefaultTemplate
private java.util.List<java.io.File> siteDirectories
private java.util.Map<java.lang.String,java.lang.String> moduleExcludes
private java.util.List<ExtraDoxiaModuleReference> modules
private boolean validate
private java.util.Date publishDate
private java.io.File processedContentOutput
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 org.apache.maven.artifact.Artifact getSkin()
Getter for the field skin
.
Artifact
object.public void setSkin(org.apache.maven.artifact.Artifact skin)
Setter for the field skinJarFile
.
skin
- an Artifact
object.public SkinModel getSkinModel()
Getter for the field skinModel
.
SkinModel
object.public void setSkinModel(SkinModel skinModel)
Setter for the field skinModel
.
skinModel
- a SkinModel
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 siteDirectory)
src/site
or target/generated-site
.siteDirectory
- a File
object.public void addModuleDirectory(java.io.File moduleBasedir, java.lang.String moduleParserId)
${basedir}/xdocs
layout, which contains
xdoc
and fml
.moduleBasedir
- The base directory for module's source files.moduleParserId
- module's Doxia parser id.public java.util.List<java.io.File> getSiteDirectories()
Getter for the field siteDirectories
.
public java.util.List<ExtraDoxiaModuleReference> 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.public java.util.Date getPublishDate()
If you want to specify a specific publish date instead of the current date.
null
public void setPublishDate(java.util.Date publishDate)
Specify a specific publish date instead of the current date.
publishDate
- the publish datepublic java.io.File getProcessedContentOutput()
*.vm
), but before parsing it with Doxia.public void setProcessedContentOutput(java.io.File processedContentOutput)
*.vm
), but before parsing it with
Doxia?processedContentOutput
- not null if the documents are to be saved