Serialized Form


Package org.apache.maven.doxia.docrenderer

Class org.apache.maven.doxia.docrenderer.DocumentRendererException extends Exception implements Serializable

serialVersionUID: 295967936746221567L


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

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

Serialized Fields

name

String name
The name of the banner.


src

String src
The source location of an image for the banner.


alt

String alt
The alt description for the banner image.


href

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


border

String border
The border to use for the banner image.


width

String width
The width to use for the banner image.


height

String height
The height to use for the banner image.


title

String title
The title for the banner image.

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

Serialized Fields

head

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


links

List<E> links
Field links.


breadcrumbs

List<E> breadcrumbs
Field breadcrumbs.


menus

List<E> menus
Field menus.


footer

Object footer
If present, the contained text will be used instead of the generated copyright text.

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

Serialized Fields

name

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.


googleAdSenseClient

String googleAdSenseClient
Your Google AdSense client id.


googleAdSenseSlot

String googleAdSenseSlot
Your Google AdSense slot id.


googleAnalyticsAccountId

String googleAnalyticsAccountId
The id for your Google Analytics account.


publishDate

PublishDate publishDate
Modify the date published display properties.


version

Version version
Modify the version published display properties.


poweredBy

List<E> poweredBy
Field poweredBy.


skin

Skin skin
The artifact containing the skin for the site.


body

Body body
The main site content decoration.


custom

Object custom
Custom configuration for use with customized Velocity templates. Data from this field are accessible in Velocity template from $decoration.custom variable as DOM content. Example: $decoration.custom.getChild( 'customElement' ).getValue()


lastModified

long lastModified
Timestamp of the last modification of this decoration model.


modelEncoding

String modelEncoding
Field modelEncoding.


menusByRef

Map<K,V> menusByRef

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

Serialized Fields

name

String name
The name to display for the link.


href

String href
The href to use for the link.


img

String img
The source location of an image.


position

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


alt

String alt
The alt to use for the image.


border

String border
The border to use for the image.


width

String width
The width to use for the image.


height

String height
The height to use for the image.


target

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.


title

String title
The title to use for the image.

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

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

Serialized Fields

name

String name
The name to display for the menu.


inherit

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

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


img

String img
The source location of an menu image.


alt

String alt
The alt description for the image.


position

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


border

String border
The border to use for the menu image.


width

String width
The width to use for the menu image.


height

String height
The height to use for the menu image.


title

String title
The title for the image.


items

List<E> items
Field items.

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

Serialized Fields

description

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

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

List<E> items
Field items.

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

Serialized Fields

position

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


format

String format
Date format to use.

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

Serialized Fields

groupId

String groupId
The skin group ID.


artifactId

String artifactId
The skin artifact ID.


version

String version
The skin version.

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

Serialized Fields

position

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


Package org.apache.maven.doxia.siterenderer

Class org.apache.maven.doxia.siterenderer.RendererException extends Exception implements Serializable

serialVersionUID: 3141592653589793238L



Copyright © 2005-2013 The Apache Software Foundation. All Rights Reserved.