- generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
-
- 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.io.xpp3.SiteXpp3Reader
-
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.
- getAlt() - Method in class org.apache.maven.doxia.site.Image
-
Get the alternative text to use.
- getArtifactId() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Get the skin artifact ID.
- getArtifactId() - Method in class org.apache.maven.doxia.site.Skin
-
Get the skin artifact ID.
- getAttribute(String) - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
getAttribute.
- getAuthors() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent
-
Get the authors of the document.
- getAuthors() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Get the authors of the document.
- getBannerLeft() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get banner logo on the masthead of the site to the left.
- getBannerLeft() - Method in class org.apache.maven.doxia.site.SiteModel
-
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.
- getBannerRight() - Method in class org.apache.maven.doxia.site.SiteModel
-
Get banner logo on the masthead of the site to the right.
- getBasedir() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Getter for the field basedir
.
- getBasedirRelativePath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get the relative path of basedir (when a Doxia source)
- getBaseURI() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor
-
Return the base of this URIPathDescriptor as a URI.
- 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.site.SiteModel
-
Get the main site content.
- 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.
- 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.Body
-
Method getBreadcrumbs.
- 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
).
- getCombineSelf() - Method in class org.apache.maven.doxia.site.SiteModel
-
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.
- getCustom() - Method in class org.apache.maven.doxia.site.SiteModel
-
Get custom configuration for use with customized Velocity
templates.
- getCustomChild(String) - Method in class org.apache.maven.doxia.site.SiteModel
-
- getCustomChild(Xpp3Dom, String) - Static method in class org.apache.maven.doxia.site.SiteUtils
-
Helper to get site custom DOM element by simply specifying a dotted path.
- getCustomValue(String) - Method in class org.apache.maven.doxia.site.SiteModel
-
- getCustomValue(String, String) - Method in class org.apache.maven.doxia.site.SiteModel
-
- getCustomValue(Xpp3Dom, String) - Static method in class org.apache.maven.doxia.site.SiteUtils
-
Helper to get site custom DOM element value by simply specifying a dotted path.
- getCustomValue(Xpp3Dom, String, String) - Static method in class org.apache.maven.doxia.site.SiteUtils
-
Helper to get site 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.
- getDefaultTitle() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field defaultTitle
.
- 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.
- getDoxiaSourcePath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get the relative path to Doxia source from build root.
- getDoxiaSourcePath(String) - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get url of the Doxia source calculate from given base url.
- getEdit() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the base url to edit Doxia document sources.
- getEdit() - Method in class org.apache.maven.doxia.site.SiteModel
-
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.DocumentRenderingContext
-
Get the source document filename extension (when a Doxia source)
- getFooter() - Method in class org.apache.maven.doxia.site.Body
-
Get if present, the contained text will be used instead of
the generated copyright text.
- 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.
- getFormat() - Method in class org.apache.maven.doxia.site.PublishDate
-
Get date format to use.
- getGenerator() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
What is the generator (if any)?
- getGroupId() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Get the skin group ID.
- getGroupId() - Method in class org.apache.maven.doxia.site.Skin
-
Get the skin group ID.
- getHead() - Method in class org.apache.maven.doxia.site.Body
-
Get additional content (like JavaScript) to include in the
HEAD block of the generated pages.
- 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.
- getHeight() - Method in class org.apache.maven.doxia.site.Image
-
Get the height to use.
- 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.
- getHref() - Method in class org.apache.maven.doxia.site.LinkItem
-
Get the href to use for the link.
- getImage() - Method in class org.apache.maven.doxia.site.LinkItem
-
Get the image for the link.
- getImage() - Method in class org.apache.maven.doxia.site.Menu
-
Get the image for the menu.
- 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.
- getInherit() - Method in class org.apache.maven.doxia.site.Menu
-
Get the way in which the menu is inherited.
- getInputEncoding() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field inputEncoding
.
- getInputName() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
- getInputPath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Getter for the field inputPath
.
- 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.
- getItems() - Method in class org.apache.maven.doxia.site.Menu
-
Method getItems.
- getItems() - Method in class org.apache.maven.doxia.site.MenuItem
-
Method getItems.
- getLastModified() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get timestamp of the last modification of this decoration
model.
- getLastModified() - Method in class org.apache.maven.doxia.site.SiteModel
-
Get timestamp of the last modification of this site model.
- getLink() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor
-
Return the link of this URIPathDescriptor as a URI.
- getLinks() - Method in class org.apache.maven.doxia.site.Body
-
Method getLinks.
- 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
.
- getMenuRef(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
- getMenuRef(String) - Method in class org.apache.maven.doxia.site.SiteModel
-
- getMenus() - Method in class org.apache.maven.doxia.site.Body
-
Method getMenus.
- getMenus() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method getMenus.
- getMenus() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
- getMenus() - Method in class org.apache.maven.doxia.site.SiteModel
-
- getModelEncoding() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the modelEncoding field.
- getModelEncoding() - Method in class org.apache.maven.doxia.site.SiteModel
-
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
.
- 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.
- getName() - Method in class org.apache.maven.doxia.site.LinkItem
-
Get the name to display for the link.
- getName() - Method in class org.apache.maven.doxia.site.Menu
-
Get the name to display for the menu.
- getName() - Method in class org.apache.maven.doxia.site.SiteModel
-
Get the full name of the project site.
- 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
.
- getOutputName() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
- getOutputName() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
- getOutputName() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
- getOutputPath() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
The output path of the document.
- getOutputPath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get html output path, relative to site root.
- getParserConfigurator() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Return the configurator for parsers
.
- getParserId() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
Get the parserId when document comes from a Doxia source.
- getPath() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
-
- 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).
- getPosition() - Method in class org.apache.maven.doxia.site.Image
-
Get where to place the image relative to the displayed name
(left or right).
- getPosition() - Method in class org.apache.maven.doxia.site.PublishDate
-
Get where to place the date published (left, right,
navigation-top, navigation-bottom, bottom).
- getPosition() - Method in class org.apache.maven.doxia.site.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.
- getPoweredBy() - Method in class org.apache.maven.doxia.site.SiteModel
-
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.site.SiteModel
-
- 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).
- getRef() - Method in class org.apache.maven.doxia.site.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.MenuItem
-
Get a reference to a pre-defined menu item, such as a report
(specified by the report goal
name).
- getRelativePath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
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.
- getRenderingContext() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent
-
Get the document rendering context.
- getRenderingContext() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
-
Return the rendering context of the document.
- getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
Return the rendering context of the document.
- getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Get the document rendering context.
- getRootDirectory() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Root directory, to calculate relative path to every site directories.
- 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.
- getSiteModel() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Getter for the field siteModel
.
- getSiteModel(File, Locale, MavenProject, List<MavenProject>, RepositorySystemSession, List<RemoteRepository>) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Get a site model for a project.
- getSiteModel(File, Locale, MavenProject, List<MavenProject>, RepositorySystemSession, List<RemoteRepository>) - Method in interface org.apache.maven.doxia.tools.SiteTool
-
Get a site model for a project.
- 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.site.SiteModel
-
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(RepositorySystemSession, List<RemoteRepository>, Skin) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
-
Get a skin artifact from one of the repositories.
- getSkinArtifactFromRepository(RepositorySystemSession, List<RemoteRepository>, Skin) - 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.
- getSrc() - Method in class org.apache.maven.doxia.site.Image
-
Get the source location.
- getStyle() - Method in class org.apache.maven.doxia.site.Image
-
Get the style to use.
- 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.
- getTarget() - Method in class org.apache.maven.doxia.site.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
.
- getTimezone() - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Get the timezone to use.
- getTimezone() - Method in class org.apache.maven.doxia.site.PublishDate
-
Get the timezone to use.
- 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.
- 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.
- getVersion() - Method in class org.apache.maven.doxia.site.SiteModel
-
- getVersion() - Method in class org.apache.maven.doxia.site.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.
- getWidth() - Method in class org.apache.maven.doxia.site.Image
-
Get the width to use.
- sameSite(URI) - Method in class org.apache.maven.doxia.site.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.io.xpp3.SiteXpp3Reader
-
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.
- setAlt(String) - Method in class org.apache.maven.doxia.site.Image
-
Set the alternative text to use.
- setArtifactId(String) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Set the skin artifact ID.
- setArtifactId(String) - Method in class org.apache.maven.doxia.site.Skin
-
Set the skin artifact ID.
- setAttribute(String, String) - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext
-
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.
- setBannerLeft(Banner) - Method in class org.apache.maven.doxia.site.SiteModel
-
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.
- setBannerRight(Banner) - Method in class org.apache.maven.doxia.site.SiteModel
-
Set banner logo on the masthead of the site to the right.
- setBody(Body) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the main site content decoration.
- setBody(Body) - Method in class org.apache.maven.doxia.site.SiteModel
-
Set the main site content.
- 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.Body
-
Set a list of breadcrumbs to display in the navigation.
- 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).
- setCollapse(boolean) - Method in class org.apache.maven.doxia.site.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
).
- setCombineSelf(String) - Method in class org.apache.maven.doxia.site.SiteModel
-
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.
- setCustom(Object) - Method in class org.apache.maven.doxia.site.SiteModel
-
Set custom configuration for use with customized Velocity
templates.
- setDefaultTitle(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field defaultTitle
.
- 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.
- setEdit(String) - Method in class org.apache.maven.doxia.site.SiteModel
-
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.io.xpp3.SiteXpp3Writer
-
Method setFileComment.
- setFooter(String) - Method in class org.apache.maven.doxia.site.Body
-
Set if present, the contained text will be used instead of
the generated copyright text.
- 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.
- setFormat(String) - Method in class org.apache.maven.doxia.site.PublishDate
-
Set date format to use.
- setGroupId(String) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Set the skin group ID.
- setGroupId(String) - Method in class org.apache.maven.doxia.site.Skin
-
Set the skin group ID.
- setHead(String) - Method in class org.apache.maven.doxia.site.Body
-
Set additional content (like JavaScript) to include in the
HEAD block of the generated pages.
- 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.
- setHeight(String) - Method in class org.apache.maven.doxia.site.Image
-
Set the height to use.
- 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.
- setHref(String) - Method in class org.apache.maven.doxia.site.LinkItem
-
Set the href to use for the link.
- setImage(Image) - Method in class org.apache.maven.doxia.site.LinkItem
-
Set the image for the link.
- setImage(Image) - Method in class org.apache.maven.doxia.site.Menu
-
Set the image for the menu.
- 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.
- setInherit(String) - Method in class org.apache.maven.doxia.site.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 to true
means that it will be populated
in the project, whereas if it is
false
, it is populated in the parent and then
inherited.
- setInheritAsRef(boolean) - Method in class org.apache.maven.doxia.site.Menu
-
Set if this is a reference, setting to true
means that it will be populated
in the site, whereas if it is
false
, it is populated in the parent and then
inherited.
- 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.
- setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.Menu
-
Set a list of menu item.
- setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.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.
- setLastModified(long) - Method in class org.apache.maven.doxia.site.SiteModel
-
Set timestamp of the last modification of this site model.
- setLinks(List<LinkItem>) - Method in class org.apache.maven.doxia.site.Body
-
Set a list of links to display in the navigation.
- 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
.
- setMenus(List<Menu>) - Method in class org.apache.maven.doxia.site.Body
-
Set a list of menus to include in the navigation.
- 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.SiteModel
-
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.
- setName(String) - Method in class org.apache.maven.doxia.site.LinkItem
-
Set the name to display for the link.
- setName(String) - Method in class org.apache.maven.doxia.site.Menu
-
Set the name to display for the menu.
- setName(String) - Method in class org.apache.maven.doxia.site.SiteModel
-
Set the full name of the project site.
- setOutputEncoding(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field outputEncoding
.
- setParserConfigurator(ParserConfigurator) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Set the configurator to use for parsers
.
- 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).
- setPosition(String) - Method in class org.apache.maven.doxia.site.Image
-
Set where to place the image relative to the displayed name
(left or right).
- setPosition(String) - Method in class org.apache.maven.doxia.site.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.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.
- setPoweredBy(List<Logo>) - Method in class org.apache.maven.doxia.site.SiteModel
-
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(PublishDate) - Method in class org.apache.maven.doxia.site.SiteModel
-
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).
- setRef(String) - Method in class org.apache.maven.doxia.site.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.MenuItem
-
Set a reference to a pre-defined menu item, such as a report
(specified by the report goal
name).
- setRequireParent(boolean) - Method in class org.apache.maven.doxia.site.SiteModel
-
Set whether this "site.xml" should inherit from a parent
"site.xml".
- setRootDirectory(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Set the root directory.
- setSiteModel(SiteModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
Setter for the field siteModel
.
- setSkin(Skin) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the artifact containing the skin for the site.
- setSkin(Skin) - Method in class org.apache.maven.doxia.site.SiteModel
-
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.
- setSrc(String) - Method in class org.apache.maven.doxia.site.Image
-
Set the source location.
- setStyle(String) - Method in class org.apache.maven.doxia.site.Image
-
Set the style to use.
- 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.
- setTarget(String) - Method in class org.apache.maven.doxia.site.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
.
- setTimezone(String) - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Set the timezone to use.
- setTimezone(String) - Method in class org.apache.maven.doxia.site.PublishDate
-
Set the timezone to use.
- 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.
- 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.
- setVersion(Version) - Method in class org.apache.maven.doxia.site.SiteModel
-
Set modify the version published display properties.
- setVersion(String) - Method in class org.apache.maven.doxia.site.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.
- setWidth(String) - Method in class org.apache.maven.doxia.site.Image
-
Set the width to use.
- SiteDirectory(File, boolean) - Constructor for class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
-
- SiteModel - Class in org.apache.maven.doxia.site
-
The <site>
element is the root of
the site decoration descriptor.
- SiteModel() - Constructor for class org.apache.maven.doxia.site.SiteModel
-
- SiteModelInheritanceAssembler - Interface in org.apache.maven.doxia.site.inheritance
-
Manage inheritance of the site model.
- SiteRenderer - Interface in org.apache.maven.doxia.siterenderer
-
Site Renderer interface: render a collection of documents into a site, ie decorated with a site template.
- SiteRendererSink - Class in org.apache.maven.doxia.siterenderer.sink
-
Sink for site rendering of a document, to allow later merge document's output with a template.
- SiteRendererSink(DocumentRenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
Construct a new SiteRendererSink for a document.
- SiteRenderingContext - Class in org.apache.maven.doxia.siterenderer
-
Context for a site rendering.
- SiteRenderingContext() - Constructor for class org.apache.maven.doxia.siterenderer.SiteRenderingContext
-
- SiteRenderingContext.SiteDirectory - Class in org.apache.maven.doxia.siterenderer
-
- SiteTool - Interface in org.apache.maven.doxia.tools
-
Tool to play with
Doxia objects
like
SiteModel
.
- 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
.
- SiteUtils - Class in org.apache.maven.doxia.site
-
Site model utilities.
- SiteUtils() - Constructor for class org.apache.maven.doxia.site.SiteUtils
-
- SiteXpp3Reader - Class in org.apache.maven.doxia.site.io.xpp3
-
Class SiteXpp3Reader.
- SiteXpp3Reader() - Constructor for class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader
-
- SiteXpp3Reader(SiteXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader
-
- SiteXpp3Reader.ContentTransformer - Interface in org.apache.maven.doxia.site.io.xpp3
-
- SiteXpp3Writer - Class in org.apache.maven.doxia.site.io.xpp3
-
Class SiteXpp3Writer.
- SiteXpp3Writer() - Constructor for class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer
-
- Skin - Class in org.apache.maven.doxia.site.decoration
-
A skin artifact declaration.
- Skin() - Constructor for class org.apache.maven.doxia.site.decoration.Skin
-
- Skin - Class in org.apache.maven.doxia.site
-
A skin artifact declaration.
- Skin() - Constructor for class org.apache.maven.doxia.site.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
-
- 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
-
- startsWithAnyIgnoreCase(String, String...) - Static method in class org.apache.maven.doxia.site.SiteUtils
-