Class DecorationModel
java.lang.Object
org.apache.maven.doxia.site.decoration.DecorationModel
- All Implemented Interfaces:
Serializable
,Cloneable
The
<project>
element is the root of
the site decoration descriptor.- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Banner
Banner logo on the masthead of the site to the left.private Banner
Banner logo on the masthead of the site to the right.private Body
The main site content decoration.private String
Whether to inherit configuration from a parent project site descriptor (merge
) or not (override
).private Object
Custom configuration for use with customized Velocity templates.private String
The base url to edit Doxia document sources.private String
Your Google AdSense client id.private String
Your Google AdSense slot id.private String
The id for your Google Analytics account.private long
Timestamp of the last modification of this decoration model.static final String
private String
Field modelEncoding.private String
The full name of the project.static final String
Field poweredBy.private PublishDate
Modify the date published display properties.private Skin
The artifact containing the skin for the site.private Version
Modify the version published display properties. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPoweredBy
(Logo logo) Method addPoweredBy.clone()
Method clone.boolean
Method equals.Get banner logo on the masthead of the site to the left.Get banner logo on the masthead of the site to the right.getBody()
Get the main site content decoration.Get whether to inherit configuration from a parent project site descriptor (merge
) or not (override
).Get custom configuration for use with customized Velocity templates.getCustomChild
(String path) getCustomValue
(String path) getCustomValue
(String path, String defaultValue) getEdit()
Get the base url to edit Doxia document sources.Get your Google AdSense client id.Get your Google AdSense slot id.Get the id for your Google Analytics account.long
Get timestamp of the last modification of this decoration model.getMenuRef
(String key) getMenus()
Get the modelEncoding field.getName()
Get the full name of the project.Method getPoweredBy.getSkin()
Get the artifact containing the skin for the site.int
hashCode()
Method hashCode.boolean
boolean
boolean
boolean
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
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
Set custom configuration for use with customized Velocity templates.void
Set the base url to edit Doxia document sources.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
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
Set the artifact containing the skin for the site.void
setVersion
(Version version) Set modify the version published display properties.toString()
Method toString.
-
Field Details
-
name
The full name of the project. -
combineSelf
Whether to inherit configuration from a parent project site descriptor (merge
) or not (override
). -
bannerLeft
Banner logo on the masthead of the site to the left. -
bannerRight
Banner logo on the masthead of the site to the right. -
googleAdSenseClient
Your Google AdSense client id. -
googleAdSenseSlot
Your Google AdSense slot id. -
googleAnalyticsAccountId
The id for your Google Analytics account. -
publishDate
Modify the date published display properties. -
version
Modify the version published display properties. -
edit
The base url to edit Doxia document sources. In general,${project.scm.url}
value should do the job. -
poweredBy
Field poweredBy. -
skin
The artifact containing the skin for the site. -
body
The main site content decoration. -
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
private long lastModifiedTimestamp of the last modification of this decoration model. -
modelEncoding
Field modelEncoding. -
MERGE
- See Also:
-
OVERRIDE
- See Also:
-
-
Constructor Details
-
DecorationModel
public DecorationModel()
-
-
Method Details
-
addPoweredBy
Method addPoweredBy.- Parameters:
logo
- a logo object.
-
clone
Method clone. -
equals
Method equals. -
getBannerLeft
Get banner logo on the masthead of the site to the left.- Returns:
- Banner
-
getBannerRight
Get banner logo on the masthead of the site to the right.- Returns:
- Banner
-
getBody
Get the main site content decoration.- Returns:
- Body
-
getCombineSelf
Get whether to inherit configuration from a parent project site descriptor (merge
) or not (override
).- Returns:
- String
-
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
-
getEdit
Get the base url to edit Doxia document sources. In general,${project.scm.url}
value should do the job.- Returns:
- String
-
getGoogleAdSenseClient
Get your Google AdSense client id.- Returns:
- String
-
getGoogleAdSenseSlot
Get your Google AdSense slot id.- Returns:
- 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
Get the modelEncoding field.- Returns:
- String
-
getName
Get the full name of the project.- Returns:
- String
-
getPoweredBy
Method getPoweredBy.- Returns:
- List
-
getSkin
Get the artifact containing the skin for the site.- Returns:
- Skin
-
hashCode
public int hashCode()Method hashCode. -
removePoweredBy
Method removePoweredBy.- Parameters:
logo
- a logo object.
-
setBannerLeft
Set banner logo on the masthead of the site to the left.- Parameters:
bannerLeft
- a bannerLeft object.
-
setBannerRight
Set banner logo on the masthead of the site to the right.- Parameters:
bannerRight
- a bannerRight object.
-
setBody
Set the main site content decoration.- Parameters:
body
- a body object.
-
setCombineSelf
Set whether to inherit configuration from a parent project site descriptor (merge
) or not (override
).- Parameters:
combineSelf
- a combineSelf object.
-
setCustom
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
- a custom object.
-
setEdit
Set the base url to edit Doxia document sources. In general,${project.scm.url}
value should do the job.- Parameters:
edit
- a edit object.
-
setGoogleAdSenseClient
Set your Google AdSense client id.- Parameters:
googleAdSenseClient
- a googleAdSenseClient object.
-
setGoogleAdSenseSlot
Set your Google AdSense slot id.- Parameters:
googleAdSenseSlot
- a googleAdSenseSlot object.
-
setGoogleAnalyticsAccountId
Set the id for your Google Analytics account.- Parameters:
googleAnalyticsAccountId
- a googleAnalyticsAccountId object.
-
setLastModified
public void setLastModified(long lastModified) Set timestamp of the last modification of this decoration model.- Parameters:
lastModified
- a lastModified object.
-
setModelEncoding
Set the modelEncoding field.- Parameters:
modelEncoding
- a modelEncoding object.
-
setName
Set the full name of the project.- Parameters:
name
- a name object.
-
setPoweredBy
Set powered by logos list.- Parameters:
poweredBy
- a poweredBy object.
-
setPublishDate
Set modify the date published display properties.- Parameters:
publishDate
- a publishDate object.
-
setSkin
Set the artifact containing the skin for the site.- Parameters:
skin
- a skin object.
-
setVersion
Set modify the version published display properties.- Parameters:
version
- a version object.
-
toString
Method toString. -
isMergeParent
public boolean isMergeParent() -
getPublishDate
-
isDefaultPublishDate
public boolean isDefaultPublishDate() -
getVersion
-
isDefaultVersion
public boolean isDefaultVersion() -
getMenuRef
- Parameters:
key
- not null- Returns:
- the menu ref defined by the given key.
-
removeMenuRef
- Parameters:
key
- not null
-
getMenus
- Returns:
- the menus list or EMPTY_LIST.
-
isLink
- Since:
- 1.7
- See Also:
-
getCustomChild
- Since:
- 1.8
- See Also:
-
getCustomValue
- Since:
- 1.8
- See Also:
-
getCustomValue
- Since:
- 1.8
- See Also:
-