org.apache.maven.doxia.site.decoration
Class DecorationModel

java.lang.Object
  org.apache.maven.doxia.site.decoration.DecorationModel

All Implemented Interfaces:

java.io.Serializable

public class DecorationModel

extends java.lang.Object

implements java.io.Serializable

The <project> element is the root of the site decoration descriptor. The following table lists all of the possible child elements.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DecorationModel()

Method Summary

void	addPoweredBy(Logo logo) Method addPoweredBy.
boolean	equals(java.lang.Object other) Method equals.
Banner	getBannerLeft() Get Banner logo on the masthead of the site to the left.
Banner	getBannerRight() Get Banner logo on the masthead of the site to the right.
Body	getBody() Get The main site content decoration.
java.lang.Object	getCustom() Get Custom configuration for use with customised Velocity templates.
Menu	getMenuRef(java.lang.String key)
java.util.List	getMenus()
java.lang.String	getModelEncoding() Method getModelEncoding.
java.lang.String	getName() Get The full name of the project.
java.util.List	getPoweredBy() Method getPoweredBy.
PublishDate	getPublishDate() Get Modify the date published display properties.
Skin	getSkin() Get The artifact containing the skin for the site.
Version	getVersion() Get Modify the version published display properties.
int	hashCode() Method hashCode.
void	removeMenuRef(java.lang.String key)
void	removePoweredBy(Logo logo) Method removePoweredBy.
void	setBannerLeft(Banner bannerLeft) Set Banner logo on the masthead of the site to the left.
void	setBannerRight(Banner bannerRight) Set Banner logo on the masthead of the site to the right.
void	setBody(Body body) Set The main site content decoration.
void	setCustom(java.lang.Object custom) Set Custom configuration for use with customised Velocity templates.
void	setModelEncoding(java.lang.String modelEncoding) Set an encoding used for reading/writing the model.
void	setName(java.lang.String name) Set The full name of the project.
void	setPoweredBy(java.util.List poweredBy) Set Powered by logos list.
void	setPublishDate(PublishDate publishDate) Set Modify the date published display properties.
void	setSkin(Skin skin) Set The artifact containing the skin for the site.
void	setVersion(Version version) Set Modify the version published display properties.
java.lang.String	toString() Method toString.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DecorationModel

public DecorationModel()

Method Detail

addPoweredBy

public void addPoweredBy(Logo logo)

Method addPoweredBy.

Parameters:

logo -

equals

public boolean equals(java.lang.Object other)

Method equals.

Parameters:

other -

Returns:

boolean

getBannerLeft

public Banner getBannerLeft()

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

Returns:

Banner

getBannerRight

public Banner getBannerRight()

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

Returns:

Banner

getBody

public Body getBody()

Get The main site content decoration.

Returns:

Body

getCustom

public java.lang.Object getCustom()

Get Custom configuration for use with customised Velocity templates.

Returns:

Object

getModelEncoding

public java.lang.String getModelEncoding()

Method getModelEncoding.

Returns:

the current encoding used when reading/writing this model

getName

public java.lang.String getName()

Get The full name of the project.

Returns:

String

getPoweredBy

public java.util.List getPoweredBy()

Method getPoweredBy.

Returns:

List

getPublishDate

public PublishDate getPublishDate()

Get Modify the date published display properties.

Returns:

PublishDate

getSkin

public Skin getSkin()

Get The artifact containing the skin for the site.

Returns:

Skin

getVersion

public Version getVersion()

Get Modify the version published display properties.

Returns:

Version

hashCode

public int hashCode()

Method hashCode.

Returns:

int

removePoweredBy

public void removePoweredBy(Logo logo)

Method removePoweredBy.

Parameters:

logo -

setBannerLeft

public void setBannerLeft(Banner bannerLeft)

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

Parameters:

bannerLeft -

setBannerRight

public void setBannerRight(Banner bannerRight)

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

Parameters:

bannerRight -

setBody

public void setBody(Body body)

Set The main site content decoration.

Parameters:

body -

setCustom

public void setCustom(java.lang.Object custom)

Set Custom configuration for use with customised Velocity templates.

Parameters:

custom -

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

Set an encoding used for reading/writing the model.

Parameters:

modelEncoding -

setName

public void setName(java.lang.String name)

Set The full name of the project.

Parameters:

name -

setPoweredBy

public void setPoweredBy(java.util.List poweredBy)

Set Powered by logos list.

Parameters:

poweredBy -

setPublishDate

public void setPublishDate(PublishDate publishDate)

Set Modify the date published display properties.

Parameters:

publishDate -

setSkin

public void setSkin(Skin skin)

Set The artifact containing the skin for the site.

Parameters:

skin -

setVersion

public void setVersion(Version version)

Set Modify the version published display properties.

Parameters:

version -

toString

public java.lang.String toString()

Method toString.

Returns:

String

getMenuRef

public Menu getMenuRef(java.lang.String key)

removeMenuRef

public void removeMenuRef(java.lang.String key)

getMenus

public java.util.List getMenus()