|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType public interface Layout
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.
LayoutModel,
LayoutImpl,
LayoutModelImpl| Field Summary | |
|---|---|
static Accessor<Layout,Long> |
LAYOUT_ID_ACCESSOR
|
static Accessor<Layout,Long> |
PLID_ACCESSOR
|
| Method Summary | |
|---|---|
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)
|
ColorScheme |
getWapColorScheme()
|
Theme |
getWapTheme()
|
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 |
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 |
isInheritWapLookAndFeel()
|
boolean |
isLayoutPrototypeLinkActive()
Returns true if the current layout is built from a layout
template and still maintains an active connection to it. |
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 7.0.0, with no direct replacement |
boolean |
isTypeControlPanel()
|
boolean |
isTypeEmbedded()
|
boolean |
isTypeLinkToLayout()
|
boolean |
isTypePanel()
|
boolean |
isTypePortlet()
|
boolean |
isTypeSharedPortlet()
|
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.model.BaseModel |
|---|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes |
| Methods inherited from interface com.liferay.portal.model.ClassedModel |
|---|
getModelClass, getModelClassName |
| Methods inherited from interface com.liferay.portal.model.StagedModel |
|---|
getStagedModelType |
| Methods inherited from interface com.liferay.portal.model.PersistedModel |
|---|
persist |
| Field Detail |
|---|
static final Accessor<Layout,Long> PLID_ACCESSOR
static final Accessor<Layout,Long> LAYOUT_ID_ACCESSOR
| Method Detail |
|---|
List<Layout> getAllChildren()
long getAncestorLayoutId()
throws PortalException
PortalException
long getAncestorPlid()
throws PortalException
PortalException
List<Layout> getAncestors()
throws PortalException
PortalExceptionList<Layout> getChildren()
List<Layout> getChildren(PermissionChecker permissionChecker)
throws PortalException
permissionChecker - the user-specific context to check permissions
PortalException
ColorScheme getColorScheme()
throws PortalException
PortalException
String getCssText()
throws PortalException
Layouts and layout sets can configure CSS that is applied in addition to the theme's CSS.
PortalException
String 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 for
Map<Locale,String> getFriendlyURLMap()
String getFriendlyURLsXML()
Group getGroup()
throws PortalException
Group is Liferay's technical name for a site.
PortalExceptionString getHTMLTitle(Locale locale)
locale - the locale that the HTML title should be retrieved for
String getHTMLTitle(String localeLanguageId)
localeLanguageId - the locale that the HTML title should be
retrieved for
boolean getIconImage()
true if the current layout has a configured icon.
true if the current layout has a configured icon;
false otherwise
LayoutSet getLayoutSet()
throws PortalException
LayoutSet.
PortalExceptionLayoutType getLayoutType()
LayoutType.
Layout getLinkedToLayout()
null if no
linked layout could be found
long getParentPlid()
throws PortalException
0 if the
current layout is the topmost parent layout
PortalException
String getRegularURL(javax.servlet.http.HttpServletRequest request)
throws PortalException
PortalException
String getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
throws PortalException
PortalException
String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
throws PortalException
PortalException
Group getScopeGroup()
throws PortalException
PortalExceptionString getTarget()
Theme getTheme()
throws PortalException
PortalException
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)
ColorScheme getWapColorScheme()
throws PortalException
PortalException
Theme getWapTheme()
throws PortalException
PortalException
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 list
true if the given layout ID matches one of the
current layout's hierarchical parents; false
otherwise
PortalExceptionboolean hasChildren()
true if the current layout has child layouts.
true if the current layout has child layouts,
false otherwise
boolean hasScopeGroup()
throws PortalException
PortalExceptionboolean hasSetModifiedDate()
boolean includeLayoutContent(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
Exception
boolean 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 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 isInheritWapLookAndFeel()
boolean 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 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 otherwise
boolean 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 otherwise@Deprecated boolean isTypeArticle()
boolean isTypeControlPanel()
boolean isTypeEmbedded()
boolean isTypeLinkToLayout()
boolean isTypePanel()
boolean isTypePortlet()
boolean isTypeSharedPortlet()
boolean isTypeURL()
boolean matches(javax.servlet.http.HttpServletRequest request,
String friendlyURL)
void setLayoutSet(LayoutSet layoutSet)
void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||