Class SiteRenderingContext
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate DecorationModel
private String
private String
private Locale
private List
<ExtraDoxiaModuleReference> private String
private File
private Date
private File
private org.apache.maven.artifact.Artifact
private SkinModel
private ClassLoader
private String
private boolean
private boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addModuleDirectory
(File moduleBasedir, String moduleParserId) Add a extra-module source directory: used for Maven 1.x${basedir}/xdocs
layout, which containsxdoc
andfml
.void
addSiteDirectory
(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
(List<Locale> locales) Adds passed locales to the list of site locales.Getter for the fielddecoration
.Getter for the fielddefaultWindowTitle
.Getter for the fieldinputEncoding
.Getter for the fieldlocale
.Getter for the fieldmoduleExcludes
.Getter for the fieldmodules
.Getter for the fieldoutputEncoding
.Directory where to save content after Velocity processing (*.vm
), but before parsing it with Doxia.If you want to specify a specific publish date instead of the current date.Root directory, to calculate relative path to every site directories.Getter for the fieldsiteDirectories
.Getter for the fieldsiteLocales
- a list of locales available for this site context.org.apache.maven.artifact.Artifact
getSkin()
Getter for the fieldskin
.Getter for the fieldskinModel
.Getter for the fieldtemplateClassLoader
.Getter for the fieldtemplateName
.Getter for the fieldtemplateProperties
.boolean
isUsingDefaultTemplate.boolean
If input documents should be validated before parsing.void
setDecoration
(DecorationModel decoration) Setter for the fielddecoration
.void
setDefaultWindowTitle
(String defaultWindowTitle) Setter for the fielddefaultWindowTitle
.void
setInputEncoding
(String inputEncoding) Setter for the fieldinputEncoding
.void
Setter for the fieldlocale
.void
setModuleExcludes
(Map<String, String> moduleExcludes) Setter for the fieldmoduleExcludes
.void
setOutputEncoding
(String outputEncoding) Setter for the fieldoutputEncoding
.void
setProcessedContentOutput
(File processedContentOutput) Where to (eventually) save content after Velocity processing (*.vm
), but before parsing it with Doxia?void
setPublishDate
(Date publishDate) Specify a specific publish date instead of the current date.void
setRootDirectory
(File rootDirectory) Set the root directory.void
setSkin
(org.apache.maven.artifact.Artifact skin) Setter for the fieldskinJarFile
.void
setSkinModel
(SkinModel skinModel) Setter for the fieldskinModel
.void
setTemplateClassLoader
(ClassLoader templateClassLoader) Setter for the fieldtemplateClassLoader
.void
setTemplateName
(String templateName) Setter for the fieldtemplateName
.void
setTemplateProperties
(Map<String, ?> templateProperties) Setter for the fieldtemplateProperties
.void
setUsingDefaultTemplate
(boolean usingDefaultTemplate) Setter for the fieldusingDefaultTemplate
.void
setValidate
(boolean validate) Switch on/off validation.
-
Field Details
-
inputEncoding
-
outputEncoding
-
templateName
-
templateClassLoader
-
templateProperties
-
locale
-
siteLocales
-
decoration
-
defaultWindowTitle
-
skin
private org.apache.maven.artifact.Artifact skin -
skinModel
-
usingDefaultTemplate
private boolean usingDefaultTemplate -
rootDirectory
-
siteDirectories
-
moduleExcludes
-
modules
-
validate
private boolean validate -
publishDate
-
processedContentOutput
-
-
Constructor Details
-
SiteRenderingContext
public SiteRenderingContext()
-
-
Method Details
-
isValidate
public boolean isValidate()If input documents should be validated before parsing. By default no validation is performed.- Returns:
- true if validation is switched on.
- Since:
- 1.1.3
-
setValidate
public void setValidate(boolean validate) Switch on/off validation.- Parameters:
validate
- true to switch on validation.- Since:
- 1.1.3
-
getTemplateName
Getter for the field
templateName
.- Returns:
- a
String
object.
-
getTemplateClassLoader
Getter for the field
templateClassLoader
.- Returns:
- a
ClassLoader
object.
-
setTemplateClassLoader
Setter for the field
templateClassLoader
.- Parameters:
templateClassLoader
- aClassLoader
object.
-
getTemplateProperties
Getter for the field
templateProperties
.- Returns:
- a
Map
object.
-
setTemplateProperties
Setter for the field
templateProperties
.- Parameters:
templateProperties
- aMap
object.
-
getLocale
Getter for the field
locale
.- Returns:
- a
Locale
object.
-
setLocale
Setter for the field
locale
.- Parameters:
locale
- aLocale
object.
-
getSiteLocales
Getter for the field
siteLocales
- a list of locales available for this site context. -
addSiteLocales
Adds passed locales to the list of site locales.
- Parameters:
locales
- List ofLocale
objects to add to the site locales list.
-
getDecoration
Getter for the field
decoration
.- Returns:
- a
DecorationModel
object.
-
setDecoration
Setter for the field
decoration
.- Parameters:
decoration
- aDecorationModel
object.
-
setDefaultWindowTitle
Setter for the field
defaultWindowTitle
.- Parameters:
defaultWindowTitle
- aString
object.
-
getDefaultWindowTitle
Getter for the field
defaultWindowTitle
.- Returns:
- a
String
object.
-
getSkin
public org.apache.maven.artifact.Artifact getSkin()Getter for the field
skin
.- Returns:
- a
Artifact
object.
-
setSkin
public void setSkin(org.apache.maven.artifact.Artifact skin) Setter for the field
skinJarFile
.- Parameters:
skin
- anArtifact
object.
-
getSkinModel
Getter for the field
skinModel
.- Returns:
- a
SkinModel
object.
-
setSkinModel
Setter for the field
skinModel
.- Parameters:
skinModel
- aSkinModel
object.
-
setTemplateName
Setter for the field
templateName
.- Parameters:
templateName
- aString
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
Add a site directory, expected to have a Doxia Site layout, ie one directory per Doxia parser module containing files with parser extension. Typical values aresrc/site
ortarget/generated-site
.- Parameters:
siteDirectory
- aFile
object.
-
addModuleDirectory
Add a extra-module source directory: used for Maven 1.x${basedir}/xdocs
layout, which containsxdoc
andfml
.- Parameters:
moduleBasedir
- The base directory for module's source files.moduleParserId
- module's Doxia parser id.
-
getSiteDirectories
Getter for the field
siteDirectories
.- Returns:
- List of site directories files.
-
getModules
Getter for the field
modules
.- Returns:
- a
List
object.
-
getModuleExcludes
Getter for the field
moduleExcludes
.- Returns:
- a map defining exclude patterns (comma separated) by parser id.
-
setModuleExcludes
Setter for the field
moduleExcludes
.- Parameters:
moduleExcludes
- aMap
object.
-
getInputEncoding
Getter for the field
inputEncoding
.- Returns:
- a
String
object.
-
setInputEncoding
Setter for the field
inputEncoding
.- Parameters:
inputEncoding
- aString
object.
-
getOutputEncoding
Getter for the field
outputEncoding
.- Returns:
- a
String
object.
-
setOutputEncoding
Setter for the field
outputEncoding
.- Parameters:
outputEncoding
- aString
object.
-
getPublishDate
If you want to specify a specific publish date instead of the current date.
- Returns:
- the publish date, can be
null
-
setPublishDate
Specify a specific publish date instead of the current date.
- Parameters:
publishDate
- the publish date
-
getProcessedContentOutput
Directory where to save content after Velocity processing (*.vm
), but before parsing it with Doxia.- Returns:
- not null if the documents are to be saved
- Since:
- 1.7
-
setProcessedContentOutput
Where to (eventually) save content after Velocity processing (*.vm
), but before parsing it with Doxia?- Parameters:
processedContentOutput
- not null if the documents are to be saved- Since:
- 1.7
-
getRootDirectory
Root directory, to calculate relative path to every site directories. Corresponds to thepom.xml
directory for Maven build.- Returns:
- the root directory
- Since:
- 1.8
-
setRootDirectory
Set the root directory.- Parameters:
rootDirectory
- the root directory- Since:
- 1.8
-