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

A

addBreadcrumb(LinkItem) - Method in class org.apache.maven.doxia.site.Body

Method addBreadcrumb.

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.

addItem(MenuItem) - Method in class org.apache.maven.doxia.site.Menu

Method addItem.

addItem(MenuItem) - Method in class org.apache.maven.doxia.site.MenuItem

Method addItem.

addLink(LinkItem) - Method in class org.apache.maven.doxia.site.Body

Method addLink.

addLink(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body

Method addLink.

addMenu(Menu) - Method in class org.apache.maven.doxia.site.Body

Method addMenu.

addMenu(Menu) - Method in class org.apache.maven.doxia.site.decoration.Body

Method addMenu.

addPoweredBy(Logo) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel

Method addPoweredBy.

addPoweredBy(Logo) - Method in class org.apache.maven.doxia.site.SiteModel

Method addPoweredBy.

assembleModelInheritance(String, SiteModel, SiteModel, String, String) - Method in class org.apache.maven.doxia.site.inheritance.DefaultSiteModelInheritanceAssembler

Manage inheritance of the site model between a parent and child.

assembleModelInheritance(String, SiteModel, SiteModel, String, String) - Method in interface org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler

Manage inheritance of the site model between a parent and child.

B

Banner - Class in org.apache.maven.doxia.site

Banner logo on the masthead of the site.

Banner() - Constructor for class org.apache.maven.doxia.site.Banner

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

The main content.

Body() - Constructor for class org.apache.maven.doxia.site.Body

Body - Class in org.apache.maven.doxia.site.decoration

The main content decoration.

Body() - Constructor for class org.apache.maven.doxia.site.decoration.Body

C

clone() - Method in class org.apache.maven.doxia.site.Banner

Method clone.

clone() - Method in class org.apache.maven.doxia.site.Body

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.Banner

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.Body

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.LinkItem

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.Logo

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.Menu

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.MenuItem

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.PublishDate

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.Skin

Method clone.

clone() - Method in class org.apache.maven.doxia.site.decoration.Version

Method clone.

clone() - Method in class org.apache.maven.doxia.site.Image

Method clone.

clone() - Method in class org.apache.maven.doxia.site.LinkItem

Method clone.

clone() - Method in class org.apache.maven.doxia.site.Logo

Method clone.

clone() - Method in class org.apache.maven.doxia.site.Menu

Method clone.

clone() - Method in class org.apache.maven.doxia.site.MenuItem

Method clone.

clone() - Method in class org.apache.maven.doxia.site.PublishDate

Method clone.

clone() - Method in class org.apache.maven.doxia.site.SiteModel

Method clone.

clone() - Method in class org.apache.maven.doxia.site.Skin

Method clone.

clone() - Method in class org.apache.maven.doxia.site.Version

Method clone.

contentTransformer - Variable in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader

Field contentTransformer.

contentTransformer - Variable in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader

Field contentTransformer.

D

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

DecorationXpp3Reader - Class in org.apache.maven.doxia.site.decoration.io.xpp3

Class DecorationXpp3Reader.

DecorationXpp3Reader() - Constructor for class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader

DecorationXpp3Reader(DecorationXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader

DecorationXpp3Reader.ContentTransformer - Interface in org.apache.maven.doxia.site.decoration.io.xpp3

DefaultSiteModelInheritanceAssembler - Class in org.apache.maven.doxia.site.inheritance

Manage inheritance of the site model.

DefaultSiteModelInheritanceAssembler() - Constructor for class org.apache.maven.doxia.site.inheritance.DefaultSiteModelInheritanceAssembler

E

equals(Object) - Method in class org.apache.maven.doxia.site.Body

Method equals.

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.

equals(Object) - Method in class org.apache.maven.doxia.site.Image

Method equals.

equals(Object) - Method in class org.apache.maven.doxia.site.LinkItem

Method equals.

equals(Object) - Method in class org.apache.maven.doxia.site.Menu

Method equals.

equals(Object) - Method in class org.apache.maven.doxia.site.MenuItem

Method equals.

equals(Object) - Method in class org.apache.maven.doxia.site.PublishDate

Method equals.

equals(Object) - Method in class org.apache.maven.doxia.site.SiteModel

Method equals.

equals(Object) - Method in class org.apache.maven.doxia.site.Skin

Method equals.

equals(Object) - Method in class org.apache.maven.doxia.site.Version

Method equals.

G

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.

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.

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.

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.

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.

getDescription() - Method in class org.apache.maven.doxia.site.decoration.MenuItem

Get a description of the menu item.

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.

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.

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.

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.

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.

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.

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.

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.

getPublishDate() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel

getPublishDate() - Method in class org.apache.maven.doxia.site.SiteModel

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).

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.

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.

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.

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.

H

hashCode() - Method in class org.apache.maven.doxia.site.Body

Method hashCode.

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.

hashCode() - Method in class org.apache.maven.doxia.site.Image

Method hashCode.

hashCode() - Method in class org.apache.maven.doxia.site.LinkItem

Method hashCode.

hashCode() - Method in class org.apache.maven.doxia.site.Menu

Method hashCode.

hashCode() - Method in class org.apache.maven.doxia.site.MenuItem

Method hashCode.

hashCode() - Method in class org.apache.maven.doxia.site.PublishDate

Method hashCode.

hashCode() - Method in class org.apache.maven.doxia.site.SiteModel

Method hashCode.

hashCode() - Method in class org.apache.maven.doxia.site.Skin

Method hashCode.

hashCode() - Method in class org.apache.maven.doxia.site.Version

Method hashCode.

I

Image - Class in org.apache.maven.doxia.site

An image.

Image() - Constructor for class org.apache.maven.doxia.site.Image

isCollapse() - Method in class org.apache.maven.doxia.site.decoration.MenuItem

Get whether to collapse children elements of an item menu (by default).

isCollapse() - Method in class org.apache.maven.doxia.site.MenuItem

Get whether to collapse children elements of an item menu (by default).

isDefaultPublishDate() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel

isDefaultPublishDate() - Method in class org.apache.maven.doxia.site.SiteModel

isDefaultVersion() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel

isDefaultVersion() - Method in class org.apache.maven.doxia.site.SiteModel

isInheritAsRef() - Method in class org.apache.maven.doxia.site.decoration.Menu

Get 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.

isInheritAsRef() - Method in class org.apache.maven.doxia.site.Menu

Get 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.

isLink(String) - Method in class org.apache.maven.doxia.site.SiteModel

isLink(String) - Static method in class org.apache.maven.doxia.site.SiteUtils

isMergeParent() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel

isMergeParent() - Method in class org.apache.maven.doxia.site.SiteModel

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

LinkItem - Class in org.apache.maven.doxia.site

A link in the navigation.

LinkItem() - Constructor for class org.apache.maven.doxia.site.LinkItem

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

Logo - Class in org.apache.maven.doxia.site

Power by logo on the navigation.

Logo() - Constructor for class org.apache.maven.doxia.site.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

Menu - Class in org.apache.maven.doxia.site

A menu in the navigation.

Menu() - Constructor for class org.apache.maven.doxia.site.Menu

MenuItem - Class in org.apache.maven.doxia.site.decoration

A menu item.

MenuItem() - Constructor for class org.apache.maven.doxia.site.decoration.MenuItem

MenuItem - Class in org.apache.maven.doxia.site

A menu item.

MenuItem() - Constructor for class org.apache.maven.doxia.site.MenuItem

MERGE - Static variable in class org.apache.maven.doxia.site.decoration.DecorationModel

MERGE - Static variable in class org.apache.maven.doxia.site.SiteModel

O

org.apache.maven.doxia.site - package org.apache.maven.doxia.site

org.apache.maven.doxia.site.decoration - package org.apache.maven.doxia.site.decoration

org.apache.maven.doxia.site.decoration.io.xpp3 - package org.apache.maven.doxia.site.decoration.io.xpp3

org.apache.maven.doxia.site.inheritance - package org.apache.maven.doxia.site.inheritance

org.apache.maven.doxia.site.io.xpp3 - package org.apache.maven.doxia.site.io.xpp3

OVERRIDE - Static variable in class org.apache.maven.doxia.site.decoration.DecorationModel

OVERRIDE - Static variable in class org.apache.maven.doxia.site.SiteModel

P

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

PublishDate - Class in org.apache.maven.doxia.site

Modify display properties for date published.

PublishDate() - Constructor for class org.apache.maven.doxia.site.PublishDate

R

read(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader

Method read.

read(Reader, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader

read(Reader) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader

read(InputStream, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader

Method read.

read(InputStream) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader

Method read.

read(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader

Method read.

read(Reader, boolean) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader

read(Reader) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader

read(InputStream, boolean) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader

Method read.

read(InputStream) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader

Method read.

rebaseLink(String) - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor

Calculate the link as viewed from a different base.

relativizeLink() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor

Calculate the relative link with respect to the base.

removeBreadcrumb(LinkItem) - Method in class org.apache.maven.doxia.site.Body

Method removeBreadcrumb.

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.

removeItem(MenuItem) - Method in class org.apache.maven.doxia.site.Menu

Method removeItem.

removeItem(MenuItem) - Method in class org.apache.maven.doxia.site.MenuItem

Method removeItem.

removeLink(LinkItem) - Method in class org.apache.maven.doxia.site.Body

Method removeLink.

removeLink(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body

Method removeLink.

removeMenu(Menu) - Method in class org.apache.maven.doxia.site.Body

Method removeMenu.

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

removeMenuRef(String) - Method in class org.apache.maven.doxia.site.SiteModel

removePoweredBy(Logo) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel

Method removePoweredBy.

removePoweredBy(Logo) - Method in class org.apache.maven.doxia.site.SiteModel

Method removePoweredBy.

resolveLink() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor

Resolve the link to the base.

resolvePaths(SiteModel, String) - Method in class org.apache.maven.doxia.site.inheritance.DefaultSiteModelInheritanceAssembler

Resolve relative paths for a SiteModel given a base URL.

resolvePaths(SiteModel, String) - Method in interface org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler

Resolve relative paths for a SiteModel given a base URL.

S

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.

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.

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.

setDescription(String) - Method in class org.apache.maven.doxia.site.decoration.MenuItem

Set a description of the menu item.

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.

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.

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.

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.

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.

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.

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.

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).

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.

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.

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.

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.

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.

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

startsWithAnyIgnoreCase(String, String...) - Static method in class org.apache.maven.doxia.site.SiteUtils

T

toString() - Method in class org.apache.maven.doxia.site.Body

Method toString.

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.LinkItem

Method toString.

toString() - Method in class org.apache.maven.doxia.site.decoration.Menu

Method toString.

toString() - Method in class org.apache.maven.doxia.site.decoration.MenuItem

Method toString.

toString() - Method in class org.apache.maven.doxia.site.decoration.PublishDate

Method toString.

toString() - Method in class org.apache.maven.doxia.site.decoration.Skin

Method toString.

toString() - Method in class org.apache.maven.doxia.site.decoration.Version

Method toString.

toString() - Method in class org.apache.maven.doxia.site.Image

Method toString.

toString() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor

Construct a string representation of this URIPathDescriptor.

toString() - Method in class org.apache.maven.doxia.site.LinkItem

Method toString.

toString() - Method in class org.apache.maven.doxia.site.Menu

Method toString.

toString() - Method in class org.apache.maven.doxia.site.MenuItem

Method toString.

toString() - Method in class org.apache.maven.doxia.site.PublishDate

Method toString.

toString() - Method in class org.apache.maven.doxia.site.SiteModel

Method toString.

toString() - Method in class org.apache.maven.doxia.site.Skin

Method toString.

toString() - Method in class org.apache.maven.doxia.site.Version

Method toString.

transform(String, String) - Method in interface org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader.ContentTransformer

Interpolate the value read from the xpp3 document

transform(String, String) - Method in interface org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader.ContentTransformer

Interpolate the value read from the xpp3 document

U

URIPathDescriptor - Class in org.apache.maven.doxia.site.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.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

Version - Class in org.apache.maven.doxia.site

Modify display properties for version published.

Version() - Constructor for class org.apache.maven.doxia.site.Version

W

write(Writer, SiteModel) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer

Method write.

write(OutputStream, SiteModel) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer

Method write.

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