Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractDocumentRenderer - Class in org.apache.maven.doxia.docrenderer
-
Deprecated.
- AbstractDocumentRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- AbstractPdfRenderer - Class in org.apache.maven.doxia.docrenderer.pdf
-
Deprecated.
- AbstractPdfRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer
-
Deprecated.
- addBreadcrumb(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method addBreadcrumb.
- addDefaultEntities - Variable in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
If set the parser will be loaded with all single characters from the XHTML specification.
- addDefaultEntities - Variable in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
If set the parser will be loaded with all single characters from the XHTML specification.
- addItem(MenuItem) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Method addItem.
- addItem(MenuItem) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Method addItem.
- addLink(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method addLink.
- addMenu(Menu) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method addMenu.
- addModuleDirectory(File, String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Add a extra-module source directory: used for Maven 1.x
${basedir}/xdocs
layout, which containsxdoc
andfml
. - addModuleFiles(File, File, ParserModule, String, Map<String, DocumentRenderer>, boolean) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- addPoweredBy(Logo) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Method addPoweredBy.
- addSiteDirectory(File) - 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.
- alt - Variable in class org.apache.maven.doxia.site.decoration.Banner
-
The alt description for the banner image.
- alt - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
The alt to use for the image.
- alt - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
The alt description for the image.
- anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- anchorsInSectionTitle - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- appendMenuItem(MavenProject, Menu, String, String, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- artifactFactory - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool
-
The component used for creating artifact instances.
- artifactId - Variable in class org.apache.maven.doxia.site.decoration.Skin
-
The skin artifact ID.
- artifactResolver - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool
-
The component that is used to resolve additional artifacts required.
- assembleBodyInheritance(String, DecorationModel, DecorationModel, DefaultDecorationModelInheritanceAssembler.URLRebaser) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- assembleCustomInheritance(DecorationModel, DecorationModel) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- assembleModelInheritance(String, DecorationModel, DecorationModel, String, String) - Method in interface org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler
-
Manage inheritance of the decoration model between a parent and child.
- assembleModelInheritance(String, DecorationModel, DecorationModel, String, String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
-
Manage inheritance of the decoration model between a parent and child.
- assembler - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool
-
The component for assembling inheritance.
- attributes - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- author() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- author_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- authors - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
B
- Banner - Class in org.apache.maven.doxia.site.decoration
-
Banner logo on the masthead of the site.
- Banner() - Constructor for class org.apache.maven.doxia.site.decoration.Banner
- bannerLeft - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Banner logo on the masthead of the site to the left.
- bannerRight - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Banner logo on the masthead of the site to the right.
- basedir - Variable in class org.apache.maven.doxia.siterenderer.ExtraDoxiaModuleReference
- basedir - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- baseDir - Variable in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.The common base directory of source files.
- basedirRelativePath - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- baseURI - Variable in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
- baseUrl - Variable in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
- body - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
The main site content decoration.
- body() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Do nothing.
- Body - Class in org.apache.maven.doxia.site.decoration
-
The main content decoration.
- Body() - Constructor for class org.apache.maven.doxia.site.decoration.Body
- body_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Do nothing.
- border - Variable in class org.apache.maven.doxia.site.decoration.Banner
-
The border to use for the banner image.
- border - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
The border to use for the image.
- border - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
The border to use for the menu image.
- breadcrumbs - Variable in class org.apache.maven.doxia.site.decoration.Body
-
Field breadcrumbs.
- buildBaseUrl(String) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
- buildRelativePath(String, String, char) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
- buildUrl(URL, String) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
C
- checkFieldWithDuplicate(XmlPullParser, String, String, Set) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method checkFieldWithDuplicate.
- checkFieldWithDuplicate(XmlPullParser, String, String, Set) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method checkFieldWithDuplicate.
- checkNotNull(String, Object) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- checkUnknownAttribute(XmlPullParser, String, String, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method checkUnknownAttribute.
- checkUnknownAttribute(XmlPullParser, String, String, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method checkUnknownAttribute.
- checkUnknownElement(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method checkUnknownElement.
- checkUnknownElement(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method checkUnknownElement.
- clone() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.decoration.Logo
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.decoration.Version
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.skin.Prerequisites
-
Method clone.
- clone() - Method in class org.apache.maven.doxia.site.skin.SkinModel
-
Method clone.
- closeZipFile(ZipFile) - Static method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- codeToLocale(String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Converts a locale code like "en", "en_US" or "en_US_win" to a
java.util.Locale
object. - collapse - Variable in class org.apache.maven.doxia.site.decoration.MenuItem
-
Whether to collapse children elements of an item menu (by default).
- combineSelf - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Whether to inherit configuration from a parent project site descriptor (
merge
) or not (override
). - compare(MavenReport, MavenReport) - Method in class org.apache.maven.doxia.tools.ReportComparator
- containsKey(Object) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.Indicates whether the specified key is in the context.
- contentTransformer - Variable in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Field contentTransformer.
- contentTransformer - Variable in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Field contentTransformer.
- context - Variable in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.Storage for key/value pairs.
- convertPath(PathDescriptor, PathDescriptor) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.PathUtils
-
Deprecated.convertPath.
- copyDirectory(File, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Copy content of a directory, excluding scm-specific files.
- copyDirectory(File, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Copy the directory
- copyFileFromZip(ZipFile, ZipEntry, File) - Static method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- copyResources(File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Copies the contents of the resource directory to an output folder.
- 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.Renderer
-
Copy resource files from skin, template, and site resources.
- copyResources(SiteRenderingContext, File, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Copy resource files.
- copyResources(SiteRenderingContext, File, File) - Method in interface org.apache.maven.doxia.siterenderer.Renderer
-
Deprecated.since 1.7, use copyResources without resourcesDirectory parameter
- correctRelativePath(String) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
- createCategoryMenu(String, String, List<MavenReport>, Locale) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- createContextForSkin(Artifact, Map<String, ?>, DecorationModel, 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, ?>, DecorationModel, String, Locale) - Method in interface org.apache.maven.doxia.siterenderer.Renderer
-
Create a Site Rendering Context for a site using a skin.
- createContextForTemplate(File, Map<String, ?>, DecorationModel, String, Locale) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Deprecated.
- createContextForTemplate(File, Map<String, ?>, DecorationModel, String, Locale) - Method in interface org.apache.maven.doxia.siterenderer.Renderer
-
Deprecated.Deprecated without replacement, use skins only.
- createDocumentVelocityContext(RenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Create a Velocity Context for a Doxia document, containing every information about rendered document.
- createSiteRenderingContext(Map<String, ?>, DecorationModel, String, Locale) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- 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.
- custom - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Custom configuration for use with customized Velocity templates.
D
- date - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- date() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- date_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- debug(CharSequence) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- debug(CharSequence, Throwable) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- debug(Throwable) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- decoration - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- DecorationModel - Class in org.apache.maven.doxia.site.decoration
-
The
<project>
element is the root of the site decoration descriptor. - DecorationModel() - Constructor for class org.apache.maven.doxia.site.decoration.DecorationModel
- DecorationModelInheritanceAssembler - Interface in org.apache.maven.doxia.site.decoration.inheritance
-
Manage inheritance of the decoration model.
- decorationModelToString(DecorationModel) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- DecorationUtils - Class in org.apache.maven.doxia.site.decoration
-
Decoration model utilities.
- DecorationUtils() - Constructor for class org.apache.maven.doxia.site.decoration.DecorationUtils
- DecorationXpp3Reader - Class in org.apache.maven.doxia.site.decoration.io.xpp3
-
Class DecorationXpp3Reader.
- DecorationXpp3Reader() - Constructor for class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
- DecorationXpp3Reader(DecorationXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
- DecorationXpp3Reader.ContentTransformer - Interface in org.apache.maven.doxia.site.decoration.io.xpp3
- DecorationXpp3Writer - Class in org.apache.maven.doxia.site.decoration.io.xpp3
-
Class DecorationXpp3Writer.
- DecorationXpp3Writer() - Constructor for class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
- DEFAULT_LOCALE - Static variable in interface org.apache.maven.doxia.tools.SiteTool
-
The locale by default for a Maven Site
- DEFAULT_TEMPLATE - Static variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- DefaultDecorationModelInheritanceAssembler - Class in org.apache.maven.doxia.site.decoration.inheritance
-
Manage inheritance of the decoration model.
- DefaultDecorationModelInheritanceAssembler() - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- DefaultDecorationModelInheritanceAssembler.URLRebaser - Class in org.apache.maven.doxia.site.decoration.inheritance
-
URL rebaser: based on an old and a new path, can rebase a link based on old path to a value based on the new path.
- DefaultSiteRenderer - Class in org.apache.maven.doxia.siterenderer
-
DefaultSiteRenderer class.
- DefaultSiteRenderer() - Constructor for class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- DefaultSiteTool - Class in org.apache.maven.doxia.tools
-
Default implementation of the site tool.
- DefaultSiteTool() - Constructor for class org.apache.maven.doxia.tools.DefaultSiteTool
- defaultWindowTitle - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- description - Variable in class org.apache.maven.doxia.site.decoration.MenuItem
-
A description of the menu item.
- DocRenderer - Interface in org.apache.maven.doxia.docrenderer
-
Deprecated.Since 1.1, use
DocumentRenderer
instead. - 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.docrenderer
-
Deprecated.
- 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.
- DocumentRendererContext - Class in org.apache.maven.doxia.docrenderer
-
Deprecated.
- DocumentRendererContext() - Constructor for class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.Default constructor.
- DocumentRendererException - Exception Class in org.apache.maven.doxia.docrenderer
-
Deprecated.
- DocumentRendererException(String) - Constructor for exception class org.apache.maven.doxia.docrenderer.DocumentRendererException
-
Deprecated.Default constructor.
- DocumentRendererException(String, Throwable) - Constructor for exception class org.apache.maven.doxia.docrenderer.DocumentRendererException
-
Deprecated.Other constructor.
- doxia - Variable in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- doxia - Variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- DoxiaDocumentRenderer - Class in org.apache.maven.doxia.siterenderer
-
Renderer for a document that has a source file to be parsed by Doxia.
- DoxiaDocumentRenderer(RenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
Constructor.
- doxiaSitetools - Variable in class org.apache.maven.doxia.site.skin.Prerequisites
-
The minimum version of Doxia Sitetools required to use the resulting skin.
E
- edit - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
The base url to edit Doxia document sources.
- editable - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- encoding - Variable in class org.apache.maven.doxia.site.skin.SkinModel
-
Encoding of text content, like the Velocity template itself.
- endsWithIgnoreCase(String, String) - Static method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- endsWithIgnoreCase(String, String) - Static method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- endsWithIgnoreCase(String, String[]) - Static method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Version
-
Method equals.
- error(CharSequence) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- error(CharSequence, Throwable) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- error(Throwable) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- extension - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- ExtraDoxiaModuleReference - Class in org.apache.maven.doxia.siterenderer
-
Holds an extra Doxia source module reference in the list of added modules to the site rendering context.
- ExtraDoxiaModuleReference(String, File) - Constructor for class org.apache.maven.doxia.siterenderer.ExtraDoxiaModuleReference
F
- fileComment - Variable in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Field fileComment.
- filterExtensionIgnoreCase(List<String>, String) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- footer - Variable in class org.apache.maven.doxia.site.decoration.Body
-
If present, the contained text will be used instead of the generated copyright text.
- FoPdfRenderer - Class in org.apache.maven.doxia.docrenderer.pdf.fo
-
Deprecated.
- FoPdfRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.
- format - Variable in class org.apache.maven.doxia.site.decoration.PublishDate
-
Date format to use.
G
- generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Generate a document output from a Doxia SiteRenderer Sink, i.e.
- generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.Renderer
-
Deprecated.since 1.8, use mergeDocumentIntoSite
- generatePdf(File, File) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.Generate a final pdf ouput file from an intermediate format file.
- generatePdf(File, File) - Method in interface org.apache.maven.doxia.docrenderer.pdf.PdfRenderer
-
Deprecated.Generate a final pdf ouput file from an intermediate format file.
- generatePdf(File, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.
- generator - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- get(String) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.Gets the value corresponding to the provided key from the context.
- getAddDefaultEntities() - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Returns the state of the "add default entities" flag.
- getAddDefaultEntities() - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Returns the state of the "add default entities" flag.
- getAlt() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the alt description for the banner image.
- getAlt() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the alt to use for the image.
- getAlt() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the alt description for the image.
- getArtifactId() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Get the skin artifact ID.
- getAttribute(String) - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
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.
- getBannerLeft() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get banner logo on the masthead of the site to the left.
- getBannerRight() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get banner logo on the masthead of the site to the right.
- getBasedir() - Method in class org.apache.maven.doxia.siterenderer.ExtraDoxiaModuleReference
-
Getter for the field
basedir
. - getBasedir() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Getter for the field
basedir
. - getBaseDir() - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Return the current base directory.
- getBasedirRelativePath() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Get the relative path of basedir (when a Doxia source)
- getBaseURI() - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Return the base of this URIPathDescriptor as a URI.
- getBaseUrl() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.Get the base URL.
- getBody() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the main site content decoration.
- 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.
- getBooleanValue(String, String, XmlPullParser) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getBooleanValue.
- getBooleanValue(String, String, XmlPullParser) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getBooleanValue.
- getBooleanValue(String, String, XmlPullParser, String) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getBooleanValue.
- getBooleanValue(String, String, XmlPullParser, String) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getBooleanValue.
- getBorder() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the border to use for the banner image.
- getBorder() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the border to use for the image.
- getBorder() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the border to use for the menu image.
- getBreadcrumbs() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method getBreadcrumbs.
- getByteValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getByteValue.
- getByteValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getByteValue.
- getCharacterValue(String, String, XmlPullParser) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getCharacterValue.
- getCharacterValue(String, String, XmlPullParser) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getCharacterValue.
- getCombineSelf() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get whether to inherit configuration from a parent project site descriptor (
merge
) or not (override
). - getCustom() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get custom configuration for use with customized Velocity templates.
- getCustomChild(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- getCustomChild(Xpp3Dom, String) - Static method in class org.apache.maven.doxia.site.decoration.DecorationUtils
-
Helper to get decoration custom DOM element by simply specifying a dotted path.
- getCustomValue(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- getCustomValue(String, String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- getCustomValue(Xpp3Dom, String) - Static method in class org.apache.maven.doxia.site.decoration.DecorationUtils
-
Helper to get decoration custom DOM element value by simply specifying a dotted path.
- getCustomValue(Xpp3Dom, String, String) - Static method in class org.apache.maven.doxia.site.decoration.DecorationUtils
-
Helper to get decoration custom DOM element value by simply specifying a dotted path.
- 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.
- getDateValue(String, String, String, XmlPullParser) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getDateValue.
- getDateValue(String, String, String, XmlPullParser) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getDateValue.
- getDateValue(String, String, XmlPullParser) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getDateValue.
- getDateValue(String, String, XmlPullParser) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getDateValue.
- getDecoration() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
decoration
. - getDecorationModel(int, File, Locale, MavenProject, List<MavenProject>, ArtifactRepository, List<ArtifactRepository>) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- getDecorationModel(File, Locale, MavenProject, List<MavenProject>, ArtifactRepository, List<ArtifactRepository>) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Get a decoration model for a project.
- getDecorationModel(File, Locale, MavenProject, List<MavenProject>, ArtifactRepository, List<ArtifactRepository>) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Get a decoration model for a project.
- getDefaultSkin() - Static method in class org.apache.maven.doxia.site.decoration.Skin
- getDefaultSkinArtifact(ArtifactRepository, List<ArtifactRepository>) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- getDefaultSkinArtifact(ArtifactRepository, List<ArtifactRepository>) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Get the default skin artifact for a project from one of the repositories.
- getDefaultWindowTitle() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
defaultWindowTitle
. - getDescription() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Get a description of the menu item.
- getDistMgmntSiteUrl(DistributionManagement) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
- getDistMgmntSiteUrl(MavenProject) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Return distributionManagement.site.url if defined, null otherwise.
- getDoubleValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getDoubleValue.
- getDoubleValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getDoubleValue.
- getDoxiaSitetools() - Method in class org.apache.maven.doxia.site.skin.Prerequisites
-
Get the minimum version of Doxia Sitetools required to use the resulting skin.
- getDoxiaSourcePath() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Get the relative path to Doxia source from build root.
- getDoxiaSourcePath(String) - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Get url of the Doxia source calculate from given base url.
- getEdit() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the base url to edit Doxia document sources.
- getEncoding() - Method in class org.apache.maven.doxia.site.skin.SkinModel
-
Get encoding of text content, like the Velocity template itself.
- getExtension() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Get the source document filename extension (when a Doxia source)
- getExtensions(ParserModule) - Static method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- getFilesToProcess(File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Returns a Map of files to process.
- getFilesToProcess(Collection<String>) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Returns a Map of files to process.
- getFloatValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getFloatValue.
- getFloatValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getFloatValue.
- getFooter() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Get if present, the contained text will be used instead of the generated copyright text.
- getFormat() - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Get date format to use.
- getGenerator() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
What is the generator (if any)?
- getGoogleAdSenseClient() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get your Google AdSense client id.
- getGoogleAdSenseSlot() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get your Google AdSense slot id.
- getGoogleAnalyticsAccountId() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the id for your Google Analytics account.
- getGroupId() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Get the skin group ID.
- getHead() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Get additional content (like JavaScript) to include in the HEAD block of the generated pages.
- 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.
- getHeight() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the height to use for the banner image.
- getHeight() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the height to use for the image.
- getHeight() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the height to use for the menu image.
- getHref() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the href of a link to be used for the banner image.
- getHref() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the href to use for the link.
- getImg() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the source location of an image.
- getImg() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the source location of an menu image.
- getInherit() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the way in which the menu is inherited.
- getInputEncoding() - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.
- getInputEncoding() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
inputEncoding
. - getInputName() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Getter for the field
inputName
. - getIntegerValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getIntegerValue.
- getIntegerValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getIntegerValue.
- getInterpolatedSiteDescriptorContent(Map<String, String>, MavenProject, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Interpolating several expressions in the site descriptor content.
- getInterpolatedSiteDescriptorContent(Map<String, String>, MavenProject, String) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Interpolating several expressions in the site descriptor content.
- getInterpolatedSiteDescriptorContent(MavenProject, String, boolean) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- getItems() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Method getItems.
- getItems() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Method getItems.
- getKeys() - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.Get all the keys for the values in the context
- getLastModified() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get timestamp of the last modification of this decoration model.
- getLastModified(Resource) - Method in class org.apache.maven.doxia.docrenderer.SiteResourceLoader
-
Deprecated.
- getLastModified(Resource) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader
-
Deprecated.
- getLink() - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Return the link of this URIPathDescriptor as a URI.
- getLinks() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method getLinks.
- getLocale() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
locale
. - getLocation() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.Get the location for files.
- getLongValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getLongValue.
- getLongValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getLongValue.
- getMavenVersion() - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
- getMenuRef(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- getMenus() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method getMenus.
- getMenus() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- getModelEncoding() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the modelEncoding field.
- getModelEncoding() - Method in class org.apache.maven.doxia.site.skin.SkinModel
-
Get the modelEncoding field.
- getModuleExcludes() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
moduleExcludes
. - getModuleFromReactor(MavenProject, List<MavenProject>, String) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
- getModules() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
modules
. - getName() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the name of the banner.
- getName() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the full name of the project.
- getName() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the name to display for the link.
- getName() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the name to display for the menu.
- getNewPath() - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLRebaser
-
Get the new path.
- getNormalizedPath(String) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
- getOldPath() - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLRebaser
-
Get the old path.
- getOutputEncoding() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
outputEncoding
. - getOutputExtension() - Method in interface org.apache.maven.doxia.docrenderer.DocRenderer
-
Deprecated.Get the output extension supported
- getOutputExtension() - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Deprecated.Get the output extension associated with this DocumentRenderer.
- getOutputExtension() - Method in class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer
-
Deprecated.Get the output extension associated with this DocumentRenderer.
- getOutputName() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
The name of the output document.
- getOutputName() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
The name of the output document.
- getOutputName() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Get html output name, relative to site root.
- getOutputName(DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- getParentProject(MavenProject, List<MavenProject>, ArtifactRepository) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Returns the parent POM with interpolated URLs.
- getParentProject(MavenProject, List<MavenProject>, ArtifactRepository) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Returns the parent POM with interpolated URLs.
- getParserId() - Method in class org.apache.maven.doxia.siterenderer.ExtraDoxiaModuleReference
-
Getter for the field
parserId
. - getParserId() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Get the parserId when document comes from a Doxia source.
- getPath() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.Get the path.
- getPathUrl() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.Get the path as a URL.
- getPosition() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get where to place the image regarding the displayed name (left or right).
- getPosition() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get where to place the image regarding the displayed name (left or right).
- getPosition() - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Get where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
- getPosition() - Method in class org.apache.maven.doxia.site.decoration.Version
-
Get where to place the version published (left, right, navigation-top, navigation-bottom, bottom).
- getPoweredBy() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Method getPoweredBy.
- getPrerequisites() - Method in class org.apache.maven.doxia.site.skin.SkinModel
-
Get describes the prerequisites in the build environment for using this skin.
- 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.site.decoration.DecorationModel
- getPublishDate() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
If you want to specify a specific publish date instead of the current date.
- getRef() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get mark this menu as reference to a pre-defined menu:
reports
,modules
orparent
. - getRef() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Get a reference to a pre-defined menu item, such as a report (specified by the report goal name).
- getRelativeFilePath(String, String) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
- getRelativePath() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Get the relative path to site root.
- getRelativePath(String, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Deprecated.
- getRelativePath(String, String) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Calculate the relative path between two URLs or between two files.
- getRelativePath(PathDescriptor, PathDescriptor) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.PathUtils
-
Deprecated.getRelativePath.
- 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 RenderingContext of the document.
- getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
Return the RenderingContext of the document.
- getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Get the document rendering context.
- getRequiredAttributeValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getRequiredAttributeValue.
- getRequiredAttributeValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getRequiredAttributeValue.
- getResourceReader(String, String) - Method in class org.apache.maven.doxia.docrenderer.SiteResourceLoader
-
Deprecated.
- getResourceReader(String, String) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader
-
Deprecated.
- getRootDirectory() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Root directory, to calculate relative path to every site directories.
- getShortValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getShortValue.
- getShortValue(String, String, XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getShortValue.
- getSiteDescriptor(File, Locale) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Get a site descriptor from the project's site directory.
- getSiteDescriptor(File, Locale) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Get a site descriptor from the project's site directory.
- getSiteDescriptorFromRepository(MavenProject, ArtifactRepository, List<ArtifactRepository>, Locale) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Get a site descriptor from one of the repositories.
- 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. - getSiteLocales(String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Extracts from a comma-separated list the locales that are available in
site-tool
resource bundle. - getSiteLocales(String) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Extracts from a comma-separated list the locales that are available in
site-tool
resource bundle. - getSkin() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the artifact containing the skin for the site.
- getSkin() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
skin
. - getSkinArtifactFromRepository(ArtifactRepository, List<ArtifactRepository>, DecorationModel) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- getSkinArtifactFromRepository(ArtifactRepository, List<ArtifactRepository>, DecorationModel) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Get a skin artifact from one of the repositories.
- getSkinModel() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field
skinModel
. - getSrc() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the source location of an image for the banner.
- getTarget() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get where the new document will be displayed when the user follows a link, i.e.
- 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 class org.apache.maven.doxia.site.decoration.Banner
-
Get the title for the banner image.
- getTitle() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the title to use for the image.
- getTitle() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the title for the image.
- 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.
- getTrimmedValue(String) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method getTrimmedValue.
- getTrimmedValue(String) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method getTrimmedValue.
- getVelocityReader(File, String, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.TODO: DOXIA-111: we need a general filter here that knows how to alter the context
- getVersion() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- getVersion() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Get the skin version.
- getWidth() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the width to use for the banner image.
- getWidth() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the width to use for the image.
- getWidth() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the width to use for the menu image.
- getZipFile(File) - Static method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- googleAdSenseClient - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Your Google AdSense client id.
- googleAdSenseSlot - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Your Google AdSense slot id.
- googleAnalyticsAccountId - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
The id for your Google Analytics account.
- groupId - Variable in class org.apache.maven.doxia.site.decoration.Skin
-
The skin group ID.
H
- hashCode() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.site.decoration.Version
-
Method hashCode.
- head - Variable in class org.apache.maven.doxia.site.decoration.Body
-
Additional content (like JavaScript) to include in the HEAD block of the generated pages.
- head() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- head_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- headWriter - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- height - Variable in class org.apache.maven.doxia.site.decoration.Banner
-
The height to use for the banner image.
- height - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
The height to use for the image.
- height - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
The height to use for the menu image.
- href - Variable in class org.apache.maven.doxia.site.decoration.Banner
-
The href of a link to be used for the banner image.
- href - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
The href to use for the link.
I
- i18n - Variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- i18n - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Internationalization.
- img - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
The source location of an image.
- img - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
The source location of an menu image.
- info(CharSequence) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- info(CharSequence, Throwable) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- info(Throwable) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- inherit - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
The way in which the menu is inherited.
- inheritAsRef - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
If this is a reference, setting <inheritAsRef>true</inheritAsRef> means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.
- init(ExtProperties) - Method in class org.apache.maven.doxia.docrenderer.SiteResourceLoader
-
Deprecated.
- init(ExtProperties) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader
-
Deprecated.
- inputEncoding - Variable in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.
- inputEncoding - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- inputName - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- interpolatedTrimmed(String, String) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method interpolatedTrimmed.
- interpolatedTrimmed(String, String) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method interpolatedTrimmed.
- isCollapse() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Get whether to collapse children elements of an item menu (by default).
- isDebugEnabled() - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- isDefaultPublishDate() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- isDefaultVersion() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- isDoxiaSource() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Is the document rendered from a Doxia source?
- isEditable() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Is the source document editable?
- isEmptyList(List<?>) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Convenience method.
- isErrorEnabled() - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- 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
- isFile() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.Check if this PathDescriptor describes a file.
- isInfoEnabled() - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- isInheritAsRef() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get if this is a reference, setting <inheritAsRef>true</inheritAsRef> means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.
- isLink(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- isLink(String) - Static method in class org.apache.maven.doxia.site.decoration.DecorationUtils
- isMaven3OrMore() - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Check the current Maven version to see if it's Maven 3.0 or newer.
- isMergeParent() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- 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.
- isRelative() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.Check if this PathDescriptor describes a relative path.
- isSectionTitle - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- isSourceModified(Resource) - Method in class org.apache.maven.doxia.docrenderer.SiteResourceLoader
-
Deprecated.
- isSourceModified(Resource) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader
-
Deprecated.
- isUsingDefaultTemplate() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
isUsingDefaultTemplate.
- isValidate() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
If input documents should be validated before parsing.
- isVelocityFile(File) - Static method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- isWarnEnabled() - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- items - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
Field items.
- items - Variable in class org.apache.maven.doxia.site.decoration.MenuItem
-
Field items.
L
- lastModified - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Timestamp of the last modification of this decoration model.
- link - Variable in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
- LinkItem - Class in org.apache.maven.doxia.site.decoration
-
A link in the navigation.
- LinkItem() - Constructor for class org.apache.maven.doxia.site.decoration.LinkItem
- links - Variable in class org.apache.maven.doxia.site.decoration.Body
-
Field links.
- locale - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- locale - Variable in class org.apache.maven.doxia.tools.ReportComparator
-
the local
- 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.Renderer
-
Deprecated.since 1.8, use locateDocumentFiles with editable parameter
- locateDocumentFiles(SiteRenderingContext, boolean) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Locate Doxia document source files in the site source context.
- locateDocumentFiles(SiteRenderingContext, boolean) - Method in interface org.apache.maven.doxia.siterenderer.Renderer
-
Locate Doxia document source files in the site source context.
- Logo - Class in org.apache.maven.doxia.site.decoration
-
Power by logo on the navigation.
- Logo() - Constructor for class org.apache.maven.doxia.site.decoration.Logo
M
- matchVersion(String, String) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- mavenProjectBuilder - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Project builder (deprecated in Maven 3: should use ProjectBuilder, which will avoid issues like DOXIASITETOOLS-166)
- Menu - Class in org.apache.maven.doxia.site.decoration
-
A menu in the navigation.
- Menu() - Constructor for class org.apache.maven.doxia.site.decoration.Menu
- MenuItem - Class in org.apache.maven.doxia.site.decoration
-
A menu item.
- MenuItem() - Constructor for class org.apache.maven.doxia.site.decoration.MenuItem
- menus - Variable in class org.apache.maven.doxia.site.decoration.Body
-
Field menus.
- menusByRef - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
- MERGE - Static variable in class org.apache.maven.doxia.site.decoration.DecorationModel
- mergeAllSources(Map<String, ParserModule>, FoAggregateSink, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.
- 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.Renderer
-
Generate a document output integrated in a site from a document content, i.e.
- mergeLinkItemLists(List<LinkItem>, List<LinkItem>, DefaultDecorationModelInheritanceAssembler.URLRebaser, boolean) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- mergeMenus(List<Menu>, List<Menu>, DefaultDecorationModelInheritanceAssembler.URLRebaser) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- mergePoweredByLists(List<Logo>, List<Logo>, DefaultDecorationModelInheritanceAssembler.URLRebaser) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- mergeSourcesFromTOC(DocumentTOC, FoAggregateSink, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.
- modelEncoding - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Field modelEncoding.
- modelEncoding - Variable in class org.apache.maven.doxia.site.skin.SkinModel
-
Field modelEncoding.
- moduleExcludes - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- modules - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- mojoLog - Variable in class org.apache.maven.doxia.tools.MojoLogWrapper
- MojoLogWrapper - Class in org.apache.maven.doxia.tools
-
Wrap a Mojo logger into a Doxia logger.
- MojoLogWrapper(Log) - Constructor for class org.apache.maven.doxia.tools.MojoLogWrapper
N
- name - Variable in class org.apache.maven.doxia.site.decoration.Banner
-
The name of the banner.
- name - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
The full name of the project.
- name - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
The name to display for the link.
- name - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
The name to display for the menu.
- NAMESPACE - Static variable in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Field NAMESPACE.
- newPath - Variable in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLRebaser
- nextTag(XmlPullParser) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method nextTag.
- nextTag(XmlPullParser) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method nextTag.
- normalizeNewline(InputStream) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader
-
Deprecated.
O
- oldPath - Variable in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLRebaser
- onSectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- onSectionTitle_(int) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- org.apache.maven.doxia.docrenderer - package org.apache.maven.doxia.docrenderer
- org.apache.maven.doxia.docrenderer.pdf - package org.apache.maven.doxia.docrenderer.pdf
- org.apache.maven.doxia.docrenderer.pdf.fo - package org.apache.maven.doxia.docrenderer.pdf.fo
- org.apache.maven.doxia.site.decoration - package org.apache.maven.doxia.site.decoration
- org.apache.maven.doxia.site.decoration.inheritance - package org.apache.maven.doxia.site.decoration.inheritance
- org.apache.maven.doxia.site.decoration.io.xpp3 - package org.apache.maven.doxia.site.decoration.io.xpp3
- org.apache.maven.doxia.site.skin - package org.apache.maven.doxia.site.skin
- org.apache.maven.doxia.site.skin.io.xpp3 - package org.apache.maven.doxia.site.skin.io.xpp3
- org.apache.maven.doxia.siterenderer - package org.apache.maven.doxia.siterenderer
- org.apache.maven.doxia.siterenderer.sink - package org.apache.maven.doxia.siterenderer.sink
- org.apache.maven.doxia.tools - package org.apache.maven.doxia.tools
- outputEncoding - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- outputName - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- OVERRIDE - Static variable in class org.apache.maven.doxia.site.decoration.DecorationModel
P
- parse(String, String, Sink) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- parse(String, String, Sink, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Parse a source document into a sink.
- parseBanner(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parseBanner.
- parseBody(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parseBody.
- parseDecorationModel(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parseDecorationModel.
- parseLinkItem(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parseLinkItem.
- parseLogo(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parseLogo.
- parseMenu(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parseMenu.
- parseMenuItem(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parseMenuItem.
- parsePrerequisites(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method parsePrerequisites.
- parsePublishDate(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parsePublishDate.
- parserId - Variable in class org.apache.maven.doxia.siterenderer.ExtraDoxiaModuleReference
- parserId - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- parserModuleManager - Variable in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- parserModuleManager - Variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- parseSkin(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parseSkin.
- parseSkinModel(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method parseSkinModel.
- parseTocItems(List<DocumentTOCItem>, FoAggregateSink, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.
- parseVersion(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method parseVersion.
- PathDescriptor - Class in org.apache.maven.doxia.site.decoration.inheritance
-
Deprecated.use
URIPathDescriptor
instead. - PathDescriptor(String) - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.Construct a PathDescriptor from a path.
- PathDescriptor(String, String) - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.Construct a PathDescriptor from a path and a base.
- PathDescriptor(URL, String) - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.Construct a PathDescriptor from a path and a base.
- pathUrl - Variable in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
- PathUtils - Class in org.apache.maven.doxia.site.decoration.inheritance
-
Deprecated.this only operates on deprecated classes, it is not used anymore.
- PathUtils() - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.PathUtils
-
Deprecated.Private constructor.
- PdfRenderer - Interface in org.apache.maven.doxia.docrenderer.pdf
-
Deprecated.
- plexus - Variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- populateModulesMenu(DecorationModel, Locale, MavenProject, List<MavenProject>, ArtifactRepository, boolean) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Populate the pre-defined
modules
menu of the decoration model, if used through<menu ref="modules"/>
. - populateParentMenu(DecorationModel, Locale, MavenProject, MavenProject, boolean) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Populate the pre-defined
parent
menu of the decoration model, if used through<menu ref="parent"/>
. - populateReportsMenu(DecorationModel, Locale, Map<String, List<MavenReport>>) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Populate the pre-defined
reports
menu of the decoration model, if used through<menu ref="reports"/>
. - populateReportsMenu(DecorationModel, Locale, Map<String, List<MavenReport>>) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Populate the pre-defined
reports
menu of the decoration model, if used through<menu ref="reports"/>
. - position - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
Where to place the image regarding the displayed name (left or right).
- position - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
Where to place the image regarding the displayed name (left or right).
- position - Variable in class org.apache.maven.doxia.site.decoration.PublishDate
-
Where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
- position - Variable in class org.apache.maven.doxia.site.decoration.Version
-
Where to place the version published (left, right, navigation-top, navigation-bottom, bottom).
- poweredBy - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Field poweredBy.
- prerequisites - Variable in class org.apache.maven.doxia.site.skin.SkinModel
-
Describes the prerequisites in the build environment for using this skin.
- Prerequisites - Class in org.apache.maven.doxia.site.skin
-
Describes the prerequisites a skin can have.
- Prerequisites() - Constructor for class org.apache.maven.doxia.site.skin.Prerequisites
- processedContentOutput - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- publishDate - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Modify the date published display properties.
- publishDate - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- PublishDate - Class in org.apache.maven.doxia.site.decoration
-
Modify display properties for date published.
- PublishDate() - Constructor for class org.apache.maven.doxia.site.decoration.PublishDate
- put(String, Object) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.Adds a name/value pair to the context.
R
- read(InputStream) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method read.
- read(InputStream) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method read.
- read(InputStream, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method read.
- read(InputStream, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method read.
- read(Reader) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
- read(Reader) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
- read(Reader, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
- read(Reader, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
- read(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method read.
- read(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method read.
- readDecorationModel(String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- readDocumentModel(File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Read a document model from a file.
- readDocumentModel(File) - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Deprecated.Read a document model from a file.
- readSiteDescriptor(Reader, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Read site descriptor content from Reader, adding support for deprecated
${reports}
,${parentProject}
and${modules}
tags. - rebaseBannerPaths(Banner, DefaultDecorationModelInheritanceAssembler.URLRebaser) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- rebaseLink(String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLRebaser
-
Rebase only affects relative links, a relative link wrt an old base gets translated, so it points to the same location as viewed from a new base
- rebaseLink(String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Calculate the link as viewed from a different base.
- rebaseLinkItemPaths(LinkItem, DefaultDecorationModelInheritanceAssembler.URLRebaser) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- rebaseLogoPaths(Logo, DefaultDecorationModelInheritanceAssembler.URLRebaser) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- rebaseMenuPaths(List<MenuItem>, DefaultDecorationModelInheritanceAssembler.URLRebaser) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- ref - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
Mark this menu as reference to a pre-defined menu:
reports
,modules
orparent
. - ref - Variable in class org.apache.maven.doxia.site.decoration.MenuItem
-
A reference to a pre-defined menu item, such as a report (specified by the report goal name).
- relativePath - Variable in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
- relativePath - Variable in class org.apache.maven.doxia.siterenderer.RenderingContext
- relativizeBannerPaths(Banner, String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
-
Resolves all relative paths between the elements in a banner.
- relativizeLink() - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Calculate the relative link with respect to the base.
- relativizeLink(String, String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- relativizeLink(String, URI) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
- relativizeLinkItemPaths(LinkItem, String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- relativizeLogoPaths(Logo, String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- relativizeMenuPaths(List<MenuItem>, String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
- remove(Object) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.Removes the value associated with the specified key from the context.
- removeBreadcrumb(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method removeBreadcrumb.
- removeItem(MenuItem) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Method removeItem.
- removeItem(MenuItem) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Method removeItem.
- removeLink(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method removeLink.
- removeMenu(Menu) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method removeMenu.
- removeMenuRef(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
- removePoweredBy(Logo) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Method removePoweredBy.
- render(File, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Render a document from the files found in baseDirectory.
- render(File, File) - Method in interface org.apache.maven.doxia.docrenderer.DocRenderer
-
Deprecated.Render all files from a site directory to an output directory
- render(File, File, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Render a document from the files found in baseDirectory.
- render(File, File, File) - Method in interface org.apache.maven.doxia.docrenderer.DocRenderer
-
Deprecated.Render a document depending a context and a document descriptor
- render(File, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Render a document from the files found in a source directory, depending on a rendering context.
- render(File, File, DocumentModel) - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Deprecated.Render a document from the files found in a source directory, depending on a rendering context.
- render(File, File, DocumentModel, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Render a document from the files found in a source directory, depending on a rendering context.
- render(Collection<String>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Render a document from a set of files, depending on a rendering context.
- render(Collection<String>, File, DocumentModel) - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Deprecated.Render a document from a set of files, depending on a rendering context.
- 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.Renderer
-
Render a collection of documents into a site.
- render(Map<String, ParserModule>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- render(Map<String, ParserModule>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer
-
Deprecated.Render an aggregate document from the files found in a Map.
- render(Map<String, ParserModule>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.Render an aggregate document from the files found in a Map.
- render(Map<String, ParserModule>, File, DocumentModel, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Render an aggregate document from the files found in a Map.
- render(Map<String, ParserModule>, File, DocumentModel, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.Render an aggregate document from the files found in a Map.
- renderDocument(Writer, Renderer, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
Render a document in a site.
- renderDocument(Writer, Renderer, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
Render a document in a site.
- renderDocument(Writer, RenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Render a document written in a Doxia markup language.
- renderDocument(Writer, RenderingContext, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.Renderer
-
Render a document written in a Doxia markup language.
- Renderer - Interface in org.apache.maven.doxia.siterenderer
-
Site Renderer interface: render a collection of documents into a site, ie decored with a site template (eventually packaged as skin).
- RendererException - Exception Class in org.apache.maven.doxia.siterenderer
-
RendererException class.
- RendererException(String) - Constructor for exception class org.apache.maven.doxia.siterenderer.RendererException
-
Construct a RendererException with a message.
- RendererException(String, Throwable) - Constructor for exception class org.apache.maven.doxia.siterenderer.RendererException
-
Construct a RendererException with a message and a cause.
- renderIndividual(Map<String, ParserModule>, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- renderIndividual(Map<String, ParserModule>, File) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.Render documents separately for each file found in a Map.
- renderIndividual(Map<String, ParserModule>, File, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Render documents separately for each file found in a Map.
- renderIndividual(Map<String, ParserModule>, File, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.Render documents separately for each file found in a Map.
- renderingContext - Variable in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
- renderingContext - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- RenderingContext - Class in org.apache.maven.doxia.siterenderer
-
The rendering context of a document.
- RenderingContext(File, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext
-
Deprecated.
- RenderingContext(File, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext
-
Constructor for RenderingContext when document is not rendered from a Doxia markup source.
- RenderingContext(File, String, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext
-
Deprecated.
- RenderingContext(File, String, String, String, String, boolean) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext
- RenderingContext(File, String, String, String, String, boolean, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext
-
Constructor for document RenderingContext.
- renderModules(String, FoAggregateSink, DocumentTOCItem, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Deprecated.
- ReportComparator - Class in org.apache.maven.doxia.tools
-
Sorts reports.
- ReportComparator(Locale) - Constructor for class org.apache.maven.doxia.tools.ReportComparator
-
Default constructor.
- resolveLink() - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Resolve the link to the base.
- resolvePaths(DecorationModel, String) - Method in interface org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler
-
Resolve relative paths for a DecorationModel given a base URL.
- resolvePaths(DecorationModel, String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler
-
Resolve relative paths for a DecorationModel given a base URL.
- resolveSiteDescriptor(MavenProject, ArtifactRepository, List<ArtifactRepository>, Locale) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
- resource - Static variable in class org.apache.maven.doxia.docrenderer.SiteResourceLoader
-
Deprecated.
- RESOURCE_DIR - Static variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- resourceDir - Static variable in class org.apache.maven.doxia.docrenderer.SiteResourceLoader
-
Deprecated.
- ROLE - Static variable in interface org.apache.maven.doxia.docrenderer.DocRenderer
-
Deprecated.Plexus lookup.
- ROLE - Static variable in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Deprecated.Plexus lookup role.
- ROLE - Static variable in interface org.apache.maven.doxia.docrenderer.pdf.PdfRenderer
-
Deprecated.Plexus lookup role.
- ROLE - Static variable in interface org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler
-
Plexus lookup role.
- ROLE - Static variable in interface org.apache.maven.doxia.siterenderer.Renderer
-
Plexus lookup role.
- ROLE - Static variable in interface org.apache.maven.doxia.tools.SiteTool
-
Plexus Role
- rootDirectory - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
S
- sameSite(URI) - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Check if this URIPathDescriptor lives on the same site as the given URI.
- sameSite(URI, URI) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
- sanitizeBase(String) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
- sanitizeLink(String) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
- saveVelocityProcessedContent(RenderingContext, SiteRenderingContext, String) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- sectionHasID - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- sectionTitleBuffer - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- sectionTitleWriteBuffer - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- serialVersionUID - Static variable in exception class org.apache.maven.doxia.docrenderer.DocumentRendererException
-
Deprecated.serialVersionUID
- serialVersionUID - Static variable in exception class org.apache.maven.doxia.siterenderer.RendererException
- serialVersionUID - Static variable in exception class org.apache.maven.doxia.tools.SiteToolException
-
serialVersionUID
- setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Sets the state of the "add default entities" flag.
- setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Sets the state of the "add default entities" flag.
- setAlt(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the alt description for the banner image.
- setAlt(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the alt to use for the image.
- setAlt(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the alt description for the image.
- setArtifactId(String) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Set the skin artifact ID.
- setAttribute(String, String) - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
setAttribute.
- setBannerLeft(Banner) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set banner logo on the masthead of the site to the left.
- setBannerRight(Banner) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set banner logo on the masthead of the site to the right.
- setBaseDir(String) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.Sets the current base directory.
- setBody(Body) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the main site content decoration.
- setBorder(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the border to use for the banner image.
- setBorder(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the border to use for the image.
- setBorder(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the border to use for the menu image.
- setBreadcrumbs(List<LinkItem>) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set a list of breadcrumbs to display in the navigation.
- setCollapse(boolean) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Set whether to collapse children elements of an item menu (by default).
- setCombineSelf(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set whether to inherit configuration from a parent project site descriptor (
merge
) or not (override
). - setCustom(Object) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set custom configuration for use with customized Velocity templates.
- setDecoration(DecorationModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
decoration
. - setDefaultWindowTitle(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
defaultWindowTitle
. - setDescription(String) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Set a description of the menu item.
- setDoxiaSitetools(String) - Method in class org.apache.maven.doxia.site.skin.Prerequisites
-
Set the minimum version of Doxia Sitetools required to use the resulting skin.
- setEdit(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the base url to edit Doxia document sources.
- setEncoding(String) - Method in class org.apache.maven.doxia.site.skin.SkinModel
-
Set encoding of text content, like the Velocity template itself.
- setFileComment(String) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method setFileComment.
- setFooter(String) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set if present, the contained text will be used instead of the generated copyright text.
- setFormat(String) - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Set date format to use.
- setGoogleAdSenseClient(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set your Google AdSense client id.
- setGoogleAdSenseSlot(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set your Google AdSense slot id.
- setGoogleAnalyticsAccountId(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the id for your Google Analytics account.
- setGroupId(String) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Set the skin group ID.
- setHead(String) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set additional content (like JavaScript) to include in the HEAD block of the generated pages.
- setHeight(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the height to use for the banner image.
- setHeight(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the height to use for the image.
- setHeight(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the height to use for the menu image.
- setHref(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the href of a link to be used for the banner image.
- setHref(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the href to use for the link.
- setImg(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the source location of an image.
- setImg(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the source location of an menu image.
- setInherit(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the way in which the menu is inherited.
- setInheritAsRef(boolean) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set if this is a reference, setting <inheritAsRef>true</inheritAsRef> means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.
- setInputEncoding(String) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Deprecated.
- setInputEncoding(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
inputEncoding
. - setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set a list of menu item.
- setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Set a list of menu item.
- setLastModified(long) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set timestamp of the last modification of this decoration model.
- setLinks(List<LinkItem>) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set a list of links to display in the navigation.
- setLocale(Locale) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
locale
. - setLogLevel(int) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- setMenus(List<Menu>) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set a list of menus to include in the navigation.
- setModelEncoding(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the modelEncoding field.
- setModelEncoding(String) - Method in class org.apache.maven.doxia.site.skin.SkinModel
-
Set the modelEncoding field.
- setModuleExcludes(Map<String, String>) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
moduleExcludes
. - setName(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the name of the banner.
- setName(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the full name of the project.
- setName(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the name to display for the link.
- setName(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the name to display for the menu.
- setOutputEncoding(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
outputEncoding
. - setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set where to place the image regarding the displayed name (left or right).
- setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set where to place the image regarding the displayed name (left or right).
- setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Set where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
- setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.Version
-
Set where to place the version published (left, right, navigation-top, navigation-bottom, bottom).
- setPoweredBy(List<Logo>) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set powered by logos list.
- setPrerequisites(Prerequisites) - Method in class org.apache.maven.doxia.site.skin.SkinModel
-
Set describes the prerequisites in the build environment for using this skin.
- 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.
- setPublishDate(PublishDate) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set modify the date published display properties.
- setRef(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set mark this menu as reference to a pre-defined menu:
reports
,modules
orparent
. - setRef(String) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Set a reference to a pre-defined menu item, such as a report (specified by the report goal name).
- setResource(String) - Static method in class org.apache.maven.doxia.docrenderer.SiteResourceLoader
-
Deprecated.
- setRootDirectory(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Set the root directory.
- setSkin(Artifact) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
skinJarFile
. - setSkin(Skin) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the artifact containing the skin for the site.
- setSkinModel(SkinModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
skinModel
. - setSrc(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the source location of an image for the banner.
- setTarget(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set where the new document will be displayed when the user follows a link, i.e.
- 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
. - setTitle(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the title for the banner image.
- setTitle(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the title to use for the image.
- setTitle(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the title for the image.
- setUsingDefaultTemplate(boolean) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field
usingDefaultTemplate
. - setValidate(boolean) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Switch on/off validation.
- setVersion(String) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Set the skin version.
- setVersion(Version) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set modify the version published display properties.
- setWidth(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the width to use for the banner image.
- setWidth(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the width to use for the image.
- setWidth(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the width to use for the menu image.
- siteDirectories - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- siteLocales - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- 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(StringWriter, RenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Construct a new SiteRendererSink for a document.
- SiteRendererSink(RenderingContext) - 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
- SiteResourceLoader - Class in org.apache.maven.doxia.docrenderer
-
Deprecated.use
FileResourceLoader
- SiteResourceLoader() - Constructor for class org.apache.maven.doxia.docrenderer.SiteResourceLoader
-
Deprecated.
- SiteTool - Interface in org.apache.maven.doxia.tools
-
Tool to play with Doxia objects like
DecorationModel
. - SiteToolException - Exception Class in org.apache.maven.doxia.tools
-
An exception occurring during the execution of this tool.
- SiteToolException(String) - Constructor for exception class org.apache.maven.doxia.tools.SiteToolException
-
Construct a new
SiteToolException
exception providing amessage
. - SiteToolException(String, Exception) - Constructor for exception class org.apache.maven.doxia.tools.SiteToolException
-
Construct a new
SiteToolException
exception wrapping an underlyingException
and providing amessage
. - SiteToolException(String, Throwable) - Constructor for exception class org.apache.maven.doxia.tools.SiteToolException
-
Construct a new
SiteToolException
exception wrapping an underlyingThrowable
and providing amessage
. - skin - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
The artifact containing the skin for the site.
- skin - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- Skin - Class in org.apache.maven.doxia.site.decoration
-
An skin artifact declaration.
- Skin() - Constructor for class org.apache.maven.doxia.site.decoration.Skin
- SKIN_DESCRIPTOR_LOCATION - Static variable in class org.apache.maven.doxia.site.skin.SkinModel
- SKIN_TEMPLATE_LOCATION - Static variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- skinModel - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- SkinModel - Class in org.apache.maven.doxia.site.skin
-
The
<skin>
element is the root of the skin descriptor. - SkinModel() - Constructor for class org.apache.maven.doxia.site.skin.SkinModel
- SkinResourceLoader - Class in org.apache.maven.doxia.siterenderer
-
Deprecated.
- SkinResourceLoader() - Constructor for class org.apache.maven.doxia.siterenderer.SkinResourceLoader
-
Deprecated.
- SkinXpp3Reader - Class in org.apache.maven.doxia.site.skin.io.xpp3
-
Class SkinXpp3Reader.
- SkinXpp3Reader() - Constructor for class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
- SkinXpp3Reader(SkinXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
- SkinXpp3Reader.ContentTransformer - Interface in org.apache.maven.doxia.site.skin.io.xpp3
- src - Variable in class org.apache.maven.doxia.site.decoration.Banner
-
The source location of an image for the banner.
- startsWithAnyIgnoreCase(String, String...) - Static method in class org.apache.maven.doxia.site.decoration.DecorationUtils
- startsWithIgnoreCase(String, String) - Static method in class org.apache.maven.doxia.site.decoration.DecorationUtils
T
- target - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
Where the new document will be displayed when the user follows a link, i.e.
- templateClassLoader - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- templateName - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- templateProperties - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- text(String) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- title - Variable in class org.apache.maven.doxia.site.decoration.Banner
-
The title for the banner image.
- title - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
The title to use for the image.
- title - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
The title for the image.
- title - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- title() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Reset text buffer, since text content before title mustn't be in title.
- title_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- TOOLS_LOCATION - Static variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- toString() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
- toString() - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Construct a string representation of this URIPathDescriptor.
- toString() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.site.decoration.Version
-
Method toString.
- toString(CharSequence) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- transform(String, String) - Method in interface org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader.ContentTransformer
-
Interpolate the value read from the xpp3 document
- transform(String, String) - Method in interface org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader.ContentTransformer
-
Interpolate the value read from the xpp3 document
U
- URIPathDescriptor - Class in org.apache.maven.doxia.site.decoration.inheritance
-
Describes a link that may be absolute or relative, and that is anchored to an absolute URI.
- URIPathDescriptor(String, String) - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
A URIPathDescriptor consists of a base URI and a link.
- urlEncode(String) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
- URLRebaser(String, String) - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLRebaser
-
Construct a URL rebaser.
- usingDefaultTemplate - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
V
- validate - Variable in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
- validate(Reader, String) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- validate(Reader, String) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- velocity - Variable in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- velocity - Variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- version - Variable in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Modify the version published display properties.
- version - Variable in class org.apache.maven.doxia.site.decoration.Skin
-
The skin version.
- Version - Class in org.apache.maven.doxia.site.decoration
-
Modify display properties for version published.
- Version() - Constructor for class org.apache.maven.doxia.site.decoration.Version
W
- warn(CharSequence) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- warn(CharSequence, Throwable) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- warn(Throwable) - Method in class org.apache.maven.doxia.tools.MojoLogWrapper
- width - Variable in class org.apache.maven.doxia.site.decoration.Banner
-
The width to use for the banner image.
- width - Variable in class org.apache.maven.doxia.site.decoration.LinkItem
-
The width to use for the image.
- width - Variable in class org.apache.maven.doxia.site.decoration.Menu
-
The width to use for the menu image.
- write(OutputStream, DecorationModel) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method write.
- write(Writer, DecorationModel) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method write.
- write(String) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- writeBanner(Banner, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writeBanner.
- writeBody(Body, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writeBody.
- writeDecorationModel(DecorationModel, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writeDecorationModel.
- writeLinkItem(LinkItem, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writeLinkItem.
- writeLogo(Logo, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writeLogo.
- writeMenu(Menu, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writeMenu.
- writeMenuItem(MenuItem, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writeMenuItem.
- writePublishDate(PublishDate, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writePublishDate.
- writer - Variable in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
- writeSkin(Skin, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writeSkin.
- writeVersion(Version, String, XmlSerializer) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer
-
Method writeVersion.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form