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

A

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.

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

Method addPoweredBy.

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.

B

Banner - class org.apache.maven.doxia.site.decoration.Banner.

Banner logo on the masthead of the site.

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

Body - class org.apache.maven.doxia.site.decoration.Body.

The main content decoration.

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

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

Method breakMenuItemAssociation.

C

convertPath(PathDescriptor, PathDescriptor) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.PathUtils

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

Method createMenuItemAssociation.

D

DecorationModel - class org.apache.maven.doxia.site.decoration.DecorationModel.

The <project> element is the root of the site decoration descriptor.

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

DecorationModelInheritanceAssembler - interface org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler.

Manage inheritance of the decoration model.

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

Class DecorationXpp3Reader.

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

DecorationXpp3Writer - class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer.

Class DecorationXpp3Writer.

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

DefaultDecorationModelInheritanceAssembler - class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.

Manage inheritance of the decoration model.

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

DefaultDecorationModelInheritanceAssembler.URLContainer - class org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler.URLContainer.

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.

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

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.

G

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.

getArtifactId() - Method in class org.apache.maven.doxia.site.decoration.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.

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

Get Banner logo on the masthead of the site to the right.

getBaseUrl() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

Get the base URL.

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

Get The main site content decoration.

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

Method getBreadcrumbs.

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

Get Custom configuration for use with customised Velocity templates.

getDefaultSkin() - Static method in class org.apache.maven.doxia.site.decoration.Skin

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

Get A description of the menu item.

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

Get Date format to use.

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.

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

Get The href of a link to be used for the power by image.

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

Get The location of an image.

getInherit() - Method in class org.apache.maven.doxia.site.decoration.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.

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

Method getLinks.

getLocation() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

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

Method getModelEncoding.

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.

getPath() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

Get the path.

getPathUrl() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

Get the path as a URL.

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

Get Modify the date published display properties.

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

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

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

Get The artifact containing the skin for the site.

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

Get The location of an image for the banner.

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

Get Modify the version published display properties.

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

Get The skin version.

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

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.

I

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

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

isFile() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

Check if this PathDescriptor decribes 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.

isRelative() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

Check if this PathDescriptor decribes a relative path.

L

LinkItem - class org.apache.maven.doxia.site.decoration.LinkItem.

A link in the navigation.

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

Logo - class org.apache.maven.doxia.site.decoration.Logo.

Power by logo on the navigation.

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

M

Menu - class org.apache.maven.doxia.site.decoration.Menu.

A menu in the navigation.

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

MenuItem - class org.apache.maven.doxia.site.decoration.MenuItem.

A menu item.

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

O

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

P

PathDescriptor - class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor.

This class holds an instance of a maven path.

PathDescriptor(String) - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

Construct a PathDescriptor from a path.

PathDescriptor(String, String) - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

Construct a PathDescriptor from a path and a base.

PathDescriptor(URL, String) - Constructor for class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor

Construct a PathDescriptor from a path and a base.

PathUtils - class org.apache.maven.doxia.site.decoration.inheritance.PathUtils.

Utilities that allow conversion of old and new pathes and URLs relative to each other.

PublishDate - class org.apache.maven.doxia.site.decoration.PublishDate.

Modify display properties for date published.

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

R

ROLE - Static variable in interface org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler

Plexus lookup role.

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.

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.

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.

S

Skin - class org.apache.maven.doxia.site.decoration.Skin.

An skin artifact declaration.

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

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.

setArtifactId(String) - Method in class org.apache.maven.doxia.site.decoration.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.

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

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.

setBreadcrumbs(List) - 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).

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

Set Custom configuration for use with customised Velocity templates.

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

Set A description of the menu item.

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

Set Date format to use.

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.

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

Set The href of a link to be used for the power by image.

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

Set The location of an 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.

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

Set A list of menu item.

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

Set menu item.

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

Set A list of links to display in the navigation.

setMenus(List) - 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 an encoding used for reading/writing the model.

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.

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

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

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.

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

Set The location of an image for the banner.

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.

T

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

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.decoration.inheritance.PathDescriptor

V

Version - class org.apache.maven.doxia.site.decoration.Version.

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.

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