Package 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.AttachedModel,com.liferay.portal.kernel.model.AuditedModel,com.liferay.portal.kernel.model.BaseModel<com.liferay.portal.kernel.model.Layout>,com.liferay.portal.kernel.model.change.tracking.CTModel<com.liferay.portal.kernel.model.Layout>,com.liferay.portal.kernel.model.ClassedModel,com.liferay.portal.kernel.model.ExternalReferenceCodeModel,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,com.liferay.portal.kernel.model.TypedModel,com.liferay.portal.kernel.model.WorkflowedModel,Serializable,Cloneable,Comparable<com.liferay.portal.kernel.model.Layout>
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:
-
Field Summary
Fields inherited from class com.liferay.portal.model.impl.LayoutModelImpl
CLASSNAMEID_COLUMN_BITMASK, CLASSPK_COLUMN_BITMASK, COLUMN_BITMASK_ENABLED, COMPANYID_COLUMN_BITMASK, DATA_SOURCE, ENTITY_CACHE_ENABLED, EXTERNALREFERENCECODE_COLUMN_BITMASK, FINDER_CACHE_ENABLED, FRIENDLYURL_COLUMN_BITMASK, GROUPID_COLUMN_BITMASK, HIDDEN_COLUMN_BITMASK, ICONIMAGEID_COLUMN_BITMASK, LAYOUTID_COLUMN_BITMASK, LAYOUTPROTOTYPEUUID_COLUMN_BITMASK, LOCK_EXPIRATION_TIME, MASTERLAYOUTPLID_COLUMN_BITMASK, ORDER_BY_JPQL, ORDER_BY_SQL, ORDER_BY_SQL_INLINE_DISTINCT, PARENTLAYOUTID_COLUMN_BITMASK, PARENTPLID_COLUMN_BITMASK, PRIORITY_COLUMN_BITMASK, PRIVATELAYOUT_COLUMN_BITMASK, SESSION_FACTORY, SOURCEPROTOTYPELAYOUTUUID_COLUMN_BITMASK, STATUS_COLUMN_BITMASK, SYSTEM_COLUMN_BITMASK, TABLE_COLUMNS, TABLE_COLUMNS_MAP, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, TX_MANAGER, TYPE_COLUMN_BITMASK, UUID_COLUMN_BITMASKFields inherited from interface com.liferay.portal.kernel.model.Layout
LAYOUT_ID_ACCESSOR, PLID_ACCESSOR -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncom.liferay.portal.kernel.model.LayoutList<com.liferay.portal.kernel.model.Layout>Returns all layouts that are direct or indirect children of the current layout.longReturns the ID of the topmost parent layout (e.g. n-th parent layout) of the current layout.longReturns the plid of the topmost parent layout (e.g. n-th parent layout) of the current layout.List<com.liferay.portal.kernel.model.Layout>Returns all parent layouts of the current layout.getBreadcrumb(Locale locale) List<com.liferay.portal.kernel.model.Layout>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.ColorSchemeReturns 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 CSS text for the current layout, or for the layout set if no CSS text is configured in the current layout.getDefaultThemeSetting(String key, String device, boolean inheritLookAndFeel) List<com.liferay.portal.kernel.model.Portlet>List<com.liferay.portal.kernel.model.Portlet>getEmbeddedPortlets(long groupId) getFriendlyURL(Locale locale) Returns the layout's friendly URL for the given locale.Returns the friendly URLs for all configured locales.com.liferay.portal.kernel.model.GroupgetGroup()Returns the current layout's group.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.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.getIcon()booleanReturnstrueif the current layout has a configured icon.com.liferay.portal.kernel.model.LayoutSetReturns the current layout'sLayoutSet.com.liferay.portal.kernel.model.Layoutcom.liferay.portal.kernel.model.LayoutTypeReturns the current layout'sLayoutType.com.liferay.portal.kernel.model.LayoutReturns the current layout's linked layout.getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest) getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest) getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest) com.liferay.portal.kernel.model.Groupcom.liferay.portal.kernel.model.ThemegetTheme()Returns the current layout's theme, or the layout set's theme if no layout theme is configured.getThemeSetting(String key, String device) getThemeSetting(String key, String device, boolean inheritLookAndFeel) com.liferay.portal.kernel.util.UnicodePropertiesgetTypeSettingsProperty(String key, String defaultValue) booleanhasAncestor(long layoutId) Returnstrueif the given layout ID matches one of the current layout's hierarchical parents.booleanReturnstrueif the current layout has child layouts.static booleanhasFriendlyURLKeyword(String friendlyURL) booleanbooleanbooleanincludeLayoutContent(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) booleanisChildSelected(boolean selectable, com.liferay.portal.kernel.model.Layout layout) booleanReturnstrueif the current layout can be used as a content display page.booleanbooleanbooleanbooleanReturnstrueif the current layout is the first layout in its parent's hierarchical list of children layouts.booleanReturnstrueif the current layout is the topmost parent layout.booleanbooleanReturnstrueif the current layout utilizes itsLayoutSet's look and feel options (e.g. theme and color scheme).booleanbooleanReturnstrueif the current layout is built from a layout template and still maintains an active connection to it.booleanbooleanbooleanisPortletEmbedded(String portletId, long groupId) booleanReturnstrueif the current layout is part of the publicLayoutSet.booleanbooleanReturnstrueif the current layout is the root layout.booleanisSelected(boolean selectable, com.liferay.portal.kernel.model.Layout layout, long ancestorPlid) booleanReturnstrueif the current layout can hold embedded portlets.booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisUnlocked(String mode, long userId) booleanvoidsetGroupId(long groupId) voidsetLayoutSet(com.liferay.portal.kernel.model.LayoutSet layoutSet) voidsetPrivateLayout(boolean privateLayout) voidsetTypeSettings(String typeSettings) voidsetTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties) static intvalidateFriendlyURL(String friendlyURL) static intvalidateFriendlyURL(String friendlyURL, boolean checkMaxLength) Checks whether the URL is a valid friendly URL.static voidvalidateFriendlyURLKeyword(String friendlyURL) Methods inherited from class com.liferay.portal.model.impl.LayoutBaseImpl
persistMethods inherited from class com.liferay.portal.model.impl.LayoutModelImpl
clone, cloneWithOriginalValues, compareTo, equals, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getAvailableLanguageIds, getClassName, getClassNameId, getClassPK, getColorSchemeId, getColumnBitmask, getColumnBitmask, getColumnOriginalValue, getColumnValue, getCompanyId, getCreateDate, getCss, getCtCollectionId, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getExternalReferenceCode, getFaviconFileEntryId, getFriendlyURL, getGroupId, getHidden, getIconImageId, getKeywords, getKeywords, getKeywords, getKeywords, getKeywords, getKeywordsCurrentLanguageId, getKeywordsCurrentValue, getKeywordsMap, getLastPublishDate, getLayoutId, getLayoutPrototypeLinkEnabled, getLayoutPrototypeUuid, getMasterLayoutPlid, getModelAttributes, getModelClass, getModelClassName, getModifiedDate, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getOriginalClassNameId, getOriginalClassPK, getOriginalCompanyId, getOriginalExternalReferenceCode, getOriginalFriendlyURL, getOriginalGroupId, getOriginalHidden, getOriginalIconImageId, getOriginalLayoutId, getOriginalLayoutPrototypeUuid, getOriginalMasterLayoutPlid, getOriginalParentLayoutId, getOriginalParentPlid, getOriginalPriority, getOriginalPrivateLayout, getOriginalSourcePrototypeLayoutUuid, getOriginalStatus, getOriginalSystem, getOriginalType, getOriginalUuid, getParentLayoutId, getParentPlid, getPlid, getPrimaryKey, getPrimaryKeyObj, getPriority, getPrivateLayout, getPublishDate, getRobots, getRobots, getRobots, getRobots, getRobots, getRobotsCurrentLanguageId, getRobotsCurrentValue, getRobotsMap, getSourcePrototypeLayoutUuid, getStagedModelType, getStatus, getStatusByUserId, getStatusByUserName, getStatusByUserUuid, getStatusDate, getStyleBookEntryId, getSystem, getThemeId, getTitle, getTitle, getTitle, getTitle, getTitle, getTitleCurrentLanguageId, getTitleCurrentValue, getTitleMap, getType, getUserId, getUserName, getUserUuid, getUuid, hashCode, isApproved, isDenied, isDraft, isEntityCacheEnabled, isExpired, isFinderCacheEnabled, isHidden, isInactive, isIncomplete, isLayoutPrototypeLinkEnabled, isPending, isPrivateLayout, isScheduled, isSystem, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, resetOriginalValues, setClassName, setClassNameId, setClassPK, setColorSchemeId, setCompanyId, setCreateDate, setCss, setCtCollectionId, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setExternalReferenceCode, setFaviconFileEntryId, setFriendlyURL, setHidden, setIconImageId, setKeywords, setKeywords, setKeywords, setKeywordsCurrentLanguageId, setKeywordsMap, setKeywordsMap, setLastPublishDate, setLayoutId, setLayoutPrototypeLinkEnabled, setLayoutPrototypeUuid, setMasterLayoutPlid, setModelAttributes, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentLayoutId, setParentPlid, setPlid, setPrimaryKey, setPrimaryKeyObj, setPriority, setPublishDate, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setStatus, setStatusByUserId, setStatusByUserName, setStatusByUserUuid, setStatusDate, setStyleBookEntryId, setSystem, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, setUserId, setUserName, setUserUuid, setUuid, toCacheModel, toEscapedModel, toStringMethods inherited from class com.liferay.portal.kernel.model.impl.BaseModelImpl
getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, toUnescapedModelMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.LayoutModel
cloneWithOriginalValues, getAvailableLanguageIds, getClassName, getClassNameId, getClassPK, getColorSchemeId, getCompanyId, getCreateDate, getCss, getCtCollectionId, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExternalReferenceCode, getFaviconFileEntryId, getFriendlyURL, getGroupId, getHidden, getIconImageId, getKeywords, getKeywords, getKeywords, getKeywords, getKeywords, getKeywordsCurrentLanguageId, getKeywordsCurrentValue, getKeywordsMap, getLastPublishDate, getLayoutId, getLayoutPrototypeLinkEnabled, getLayoutPrototypeUuid, getMasterLayoutPlid, getModifiedDate, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getParentLayoutId, getParentPlid, getPlid, getPrimaryKey, getPriority, getPrivateLayout, getPublishDate, getRobots, getRobots, getRobots, getRobots, getRobots, getRobotsCurrentLanguageId, getRobotsCurrentValue, getRobotsMap, getSourcePrototypeLayoutUuid, getStatus, getStatusByUserId, getStatusByUserName, getStatusByUserUuid, getStatusDate, getStyleBookEntryId, getSystem, getThemeId, getTitle, getTitle, getTitle, getTitle, getTitle, getTitleCurrentLanguageId, getTitleCurrentValue, getTitleMap, getType, getUserId, getUserName, getUserUuid, getUuid, isApproved, isDenied, isDraft, isExpired, isHidden, isInactive, isIncomplete, isLayoutPrototypeLinkEnabled, isPending, isPrivateLayout, isScheduled, isSystem, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setClassName, setClassNameId, setClassPK, setColorSchemeId, setCompanyId, setCreateDate, setCss, setCtCollectionId, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExternalReferenceCode, setFaviconFileEntryId, setFriendlyURL, setHidden, setIconImageId, setKeywords, setKeywords, setKeywords, setKeywordsCurrentLanguageId, setKeywordsMap, setKeywordsMap, setLastPublishDate, setLayoutId, setLayoutPrototypeLinkEnabled, setLayoutPrototypeUuid, setMasterLayoutPlid, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentLayoutId, setParentPlid, setPlid, setPrimaryKey, setPriority, setPublishDate, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setStatus, setStatusByUserId, setStatusByUserName, setStatusByUserUuid, setStatusDate, setStyleBookEntryId, setSystem, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, setUserId, setUserName, setUserUuid, setUuid, toXmlStringMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Constructor Details
-
LayoutImpl
public LayoutImpl()
-
-
Method Details
-
hasFriendlyURLKeyword
-
validateFriendlyURL
-
validateFriendlyURL
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 checkedcheckMaxLength- whether to check that the URL's length does not exceed the maximum length- Returns:
-1if the URL is a valid friendly URL; aLayoutFriendlyURLExceptionconstant otherwise
-
validateFriendlyURLKeyword
public static void validateFriendlyURLKeyword(String friendlyURL) throws com.liferay.portal.kernel.exception.LayoutFriendlyURLException - Throws:
com.liferay.portal.kernel.exception.LayoutFriendlyURLException
-
fetchDraftLayout
public com.liferay.portal.kernel.model.Layout fetchDraftLayout() -
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.PortalExceptionReturns 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.PortalExceptionReturns 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.PortalExceptionReturns 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
-
getBreadcrumb
public String getBreadcrumb(Locale locale) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
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.PortalExceptionReturns 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
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
-
getEmbeddedPortlets
-
getEmbeddedPortlets
-
getFaviconURL
-
getFriendlyURL
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
Returns the friendly URLs for all configured locales.- Returns:
- the friendly URLs for all configured locales
-
getFriendlyURLsXML
-
getGroup
public com.liferay.portal.kernel.model.Group getGroup()Returns the current layout's group.Group is Liferay's technical name for a site.
- Returns:
- the current layout's group
-
getHTMLTitle
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
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
-
getIcon
-
getIconImage
public boolean getIconImage()Returnstrueif the current layout has a configured icon.- Returns:
trueif the current layout has a configured icon;falseotherwise
-
getLayoutSet
public com.liferay.portal.kernel.model.LayoutSet getLayoutSet()Returns the current layout'sLayoutSet.- Returns:
- the current layout's layout set
-
getLayoutSetPrototypeLayout
public com.liferay.portal.kernel.model.Layout getLayoutSetPrototypeLayout() -
getLayoutType
public com.liferay.portal.kernel.model.LayoutType getLayoutType()Returns the current layout'sLayoutType.- 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
nullif no linked layout could be found
-
getRegularURL
public String getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getResetLayoutURL
public String getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getResetMaxStateURL
public String getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest) 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
-
getTheme
public com.liferay.portal.kernel.model.Theme getTheme() throws com.liferay.portal.kernel.exception.PortalExceptionReturns 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
-
getThemeSetting
-
getTypeSettings
- Specified by:
getTypeSettingsin interfacecom.liferay.portal.kernel.model.LayoutModel- Overrides:
getTypeSettingsin classLayoutModelImpl
-
getTypeSettingsProperties
public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties() -
getTypeSettingsProperty
-
getTypeSettingsProperty
-
hasAncestor
public boolean hasAncestor(long layoutId) throws com.liferay.portal.kernel.exception.PortalException Returnstrueif 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:
trueif the given layout ID matches one of the current layout's hierarchical parents;falseotherwise- Throws:
com.liferay.portal.kernel.exception.PortalException
-
hasChildren
public boolean hasChildren()Returnstrueif the current layout has child layouts.- Returns:
trueif the current layout has child layouts,falseotherwise
-
hasScopeGroup
public boolean hasScopeGroup() throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
hasSetModifiedDate
public boolean hasSetModifiedDate()- Specified by:
hasSetModifiedDatein interfacecom.liferay.portal.kernel.model.Layout- Overrides:
hasSetModifiedDatein classLayoutModelImpl
-
includeLayoutContent
public boolean includeLayoutContent(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) 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()Returnstrueif 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:
trueif the current layout can be used as a content display page;falseotherwise
-
isCustomizable
public boolean isCustomizable() -
isDraftLayout
public boolean isDraftLayout() -
isEmbeddedPersonalApplication
public boolean isEmbeddedPersonalApplication() -
isFirstChild
public boolean isFirstChild()Returnstrueif the current layout is the first layout in its parent's hierarchical list of children layouts.- Returns:
trueif the current layout is the first layout in its parent's hierarchical list of children layouts;falseotherwise
-
isFirstParent
public boolean isFirstParent()Returnstrueif the current layout is the topmost parent layout.- Returns:
trueif the current layout is the topmost parent layout;falseotherwise
-
isIconImage
public boolean isIconImage() -
isInheritLookAndFeel
public boolean isInheritLookAndFeel()Returnstrueif the current layout utilizes itsLayoutSet's look and feel options (e.g. theme and color scheme).- Returns:
trueif the current layout utilizes its layout set's look and feel options;falseotherwise
-
isLayoutDeleteable
public boolean isLayoutDeleteable() -
isLayoutPrototypeLinkActive
public boolean isLayoutPrototypeLinkActive()Returnstrueif the current layout is built from a layout template and still maintains an active connection to it.- Returns:
trueif the current layout is built from a layout template and still maintains an active connection to it;falseotherwise
-
isLayoutSortable
public boolean isLayoutSortable() -
isLayoutUpdateable
public boolean isLayoutUpdateable() -
isPortletEmbedded
-
isPublicLayout
public boolean isPublicLayout()Returnstrueif the current layout is part of the publicLayoutSet.Note, the returned value reflects the layout's default access options, not its access permissions.
- Returns:
trueif the current layout is part of the public layout set;falseotherwise
-
isPublished
public boolean isPublished() -
isRootLayout
public boolean isRootLayout()Returnstrueif the current layout is the root layout.- Returns:
trueif the current layout is the root layout;falseotherwise
-
isSelected
public boolean isSelected(boolean selectable, com.liferay.portal.kernel.model.Layout layout, long ancestorPlid) -
isSupportsEmbeddedPortlets
public boolean isSupportsEmbeddedPortlets()Returnstrueif the current layout can hold embedded portlets.- Returns:
trueif the current layout can hold embedded portlets;falseotherwise
-
isTypeAssetDisplay
public boolean isTypeAssetDisplay() -
isTypeContent
public boolean isTypeContent() -
isTypeControlPanel
public boolean isTypeControlPanel() -
isTypeEmbedded
public boolean isTypeEmbedded() -
isTypeLinkToLayout
public boolean isTypeLinkToLayout() -
isTypePanel
public boolean isTypePanel() -
isTypePortlet
public boolean isTypePortlet() -
isTypeURL
public boolean isTypeURL() -
isTypeUtility
public boolean isTypeUtility() -
isUnlocked
-
matches
public boolean matches(javax.servlet.http.HttpServletRequest httpServletRequest, String friendlyURL) -
setGroupId
public void setGroupId(long groupId) - Specified by:
setGroupIdin interfacecom.liferay.portal.kernel.model.GroupedModel- Specified by:
setGroupIdin interfacecom.liferay.portal.kernel.model.LayoutModel- Overrides:
setGroupIdin classLayoutModelImpl
-
setLayoutSet
public void setLayoutSet(com.liferay.portal.kernel.model.LayoutSet layoutSet) -
setPrivateLayout
public void setPrivateLayout(boolean privateLayout) - Specified by:
setPrivateLayoutin interfacecom.liferay.portal.kernel.model.LayoutModel- Overrides:
setPrivateLayoutin classLayoutModelImpl
-
setTypeSettings
- Specified by:
setTypeSettingsin interfacecom.liferay.portal.kernel.model.LayoutModel- Overrides:
setTypeSettingsin classLayoutModelImpl
-
setTypeSettingsProperties
public void setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties)
-