|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.doxia.site.decoration.DecorationModel
public class DecorationModel
The <project>
element is the root of
the site decoration descriptor.
The following table lists all of the possible child
elements.
Constructor Summary | |
---|---|
DecorationModel()
|
Method Summary | |
---|---|
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. |
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()
Get modify the date published display properties. |
Skin |
getSkin()
Get the artifact containing the skin for the site. |
Version |
getVersion()
Get modify the version published display properties. |
int |
hashCode()
Method hashCode. |
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 |
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 |
Constructor Detail |
---|
public DecorationModel()
Method Detail |
---|
public void addPoweredBy(Logo logo)
logo
- public DecorationModel clone()
clone
in class Object
public boolean equals(Object other)
equals
in class Object
other
-
public Banner getBannerLeft()
public Banner getBannerRight()
public Body getBody()
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 List<Logo> getPoweredBy()
public PublishDate getPublishDate()
public Skin getSkin()
public Version getVersion()
public int hashCode()
hashCode
in class 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 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()
toString
in class Object
public Menu getMenuRef(String key)
key
- not null
public void removeMenuRef(String key)
key
- not nullpublic List<Menu> getMenus()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |