- generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Generate a document output from a Doxia SiteRenderer Sink.
- generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.Renderer
-
Generate a document output from a Doxia SiteRenderer Sink.
- generateOutput(File, File) - Method in class org.apache.maven.doxia.docrenderer.itext.AbstractITextRender
-
Deprecated.
Generate an ouput file with the iText framework
- generateOutput(File, File) - Method in class org.apache.maven.doxia.docrenderer.itext.DefaultPdfRenderer
-
Deprecated.
Generate an ouput file with the iText framework
- generateOutput(File, File) - Method in class org.apache.maven.doxia.docrenderer.itext.DefaultRtfRenderer
-
Deprecated.
Generate an ouput file with the iText framework
- generatePdf(File, File) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Generate a final pdf ouput file from an intermediate format file.
- generatePdf(File, File) - Method in class org.apache.maven.doxia.docrenderer.pdf.itext.ITextPdfRenderer
-
Generate a final pdf ouput file from an intermediate format file.
- generatePdf(File, File) - Method in interface org.apache.maven.doxia.docrenderer.pdf.PdfRenderer
-
Generate a final pdf ouput file from an intermediate format file.
- get(String) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
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 class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Getter for the field authors.
- 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.docrenderer.AbstractDocumentRenderer
-
Return the current base directory.
- getBasedir() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Getter for the field basedir.
- 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 class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
getBody.
- 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.
- 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.
- getDate() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Getter for the field date.
- getDecoration() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field decoration.
- 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
-
Get the default skin artifact for a project from one of the repositories.
- 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.
- getDoxiaSitetools() - Method in class org.apache.maven.doxia.site.skin.Prerequisites
-
Get the minimum version of Doxia Sitetools required to use
the resulting skin.
- 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
-
Getter for the field extension.
- getExtensions(ParserModule) - Static method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
- getFilesToProcess(File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Returns a Map of files to process.
- getFilesToProcess(Collection<String>) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Returns a Map of files to process.
- 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.
- 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 class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
getHead.
- 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
-
- 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.
- 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.
- 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
-
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.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.
- 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.
- 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.
- getNormalizedPath(String) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
- 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
-
Get the output extension associated with this DocumentRenderer.
- getOutputExtension() - Method in class org.apache.maven.doxia.docrenderer.itext.DefaultPdfRenderer
-
Deprecated.
Get the output extension supported
- getOutputExtension() - Method in class org.apache.maven.doxia.docrenderer.itext.DefaultRtfRenderer
-
Deprecated.
Get the output extension supported
- getOutputExtension() - Method in class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer
-
Get the output extension associated with this DocumentRenderer.
- getOutputName(DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
- 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
-
Getter for the field outputName.
- 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.RenderingContext
-
Getter for the field parserId.
- 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
or parent.
- 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).
- getRelativePath(PathDescriptor, PathDescriptor) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.PathUtils
-
Deprecated.
getRelativePath.
- getRelativePath() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext
-
Getter for the field relativePath.
- getRelativePath(String, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Calculate the relative path between two URLs or between two files.
- getRelativePath(String, String) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Calculate the relative path between two URLs or between two files.
- 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
-
Getter for the field renderingContext.
- getResourceStream(String) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader
-
Deprecated.
- 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.
- 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
-
Get a skin artifact from one of the repositories.
- 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 class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Getter for the field title.
- 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.
- read(Reader, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
- read(Reader) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
- read(InputStream, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method read.
- read(InputStream) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Method read.
- read(Reader, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
- read(Reader) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
- read(InputStream, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method read.
- read(InputStream) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
-
Method read.
- readDocumentModel(File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Read a document model from a file.
- readDocumentModel(File) - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Read a document model from a file.
- rebaseLink(String) - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Calculate the link as viewed from a different base.
- relativizeLink() - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Calculate the relative link with respect to the base.
- remove(Object) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
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(Map<String, ParserModule>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
- render(Collection<String>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render a document from a set of files, depending on a rendering context.
- render(File, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render a document from the files found in a source directory, depending on a rendering context.
- render(Map<String, ParserModule>, File, DocumentModel, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render an aggregate document from the files found in a Map.
- render(File, File, DocumentModel, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render a document from the files found in a source directory, depending on a rendering context.
- render(File, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render a document from the files found in baseDirectory.
- render(File, File, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
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 interface org.apache.maven.doxia.docrenderer.DocRenderer
-
Deprecated.
Render a document depending a context and a document descriptor
- render(Collection<String>, File, DocumentModel) - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Render a document from a set of files, depending on a rendering context.
- render(File, File, DocumentModel) - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Render a document from the files found in a source directory, depending on a rendering context.
- render(File, File) - Method in class org.apache.maven.doxia.docrenderer.itext.AbstractITextRender
-
Deprecated.
Render all files from a site directory to an output directory
- render(File, File, File) - Method in class org.apache.maven.doxia.docrenderer.itext.AbstractITextRender
-
Deprecated.
Render a document depending a context and a document descriptor
- render(Map<String, ParserModule>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer
-
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
-
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
-
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.itext.ITextPdfRenderer
-
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.itext.ITextPdfRenderer
-
Render an aggregate document from the files found in a Map.
- 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.
- renderDocument(Writer, RenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
Render a document written in a Doxia markup language.
- renderDocument(Writer, Renderer, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
Render a document.
- renderDocument(Writer, Renderer, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
Render a document.
- 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 in org.apache.maven.doxia.siterenderer
-
RendererException class.
- RendererException(String) - Constructor for exception org.apache.maven.doxia.siterenderer.RendererException
-
Construct a RendererException with a message.
- RendererException(String, Throwable) - Constructor for exception org.apache.maven.doxia.siterenderer.RendererException
-
Construct a RendererException with a message and a cause.
- renderIndividual(Map<String, ParserModule>, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
- renderIndividual(Map<String, ParserModule>, File, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render documents separately for each file found in a Map.
- renderIndividual(Map<String, ParserModule>, File) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
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
-
Render documents separately for each file found in a Map.
- renderIndividual(Map<String, ParserModule>, File) - Method in class org.apache.maven.doxia.docrenderer.pdf.itext.ITextPdfRenderer
-
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.itext.ITextPdfRenderer
-
Render documents separately for each file found in a Map.
- 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
-
Constructor for RenderingContext when document is not rendered from a Doxia source.
- RenderingContext(File, String, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext
-
Constructor for RenderingContext.
- 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.
- 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
-
Plexus lookup role.
- ROLE - Static variable in interface org.apache.maven.doxia.docrenderer.itext.PdfRenderer
-
Deprecated.
- ROLE - Static variable in interface org.apache.maven.doxia.docrenderer.itext.RtfRenderer
-
Deprecated.
- ROLE - Static variable in interface org.apache.maven.doxia.docrenderer.pdf.PdfRenderer
-
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
- RtfRenderer - Interface in org.apache.maven.doxia.docrenderer.itext
-
- 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.
- 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
-
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.
- setEncoding(String) - Method in class org.apache.maven.doxia.site.skin.SkinModel
-
Set encoding of text content, like the Velocity template
itself.
- 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
true 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
-
- 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(PublishDate) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set modify the date published display properties.
- setPublishDate(Date) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Specify a specific publish date instead of the current date.
- 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
or parent.
- 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).
- setSkin(Skin) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the artifact containing the skin for the site.
- setSkin(Artifact) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field skinJarFile.
- setSkinModel(SkinModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field skinModel.
- 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(Version) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set modify the version published display properties.
- setVersion(String) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Set the skin version.
- 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.
- 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(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
-
- SiteTool - Interface in org.apache.maven.doxia.tools
-
Tool to play with
Doxia objects
like
DecorationModel.
- SiteToolException - Exception in org.apache.maven.doxia.tools
-
An exception occurring during the execution of this tool.
- SiteToolException(String, Exception) - Constructor for exception org.apache.maven.doxia.tools.SiteToolException
-
Construct a new SiteToolException exception wrapping an underlying Exception
and providing a message.
- SiteToolException(String, Throwable) - Constructor for exception org.apache.maven.doxia.tools.SiteToolException
-
Construct a new SiteToolException exception wrapping an underlying Throwable
and providing a message.
- SiteToolException(String) - Constructor for exception org.apache.maven.doxia.tools.SiteToolException
-
Construct a new SiteToolException exception providing a message.
- 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
-
- 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
-
- startsWithAnyIgnoreCase(String, String...) - Static method in class org.apache.maven.doxia.site.decoration.DecorationUtils
-