@ProviderType public interface Layout extends LayoutModel, PersistedModel
LayoutModel| Modifier and Type | Field and Description |
|---|---|
static Accessor<Layout,Long> |
LAYOUT_ID_ACCESSOR |
static Accessor<Layout,Long> |
PLID_ACCESSOR
NOTE FOR DEVELOPERS:
Never modify this interface directly.
|
| 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.
|
String |
getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest) |
String |
getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest) |
String |
getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest) |
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 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(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 |
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 httpServletRequest,
String friendlyURL) |
void |
setLayoutSet(LayoutSet layoutSet) |
void |
setTypeSettingsProperties(UnicodeProperties typeSettingsProperties) |
getAvailableLanguageIds, getClassName, getClassNameId, getClassPK, getColorSchemeId, getCompanyId, getCreateDate, getCss, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getFriendlyURL, getGroupId, getHeadId, 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, getParentPlid, getPlid, getPrimaryKey, getPriority, getPrivateLayout, getPublishDate, getRobots, getRobots, getRobots, getRobots, getRobots, getRobotsCurrentLanguageId, getRobotsCurrentValue, getRobotsMap, getSourcePrototypeLayoutUuid, getSystem, getThemeId, getTitle, getTitle, getTitle, getTitle, getTitle, getTitleCurrentLanguageId, getTitleCurrentValue, getTitleMap, getType, getTypeSettings, getUserId, getUserName, getUserUuid, getUuid, isHidden, isLayoutPrototypeLinkEnabled, isPrivateLayout, isSystem, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setClassName, setClassNameId, setClassPK, setColorSchemeId, setCompanyId, setCreateDate, setCss, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setFriendlyURL, setGroupId, setHeadId, setHidden, setIconImageId, setKeywords, setKeywords, setKeywords, setKeywordsCurrentLanguageId, setKeywordsMap, setKeywordsMap, setLastPublishDate, setLayoutId, setLayoutPrototypeLinkEnabled, setLayoutPrototypeUuid, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentLayoutId, setParentPlid, setPlid, setPrimaryKey, setPriority, setPrivateLayout, setPublishDate, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setSystem, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, setTypeSettings, setUserId, setUserName, setUserUuid, setUuidclone, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlStringgetModelClass, getModelClassNameclone, getStagedModelTypeisDraft, isHead, populateVersionModelpersiststatic final Accessor<Layout,Long> PLID_ACCESSOR
com.liferay.portal.model.impl.LayoutImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.List<Layout> getAllChildren()
long getAncestorLayoutId()
throws PortalException
PortalExceptionlong getAncestorPlid()
throws PortalException
PortalExceptionList<Layout> getAncestors() throws PortalException
PortalExceptionList<Layout> getChildren()
List<Layout> getChildren(PermissionChecker permissionChecker) throws PortalException
permissionChecker - the user-specific context to check permissionsPortalExceptionColorScheme getColorScheme() throws PortalException
PortalExceptionString getCssText()
throws PortalException
Layouts and layout sets can configure CSS that is applied in addition to the theme's CSS.
PortalExceptionString getDefaultThemeSetting(String key,
String device,
boolean inheritLookAndFeel)
List<Portlet> getEmbeddedPortlets()
List<Portlet> getEmbeddedPortlets(long groupId)
String getFriendlyURL(Locale locale)
locale - the locale that the friendly URL should be retrieved forMap<Locale,String> getFriendlyURLMap()
String getFriendlyURLsXML()
Group getGroup()
Group is Liferay's technical name for a site.
String getHTMLTitle(Locale locale)
locale - the locale that the HTML title should be retrieved forString getHTMLTitle(String localeLanguageId)
localeLanguageId - the locale that the HTML title should be
retrieved forboolean getIconImage()
true if the current layout has a configured icon.true if the current layout has a configured icon;
false otherwiseLayoutSet getLayoutSet()
LayoutSet.LayoutType getLayoutType()
LayoutType.Layout getLinkedToLayout()
null if no
linked layout could be foundString getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest)
throws PortalException
PortalExceptionString getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest)
throws PortalException
PortalExceptionString getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest)
throws PortalException
PortalExceptionGroup getScopeGroup() throws PortalException
PortalExceptionString getTarget()
Theme getTheme() throws PortalException
PortalExceptionString 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)
throws PortalException
true if the given layout ID matches one of the
current layout's hierarchical parents.layoutId - the layout ID to search for in the current layout's
parent listtrue if the given layout ID matches one of the
current layout's hierarchical parents; false
otherwisePortalExceptionboolean hasChildren()
true if the current layout has child layouts.true if the current layout has child layouts,
false otherwiseboolean hasScopeGroup()
throws PortalException
PortalExceptionboolean hasSetModifiedDate()
boolean includeLayoutContent(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse)
throws Exception
Exceptionboolean isChildSelected(boolean selectable,
Layout layout)
throws PortalException
PortalExceptionboolean isContentDisplayPage()
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.
true if the current layout can be used as a content
display page; false otherwiseboolean isCustomizable()
boolean isFirstChild()
true if the current layout is the first layout in
its parent's hierarchical list of children layouts.true if the current layout is the first layout in
its parent's hierarchical list of children layouts;
false otherwiseboolean isFirstParent()
true if the current layout is the topmost parent
layout.true if the current layout is the topmost parent
layout; false otherwiseboolean isIconImage()
boolean isInheritLookAndFeel()
true if the current layout utilizes its LayoutSet's look and feel options (e.g. theme and color scheme).true if the current layout utilizes its layout set's
look and feel options; false otherwiseboolean isLayoutPrototypeLinkActive()
true if the current layout is built from a layout
template and still maintains an active connection to it.true if the current layout is built from a layout
template and still maintains an active connection to it;
false otherwiseboolean isPortletEmbedded(String portletId,
long groupId)
boolean isPublicLayout()
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.
true if the current layout is part of the public
layout set; false otherwiseboolean isRootLayout()
true if the current layout is the root layout.true if the current layout is the root layout;
false otherwiseboolean isSelected(boolean selectable,
Layout layout,
long ancestorPlid)
boolean isSupportsEmbeddedPortlets()
true if the current layout can hold embedded
portlets.true if the current layout can hold embedded
portlets; false otherwiseboolean isTypeControlPanel()
boolean isTypeEmbedded()
boolean isTypeLinkToLayout()
boolean isTypePanel()
boolean isTypePortlet()
@Deprecated boolean isTypeSharedPortlet()
boolean isTypeURL()
boolean matches(javax.servlet.http.HttpServletRequest httpServletRequest,
String friendlyURL)
void setLayoutSet(LayoutSet layoutSet)
void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)