com.liferay.portal.kernel.model

Interface Layout

All Superinterfaces:

AttachedModel, AuditedModel, BaseModel<Layout>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<Layout>, CTModel<Layout>, GroupedModel, LayoutModel, LocalizedModel, MVCCModel, PersistedModel, java.io.Serializable, ShardedModel, StagedGroupedModel, StagedModel, TypedModel, WorkflowedModel

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

Generated:

Field Summary

Fields

Modifier and Type	Field and Description
static Accessor<Layout,java.lang.Long>	LAYOUT_ID_ACCESSOR
static Accessor<Layout,java.lang.Long>	PLID_ACCESSOR

Method Summary

Modifier and Type	Method and Description
Layout	fetchDraftLayout()
java.util.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.
java.util.List<Layout>	getAncestors() Returns all parent layouts of the current layout.
java.util.List<Layout>	getChildren() Returns all child layouts of the current layout, independent of user access permissions.
java.util.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.
java.lang.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.
java.lang.String	getDefaultThemeSetting(java.lang.String key, java.lang.String device, boolean inheritLookAndFeel)
java.util.List<Portlet>	getEmbeddedPortlets()
java.util.List<Portlet>	getEmbeddedPortlets(long groupId)
java.lang.String	getFriendlyURL(java.util.Locale locale) Returns the layout's friendly URL for the given locale.
java.util.Map<java.util.Locale,java.lang.String>	getFriendlyURLMap() Returns the friendly URLs for all configured locales.
java.lang.String	getFriendlyURLsXML()
Group	getGroup() Returns the current layout's group.
java.lang.String	getHTMLTitle(java.util.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.
java.lang.String	getHTMLTitle(java.lang.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.
java.lang.String	getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest)
java.lang.String	getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest)
java.lang.String	getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest)
Group	getScopeGroup()
java.lang.String	getTarget()
Theme	getTheme() Returns the current layout's theme, or the layout set's theme if no layout theme is configured.
java.lang.String	getThemeSetting(java.lang.String key, java.lang.String device)
java.lang.String	getThemeSetting(java.lang.String key, java.lang.String device, boolean inheritLookAndFeel)
UnicodeProperties	getTypeSettingsProperties()
java.lang.String	getTypeSettingsProperty(java.lang.String key)
java.lang.String	getTypeSettingsProperty(java.lang.String key, java.lang.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 httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
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(java.lang.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	isTypeAssetDisplay()
boolean	isTypeContent()
boolean	isTypeControlPanel()
boolean	isTypeEmbedded()
boolean	isTypeLinkToLayout()
boolean	isTypePanel()
boolean	isTypePortlet()
boolean	isTypeURL()
boolean	matches(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String friendlyURL)
void	setLayoutSet(LayoutSet layoutSet)
void	setTypeSettingsProperties(UnicodeProperties typeSettingsUnicodeProperties)

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

getAvailableLanguageIds, getClassName, getClassNameId, getClassPK, getColorSchemeId, getCompanyId, getCreateDate, getCss, getCtCollectionId, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, 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, getTypeSettings, 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, setFriendlyURL, setGroupId, 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, setPrivateLayout, setPublishDate, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setStatus, setStatusByUserId, setStatusByUserName, setStatusByUserUuid, setStatusDate, setStyleBookEntryId, setSystem, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, setTypeSettings, setUserId, setUserName, setUserUuid, setUuid

Methods 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, toUnescapedModel, toXmlString

Methods inherited from interface java.lang.Comparable

compareTo

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

getModelClass, getModelClassName

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

clone, getStagedModelType

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

persist

Field Detail

PLID_ACCESSOR

static final Accessor<Layout,java.lang.Long> PLID_ACCESSOR

LAYOUT_ID_ACCESSOR

static final Accessor<Layout,java.lang.Long> LAYOUT_ID_ACCESSOR

Method Detail

fetchDraftLayout

Layout fetchDraftLayout()

getAllChildren

java.util.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

java.util.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

java.util.List<Layout> getChildren()

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

Returns:

the list of all child layouts

getChildren

java.util.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

java.lang.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

java.lang.String getDefaultThemeSetting(java.lang.String key,
                                        java.lang.String device,
                                        boolean inheritLookAndFeel)

getEmbeddedPortlets

java.util.List<Portlet> getEmbeddedPortlets()

getEmbeddedPortlets

java.util.List<Portlet> getEmbeddedPortlets(long groupId)

getFriendlyURL

java.lang.String getFriendlyURL(java.util.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

java.util.Map<java.util.Locale,java.lang.String> getFriendlyURLMap()

Returns the friendly URLs for all configured locales.

Returns:

the friendly URLs for all configured locales

getFriendlyURLsXML

java.lang.String getFriendlyURLsXML()

getGroup

Group getGroup()

Returns the current layout's group.

Group is Liferay's technical name for a site.

Returns:

the current layout's group

getHTMLTitle

java.lang.String getHTMLTitle(java.util.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

java.lang.String getHTMLTitle(java.lang.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()

Returns the current layout's LayoutSet.

Returns:

the current layout's layout set

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

getRegularURL

java.lang.String getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest)
                        throws PortalException

Throws:

PortalException

getResetLayoutURL

java.lang.String getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest)
                            throws PortalException

Throws:

PortalException

getResetMaxStateURL

java.lang.String getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest)
                              throws PortalException

Throws:

PortalException

getScopeGroup

Group getScopeGroup()
             throws PortalException

Throws:

PortalException

getTarget

java.lang.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

java.lang.String getThemeSetting(java.lang.String key,
                                 java.lang.String device)

getThemeSetting

java.lang.String getThemeSetting(java.lang.String key,
                                 java.lang.String device,
                                 boolean inheritLookAndFeel)

getTypeSettingsProperties

UnicodeProperties getTypeSettingsProperties()

getTypeSettingsProperty

java.lang.String getTypeSettingsProperty(java.lang.String key)

getTypeSettingsProperty

java.lang.String getTypeSettingsProperty(java.lang.String key,
                                         java.lang.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 httpServletRequest,
                             javax.servlet.http.HttpServletResponse httpServletResponse)
                      throws java.lang.Exception

Throws:

java.lang.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(java.lang.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

isTypeAssetDisplay

boolean isTypeAssetDisplay()

isTypeContent

boolean isTypeContent()

isTypeControlPanel

boolean isTypeControlPanel()

isTypeEmbedded

boolean isTypeEmbedded()

isTypeLinkToLayout

boolean isTypeLinkToLayout()

isTypePanel

boolean isTypePanel()

isTypePortlet

boolean isTypePortlet()

isTypeURL

boolean isTypeURL()

matches

boolean matches(javax.servlet.http.HttpServletRequest httpServletRequest,
                java.lang.String friendlyURL)

setLayoutSet

void setLayoutSet(LayoutSet layoutSet)

setTypeSettingsProperties

void setTypeSettingsProperties(UnicodeProperties typeSettingsUnicodeProperties)