Liferay 7.0-ce-b4

com.liferay.portal.model.impl
Class LayoutSetImpl

java.lang.Object
  extended by com.liferay.portal.model.impl.BaseModelImpl<LayoutSet>
      extended by com.liferay.portal.model.impl.LayoutSetModelImpl
          extended by com.liferay.portal.model.impl.LayoutSetBaseImpl
              extended by com.liferay.portal.model.impl.LayoutSetImpl
All Implemented Interfaces:
BaseModel<LayoutSet>, ClassedModel, LayoutSet, LayoutSetModel, MVCCModel, PersistedModel, ShardedModel, Serializable, Cloneable, Comparable<LayoutSet>

public class LayoutSetImpl
extends LayoutSetBaseImpl

Represents a portal layout set, providing access to the layout set's color schemes, groups, prototypes, themes, and more.

Each Group in Liferay can have a public and a private layout set. This keeps information common to all layouts (pages) in the layout set.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.liferay.portal.model.impl.LayoutSetModelImpl
COLUMN_BITMASK_ENABLED, DATA_SOURCE, ENTITY_CACHE_ENABLED, FINDER_CACHE_ENABLED, GROUPID_COLUMN_BITMASK, LAYOUTSETID_COLUMN_BITMASK, LAYOUTSETPROTOTYPEUUID_COLUMN_BITMASK, LOCK_EXPIRATION_TIME, ORDER_BY_JPQL, ORDER_BY_SQL, PRIVATELAYOUT_COLUMN_BITMASK, SESSION_FACTORY, TABLE_COLUMNS, TABLE_COLUMNS_MAP, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, TX_MANAGER
 
Fields inherited from interface com.liferay.portal.model.LayoutSet
LAYOUT_SET_ID_ACCESSOR
 
Constructor Summary
LayoutSetImpl()
           
 
Method Summary
 ColorScheme getColorScheme()
          Returns the layout set's color scheme.
 String getCompanyFallbackVirtualHostname()
           
 Group getGroup()
          Returns the layout set's group.
 long getLayoutSetPrototypeId()
          Returns the layout set prototype's ID, or 0 if it has no layout set prototype.
 long getLiveLogoId()
           
 boolean getLogo()
           
 String getSettings()
          Returns the settings of this layout set.
 UnicodeProperties getSettingsProperties()
           
 String getSettingsProperty(String key)
           
 Theme getTheme()
           
protected  Theme getTheme(String device)
           
 String getThemeSetting(String key, String device)
           
 String getVirtualHostname()
          Returns the name of the layout set's virtual host.
 ColorScheme getWapColorScheme()
           
 Theme getWapTheme()
           
 boolean hasSetModifiedDate()
           
 boolean isLayoutSetPrototypeLinkActive()
           
 boolean isLogo()
           
 void setCompanyFallbackVirtualHostname(String companyFallbackVirtualHostname)
           
 void setSettings(String settings)
          Sets the settings of this layout set.
 void setSettingsProperties(UnicodeProperties settingsProperties)
           
 void setVirtualHostname(String virtualHostname)
          Sets the name of the layout set's virtual host.
 
Methods inherited from class com.liferay.portal.model.impl.LayoutSetBaseImpl
persist
 
Methods inherited from class com.liferay.portal.model.impl.LayoutSetModelImpl
clone, compareTo, equals, getColorSchemeId, getColumnBitmask, getCompanyId, getCreateDate, getCss, getExpandoBridge, getGroupId, getLayoutSetId, getLayoutSetPrototypeLinkEnabled, getLayoutSetPrototypeUuid, getLogoId, getModelAttributes, getModelClass, getModelClassName, getModifiedDate, getMvccVersion, getOriginalGroupId, getOriginalLayoutSetPrototypeUuid, getOriginalPrivateLayout, getPageCount, getPrimaryKey, getPrimaryKeyObj, getPrivateLayout, getThemeId, getWapColorSchemeId, getWapThemeId, hashCode, isEntityCacheEnabled, isFinderCacheEnabled, isLayoutSetPrototypeLinkEnabled, isPrivateLayout, resetOriginalValues, setColorSchemeId, setCompanyId, setCreateDate, setCss, setExpandoBridgeAttributes, setGroupId, setLayoutSetId, setLayoutSetPrototypeLinkEnabled, setLayoutSetPrototypeUuid, setLogoId, setModelAttributes, setModifiedDate, setMvccVersion, setPageCount, setPrimaryKey, setPrimaryKeyObj, setPrivateLayout, setThemeId, setWapColorSchemeId, setWapThemeId, toCacheModel, toEscapedModel, toModel, toModels, toString, toXmlString
 
Methods inherited from class com.liferay.portal.model.impl.BaseModelImpl
getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, toUnescapedModel
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.liferay.portal.model.LayoutSetModel
clone, compareTo, getColorSchemeId, getCompanyId, getCreateDate, getCss, getExpandoBridge, getGroupId, getLayoutSetId, getLayoutSetPrototypeLinkEnabled, getLayoutSetPrototypeUuid, getLogoId, getModifiedDate, getMvccVersion, getPageCount, getPrimaryKey, getPrimaryKeyObj, getPrivateLayout, getThemeId, getWapColorSchemeId, getWapThemeId, hashCode, isCachedModel, isEscapedModel, isLayoutSetPrototypeLinkEnabled, isNew, isPrivateLayout, setCachedModel, setColorSchemeId, setCompanyId, setCreateDate, setCss, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setGroupId, setLayoutSetId, setLayoutSetPrototypeLinkEnabled, setLayoutSetPrototypeUuid, setLogoId, setModifiedDate, setMvccVersion, setNew, setPageCount, setPrimaryKey, setPrimaryKeyObj, setPrivateLayout, setThemeId, setWapColorSchemeId, setWapThemeId, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Constructor Detail

LayoutSetImpl

public LayoutSetImpl()
Method Detail

getColorScheme

public ColorScheme getColorScheme()
Returns the layout set's color scheme.

Just like themes, color schemes can be configured on the layout set level. The layout set's color scheme can be overridden on the layout level.

Returns:
the layout set's color scheme

getCompanyFallbackVirtualHostname

public String getCompanyFallbackVirtualHostname()
Specified by:
getCompanyFallbackVirtualHostname in interface LayoutSet
Overrides:
getCompanyFallbackVirtualHostname in class LayoutSetModelImpl

getGroup

public Group getGroup()
               throws PortalException
Returns the layout set's group.

Returns:
the layout set's group
Throws:
PortalException

getLayoutSetPrototypeId

public long getLayoutSetPrototypeId()
                             throws PortalException
Returns the layout set prototype's ID, or 0 if it has no layout set prototype.

Prototype is Liferay's technical name for a site template.

Returns:
the layout set prototype's ID, or 0 if it has no layout set prototype
Throws:
PortalException

getLiveLogoId

public long getLiveLogoId()

getLogo

public boolean getLogo()

getSettings

public String getSettings()
Description copied from interface: LayoutSetModel
Returns the settings of this layout set.

Specified by:
getSettings in interface LayoutSetModel
Overrides:
getSettings in class LayoutSetModelImpl
Returns:
the settings of this layout set

getSettingsProperties

public UnicodeProperties getSettingsProperties()

getSettingsProperty

public String getSettingsProperty(String key)

getTheme

public Theme getTheme()

getThemeSetting

public String getThemeSetting(String key,
                              String device)

getVirtualHostname

public String getVirtualHostname()
Returns the name of the layout set's virtual host.

When accessing a layout set that has a the virtual host, the URL elements "/web/sitename" or "/group/sitename" can be omitted.

Specified by:
getVirtualHostname in interface LayoutSet
Overrides:
getVirtualHostname in class LayoutSetModelImpl
Returns:
the layout set's virtual host name, or an empty string if the layout set has no virtual host configured

getWapColorScheme

public ColorScheme getWapColorScheme()

getWapTheme

public Theme getWapTheme()

hasSetModifiedDate

public boolean hasSetModifiedDate()
Specified by:
hasSetModifiedDate in interface LayoutSet
Overrides:
hasSetModifiedDate in class LayoutSetModelImpl

isLayoutSetPrototypeLinkActive

public boolean isLayoutSetPrototypeLinkActive()

isLogo

public boolean isLogo()

setCompanyFallbackVirtualHostname

public void setCompanyFallbackVirtualHostname(String companyFallbackVirtualHostname)
Specified by:
setCompanyFallbackVirtualHostname in interface LayoutSet
Overrides:
setCompanyFallbackVirtualHostname in class LayoutSetModelImpl

setSettings

public void setSettings(String settings)
Description copied from interface: LayoutSetModel
Sets the settings of this layout set.

Specified by:
setSettings in interface LayoutSetModel
Overrides:
setSettings in class LayoutSetModelImpl
Parameters:
settings - the settings of this layout set

setSettingsProperties

public void setSettingsProperties(UnicodeProperties settingsProperties)

setVirtualHostname

public void setVirtualHostname(String virtualHostname)
Sets the name of the layout set's virtual host.

Specified by:
setVirtualHostname in interface LayoutSet
Overrides:
setVirtualHostname in class LayoutSetModelImpl
Parameters:
virtualHostname - the name of the layout set's virtual host
See Also:
getVirtualHostname()

getTheme

protected Theme getTheme(String device)

Liferay 7.0-ce-b4