Class DecorationModel

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class DecorationModel
    extends java.lang.Object
    implements java.io.Serializable, java.lang.Cloneable
    The <project> element is the root of the site decoration descriptor.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Constructor Detail

      • DecorationModel

        public DecorationModel()
    • Method Detail

      • addPoweredBy

        public void addPoweredBy​(Logo logo)
        Method addPoweredBy.
        Parameters:
        logo -
      • clone

        public DecorationModel clone()
        Method clone.
        Overrides:
        clone in class java.lang.Object
        Returns:
        DecorationModel
      • equals

        public boolean equals​(java.lang.Object other)
        Method equals.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        other -
        Returns:
        boolean
      • getBannerLeft

        public Banner getBannerLeft()
        Get banner logo on the masthead of the site to the left.
        Returns:
        Banner
      • getBannerRight

        public Banner getBannerRight()
        Get banner logo on the masthead of the site to the right.
        Returns:
        Banner
      • getBody

        public Body getBody()
        Get the main site content decoration.
        Returns:
        Body
      • getCombineSelf

        public java.lang.String getCombineSelf()
        Get whether to inherit configuration from a parent project site descriptor (merge) or not (override).
        Returns:
        String
      • getCustom

        public java.lang.Object 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
      • getGoogleAdSenseClient

        public java.lang.String getGoogleAdSenseClient()
        Get your Google AdSense client id.
        Returns:
        String
      • getGoogleAdSenseSlot

        public java.lang.String getGoogleAdSenseSlot()
        Get your Google AdSense slot id.
        Returns:
        String
      • getGoogleAnalyticsAccountId

        public java.lang.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

        public java.lang.String getModelEncoding()
        Get the modelEncoding field.
        Returns:
        String
      • getName

        public java.lang.String getName()
        Get the full name of the project.
        Returns:
        String
      • getPoweredBy

        public java.util.List<Logo> getPoweredBy()
        Method getPoweredBy.
        Returns:
        List
      • getSkin

        public Skin getSkin()
        Get the artifact containing the skin for the site.
        Returns:
        Skin
      • hashCode

        public int hashCode()
        Method hashCode.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int
      • removePoweredBy

        public void removePoweredBy​(Logo logo)
        Method removePoweredBy.
        Parameters:
        logo -
      • setBannerLeft

        public void setBannerLeft​(Banner bannerLeft)
        Set banner logo on the masthead of the site to the left.
        Parameters:
        bannerLeft -
      • setBannerRight

        public void setBannerRight​(Banner bannerRight)
        Set banner logo on the masthead of the site to the right.
        Parameters:
        bannerRight -
      • setBody

        public void setBody​(Body body)
        Set the main site content decoration.
        Parameters:
        body -
      • setCombineSelf

        public void setCombineSelf​(java.lang.String combineSelf)
        Set whether to inherit configuration from a parent project site descriptor (merge) or not (override).
        Parameters:
        combineSelf -
      • setCustom

        public void setCustom​(java.lang.Object custom)
        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 -
      • setGoogleAdSenseClient

        public void setGoogleAdSenseClient​(java.lang.String googleAdSenseClient)
        Set your Google AdSense client id.
        Parameters:
        googleAdSenseClient -
      • setGoogleAdSenseSlot

        public void setGoogleAdSenseSlot​(java.lang.String googleAdSenseSlot)
        Set your Google AdSense slot id.
        Parameters:
        googleAdSenseSlot -
      • setGoogleAnalyticsAccountId

        public void setGoogleAnalyticsAccountId​(java.lang.String googleAnalyticsAccountId)
        Set the id for your Google Analytics account.
        Parameters:
        googleAnalyticsAccountId -
      • setLastModified

        public void setLastModified​(long lastModified)
        Set timestamp of the last modification of this decoration model.
        Parameters:
        lastModified -
      • setModelEncoding

        public void setModelEncoding​(java.lang.String modelEncoding)
        Set the modelEncoding field.
        Parameters:
        modelEncoding -
      • setName

        public void setName​(java.lang.String name)
        Set the full name of the project.
        Parameters:
        name -
      • setPoweredBy

        public void setPoweredBy​(java.util.List<Logo> poweredBy)
        Set powered by logos list.
        Parameters:
        poweredBy -
      • setPublishDate

        public void setPublishDate​(PublishDate publishDate)
        Set modify the date published display properties.
        Parameters:
        publishDate -
      • setSkin

        public void setSkin​(Skin skin)
        Set the artifact containing the skin for the site.
        Parameters:
        skin -
      • setVersion

        public void setVersion​(Version version)
        Set modify the version published display properties.
        Parameters:
        version -
      • toString

        public java.lang.String toString()
        Method toString.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String
      • isMergeParent

        public boolean isMergeParent()
      • isDefaultPublishDate

        public boolean isDefaultPublishDate()
      • getVersion

        public Version getVersion()
      • isDefaultVersion

        public boolean isDefaultVersion()
      • getMenuRef

        public Menu getMenuRef​(java.lang.String key)
        Parameters:
        key - not null
        Returns:
        the menu ref defined by the given key.
      • removeMenuRef

        public void removeMenuRef​(java.lang.String key)
        Parameters:
        key - not null
      • getMenus

        public java.util.List<Menu> getMenus()
        Returns:
        the menus list or EMPTY_LIST.