Layout (Liferay 7.0.10 portal-kernel API)

All Superinterfaces:

AuditedModel, BaseModel<Layout>, ClassedModel, Cloneable, Comparable<Layout>, GroupedModel, LayoutModel, LocalizedModel, MVCCModel, PersistedModel, Serializable, ShardedModel, StagedGroupedModel, StagedModel

All Known Implementing Classes:

LayoutWrapper, VirtualLayout
```
@ProviderType
public interface Layout
extends LayoutModel, PersistedModel
```
The extended model interface for the Layout service. Represents a row in the "Layout" database table, with each column mapped to a property of this class.

Author:

Brian Wing Shun Chan

See Also:

LayoutModel, LayoutImpl, LayoutModelImpl

{$generated.description}

Field Summary

Fields
Modifier and Type Field and Description

static Accessor<Layout,Long> LAYOUT_ID_ACCESSOR

static Accessor<Layout,Long> PLID_ACCESSOR

Fields
Modifier and Type	Field and Description
`static Accessor<Layout,Long>`	`LAYOUT_ID_ACCESSOR`
`static Accessor<Layout,Long>`	`PLID_ACCESSOR`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`List<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<Layout>`	`getAncestors()` Returns all parent layouts of the current layout.
`List<Layout>`	`getChildren()` Returns all child layouts of the current layout, independent of user access permissions.
`List<Layout>`	`getChildren(PermissionChecker permissionChecker)` Returns all child layouts of the current layout that the user has permission to access.
`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<Portlet>`	`getEmbeddedPortlets()`
`List<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()`
`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.
`LayoutSet`	`getLayoutSet()` Returns the current layout's `LayoutSet`.
`LayoutType`	`getLayoutType()` Returns the current layout's `LayoutType`.
`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)`
`Group`	`getScopeGroup()`
`String`	`getTarget()`
`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)`
`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.
`boolean`	`hasScopeGroup()`
`boolean`	`hasSetModifiedDate()`
`boolean`	`includeLayoutContent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`boolean`	`isChildSelected(boolean selectable, 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, 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`	`setLayoutSet(LayoutSet layoutSet)`
`void`	`setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)`

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, getTypeSettings, 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, setGroupId, 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, setPrivateLayout, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, setTypeSettings, 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

Methods inherited from interface com.liferay.portal.kernel.model.PersistedModel
persist

- Field Detail
  - PLID_ACCESSOR
```
static final Accessor<Layout,Long> PLID_ACCESSOR
```
  - LAYOUT_ID_ACCESSOR
```
static final Accessor<Layout,Long> LAYOUT_ID_ACCESSOR
```
- Method Detail
  - getAllChildren
```
List<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
```
long getAncestorLayoutId()
                  throws 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:
    
    PortalException
  - getAncestorPlid
```
long getAncestorPlid()
              throws 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:
    
    PortalException
  - getAncestors
```
List<Layout> getAncestors()
                   throws 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:
    
    PortalException
  - getChildren
```
List<Layout> getChildren()
```
    Returns all child layouts of the current layout, independent of user access permissions.
    
    Returns:
    
    the list of all child layouts
  - getChildren
```
List<Layout> getChildren(PermissionChecker permissionChecker)
                  throws 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:
    
    PortalException
  - getColorScheme
```
ColorScheme getColorScheme()
                    throws 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:
    
    PortalException
  - getCssText
```
String getCssText()
           throws 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:
    
    PortalException
  - getDefaultThemeSetting
```
String getDefaultThemeSetting(String key,
                              String device,
                              boolean inheritLookAndFeel)
```
  - getEmbeddedPortlets
```
List<Portlet> getEmbeddedPortlets()
```
  - getEmbeddedPortlets
```
List<Portlet> getEmbeddedPortlets(long groupId)
```
  - getFriendlyURL
```
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
```
Map<Locale,String> getFriendlyURLMap()
```
    Returns the friendly URLs for all configured locales.
    
    Returns:
    
    the friendly URLs for all configured locales
  - getFriendlyURLsXML
```
String getFriendlyURLsXML()
```
  - getGroup
```
Group getGroup()
        throws PortalException
```
    Returns the current layout's group.
    Group is Liferay's technical name for a site.
    
    Returns:
    
    the current layout's group
    
    Throws:
    
    PortalException
  - getHTMLTitle
```
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
```
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
```
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
```
LayoutSet getLayoutSet()
                throws PortalException
```
    Returns the current layout's LayoutSet.
    
    Returns:
    
    the current layout's layout set
    
    Throws:
    
    PortalException
  - getLayoutType
```
LayoutType getLayoutType()
```
    Returns the current layout's LayoutType.
    
    Returns:
    
    the current layout's layout type
  - getLinkedToLayout
```
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
```
long getParentPlid()
            throws 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:
    
    PortalException
  - getRegularURL
```
String getRegularURL(javax.servlet.http.HttpServletRequest request)
              throws PortalException
```
    Throws:
    
    PortalException
  - getResetLayoutURL
```
String getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
                  throws PortalException
```
    Throws:
    
    PortalException
  - getResetMaxStateURL
```
String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
                    throws PortalException
```
    Throws:
    
    PortalException
  - getScopeGroup
```
Group getScopeGroup()
             throws PortalException
```
    Throws:
    
    PortalException
  - getTarget
```
String getTarget()
```
  - getTheme
```
Theme getTheme()
        throws 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:
    
    PortalException
  - getThemeSetting
```
String getThemeSetting(String key,
                       String device)
```
  - getThemeSetting
```
String getThemeSetting(String key,
                       String device,
                       boolean inheritLookAndFeel)
```
  - getTypeSettingsProperties
```
UnicodeProperties getTypeSettingsProperties()
```
  - getTypeSettingsProperty
```
String getTypeSettingsProperty(String key)
```
  - getTypeSettingsProperty
```
String getTypeSettingsProperty(String key,
                               String defaultValue)
```
  - hasAncestor
```
boolean hasAncestor(long layoutId)
             throws 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:
    
    PortalException
  - hasChildren
```
boolean hasChildren()
```
    Returns true if the current layout has child layouts.
    
    Returns:
    
    true if the current layout has child layouts, false otherwise
  - hasScopeGroup
```
boolean hasScopeGroup()
               throws PortalException
```
    Throws:
    
    PortalException
  - hasSetModifiedDate
```
boolean hasSetModifiedDate()
```
  - includeLayoutContent
```
boolean includeLayoutContent(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws Exception
```
    Throws:
    
    Exception
  - isChildSelected
```
boolean isChildSelected(boolean selectable,
                        Layout layout)
                 throws PortalException
```
    Throws:
    
    PortalException
  - isContentDisplayPage
```
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
```
boolean isCustomizable()
```
  - isFirstChild
```
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
```
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
```
boolean isIconImage()
```
  - isInheritLookAndFeel
```
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
```
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
```
boolean isPortletEmbedded(String portletId,
                          long groupId)
```
  - isPublicLayout
```
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
```
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
```
boolean isSelected(boolean selectable,
                   Layout layout,
                   long ancestorPlid)
```
  - isSupportsEmbeddedPortlets
```
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
boolean isTypeArticle()
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
  - isTypeControlPanel
```
boolean isTypeControlPanel()
```
  - isTypeEmbedded
```
boolean isTypeEmbedded()
```
  - isTypeLinkToLayout
```
boolean isTypeLinkToLayout()
```
  - isTypePanel
```
boolean isTypePanel()
```
  - isTypePortlet
```
boolean isTypePortlet()
```
  - isTypeSharedPortlet
```
@Deprecated
boolean isTypeSharedPortlet()
```
    Deprecated. As of Judson (7.1.x), with no direct replacement
  - isTypeURL
```
boolean isTypeURL()
```
  - matches
```
boolean matches(javax.servlet.http.HttpServletRequest request,
                String friendlyURL)
```
  - setLayoutSet
```
void setLayoutSet(LayoutSet layoutSet)
```
  - setTypeSettingsProperties
```
void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
```

Interface Layout

Field Summary

Method Summary

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

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

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

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

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

Field Detail

PLID_ACCESSOR

LAYOUT_ID_ACCESSOR

Method Detail

getAllChildren

getAncestorLayoutId

getAncestorPlid

getAncestors

getChildren

getChildren

getColorScheme

getCssText

getDefaultThemeSetting

getEmbeddedPortlets

getEmbeddedPortlets

getFriendlyURL

getFriendlyURLMap

getFriendlyURLsXML

getGroup

getHTMLTitle

getHTMLTitle

getIconImage

getLayoutSet

getLayoutType

getLinkedToLayout

getParentPlid

getRegularURL

getResetLayoutURL

getResetMaxStateURL

getScopeGroup

getTarget

getTheme

getThemeSetting

getThemeSetting

getTypeSettingsProperties

getTypeSettingsProperty

getTypeSettingsProperty

hasAncestor

hasChildren

hasScopeGroup

hasSetModifiedDate

includeLayoutContent

isChildSelected

isContentDisplayPage

isCustomizable

isFirstChild

isFirstParent

isIconImage

isInheritLookAndFeel

isLayoutPrototypeLinkActive

isPortletEmbedded

isPublicLayout

isRootLayout

isSelected

isSupportsEmbeddedPortlets

isTypeArticle

isTypeControlPanel

isTypeEmbedded

isTypeLinkToLayout

isTypePanel

isTypePortlet

isTypeSharedPortlet

isTypeURL

matches

setLayoutSet

setTypeSettingsProperties