Serialized Form

Package org.apache.maven.doxia.site.decoration

Class org.apache.maven.doxia.site.decoration.Banner extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the banner.

src

java.lang.String src

The source location of an image for the banner.

alt

java.lang.String alt

The alt description for the banner image.

href

java.lang.String href

The href of a link to be used for the banner image.

border

java.lang.String border

The border to use for the banner image.

width

java.lang.String width

The width to use for the banner image.

height

java.lang.String height

The height to use for the banner image.

Class org.apache.maven.doxia.site.decoration.Body extends java.lang.Object implements Serializable

Serialized Fields

head

java.lang.Object head

Additional content (like Javascript) to include in the HEAD block of the generated pages.

links

java.util.List links

Field links.

breadcrumbs

java.util.List breadcrumbs

Field breadcrumbs.

menus

java.util.List menus

Field menus.

Class org.apache.maven.doxia.site.decoration.DecorationModel extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The full name of the project.

bannerLeft

Banner bannerLeft

Banner logo on the masthead of the site to the left.

bannerRight

Banner bannerRight

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

publishDate

PublishDate publishDate

Modify the date published display properties.

version

Version version

Modify the version published display properties.

poweredBy

java.util.List poweredBy

Field poweredBy.

skin

Skin skin

The artifact containing the skin for the site.

body

Body body

The main site content decoration.

custom

java.lang.Object custom

Custom configuration for use with customized Velocity templates.

lastModified

long lastModified

Timestamp of the last modification of this decoration model.

modelEncoding

java.lang.String modelEncoding

Field modelEncoding.

menusByRef

java.util.Map menusByRef

Class org.apache.maven.doxia.site.decoration.LinkItem extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name to display for the link.

href

java.lang.String href

The href to use for the link.

img

java.lang.String img

The source location of an image.

position

java.lang.String position

Where to place the image regarding the displayed name (left or right).

alt

java.lang.String alt

The alt to use for the image.

border

java.lang.String border

The border to use for the image.

width

java.lang.String width

The width to use for the image.

height

java.lang.String height

The height to use for the image.

target

java.lang.String target

Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window.

Class org.apache.maven.doxia.site.decoration.Logo extends LinkItem implements Serializable

Class org.apache.maven.doxia.site.decoration.Menu extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name to display for the menu.

inherit

java.lang.String inherit

The way in which the menu is inherited. Can be one of : top, bottom.

inheritAsRef

boolean inheritAsRef

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.

ref

java.lang.String ref

A reference to a pre-defined menu, such as a reports, modules or parent.

img

java.lang.String img

The source location of an menu image.

alt

java.lang.String alt

The alt description for the image.

position

java.lang.String position

Where to place the image regarding the displayed name (left or right).

border

java.lang.String border

The border to use for the menu image.

width

java.lang.String width

The width to use for the menu image.

height

java.lang.String height

The height to use for the menu image.

items

java.util.List items

Field items.

Class org.apache.maven.doxia.site.decoration.MenuItem extends LinkItem implements Serializable

Serialized Fields

description

java.lang.String description

A description of the menu item. This is used on any summary pages for a menu.

collapse

boolean collapse

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

ref

java.lang.String ref

A reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.

items

java.util.List items

Field items.

Class org.apache.maven.doxia.site.decoration.PublishDate extends java.lang.Object implements Serializable

Serialized Fields

position

java.lang.String position

Where to place the date published (left, right, navigation-top, navigation-bottom, bottom).

format

java.lang.String format

Date format to use. The default is ISO-8601 yyyy-MM-dd.

Class org.apache.maven.doxia.site.decoration.Skin extends java.lang.Object implements Serializable

Serialized Fields

groupId

java.lang.String groupId

The skin group ID.

artifactId

java.lang.String artifactId

The skin artifact ID.

version

java.lang.String version

The skin version.

Class org.apache.maven.doxia.site.decoration.Version extends java.lang.Object implements Serializable

Serialized Fields

position

java.lang.String position

Where to place the version published (left, right, navigation-top, navigation-bottom, bottom).