public class DecorationModel
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
<project>
element is the root of
the site decoration descriptor.Modifier and Type | Field and Description |
---|---|
private Banner |
bannerLeft
Banner logo on the masthead of the site to the left.
|
private Banner |
bannerRight
Banner logo on the masthead of the site to the right.
|
private Body |
body
The main site content decoration.
|
private java.lang.String |
combineSelf
Whether to inherit configuration from a parent
project site descriptor (
merge )
or not (override ). |
private java.lang.Object |
custom
Custom configuration for use with customized
Velocity templates.
|
private java.lang.String |
edit
The base url to edit Doxia document sources.
|
private java.lang.String |
googleAdSenseClient
Your Google AdSense client id.
|
private java.lang.String |
googleAdSenseSlot
Your Google AdSense slot id.
|
private java.lang.String |
googleAnalyticsAccountId
The id for your Google Analytics account.
|
private long |
lastModified
Timestamp of the last modification of this decoration model.
|
private java.util.Map<java.lang.String,Menu> |
menusByRef |
static java.lang.String |
MERGE |
private java.lang.String |
modelEncoding
Field modelEncoding.
|
private java.lang.String |
name
The full name of the project.
|
static java.lang.String |
OVERRIDE |
private java.util.List<Logo> |
poweredBy
Field poweredBy.
|
private PublishDate |
publishDate
Modify the date published display properties.
|
private Skin |
skin
The artifact containing the skin for the site.
|
private Version |
version
Modify the version published display properties.
|
Constructor and Description |
---|
DecorationModel() |
Modifier and Type | Method and Description |
---|---|
void |
addPoweredBy(Logo logo)
Method addPoweredBy.
|
DecorationModel |
clone()
Method clone.
|
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.String |
getCombineSelf()
Get whether to inherit configuration from a parent project
site descriptor (
merge )
or not (override ). |
java.lang.Object |
getCustom()
Get custom configuration for use with customized Velocity
templates.
|
java.lang.Object |
getCustomChild(java.lang.String path) |
java.lang.String |
getCustomValue(java.lang.String path) |
java.lang.String |
getCustomValue(java.lang.String path,
java.lang.String defaultValue) |
java.lang.String |
getEdit()
Get the base url to edit Doxia document sources.
|
java.lang.String |
getGoogleAdSenseClient()
Get your Google AdSense client id.
|
java.lang.String |
getGoogleAdSenseSlot()
Get your Google AdSense slot id.
|
java.lang.String |
getGoogleAnalyticsAccountId()
Get the id for your Google Analytics account.
|
long |
getLastModified()
Get timestamp of the last modification of this decoration
model.
|
Menu |
getMenuRef(java.lang.String key) |
java.util.List<Menu> |
getMenus() |
java.lang.String |
getModelEncoding()
Get the modelEncoding field.
|
java.lang.String |
getName()
Get the full name of the project.
|
java.util.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 |
isLink(java.lang.String href) |
boolean |
isMergeParent() |
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 |
setCombineSelf(java.lang.String combineSelf)
Set whether to inherit configuration from a parent project
site descriptor (
merge )
or not (override ). |
void |
setCustom(java.lang.Object custom)
Set custom configuration for use with customized Velocity
templates.
|
void |
setEdit(java.lang.String edit)
Set the base url to edit Doxia document sources.
|
void |
setGoogleAdSenseClient(java.lang.String googleAdSenseClient)
Set your Google AdSense client id.
|
void |
setGoogleAdSenseSlot(java.lang.String googleAdSenseSlot)
Set your Google AdSense slot id.
|
void |
setGoogleAnalyticsAccountId(java.lang.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(java.lang.String modelEncoding)
Set the modelEncoding field.
|
void |
setName(java.lang.String name)
Set the full name of the project.
|
void |
setPoweredBy(java.util.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.
|
java.lang.String |
toString()
Method toString.
|
private java.lang.String name
private java.lang.String combineSelf
merge
)
or not (override
).private Banner bannerLeft
private Banner bannerRight
private java.lang.String googleAdSenseClient
private java.lang.String googleAdSenseSlot
private java.lang.String googleAnalyticsAccountId
private PublishDate publishDate
private Version version
private java.lang.String edit
${project.scm.url}
value should do the job.private java.util.List<Logo> poweredBy
private Skin skin
private Body body
private java.lang.Object custom
$decoration.custom
variable as DOM content.
Example: $decoration.custom.getChild(
'customElement' ).getValue()
private long lastModified
private java.lang.String modelEncoding
public static final java.lang.String MERGE
public static final java.lang.String OVERRIDE
private java.util.Map<java.lang.String,Menu> menusByRef
public void addPoweredBy(Logo logo)
logo
- public DecorationModel clone()
clone
in class java.lang.Object
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- public Banner getBannerLeft()
public Banner getBannerRight()
public Body getBody()
public java.lang.String getCombineSelf()
merge
)
or not (override
).public java.lang.Object getCustom()
$decoration.custom
variable as DOM content.
Example: $decoration.custom.getChild(
'customElement' ).getValue()
public java.lang.String getEdit()
${project.scm.url}
value should do the job.public java.lang.String getGoogleAdSenseClient()
public java.lang.String getGoogleAdSenseSlot()
public java.lang.String getGoogleAnalyticsAccountId()
public long getLastModified()
public java.lang.String getModelEncoding()
public java.lang.String getName()
public java.util.List<Logo> getPoweredBy()
public Skin getSkin()
public int hashCode()
hashCode
in class java.lang.Object
public void removePoweredBy(Logo logo)
logo
- public void setBannerLeft(Banner bannerLeft)
bannerLeft
- public void setBannerRight(Banner bannerRight)
bannerRight
- public void setBody(Body body)
body
- public void setCombineSelf(java.lang.String combineSelf)
merge
)
or not (override
).combineSelf
- public void setCustom(java.lang.Object custom)
$decoration.custom
variable as DOM content.
Example: $decoration.custom.getChild(
'customElement' ).getValue()
custom
- public void setEdit(java.lang.String edit)
${project.scm.url}
value should do the job.edit
- public void setGoogleAdSenseClient(java.lang.String googleAdSenseClient)
googleAdSenseClient
- public void setGoogleAdSenseSlot(java.lang.String googleAdSenseSlot)
googleAdSenseSlot
- public void setGoogleAnalyticsAccountId(java.lang.String googleAnalyticsAccountId)
googleAnalyticsAccountId
- public void setLastModified(long lastModified)
lastModified
- public void setModelEncoding(java.lang.String modelEncoding)
modelEncoding
- public void setName(java.lang.String name)
name
- public void setPoweredBy(java.util.List<Logo> poweredBy)
poweredBy
- public void setPublishDate(PublishDate publishDate)
publishDate
- public void setSkin(Skin skin)
skin
- public void setVersion(Version version)
version
- public java.lang.String toString()
toString
in class java.lang.Object
public boolean isMergeParent()
public PublishDate getPublishDate()
public boolean isDefaultPublishDate()
public Version getVersion()
public boolean isDefaultVersion()
public Menu getMenuRef(java.lang.String key)
key
- not nullpublic void removeMenuRef(java.lang.String key)
key
- not nullpublic java.util.List<Menu> getMenus()
public boolean isLink(java.lang.String href)
DecorationUtils.isLink(java.lang.String)
public java.lang.Object getCustomChild(java.lang.String path)
public java.lang.String getCustomValue(java.lang.String path)
public java.lang.String getCustomValue(java.lang.String path, java.lang.String defaultValue)