装饰模型（Doxia Sitetools :: 装饰模型 2.0.0-M2 API）

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

所有实现的接口：

可序列化,可克隆
```
public class DecorationModel
extends Object
implements Serializable, Cloneable
```
该<project>元素是站点装饰描述符的根。

版本：

$修订$ $日期$

也可以看看：

序列化表格

字段摘要

字段
修饰符和类型字段和说明

static String MERGE

static String OVERRIDE

字段
修饰符和类型	字段和说明
`static String`	`MERGE`
`static String`	`OVERRIDE`

构造函数摘要

构造函数
构造函数和描述

DecorationModel()

构造函数
构造函数和描述
`DecorationModel()`

方法总结

所有方法实例方法具体方法
修饰符和类型	方法及说明
`void`	`addPoweredBy(Logo logo)` 方法 addPoweredBy。
`DecorationModel`	`clone()` 方法克隆。
`boolean`	`equals(Object other)` 方法等于。
`Banner`	`getBannerLeft()` 在左侧网站的标头上获取横幅徽标。
`Banner`	`getBannerRight()` 在右侧网站的标头上获取横幅徽标。
`Body`	`getBody()` 获取主站点内容装饰。
`String`	`getCombineSelf()` 获取是否从父项目站点描述符 ( `merge`) 继承配置 ( `override`)。
`Object`	`getCustom()` 获取自定义配置以与自定义 Velocity 模板一起使用。
`Object`	`getCustomChild(String path)`
`String`	`getCustomValue(String path)`
`String`	`getCustomValue(String path, String defaultValue)`
`String`	`getEdit()` 获取基础 url 以编辑 Doxia 文档源。
`String`	`getGoogleAdSenseClient()` 获取您的 Google AdSense 客户端 ID。
`String`	`getGoogleAdSenseSlot()` 获取您的 Google AdSense 广告位 ID。
`String`	`getGoogleAnalyticsAccountId()` 获取您的 Google Analytics（分析）帐户的 ID。
`long`	`getLastModified()` 获取此装饰模型的最后修改的时间戳。
`Menu`	`getMenuRef(String key)`
`List<Menu>`	`getMenus()`
`String`	`getModelEncoding()` 获取模型编码字段。
`String`	`getName()` 获取项目的全名。
`List<Logo>`	`getPoweredBy()` 方法 getPoweredBy。
`PublishDate`	`getPublishDate()`
`Skin`	`getSkin()` 获取包含站点皮肤的工件。
`Version`	`getVersion()`
`int`	`hashCode()` 方法哈希码。
`boolean`	`isDefaultPublishDate()`
`boolean`	`isDefaultVersion()`
`boolean`	`isLink(String href)`
`boolean`	`isMergeParent()`
`void`	`removeMenuRef(String key)`
`void`	`removePoweredBy(Logo logo)` 方法 removePoweredBy。
`void`	`setBannerLeft(Banner bannerLeft)` 在左侧的网站标头上设置横幅徽标。
`void`	`setBannerRight(Banner bannerRight)` 在右侧的站点标头上设置横幅徽标。
`void`	`setBody(Body body)` 设置主站点内容装饰。
`void`	`setCombineSelf(String combineSelf)` 设置是否从父项目站点描述符 ( `merge`) 继承配置 ( `override`)。
`void`	`setCustom(Object custom)` 设置自定义配置以与自定义 Velocity 模板一起使用。
`void`	`setEdit(String edit)` 设置基本 url 以编辑 Doxia 文档源。
`void`	`setGoogleAdSenseClient(String googleAdSenseClient)` 设置您的 Google AdSense 客户端 ID。
`void`	`setGoogleAdSenseSlot(String googleAdSenseSlot)` 设置您的 Google AdSense 广告位 ID。
`void`	`setGoogleAnalyticsAccountId(String googleAnalyticsAccountId)` 为您的 Google Analytics（分析）帐户设置 ID。
`void`	`setLastModified(long lastModified)` 设置此装饰模型的最后修改的时间戳。
`void`	`setModelEncoding(String modelEncoding)` 设置模型编码字段。
`void`	`setName(String name)` 设置项目的全名。
`void`	`setPoweredBy(List<Logo> poweredBy)` 设置由徽标列表提供支持。
`void`	`setPublishDate(PublishDate publishDate)` 设置修改发布日期的显示属性。
`void`	`setSkin(Skin skin)` 设置包含站点皮肤的工件。
`void`	`setVersion(Version version)` 设置修改版本发布的显示属性。
`String`	`toString()` 方法 toString。

从类 java.lang 继承的方法。目的
finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细信息
  - 合并
```
public static final String MERGE
```
    也可以看看：
    
    常量字段值
  - 覆盖
```
public static final String OVERRIDE
```
    也可以看看：
    
    常量字段值
- 构造函数详细信息
  - 装饰模型
```
public DecorationModel()
```
- 方法详情
  - addPoweredBy
```
public void addPoweredBy(Logo logo)
```
    方法 addPoweredBy。
    
    参数：
    
    logo-
  - 克隆
```
public DecorationModel clone()
```
    方法克隆。
    
    覆盖：
    
    clone 在班上 Object
    
    回报：
    
    装饰模型
  - 等于
```
public boolean equals(Object other)
```
    方法等于。
    
    覆盖：
    
    equals 在班上 Object
    
    参数：
    
    other-
    
    回报：
    
    布尔值
  - getBannerLeft
```
public Banner getBannerLeft()
```
    在左侧网站的标头上获取横幅徽标。
    
    回报：
    
    横幅
  - getBannerRight
```
public Banner getBannerRight()
```
    在右侧网站的标头上获取横幅徽标。
    
    回报：
    
    横幅
  - 获取正文
```
public Body getBody()
```
    获取主站点内容装饰。
    
    回报：
    
    身体
  - getCombineSelf
```
public String getCombineSelf()
```
    获取是否从父项目站点描述符 ( merge) 继承配置 ( override)。
    
    回报：
    
    细绳
  - 获取自定义
```
public Object getCustom()
```
    获取自定义配置以与自定义 Velocity 模板一起使用。来自该字段的数据可在 Velocity 模板中从 $decoration.custom变量作为 DOM 内容访问。例子：$decoration.custom.getChild( 'customElement' ).getValue()
    
    回报：
    
    目的
  - 获取编辑
```
public String getEdit()
```
    获取基础 url 以编辑 Doxia 文档源。一般来说，${project.scm.url} 价值应该发挥作用。
    
    回报：
    
    细绳
  - 获取 GoogleAdSense 客户端
```
public String getGoogleAdSenseClient()
```
    获取您的 Google AdSense 客户端 ID。
    
    回报：
    
    细绳
  - 获取GoogleAdSenseSlot
```
public String getGoogleAdSenseSlot()
```
    获取您的 Google AdSense 广告位 ID。
    
    回报：
    
    细绳
  - 获取 GoogleAnalyticsAccountId
```
public String getGoogleAnalyticsAccountId()
```
    获取您的 Google Analytics（分析）帐户的 ID。
    
    回报：
    
    细绳
  - 获取最后修改
```
public long getLastModified()
```
    获取此装饰模型的最后修改的时间戳。
    
    回报：
    
    长
  - 获取模型编码
```
public String getModelEncoding()
```
    获取模型编码字段。
    
    回报：
    
    细绳
  - 获取名称
```
public String getName()
```
    获取项目的全名。
    
    回报：
    
    细绳
  - getPoweredBy
```
public List<Logo> getPoweredBy()
```
    方法 getPoweredBy。
    
    回报：
    
    列表
  - 获取皮肤
```
public Skin getSkin()
```
    获取包含站点皮肤的工件。
    
    回报：
    
    皮肤
  - 哈希码
```
public int hashCode()
```
    方法哈希码。
    
    覆盖：
    
    hashCode 在班上 Object
    
    回报：
    
    整数
  - 移除PoweredBy
```
public void removePoweredBy(Logo logo)
```
    方法 removePoweredBy。
    
    参数：
    
    logo-
  - setBannerLeft
```
public void setBannerLeft(Banner bannerLeft)
```
    在左侧的网站标头上设置横幅徽标。
    
    参数：
    
    bannerLeft-
  - setBannerRight
```
public void setBannerRight(Banner bannerRight)
```
    在右侧的站点标头上设置横幅徽标。
    
    参数：
    
    bannerRight-
  - 集合体
```
public void setBody(Body body)
```
    设置主站点内容装饰。
    
    参数：
    
    body-
  - setCombineSelf
```
public void setCombineSelf(String combineSelf)
```
    设置是否从父项目站点描述符 ( merge) 继承配置 ( override)。
    
    参数：
    
    combineSelf-
  - 设置自定义
```
public void setCustom(Object custom)
```
    设置自定义配置以与自定义 Velocity 模板一起使用。来自该字段的数据可在 Velocity 模板中从 $decoration.custom变量作为 DOM 内容访问。例子：$decoration.custom.getChild( 'customElement' ).getValue()
    
    参数：
    
    custom-
  - 设置编辑
```
public void setEdit(String edit)
```
    设置基本 url 以编辑 Doxia 文档源。一般来说，${project.scm.url} 价值应该发挥作用。
    
    参数：
    
    edit-
  - 设置GoogleAdSenseClient
```
public void setGoogleAdSenseClient(String googleAdSenseClient)
```
    设置您的 Google AdSense 客户端 ID。
    
    参数：
    
    googleAdSenseClient-
  - 设置GoogleAdSenseSlot
```
public void setGoogleAdSenseSlot(String googleAdSenseSlot)
```
    设置您的 Google AdSense 广告位 ID。
    
    参数：
    
    googleAdSenseSlot-
  - setGoogleAnalyticsAccountId
```
public void setGoogleAnalyticsAccountId(String googleAnalyticsAccountId)
```
    为您的 Google Analytics（分析）帐户设置 ID。
    
    参数：
    
    googleAnalyticsAccountId-
  - setLastModified
```
public void setLastModified(long lastModified)
```
    设置此装饰模型的最后修改的时间戳。
    
    参数：
    
    lastModified-
  - 设置模型编码
```
public void setModelEncoding(String modelEncoding)
```
    设置模型编码字段。
    
    参数：
    
    modelEncoding-
  - 设置名称
```
public void setName(String name)
```
    设置项目的全名。
    
    参数：
    
    name-
  - setPoweredBy
```
public void setPoweredBy(List<Logo> poweredBy)
```
    设置由徽标列表提供支持。
    
    参数：
    
    poweredBy-
  - 设置发布日期
```
public void setPublishDate(PublishDate publishDate)
```
    设置修改发布日期的显示属性。
    
    参数：
    
    publishDate-
  - 设置皮肤
```
public void setSkin(Skin skin)
```
    设置包含站点皮肤的工件。
    
    参数：
    
    skin-
  - 设置版本
```
public void setVersion(Version version)
```
    设置修改版本发布的显示属性。
    
    参数：
    
    version-
  - ```
  public String toString()
```
  方法 toString。
  
  覆盖：
  
  toString 在班上 Object
  
  回报：
  
  细绳
- isMergeParent
```
  public boolean isMergeParent()
```
- 获取发布日期
```
  public PublishDate getPublishDate()
```
- isDefaultPublishDate
```
  public boolean isDefaultPublishDate()
```
- 获取版本
```
  public Version getVersion()
```
- isDefaultVersion
```
  public boolean isDefaultVersion()
```
- 获取菜单引用
```
  public Menu getMenuRef(String key)
```
  参数：
  
  key- 不为空
  
  回报：
  
  由给定键定义的菜单引用。
- 删除菜单引用
```
  public void removeMenuRef(String key)
```
  参数：
  
  key- 不为空
- 获取菜单
```
  public List<Menu> getMenus()
```
  回报：
  
  菜单列表或 EMPTY_LIST。
- isLink
```
  public boolean isLink(String href)
```
  自从：
  
  1.7
  
  也可以看看：
  
  DecorationUtils.isLink(java.lang.String)
- getCustomChild
```
  public Object getCustomChild(String path)
```
  自从：
  
  1.8
  
  也可以看看：
  
  DecorationUtils.getCustomChild(org.codehaus.plexus.util.xml.Xpp3Dom, java.lang.String)
- 获取自定义值
```
  public String getCustomValue(String path)
```
  自从：
  
  1.8
  
  也可以看看：
  
  DecorationUtils.getCustomValue(org.codehaus.plexus.util.xml.Xpp3Dom, java.lang.String)
- 获取自定义值
```
  public String getCustomValue(String path,
                               String defaultValue)
```
  自从：
  
  1.8
  
  也可以看看：
  
  DecorationUtils.getCustomValue(org.codehaus.plexus.util.xml.Xpp3Dom, java.lang.String)

班级装饰模型

字段摘要

构造函数摘要

方法总结

从类 java.lang 继承的方法。目的

字段详细信息

合并

覆盖

构造函数详细信息

装饰模型

方法详情

addPoweredBy

克隆

等于

getBannerLeft

getBannerRight

获取正文

getCombineSelf

获取自定义

获取编辑

获取 GoogleAdSense 客户端

获取GoogleAdSenseSlot

获取 GoogleAnalyticsAccountId

获取最后修改

获取模型编码

获取名称

getPoweredBy

获取皮肤

哈希码

移除PoweredBy

setBannerLeft

setBannerRight

集合体

setCombineSelf

设置自定义

设置编辑

设置GoogleAdSenseClient

设置GoogleAdSenseSlot

setGoogleAnalyticsAccountId

setLastModified

设置模型编码

设置名称

setPoweredBy

设置发布日期

设置皮肤

设置版本

isMergeParent

获取发布日期

isDefaultPublishDate

获取版本

isDefaultVersion

获取菜单引用

删除菜单引用

获取菜单

isLink

getCustomChild

获取自定义值

获取自定义值