Index (Doxia :: Sitetools 1.6 API)

A B C D E F G H I L M O P R S T U V W

A

AbstractDocumentRenderer - Class in org.apache.maven.doxia.docrenderer: Abstract document renderer.
AbstractDocumentRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
AbstractITextRender - Class in org.apache.maven.doxia.docrenderer.itext: Deprecated.
since 1.1, use an implementation of DocumentRenderer.
AbstractITextRender() - Constructor for class org.apache.maven.doxia.docrenderer.itext.AbstractITextRender: Deprecated.
AbstractPdfRenderer - Class in org.apache.maven.doxia.docrenderer.pdf: Abstract pdf renderer, this doesn't depend on the framework.
AbstractPdfRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer
addBreadcrumb(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body: Method addBreadcrumb.
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 module source directory.
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: addSiteDirectory.
addSiteLocales(List<Locale>) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Adds passed locales to the list of site locales.
anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
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.
author() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
author_() - Method 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
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.
body_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Do nothing.

C

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.
containsKey(Object) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext: Indicates whether the specified key is in the context.
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: Copy content of a directory, excluding scm-specific files.
copyDirectory(File, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Copy the directory
copyResources(File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer: Copies the contents of the resource directory to an output folder.
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: Copy resource files.
createContextForSkin(File, Map<String, ?>, DecorationModel, String, Locale) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Return a SiteRenderingContext.
createContextForSkin(File, Map<String, ?>, DecorationModel, String, Locale) - Method in interface org.apache.maven.doxia.siterenderer.Renderer: Return a SiteRenderingContext.
createContextForTemplate(File, File, Map<String, ?>, DecorationModel, String, Locale) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Return a SiteRenderingContext.
createContextForTemplate(File, File, Map<String, ?>, DecorationModel, String, Locale) - Method in interface org.apache.maven.doxia.siterenderer.Renderer: Return a SiteRenderingContext.

D

date() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
date_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
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.
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
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
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.URLContainer - Class in org.apache.maven.doxia.site.decoration.inheritance: Contains an old and a new path.
DefaultDecorationModelInheritanceAssembler.URLContainer(String, String) - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLContainer: Construct a URLContainer.
DefaultPdfRenderer - Class in org.apache.maven.doxia.docrenderer.itext: Deprecated.
since 1.1, use ITextPdfRenderer.
DefaultPdfRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.itext.DefaultPdfRenderer: Deprecated.
DefaultRtfRenderer - Class in org.apache.maven.doxia.docrenderer.itext: Deprecated.
since 1.1, use ITextPdfRenderer.
DefaultRtfRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.itext.DefaultRtfRenderer: Deprecated.
DefaultSiteRenderer - Class in org.apache.maven.doxia.siterenderer: DefaultSiteRenderer class.
DefaultSiteRenderer() - Constructor for class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
DocRenderer - Interface in org.apache.maven.doxia.docrenderer: Deprecated.
Since 1.1, use DocumentRenderer instead.
DocumentRenderer - Interface in org.apache.maven.doxia.docrenderer: Base interface for rendering documents from a set of input files.
DocumentRenderer - Interface in org.apache.maven.doxia.siterenderer: Renders a page.
DocumentRendererContext - Class in org.apache.maven.doxia.docrenderer: Context when processing Velocity files using a HashMap for data storage.
DocumentRendererContext() - Constructor for class org.apache.maven.doxia.docrenderer.DocumentRendererContext: Default constructor.
DocumentRendererException - Exception in org.apache.maven.doxia.docrenderer: A document renderer exception
DocumentRendererException(String) - Constructor for exception org.apache.maven.doxia.docrenderer.DocumentRendererException: Default constructor.
DocumentRendererException(String, Throwable) - Constructor for exception org.apache.maven.doxia.docrenderer.DocumentRendererException: Other constructor.
doxia - Variable in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
doxia - Variable in class org.apache.maven.doxia.docrenderer.itext.AbstractITextRender: Deprecated.
DoxiaDocumentRenderer - Class in org.apache.maven.doxia.siterenderer: Renders a page with Doxia.
DoxiaDocumentRenderer(RenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer: Constructor.

E

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.

F

FoPdfRenderer - Class in org.apache.maven.doxia.docrenderer.pdf.fo: PDF renderer that uses Doxia's FO module.
FoPdfRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer

G

generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Generate a document.
generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.Renderer: Generate a document.
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.
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.
getDefaultSkin() - Static method in class org.apache.maven.doxia.site.decoration.Skin
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.
getExtension() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext: Getter for the field extension.
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.
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
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.
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.
getNewPath() - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLContainer: Get the new path.
getOldPath() - Method in class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLContainer: 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: 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.
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.
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 a reference to a pre-defined menu, such as a 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.
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
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.
getSkin() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get the artifact containing the skin for the site.
getSkinJarFile() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field skinJarFile.
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.

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() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
head_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

I

init(ExtendedProperties) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader
isCollapse() - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Get whether to collapse children elements of an item menu (by default).
isDefaultPublishDate() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
isDefaultVersion() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
isFile() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor: Deprecated.

Check if this PathDescriptor describes a file.
isInheritAsRef() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get 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.
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.
isSourceModified(Resource) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader
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.
ITextPdfRenderer - Class in org.apache.maven.doxia.docrenderer.pdf.itext: Abstract document render with the iText framework
ITextPdfRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.pdf.itext.ITextPdfRenderer

L

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
locateDocumentFiles(SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Return the document files in a Map.
locateDocumentFiles(SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.Renderer: Return the document files in a Map.
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

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
MERGE - Static variable in class org.apache.maven.doxia.site.decoration.DecorationModel

O

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.itext - package org.apache.maven.doxia.docrenderer.itext: DEPRECATED.
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.docrenderer.pdf.itext - package org.apache.maven.doxia.docrenderer.pdf.itext
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.siterenderer - package org.apache.maven.doxia.siterenderer
org.apache.maven.doxia.siterenderer.sink - package org.apache.maven.doxia.siterenderer.sink
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.
since 1.1.2, use AbstractDocumentRenderer.parse(String, String, Sink, DocumentRendererContext)
parse(String, String, Sink, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer: Parse a source document into a sink.
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.
PathUtils - Class in org.apache.maven.doxia.site.decoration.inheritance: Deprecated.
this only operates on deprecated classes, it is not used anymore.
PdfRenderer - Interface in org.apache.maven.doxia.docrenderer.itext: Deprecated.
since 1.1, use an implementation of DocumentRenderer.
PdfRenderer - Interface in org.apache.maven.doxia.docrenderer.pdf: PDF renderer interface.
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: Adds a name/value pair to the context.

R

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.
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, SiteModule>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer: Deprecated.
since 1.1.2, use AbstractDocumentRenderer.render(Map, File, DocumentModel, DocumentRendererContext)
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, SiteModule>, 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, SiteModule>, 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, SiteModule>, 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, SiteModule>, 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, SiteModule>, 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, SiteModule>, 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.
render(Collection<DocumentRenderer>, SiteRenderingContext, File) - Method in interface org.apache.maven.doxia.siterenderer.Renderer: Render a collection of documents.
renderDocument(Writer, RenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Render a document.
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.
Renderer - Interface in org.apache.maven.doxia.siterenderer: Renderer interface.
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, SiteModule>, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer: Deprecated.
since 1.1.2, use AbstractDocumentRenderer.renderIndividual(Map, File, DocumentRendererContext)
renderIndividual(Map<String, SiteModule>, File, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer: Render documents separately for each file found in a Map.
renderIndividual(Map<String, SiteModule>, 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, SiteModule>, 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, SiteModule>, 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, SiteModule>, 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.
RenderingContext(File, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext: Constructor for RenderingContext.
RenderingContext(File, String, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext: Constructor for RenderingContext.
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.
RtfRenderer - Interface in org.apache.maven.doxia.docrenderer.itext: Deprecated.
since 1.1, use an implementation of DocumentRenderer.

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.
setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader: 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.
setFooter(Object) - 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(Object) - 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.
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.
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.
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 a reference to a pre-defined menu, such as a 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.
setSkinJarFile(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field skinJarFile.
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.
siteModuleManager - Variable in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
siteModuleManager - Variable in class org.apache.maven.doxia.docrenderer.itext.AbstractITextRender: Deprecated.
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
Skin - Class in org.apache.maven.doxia.site.decoration: An skin artifact declaration.
Skin() - Constructor for class org.apache.maven.doxia.site.decoration.Skin
SkinResourceLoader - Class in org.apache.maven.doxia.siterenderer: Skin resource loader: gets content from context classloader, which should contain skin artifact, and normalizes newlines (see DOXIASITETOOLS-87.
SkinResourceLoader() - Constructor for class org.apache.maven.doxia.siterenderer.SkinResourceLoader

T

text(String) - Method 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
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.

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.

V

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

write(Writer, DecorationModel) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer: Method write.
write(OutputStream, 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

A B C D E F G H I L M O P R S T U V W