DecorationModel (Doxia :: Decoration Model 1.6 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class DecorationModel
extends Object
implements Serializable, Cloneable
```
The <project> element is the root of the site decoration descriptor.

Version:

$Revision$ $Date$

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String MERGE

static String OVERRIDE

Fields
Modifier and Type	Field and Description
`static String`	`MERGE`
`static String`	`OVERRIDE`

Constructor Summary

Constructors
Constructor and Description

DecorationModel()

Constructors
Constructor and Description
`DecorationModel()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPoweredBy(Logo logo)` Method addPoweredBy.
`DecorationModel`	`clone()` Method clone.
`boolean`	`equals(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.
`String`	`getCombineSelf()` Get whether to inherit configuration from a parent project site descriptor (`merge`) or not (`override`).
`Object`	`getCustom()` Get custom configuration for use with customized Velocity templates.
`String`	`getGoogleAdSenseClient()` Get your Google AdSense client id.
`String`	`getGoogleAdSenseSlot()` Get your Google AdSense slot id.
`String`	`getGoogleAnalyticsAccountId()` Get the id for your Google Analytics account.
`long`	`getLastModified()` Get timestamp of the last modification of this decoration model.
`Menu`	`getMenuRef(String key)`
`List<Menu>`	`getMenus()`
`String`	`getModelEncoding()` Get the modelEncoding field.
`String`	`getName()` Get the full name of the project.
`List<Logo>`	`getPoweredBy()` Method getPoweredBy.
`PublishDate`	`getPublishDate()`
`Skin`	`getSkin()` Get the artifact containing the skin for the site.
`Version`	`getVersion()`
`int`	`hashCode()` Method hashCode.
`boolean`	`isDefaultPublishDate()`
`boolean`	`isDefaultVersion()`
`boolean`	`isMergeParent()`
`void`	`removeMenuRef(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`	`setCombineSelf(String combineSelf)` Set whether to inherit configuration from a parent project site descriptor (`merge`) or not (`override`).
`void`	`setCustom(Object custom)` Set custom configuration for use with customized Velocity templates.
`void`	`setGoogleAdSenseClient(String googleAdSenseClient)` Set your Google AdSense client id.
`void`	`setGoogleAdSenseSlot(String googleAdSenseSlot)` Set your Google AdSense slot id.
`void`	`setGoogleAnalyticsAccountId(String googleAnalyticsAccountId)` Set the id for your Google Analytics account.
`void`	`setLastModified(long lastModified)` Set timestamp of the last modification of this decoration model.
`void`	`setModelEncoding(String modelEncoding)` Set the modelEncoding field.
`void`	`setName(String name)` Set the full name of the project.
`void`	`setPoweredBy(List<Logo> 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.
`String`	`toString()` Method toString.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MERGE
```
public static final String MERGE
```
    See Also:
    Constant Field Values
  - OVERRIDE
```
public static final String OVERRIDE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - DecorationModel
```
public DecorationModel()
```
- Method Detail
  - addPoweredBy
```
public void addPoweredBy(Logo logo)
```
    Method addPoweredBy.
    
    Parameters:
    logo -
  - clone
```
public DecorationModel clone()
```
    Method clone.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    DecorationModel
  - equals
```
public boolean equals(Object other)
```
    Method equals.
    
    Overrides:
    
    equals in class Object
    
    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
  - getCombineSelf
```
public String getCombineSelf()
```
    Get whether to inherit configuration from a parent project site descriptor (merge) or not (override).
    
    Returns:
    String
  - getCustom
```
public Object getCustom()
```
    Get 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()
    
    Returns:
    Object
  - getGoogleAdSenseClient
```
public String getGoogleAdSenseClient()
```
    Get your Google AdSense client id.
    
    Returns:
    String
  - getGoogleAdSenseSlot
```
public String getGoogleAdSenseSlot()
```
    Get your Google AdSense slot id.
    
    Returns:
    String
  - getGoogleAnalyticsAccountId
```
public String getGoogleAnalyticsAccountId()
```
    Get the id for your Google Analytics account.
    
    Returns:
    String
  - getLastModified
```
public long getLastModified()
```
    Get timestamp of the last modification of this decoration model.
    
    Returns:
    long
  - getModelEncoding
```
public String getModelEncoding()
```
    Get the modelEncoding field.
    
    Returns:
    String
  - getName
```
public String getName()
```
    Get the full name of the project.
    
    Returns:
    String
  - getPoweredBy
```
public List<Logo> getPoweredBy()
```
    Method getPoweredBy.
    
    Returns:
    List
  - getSkin
```
public Skin getSkin()
```
    Get the artifact containing the skin for the site.
    
    Returns:
    Skin
  - hashCode
```
public int hashCode()
```
    Method hashCode.
    
    Overrides:
    
    hashCode in class Object
    
    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 -
  - setCombineSelf
```
public void setCombineSelf(String combineSelf)
```
    Set whether to inherit configuration from a parent project site descriptor (merge) or not (override).
    
    Parameters:
    combineSelf -
  - setCustom
```
public void setCustom(Object custom)
```
    Set 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()
    
    Parameters:
    custom -
  - setGoogleAdSenseClient
```
public void setGoogleAdSenseClient(String googleAdSenseClient)
```
    Set your Google AdSense client id.
    
    Parameters:
    googleAdSenseClient -
  - setGoogleAdSenseSlot
```
public void setGoogleAdSenseSlot(String googleAdSenseSlot)
```
    Set your Google AdSense slot id.
    
    Parameters:
    googleAdSenseSlot -
  - setGoogleAnalyticsAccountId
```
public void setGoogleAnalyticsAccountId(String googleAnalyticsAccountId)
```
    Set the id for your Google Analytics account.
    
    Parameters:
    googleAnalyticsAccountId -
  - setLastModified
```
public void setLastModified(long lastModified)
```
    Set timestamp of the last modification of this decoration model.
    
    Parameters:
    lastModified -
  - setModelEncoding
```
public void setModelEncoding(String modelEncoding)
```
    Set the modelEncoding field.
    
    Parameters:
    modelEncoding -
  - setName
```
public void setName(String name)
```
    Set the full name of the project.
    
    Parameters:
    name -
  - setPoweredBy
```
public void setPoweredBy(List<Logo> 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 String toString()
```
    Method toString.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String
  - isMergeParent
```
public boolean isMergeParent()
```
  - getPublishDate
```
public PublishDate getPublishDate()
```
  - isDefaultPublishDate
```
public boolean isDefaultPublishDate()
```
  - getVersion
```
public Version getVersion()
```
  - isDefaultVersion
```
public boolean isDefaultVersion()
```
  - getMenuRef
```
public Menu getMenuRef(String key)
```
    Parameters:
    key - not null
    
    Returns:
    the menu ref defined by the given key.
  - removeMenuRef
```
public void removeMenuRef(String key)
```
    Parameters:
    key - not null
  - getMenus
```
public List<Menu> getMenus()
```
    Returns:
    the menus list or EMPTY_LIST.

Class DecorationModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MERGE

OVERRIDE

Constructor Detail

DecorationModel

Method Detail

addPoweredBy

clone

equals

getBannerLeft

getBannerRight

getBody

getCombineSelf

getCustom

getGoogleAdSenseClient

getGoogleAdSenseSlot

getGoogleAnalyticsAccountId

getLastModified

getModelEncoding

getName

getPoweredBy

getSkin

hashCode

removePoweredBy

setBannerLeft

setBannerRight

setBody

setCombineSelf

setCustom

setGoogleAdSenseClient

setGoogleAdSenseSlot

setGoogleAnalyticsAccountId

setLastModified

setModelEncoding

setName

setPoweredBy

setPublishDate

setSkin

setVersion

toString

isMergeParent

getPublishDate

isDefaultPublishDate

getVersion

isDefaultVersion

getMenuRef

removeMenuRef

getMenus