com.liferay.portal.model.impl

Class LayoutImpl

Object

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

com.liferay.portal.model.impl.LayoutModelImpl

com.liferay.portal.model.impl.LayoutBaseImpl

com.liferay.portal.model.impl.LayoutImpl

All Implemented Interfaces:

com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<com.liferay.portal.kernel.model.Layout>, com.liferay.portal.kernel.model.ClassedModel, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.Layout, com.liferay.portal.kernel.model.LayoutModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.PersistedModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel, com.liferay.portal.kernel.model.StagedModel, Serializable, Cloneable, Comparable<com.liferay.portal.kernel.model.Layout>

public class LayoutImpl
extends LayoutBaseImpl

Represents a portal layout, providing access to the layout's URLs, parent layouts, child layouts, theme settings, type settings, and more.

The UI name for a layout is "page." Thus, a layout represents a page in the portal. A single page is either part of the public or private layout set of a group (site). Layouts can be organized hierarchically and are summarized in a LayoutSet.

Author:

Brian Wing Shun Chan

See Also:

Serialized Form

Field Summary

Fields inherited from class com.liferay.portal.model.impl.LayoutModelImpl

COLUMN_BITMASK_ENABLED, COMPANYID_COLUMN_BITMASK, DATA_SOURCE, ENTITY_CACHE_ENABLED, FINDER_CACHE_ENABLED, FRIENDLYURL_COLUMN_BITMASK, GROUPID_COLUMN_BITMASK, ICONIMAGEID_COLUMN_BITMASK, LAYOUTID_COLUMN_BITMASK, LAYOUTPROTOTYPEUUID_COLUMN_BITMASK, LOCK_EXPIRATION_TIME, ORDER_BY_JPQL, ORDER_BY_SQL, PARENTLAYOUTID_COLUMN_BITMASK, PRIORITY_COLUMN_BITMASK, PRIVATELAYOUT_COLUMN_BITMASK, SESSION_FACTORY, SOURCEPROTOTYPELAYOUTUUID_COLUMN_BITMASK, TABLE_COLUMNS, TABLE_COLUMNS_MAP, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, TX_MANAGER, TYPE_COLUMN_BITMASK, UUID_COLUMN_BITMASK

Fields inherited from interface com.liferay.portal.kernel.model.Layout

LAYOUT_ID_ACCESSOR, PLID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
LayoutImpl()

Method Summary

Modifier and Type	Method and Description
List<com.liferay.portal.kernel.model.Layout>	getAllChildren() Returns all layouts that are direct or indirect children of the current layout.
long	getAncestorLayoutId() Returns the ID of the topmost parent layout (e.g. n-th parent layout) of the current layout.
long	getAncestorPlid() Returns the plid of the topmost parent layout (e.g. n-th parent layout) of the current layout.
List<com.liferay.portal.kernel.model.Layout>	getAncestors() Returns all parent layouts of the current layout.
List<com.liferay.portal.kernel.model.Layout>	getChildren() Returns all child layouts of the current layout, independent of user access permissions.
List<com.liferay.portal.kernel.model.Layout>	getChildren(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker) Returns all child layouts of the current layout that the user has permission to access.
com.liferay.portal.kernel.model.ColorScheme	getColorScheme() Returns the color scheme that is configured for the current layout, or the color scheme of the layout set that contains the current layout if no color scheme is configured.
String	getCssText() Returns the CSS text for the current layout, or for the layout set if no CSS text is configured in the current layout.
String	getDefaultThemeSetting(String key, String device, boolean inheritLookAndFeel)
List<com.liferay.portal.kernel.model.Portlet>	getEmbeddedPortlets()
List<com.liferay.portal.kernel.model.Portlet>	getEmbeddedPortlets(long groupId)
String	getFriendlyURL(Locale locale) Returns the layout's friendly URL for the given locale.
Map<Locale,String>	getFriendlyURLMap() Returns the friendly URLs for all configured locales.
String	getFriendlyURLsXML()
com.liferay.portal.kernel.model.Group	getGroup() Returns the current layout's group.
String	getHTMLTitle(Locale locale) Returns the current layout's HTML title for the given locale, or the current layout's name for the given locale if no HTML title is configured.
String	getHTMLTitle(String localeLanguageId) Returns the current layout's HTML title for the given locale language ID, or the current layout's name if no HTML title is configured.
boolean	getIconImage() Returns true if the current layout has a configured icon.
com.liferay.portal.kernel.model.LayoutSet	getLayoutSet() Returns the current layout's LayoutSet.
com.liferay.portal.kernel.model.LayoutType	getLayoutType() Returns the current layout's LayoutType.
com.liferay.portal.kernel.model.Layout	getLinkedToLayout() Returns the current layout's linked layout.
long	getParentPlid() Returns the current layout's parent plid.
String	getRegularURL(javax.servlet.http.HttpServletRequest request)
String	getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
String	getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
com.liferay.portal.kernel.model.Group	getScopeGroup()
String	getTarget()
com.liferay.portal.kernel.model.Theme	getTheme() Returns the current layout's theme, or the layout set's theme if no layout theme is configured.
String	getThemeSetting(String key, String device)
String	getThemeSetting(String key, String device, boolean inheritLookAndFeel)
String	getTypeSettings()
com.liferay.portal.kernel.util.UnicodeProperties	getTypeSettingsProperties()
String	getTypeSettingsProperty(String key)
String	getTypeSettingsProperty(String key, String defaultValue)
boolean	hasAncestor(long layoutId) Returns true if the given layout ID matches one of the current layout's hierarchical parents.
boolean	hasChildren() Returns true if the current layout has child layouts.
static boolean	hasFriendlyURLKeyword(String friendlyURL)
boolean	hasScopeGroup()
boolean	hasSetModifiedDate()
boolean	includeLayoutContent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	isChildSelected(boolean selectable, com.liferay.portal.kernel.model.Layout layout)
boolean	isContentDisplayPage() Returns true if the current layout can be used as a content display page.
boolean	isCustomizable()
boolean	isFirstChild() Returns true if the current layout is the first layout in its parent's hierarchical list of children layouts.
boolean	isFirstParent() Returns true if the current layout is the topmost parent layout.
boolean	isIconImage()
boolean	isInheritLookAndFeel() Returns true if the current layout utilizes its LayoutSet's look and feel options (e.g. theme and color scheme).
boolean	isLayoutPrototypeLinkActive() Returns true if the current layout is built from a layout template and still maintains an active connection to it.
boolean	isPortletEmbedded(String portletId, long groupId)
boolean	isPublicLayout() Returns true if the current layout is part of the public LayoutSet.
boolean	isRootLayout() Returns true if the current layout is the root layout.
boolean	isSelected(boolean selectable, com.liferay.portal.kernel.model.Layout layout, long ancestorPlid)
boolean	isSupportsEmbeddedPortlets() Returns true if the current layout can hold embedded portlets.
boolean	isTypeArticle() Deprecated. As of Wilberforce (7.0.x), with no direct replacement
boolean	isTypeControlPanel()
boolean	isTypeEmbedded()
boolean	isTypeLinkToLayout()
boolean	isTypePanel()
boolean	isTypePortlet()
boolean	isTypeSharedPortlet() Deprecated. As of Judson (7.1.x), with no direct replacement
boolean	isTypeURL()
boolean	matches(javax.servlet.http.HttpServletRequest request, String friendlyURL)
void	setGroupId(long groupId)
void	setLayoutSet(com.liferay.portal.kernel.model.LayoutSet layoutSet)
void	setPrivateLayout(boolean privateLayout)
void	setTypeSettings(String typeSettings)
void	setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)
static int	validateFriendlyURL(String friendlyURL)
static int	validateFriendlyURL(String friendlyURL, boolean checkMaxLength) Checks whether the URL is a valid friendly URL.
static void	validateFriendlyURLKeyword(String friendlyURL)

Methods inherited from class com.liferay.portal.model.impl.LayoutBaseImpl

persist

Methods inherited from class com.liferay.portal.model.impl.LayoutModelImpl

clone, compareTo, equals, getAvailableLanguageIds, getColorSchemeId, getColumnBitmask, getCompanyId, getCreateDate, getCss, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getFriendlyURL, getGroupId, getHidden, getIconImageId, getKeywords, getKeywords, getKeywords, getKeywords, getKeywords, getKeywordsCurrentLanguageId, getKeywordsCurrentValue, getKeywordsMap, getLastPublishDate, getLayoutId, getLayoutPrototypeLinkEnabled, getLayoutPrototypeUuid, getModelAttributes, getModelClass, getModelClassName, getModifiedDate, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getOriginalCompanyId, getOriginalFriendlyURL, getOriginalGroupId, getOriginalIconImageId, getOriginalLayoutId, getOriginalLayoutPrototypeUuid, getOriginalParentLayoutId, getOriginalPriority, getOriginalPrivateLayout, getOriginalSourcePrototypeLayoutUuid, getOriginalType, getOriginalUuid, getParentLayoutId, getPlid, getPrimaryKey, getPrimaryKeyObj, getPriority, getPrivateLayout, getRobots, getRobots, getRobots, getRobots, getRobots, getRobotsCurrentLanguageId, getRobotsCurrentValue, getRobotsMap, getSourcePrototypeLayoutUuid, getStagedModelType, getThemeId, getTitle, getTitle, getTitle, getTitle, getTitle, getTitleCurrentLanguageId, getTitleCurrentValue, getTitleMap, getType, getUserId, getUserName, getUserUuid, getUuid, hashCode, isEntityCacheEnabled, isFinderCacheEnabled, isHidden, isLayoutPrototypeLinkEnabled, isPrivateLayout, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, resetOriginalValues, setColorSchemeId, setCompanyId, setCreateDate, setCss, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setFriendlyURL, setHidden, setIconImageId, setKeywords, setKeywords, setKeywords, setKeywordsCurrentLanguageId, setKeywordsMap, setKeywordsMap, setLastPublishDate, setLayoutId, setLayoutPrototypeLinkEnabled, setLayoutPrototypeUuid, setModelAttributes, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentLayoutId, setPlid, setPrimaryKey, setPrimaryKeyObj, setPriority, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, setUserId, setUserName, setUserUuid, setUuid, 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.LayoutModel

clone, compareTo, getAvailableLanguageIds, getColorSchemeId, getCompanyId, getCreateDate, getCss, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getFriendlyURL, getGroupId, getHidden, getIconImageId, getKeywords, getKeywords, getKeywords, getKeywords, getKeywords, getKeywordsCurrentLanguageId, getKeywordsCurrentValue, getKeywordsMap, getLastPublishDate, getLayoutId, getLayoutPrototypeLinkEnabled, getLayoutPrototypeUuid, getModifiedDate, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getParentLayoutId, getPlid, getPrimaryKey, getPrimaryKeyObj, getPriority, getPrivateLayout, getRobots, getRobots, getRobots, getRobots, getRobots, getRobotsCurrentLanguageId, getRobotsCurrentValue, getRobotsMap, getSourcePrototypeLayoutUuid, getThemeId, getTitle, getTitle, getTitle, getTitle, getTitle, getTitleCurrentLanguageId, getTitleCurrentValue, getTitleMap, getType, getUserId, getUserName, getUserUuid, getUuid, hashCode, isCachedModel, isEscapedModel, isHidden, isLayoutPrototypeLinkEnabled, isNew, isPrivateLayout, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setCachedModel, setColorSchemeId, setCompanyId, setCreateDate, setCss, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setFriendlyURL, setHidden, setIconImageId, setKeywords, setKeywords, setKeywords, setKeywordsCurrentLanguageId, setKeywordsMap, setKeywordsMap, setLastPublishDate, setLayoutId, setLayoutPrototypeLinkEnabled, setLayoutPrototypeUuid, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setNew, setParentLayoutId, setPlid, setPrimaryKey, setPrimaryKeyObj, setPriority, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, setUserId, setUserName, setUserUuid, setUuid, 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

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

getStagedModelType

Constructor Detail

LayoutImpl

public LayoutImpl()

Method Detail

hasFriendlyURLKeyword

public static boolean hasFriendlyURLKeyword(String friendlyURL)

validateFriendlyURL

public static int validateFriendlyURL(String friendlyURL)

validateFriendlyURL

public static int validateFriendlyURL(String friendlyURL,
                                      boolean checkMaxLength)

Checks whether the URL is a valid friendly URL. It checks for minimal length and that syntactic restrictions are met, and can check that the URL's length does not exceed the maximum length.

Parameters:

friendlyURL - the URL to be checked

checkMaxLength - whether to check that the URL's length does not exceed the maximum length

Returns:

-1 if the URL is a valid friendly URL; a LayoutFriendlyURLException constant otherwise

validateFriendlyURLKeyword

public static void validateFriendlyURLKeyword(String friendlyURL)
                                       throws com.liferay.portal.kernel.exception.LayoutFriendlyURLException

Throws:

com.liferay.portal.kernel.exception.LayoutFriendlyURLException

getAllChildren

public List<com.liferay.portal.kernel.model.Layout> getAllChildren()

Returns all layouts that are direct or indirect children of the current layout.

Returns:

the layouts that are direct or indirect children of the current layout

getAncestorLayoutId

public long getAncestorLayoutId()
                         throws com.liferay.portal.kernel.exception.PortalException

Returns the ID of the topmost parent layout (e.g. n-th parent layout) of the current layout.

Returns:

the ID of the topmost parent layout of the current layout

Throws:

com.liferay.portal.kernel.exception.PortalException

getAncestorPlid

public long getAncestorPlid()
                     throws com.liferay.portal.kernel.exception.PortalException

Returns the plid of the topmost parent layout (e.g. n-th parent layout) of the current layout.

Returns:

the plid of the topmost parent layout of the current layout

Throws:

com.liferay.portal.kernel.exception.PortalException

getAncestors

public List<com.liferay.portal.kernel.model.Layout> getAncestors()
                                                          throws com.liferay.portal.kernel.exception.PortalException

Returns all parent layouts of the current layout. The list is retrieved recursively with the direct parent layout listed first, and most distant parent listed last.

Returns:

the current layout's list of parent layouts

Throws:

com.liferay.portal.kernel.exception.PortalException

getChildren

public List<com.liferay.portal.kernel.model.Layout> getChildren()

Returns all child layouts of the current layout, independent of user access permissions.

Returns:

the list of all child layouts

getChildren

public List<com.liferay.portal.kernel.model.Layout> getChildren(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns all child layouts of the current layout that the user has permission to access.

Parameters:

permissionChecker - the user-specific context to check permissions

Returns:

the list of all child layouts that the user has permission to access

Throws:

com.liferay.portal.kernel.exception.PortalException

getColorScheme

public com.liferay.portal.kernel.model.ColorScheme getColorScheme()
                                                           throws com.liferay.portal.kernel.exception.PortalException

Returns the color scheme that is configured for the current layout, or the color scheme of the layout set that contains the current layout if no color scheme is configured.

Returns:

the color scheme that is configured for the current layout, or the color scheme of the layout set that contains the current layout if no color scheme is configured

Throws:

com.liferay.portal.kernel.exception.PortalException

getCssText

public String getCssText()
                  throws com.liferay.portal.kernel.exception.PortalException

Returns the CSS text for the current layout, or for the layout set if no CSS text is configured in the current layout.

Layouts and layout sets can configure CSS that is applied in addition to the theme's CSS.

Returns:

the CSS text for the current layout, or for the layout set if no CSS text is configured in the current layout

Throws:

com.liferay.portal.kernel.exception.PortalException

getDefaultThemeSetting

public String getDefaultThemeSetting(String key,
                                     String device,
                                     boolean inheritLookAndFeel)

getEmbeddedPortlets

public List<com.liferay.portal.kernel.model.Portlet> getEmbeddedPortlets()

getEmbeddedPortlets

public List<com.liferay.portal.kernel.model.Portlet> getEmbeddedPortlets(long groupId)

getFriendlyURL

public String getFriendlyURL(Locale locale)

Returns the layout's friendly URL for the given locale.

Parameters:

locale - the locale that the friendly URL should be retrieved for

Returns:

the layout's friendly URL for the given locale

getFriendlyURLMap

public Map<Locale,String> getFriendlyURLMap()

Returns the friendly URLs for all configured locales.

Returns:

the friendly URLs for all configured locales

getFriendlyURLsXML

public String getFriendlyURLsXML()

getGroup

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

Returns the current layout's group.

Group is Liferay's technical name for a site.

Returns:

the current layout's group

Throws:

com.liferay.portal.kernel.exception.PortalException

getHTMLTitle

public String getHTMLTitle(Locale locale)

Returns the current layout's HTML title for the given locale, or the current layout's name for the given locale if no HTML title is configured.

Parameters:

locale - the locale that the HTML title should be retrieved for

Returns:

the current layout's HTML title for the given locale, or the current layout's name for the given locale if no HTML title is configured

getHTMLTitle

public String getHTMLTitle(String localeLanguageId)

Returns the current layout's HTML title for the given locale language ID, or the current layout's name if no HTML title is configured.

Parameters:

localeLanguageId - the locale that the HTML title should be retrieved for

Returns:

the current layout's HTML title for the given locale language ID, or the current layout's name if no HTML title is configured

getIconImage

public boolean getIconImage()

Returns true if the current layout has a configured icon.

Returns:

true if the current layout has a configured icon; false otherwise

getLayoutSet

public com.liferay.portal.kernel.model.LayoutSet getLayoutSet()
                                                       throws com.liferay.portal.kernel.exception.PortalException

Returns the current layout's LayoutSet.

Returns:

the current layout's layout set

Throws:

com.liferay.portal.kernel.exception.PortalException

getLayoutType

public com.liferay.portal.kernel.model.LayoutType getLayoutType()

Returns the current layout's LayoutType.

Returns:

the current layout's layout type

getLinkedToLayout

public com.liferay.portal.kernel.model.Layout getLinkedToLayout()

Returns the current layout's linked layout.

Returns:

the current layout's linked layout, or null if no linked layout could be found

getParentPlid

public long getParentPlid()
                   throws com.liferay.portal.kernel.exception.PortalException

Returns the current layout's parent plid.

Returns:

the current layout's parent plid, or 0 if the current layout is the topmost parent layout

Throws:

com.liferay.portal.kernel.exception.PortalException

getRegularURL

public String getRegularURL(javax.servlet.http.HttpServletRequest request)
                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getResetLayoutURL

public String getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getResetMaxStateURL

public String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getScopeGroup

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

Throws:

com.liferay.portal.kernel.exception.PortalException

getTarget

public String getTarget()

getTheme

public com.liferay.portal.kernel.model.Theme getTheme()
                                               throws com.liferay.portal.kernel.exception.PortalException

Returns the current layout's theme, or the layout set's theme if no layout theme is configured.

Returns:

the current layout's theme, or the layout set's theme if no layout theme is configured

Throws:

com.liferay.portal.kernel.exception.PortalException

getThemeSetting

public String getThemeSetting(String key,
                              String device)

getThemeSetting

public String getThemeSetting(String key,
                              String device,
                              boolean inheritLookAndFeel)

getTypeSettings

public String getTypeSettings()

Specified by:

getTypeSettings in interface com.liferay.portal.kernel.model.LayoutModel

Overrides:

getTypeSettings in class LayoutModelImpl

getTypeSettingsProperties

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

getTypeSettingsProperty

public String getTypeSettingsProperty(String key)

getTypeSettingsProperty

public String getTypeSettingsProperty(String key,
                                      String defaultValue)

hasAncestor

public boolean hasAncestor(long layoutId)
                    throws com.liferay.portal.kernel.exception.PortalException

Returns true if the given layout ID matches one of the current layout's hierarchical parents.

Parameters:

layoutId - the layout ID to search for in the current layout's parent list

Returns:

true if the given layout ID matches one of the current layout's hierarchical parents; false otherwise

Throws:

com.liferay.portal.kernel.exception.PortalException

hasChildren

public boolean hasChildren()

Returns true if the current layout has child layouts.

Returns:

true if the current layout has child layouts, false otherwise

hasScopeGroup

public boolean hasScopeGroup()
                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

hasSetModifiedDate

public boolean hasSetModifiedDate()

Specified by:

hasSetModifiedDate in interface com.liferay.portal.kernel.model.Layout

Overrides:

hasSetModifiedDate in class LayoutModelImpl

includeLayoutContent

public boolean includeLayoutContent(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws Exception

Throws:

Exception

isChildSelected

public boolean isChildSelected(boolean selectable,
                               com.liferay.portal.kernel.model.Layout layout)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

isContentDisplayPage

public boolean isContentDisplayPage()

Returns true if the current layout can be used as a content display page.

A content display page must have an Asset Publisher portlet that is configured as the default Asset Publisher for the layout.

Returns:

true if the current layout can be used as a content display page; false otherwise

isCustomizable

public boolean isCustomizable()

isFirstChild

public boolean isFirstChild()

Returns true if the current layout is the first layout in its parent's hierarchical list of children layouts.

Returns:

true if the current layout is the first layout in its parent's hierarchical list of children layouts; false otherwise

isFirstParent

public boolean isFirstParent()

Returns true if the current layout is the topmost parent layout.

Returns:

true if the current layout is the topmost parent layout; false otherwise

isIconImage

public boolean isIconImage()

isInheritLookAndFeel

public boolean isInheritLookAndFeel()

Returns true if the current layout utilizes its LayoutSet's look and feel options (e.g. theme and color scheme).

Returns:

true if the current layout utilizes its layout set's look and feel options; false otherwise

isLayoutPrototypeLinkActive

public boolean isLayoutPrototypeLinkActive()

Returns true if the current layout is built from a layout template and still maintains an active connection to it.

Returns:

true if the current layout is built from a layout template and still maintains an active connection to it; false otherwise

isPortletEmbedded

public boolean isPortletEmbedded(String portletId,
                                 long groupId)

isPublicLayout

public boolean isPublicLayout()

Returns true if the current layout is part of the public LayoutSet.

Note, the returned value reflects the layout's default access options, not its access permissions.

Returns:

true if the current layout is part of the public layout set; false otherwise

isRootLayout

public boolean isRootLayout()

Returns true if the current layout is the root layout.

Returns:

true if the current layout is the root layout; false otherwise

isSelected

public boolean isSelected(boolean selectable,
                          com.liferay.portal.kernel.model.Layout layout,
                          long ancestorPlid)

isSupportsEmbeddedPortlets

public boolean isSupportsEmbeddedPortlets()

Returns true if the current layout can hold embedded portlets.

Returns:

true if the current layout can hold embedded portlets; false otherwise

isTypeArticle

@Deprecated
public boolean isTypeArticle()

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

isTypeControlPanel

public boolean isTypeControlPanel()

isTypeEmbedded

public boolean isTypeEmbedded()

isTypeLinkToLayout

public boolean isTypeLinkToLayout()

isTypePanel

public boolean isTypePanel()

isTypePortlet

public boolean isTypePortlet()

isTypeSharedPortlet

@Deprecated
public boolean isTypeSharedPortlet()

Deprecated. As of Judson (7.1.x), with no direct replacement

isTypeURL

public boolean isTypeURL()

matches

public boolean matches(javax.servlet.http.HttpServletRequest request,
                       String friendlyURL)

setGroupId

public void setGroupId(long groupId)

Specified by:

setGroupId in interface com.liferay.portal.kernel.model.GroupedModel

Specified by:

setGroupId in interface com.liferay.portal.kernel.model.LayoutModel

Overrides:

setGroupId in class LayoutModelImpl

setLayoutSet

public void setLayoutSet(com.liferay.portal.kernel.model.LayoutSet layoutSet)

setPrivateLayout

public void setPrivateLayout(boolean privateLayout)

Specified by:

setPrivateLayout in interface com.liferay.portal.kernel.model.LayoutModel

Overrides:

setPrivateLayout in class LayoutModelImpl

setTypeSettings

public void setTypeSettings(String typeSettings)

Specified by:

setTypeSettings in interface com.liferay.portal.kernel.model.LayoutModel

Overrides:

setTypeSettings in class LayoutModelImpl

setTypeSettingsProperties

public void setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)