public class DecorationModel extends Object implements Serializable, Cloneable
<project>
element is the root of
the site decoration descriptor.Modifier and Type | Field and Description |
---|---|
static String |
MERGE |
static String |
OVERRIDE |
Constructor and Description |
---|
DecorationModel() |
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 |
isLink(String href) |
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.
|
public static final String MERGE
public static final String OVERRIDE
public void addPoweredBy(Logo logo)
logo
- public DecorationModel clone()
public boolean equals(Object other)
public Banner getBannerLeft()
public Banner getBannerRight()
public Body getBody()
public String getCombineSelf()
merge
)
or not (override
).public Object getCustom()
$decoration.custom
variable as DOM content.
Example: $decoration.custom.getChild(
'customElement' ).getValue()
public String getGoogleAdSenseClient()
public String getGoogleAdSenseSlot()
public String getGoogleAnalyticsAccountId()
public long getLastModified()
public String getModelEncoding()
public String getName()
public Skin getSkin()
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(String combineSelf)
merge
)
or not (override
).combineSelf
- public void setCustom(Object custom)
$decoration.custom
variable as DOM content.
Example: $decoration.custom.getChild(
'customElement' ).getValue()
custom
- public void setGoogleAdSenseClient(String googleAdSenseClient)
googleAdSenseClient
- public void setGoogleAdSenseSlot(String googleAdSenseSlot)
googleAdSenseSlot
- public void setGoogleAnalyticsAccountId(String googleAnalyticsAccountId)
googleAnalyticsAccountId
- public void setLastModified(long lastModified)
lastModified
- public void setModelEncoding(String modelEncoding)
modelEncoding
- public void setName(String name)
name
- 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()
public boolean isMergeParent()
public PublishDate getPublishDate()
public boolean isDefaultPublishDate()
public Version getVersion()
public boolean isDefaultVersion()
public Menu getMenuRef(String key)
key
- not nullpublic void removeMenuRef(String key)
key
- not nullpublic boolean isLink(String href)
DecorationUtils.isLink(java.lang.String)
Copyright © 2005–2016 The Apache Software Foundation. All rights reserved.