A B C D G H I L M O P R S T W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- addSiteDirectory(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Deprecated.
- addSiteDirectory(SiteRenderingContext.SiteDirectory) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Add a site directory, expected to have a Doxia Site layout, ie one directory per Doxia parser module containing files with parser extension.
- addSiteLocales(List<Locale>) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Adds passed locales to the list of site locales.
- author(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- author_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
B
- body(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Do nothing.
- body_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Do nothing.
C
- configure(String, Path, Parser) - Method in interface org.apache.maven.doxia.siterenderer.ParserConfigurator
-
Configures the given parser which is afterwards used to parse the source file with the given path.
- copyDirectory(File, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Copy the directory
- copyResources(SiteRenderingContext, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Copy resource files from skin, template, and site resources.
- copyResources(SiteRenderingContext, File) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer
-
Copy resource files from skin, template, and site resources.
- createContextForSkin(Artifact, Map<String, ?>, SiteModel, String, Locale) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Create a Site Rendering Context for a site using a skin.
- createContextForSkin(Artifact, Map<String, ?>, SiteModel, String, Locale) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer
-
Create a Site Rendering Context for a site using a skin.
- createDocumentVelocityContext(DocumentRenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Create a Velocity Context for a Doxia document, containing every information about rendered document.
- createSiteTemplateVelocityContext(DocumentContent, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Create a Velocity Context for the site template decorating the document.
- createToolManagedVelocityContext(SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Creates a Velocity Context with all generic tools configured wit the site rendering context.
D
- date(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- date_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- DefaultSiteRenderer - Class in org.apache.maven.doxia.siterenderer
-
DefaultSiteRenderer class.
- DefaultSiteRenderer() - Constructor for class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- DocumentContent - Interface in org.apache.maven.doxia.siterenderer
-
Document content, that will be merged into a site template.
- DocumentRenderer - Interface in org.apache.maven.doxia.siterenderer
-
Renders a page in a site, whatever the source is: a Doxia source file, a report or anything else.
- DocumentRenderingContext - Class in org.apache.maven.doxia.siterenderer
-
The rendering context of a document.
- DocumentRenderingContext(File, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Constructor for rendering context when document is not rendered from a Doxia markup source.
- DocumentRenderingContext(File, String, String, String, String, boolean) - Constructor for class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
- DocumentRenderingContext(File, String, String, String, String, boolean, String) - Constructor for class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Constructor for document rendering context.
- DoxiaDocumentRenderer - Class in org.apache.maven.doxia.siterenderer
-
Renderer for a document that has a source file to be parsed by Doxia.
- DoxiaDocumentRenderer(DocumentRenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
Constructor.
G
- generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- getAttribute(String) - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
getAttribute.
- getAuthors() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent
-
Get the authors of the document.
- getAuthors() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Get the authors of the document.
- getBasedir() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Getter for the field
basedir
. - getBasedirRelativePath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get the relative path of basedir (when a Doxia source)
- getBody() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent
-
Get the html body of the document.
- getBody() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Get the html body of the document.
- getDate() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent
-
Get the date of the document.
- getDate() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Get the date of the document.
- getDefaultTitle() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
defaultTitle
. - getDoxiaSourcePath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get the relative path to Doxia source from build root.
- getDoxiaSourcePath(String) - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get url of the Doxia source calculate from given base url.
- getExtension() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get the source document filename extension (when a Doxia source)
- getGenerator() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
What is the generator (if any)?
- getHead() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent
-
Get the html head of the document.
- getHead() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Get the html head of the document.
- getInputEncoding() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
inputEncoding
. - getInputName() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Deprecated.Method name does not properly reflect its purpose. Use
DocumentRenderingContext.getInputPath()
instead. - getInputPath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Getter for the field
inputPath
. - getLocale() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
locale
. - getModuleExcludes() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
moduleExcludes
. - getOutputEncoding() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
outputEncoding
. - getOutputName() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
Deprecated.Method name does not properly reflect its purpose. Implement and use
DocumentRenderer.getOutputPath()
instead. - getOutputName() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Deprecated.Method name does not properly reflect its purpose. Use
DocumentRenderingContext.getOutputPath()
instead. - getOutputName() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
- getOutputPath() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
The output path of the document.
- getOutputPath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get html output path, relative to site root.
- getParserConfigurator() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Return the configurator for
parsers
. - getParserId() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get the parserId when document comes from a Doxia source.
- getPath() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
- getProcessedContentOutput() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Directory where to save content after Velocity processing (
*.vm
), but before parsing it with Doxia. - getPublishDate() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
If you want to specify a specific publish date instead of the current date.
- getRelativePath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get the relative path to site root.
- getRenderingContext() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent
-
Get the document rendering context.
- getRenderingContext() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
Return the rendering context of the document.
- getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
Return the rendering context of the document.
- getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Get the document rendering context.
- getRootDirectory() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Root directory, to calculate relative path to every site directories.
- getSiteDirectories() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
siteDirectories
. - getSiteLocales() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
siteLocales
- a list of locales available for this site context. - getSiteModel() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
siteModel
. - getSkin() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
skin
. - getSkinModel() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
skinModel
. - getTemplateClassLoader() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
templateClassLoader
. - getTemplateName() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
templateName
. - getTemplateProperties() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
templateProperties
. - getTitle() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent
-
Get the title of the document.
- getTitle() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Get the title of the document.
H
- head(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- head_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
I
- isDoxiaSource() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Is the document rendered from a Doxia source?
- isEditable() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Is the source document editable?
- isEditable() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
- isExternalReport() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
Whether this document is an external report, independent from the site templating.
- isExternalReport() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
- isOverwrite() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
Whether to always overwrite the document, or only do so when it is changed.
- isOverwrite() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
Whether to always overwrite the document, or only do so when it is changed.
- isValidate() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
If input documents should be validated before parsing.
L
- locateDocumentFiles(SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Locate Doxia document source files in the site source context.
- locateDocumentFiles(SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer
-
Locate Doxia document source files in the site source context.
- locateDocumentFiles(SiteRenderingContext, boolean) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer
-
Deprecated.
editable
parameter is ignored sinceSiteRenderingContext.getSiteDirectories()
contain this information on a per-directory basis now.
M
- mergeDocumentIntoSite(Writer, DocumentContent, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Generate a document output integrated in a site from a document content, i.e.
- mergeDocumentIntoSite(Writer, DocumentContent, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer
-
Generate a document output integrated in a site from a document content, i.e.
O
- org.apache.maven.doxia.siterenderer - package org.apache.maven.doxia.siterenderer
- org.apache.maven.doxia.siterenderer.sink - package org.apache.maven.doxia.siterenderer.sink
P
- ParserConfigurator - Interface in org.apache.maven.doxia.siterenderer
-
Interface which allows to configure a particular
Parser
before it is being used.
R
- render(Collection<DocumentRenderer>, SiteRenderingContext, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Render a collection of documents into a site.
- render(Collection<DocumentRenderer>, SiteRenderingContext, File) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer
-
Render a collection of documents into a site.
- renderDocument(Writer, DocumentRenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Render a document written in a Doxia markup language.
- renderDocument(Writer, DocumentRenderingContext, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer
-
Render a document written in a Doxia markup language.
- renderDocument(Writer, SiteRenderer, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
Render a document in a site.
- renderDocument(Writer, SiteRenderer, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
Render a document in a site.
- Renderer - Interface in org.apache.maven.doxia.siterenderer
-
Deprecated.use
SiteRenderer
- RendererException - Exception in org.apache.maven.doxia.siterenderer
-
RendererException class.
- RendererException(String) - Constructor for exception org.apache.maven.doxia.siterenderer.RendererException
-
Construct a RendererException with a message.
- RendererException(String, Throwable) - Constructor for exception org.apache.maven.doxia.siterenderer.RendererException
-
Construct a RendererException with a message and a cause.
S
- setAttribute(String, String) - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
setAttribute.
- setDefaultTitle(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
defaultTitle
. - setInputEncoding(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
inputEncoding
. - setLocale(Locale) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
locale
. - setModuleExcludes(Map<String, String>) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
moduleExcludes
. - setOutputEncoding(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
outputEncoding
. - setParserConfigurator(ParserConfigurator) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Set the configurator to use for
parsers
. - setProcessedContentOutput(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Where to (eventually) save content after Velocity processing (
*.vm
), but before parsing it with Doxia? - setPublishDate(Date) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Specify a specific publish date instead of the current date.
- setRootDirectory(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Set the root directory.
- setSiteModel(SiteModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
siteModel
. - setSkin(Artifact) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
skinJarFile
. - setSkinModel(SkinModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
skinModel
. - setTemplateClassLoader(ClassLoader) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
templateClassLoader
. - setTemplateName(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
templateName
. - setTemplateProperties(Map<String, ?>) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
templateProperties
. - setValidate(boolean) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Switch on/off validation.
- SiteDirectory(File, boolean) - Constructor for class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
- SiteRenderer - Interface in org.apache.maven.doxia.siterenderer
-
Site Renderer interface: render a collection of documents into a site, ie decorated with a site template.
- SiteRendererSink - Class in org.apache.maven.doxia.siterenderer.sink
-
Sink for site rendering of a document, to allow later merge document's output with a template.
- SiteRendererSink(DocumentRenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Construct a new SiteRendererSink for a document.
- SiteRenderingContext - Class in org.apache.maven.doxia.siterenderer
-
Context for a site rendering.
- SiteRenderingContext() - Constructor for class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- SiteRenderingContext.SiteDirectory - Class in org.apache.maven.doxia.siterenderer
T
- title(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Reset text buffer, since text content before title must not be in title.
- title_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
W
- write(String) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
All Classes All Packages