com.liferay.portal.model.impl

Class LayoutSetImpl

Object

com.liferay.portal.kernel.model.impl.BaseModelImpl<com.liferay.portal.kernel.model.LayoutSet>

com.liferay.portal.model.impl.LayoutSetModelImpl

com.liferay.portal.model.impl.LayoutSetBaseImpl

com.liferay.portal.model.impl.LayoutSetImpl

All Implemented Interfaces:

com.liferay.portal.kernel.model.BaseModel<com.liferay.portal.kernel.model.LayoutSet>, com.liferay.portal.kernel.model.ClassedModel, com.liferay.portal.kernel.model.LayoutSet, com.liferay.portal.kernel.model.LayoutSetModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.PersistedModel, com.liferay.portal.kernel.model.ShardedModel, Serializable, Cloneable, Comparable<com.liferay.portal.kernel.model.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.

Author:

Brian Wing Shun Chan, Jorge Ferrer

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, LOGOID_COLUMN_BITMASK, 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.kernel.model.LayoutSet

LAYOUT_SET_ID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
LayoutSetImpl()

Method Summary

Modifier and Type	Method and Description
com.liferay.portal.kernel.model.ColorScheme	getColorScheme() Returns the layout set's color scheme.
String	getCompanyFallbackVirtualHostname()
com.liferay.portal.kernel.model.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()
com.liferay.portal.kernel.util.UnicodeProperties	getSettingsProperties()
String	getSettingsProperty(String key)
com.liferay.portal.kernel.model.Theme	getTheme()
protected com.liferay.portal.kernel.model.Theme	getTheme(String device)
String	getThemeSetting(String key, String device)
String	getVirtualHostname() Returns the name of the layout set's virtual host.
boolean	hasSetModifiedDate()
boolean	isLayoutSetPrototypeLinkActive()
boolean	isLogo()
void	setCompanyFallbackVirtualHostname(String companyFallbackVirtualHostname)
void	setSettings(String settings)
void	setSettingsProperties(com.liferay.portal.kernel.util.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, getOriginalLogoId, getOriginalPrivateLayout, getPageCount, getPrimaryKey, getPrimaryKeyObj, getPrivateLayout, getThemeId, hashCode, isEntityCacheEnabled, isFinderCacheEnabled, isLayoutSetPrototypeLinkEnabled, isPrivateLayout, resetOriginalValues, setColorSchemeId, setCompanyId, setCreateDate, setCss, setExpandoBridgeAttributes, setGroupId, setLayoutSetId, setLayoutSetPrototypeLinkEnabled, setLayoutSetPrototypeUuid, setLogoId, setModelAttributes, setModifiedDate, setMvccVersion, setPageCount, setPrimaryKey, setPrimaryKeyObj, setPrivateLayout, setThemeId, toCacheModel, toEscapedModel, toModel, toModels, toString, toXmlString

Methods inherited from class com.liferay.portal.kernel.model.impl.BaseModelImpl

getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, toUnescapedModel

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.liferay.portal.kernel.model.LayoutSetModel

clone, compareTo, getColorSchemeId, getCompanyId, getCreateDate, getCss, getExpandoBridge, getGroupId, getLayoutSetId, getLayoutSetPrototypeLinkEnabled, getLayoutSetPrototypeUuid, getLogoId, getModifiedDate, getMvccVersion, getPageCount, getPrimaryKey, getPrimaryKeyObj, getPrivateLayout, getThemeId, 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, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Constructor Detail

LayoutSetImpl

public LayoutSetImpl()

Method Detail

getColorScheme

public com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.LayoutSet

Overrides:

getCompanyFallbackVirtualHostname in class LayoutSetModelImpl

getGroup

public com.liferay.portal.kernel.model.Group getGroup()
                                               throws com.liferay.portal.kernel.exception.PortalException

Returns the layout set's group.

Returns:

the layout set's group

Throws:

com.liferay.portal.kernel.exception.PortalException

getLayoutSetPrototypeId

public long getLayoutSetPrototypeId()
                             throws com.liferay.portal.kernel.exception.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:

com.liferay.portal.kernel.exception.PortalException

getLiveLogoId

public long getLiveLogoId()

getLogo

public boolean getLogo()

getSettings

public String getSettings()

Specified by:

getSettings in interface com.liferay.portal.kernel.model.LayoutSetModel

Overrides:

getSettings in class LayoutSetModelImpl

getSettingsProperties

public com.liferay.portal.kernel.util.UnicodeProperties getSettingsProperties()

getSettingsProperty

public String getSettingsProperty(String key)

getTheme

public com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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

hasSetModifiedDate

public boolean hasSetModifiedDate()

Specified by:

hasSetModifiedDate in interface com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.LayoutSet

Overrides:

setCompanyFallbackVirtualHostname in class LayoutSetModelImpl

setSettings

public void setSettings(String settings)

Specified by:

setSettings in interface com.liferay.portal.kernel.model.LayoutSetModel

Overrides:

setSettings in class LayoutSetModelImpl

setSettingsProperties

public void setSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties settingsProperties)

setVirtualHostname

public void setVirtualHostname(String virtualHostname)

Sets the name of the layout set's virtual host.

Specified by:

setVirtualHostname in interface com.liferay.portal.kernel.model.LayoutSet

Overrides:

setVirtualHostname in class LayoutSetModelImpl

Parameters:

virtualHostname - the name of the layout set's virtual host

See Also:

getVirtualHostname()

getTheme

protected com.liferay.portal.kernel.model.Theme getTheme(String device)