@ProviderType public class LayoutWrapper extends Object implements Layout, ModelWrapper<Layout>
This class is a wrapper for Layout.
Layout,
Serialized FormLAYOUT_ID_ACCESSOR, PLID_ACCESSOR| Constructor and Description |
|---|
LayoutWrapper(Layout layout) |
| Modifier and Type | Method and Description |
|---|---|
Object |
clone()
Creates a shallow clone of this model instance.
|
int |
compareTo(Layout layout) |
boolean |
equals(Object obj) |
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.
|
String[] |
getAvailableLanguageIds() |
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 |
getColorSchemeId()
Returns the color scheme ID of this layout.
|
long |
getCompanyId()
Returns the company ID of this layout.
|
Date |
getCreateDate()
Returns the create date of this layout.
|
String |
getCss()
Returns the css of this layout.
|
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 |
getDefaultLanguageId() |
String |
getDefaultThemeSetting(String key,
String device,
boolean inheritLookAndFeel) |
String |
getDescription()
Returns the description of this layout.
|
String |
getDescription(Locale locale)
Returns the localized description of this layout in the language.
|
String |
getDescription(Locale locale,
boolean useDefault)
Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getDescription(String languageId)
Returns the localized description of this layout in the language.
|
String |
getDescription(String languageId,
boolean useDefault)
Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getDescriptionCurrentLanguageId() |
String |
getDescriptionCurrentValue() |
Map<Locale,String> |
getDescriptionMap()
Returns a map of the locales and localized descriptions of this layout.
|
List<Portlet> |
getEmbeddedPortlets() |
List<Portlet> |
getEmbeddedPortlets(long groupId) |
ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance.
|
String |
getFriendlyURL()
Returns the friendly u r l of this layout.
|
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.
|
long |
getGroupId()
Returns the group ID of this layout.
|
boolean |
getHidden()
Returns the hidden of this layout.
|
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. |
long |
getIconImageId()
Returns the icon image ID of this layout.
|
String |
getKeywords()
Returns the keywords of this layout.
|
String |
getKeywords(Locale locale)
Returns the localized keywords of this layout in the language.
|
String |
getKeywords(Locale locale,
boolean useDefault)
Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getKeywords(String languageId)
Returns the localized keywords of this layout in the language.
|
String |
getKeywords(String languageId,
boolean useDefault)
Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getKeywordsCurrentLanguageId() |
String |
getKeywordsCurrentValue() |
Map<Locale,String> |
getKeywordsMap()
Returns a map of the locales and localized keywordses of this layout.
|
Date |
getLastPublishDate()
Returns the last publish date of this layout.
|
long |
getLayoutId()
Returns the layout ID of this layout.
|
boolean |
getLayoutPrototypeLinkEnabled()
Returns the layout prototype link enabled of this layout.
|
String |
getLayoutPrototypeUuid()
Returns the layout prototype uuid of this layout.
|
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.
|
Map<String,Object> |
getModelAttributes() |
Class<?> |
getModelClass() |
String |
getModelClassName() |
Date |
getModifiedDate()
Returns the modified date of this layout.
|
long |
getMvccVersion()
Returns the mvcc version of this layout.
|
String |
getName()
Returns the name of this layout.
|
String |
getName(Locale locale)
Returns the localized name of this layout in the language.
|
String |
getName(Locale locale,
boolean useDefault)
Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getName(String languageId)
Returns the localized name of this layout in the language.
|
String |
getName(String languageId,
boolean useDefault)
Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getNameCurrentLanguageId() |
String |
getNameCurrentValue() |
Map<Locale,String> |
getNameMap()
Returns a map of the locales and localized names of this layout.
|
long |
getParentLayoutId()
Returns the parent layout ID of this layout.
|
long |
getParentPlid()
Returns the current layout's parent plid.
|
long |
getPlid()
Returns the plid of this layout.
|
long |
getPrimaryKey()
Returns the primary key of this layout.
|
Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance.
|
int |
getPriority()
Returns the priority of this layout.
|
boolean |
getPrivateLayout()
Returns the private layout of this layout.
|
String |
getRegularURL(javax.servlet.http.HttpServletRequest request) |
String |
getResetLayoutURL(javax.servlet.http.HttpServletRequest request) |
String |
getResetMaxStateURL(javax.servlet.http.HttpServletRequest request) |
String |
getRobots()
Returns the robots of this layout.
|
String |
getRobots(Locale locale)
Returns the localized robots of this layout in the language.
|
String |
getRobots(Locale locale,
boolean useDefault)
Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getRobots(String languageId)
Returns the localized robots of this layout in the language.
|
String |
getRobots(String languageId,
boolean useDefault)
Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getRobotsCurrentLanguageId() |
String |
getRobotsCurrentValue() |
Map<Locale,String> |
getRobotsMap()
Returns a map of the locales and localized robotses of this layout.
|
Group |
getScopeGroup() |
String |
getSourcePrototypeLayoutUuid()
Returns the source prototype layout uuid of this layout.
|
StagedModelType |
getStagedModelType() |
String |
getTarget() |
Theme |
getTheme()
Returns the current layout's theme, or the layout set's theme if no
layout theme is configured.
|
String |
getThemeId()
Returns the theme ID of this layout.
|
String |
getThemeSetting(String key,
String device) |
String |
getThemeSetting(String key,
String device,
boolean inheritLookAndFeel) |
String |
getTitle()
Returns the title of this layout.
|
String |
getTitle(Locale locale)
Returns the localized title of this layout in the language.
|
String |
getTitle(Locale locale,
boolean useDefault)
Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getTitle(String languageId)
Returns the localized title of this layout in the language.
|
String |
getTitle(String languageId,
boolean useDefault)
Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
|
String |
getTitleCurrentLanguageId() |
String |
getTitleCurrentValue() |
Map<Locale,String> |
getTitleMap()
Returns a map of the locales and localized titles of this layout.
|
String |
getType()
Returns the type of this layout.
|
String |
getTypeSettings()
Returns the type settings of this layout.
|
UnicodeProperties |
getTypeSettingsProperties() |
String |
getTypeSettingsProperty(String key) |
String |
getTypeSettingsProperty(String key,
String defaultValue) |
long |
getUserId()
Returns the user ID of this layout.
|
String |
getUserName()
Returns the user name of this layout.
|
String |
getUserUuid()
Returns the user uuid of this layout.
|
String |
getUuid()
Returns the uuid of this layout.
|
Layout |
getWrappedModel() |
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. |
int |
hashCode() |
boolean |
hasScopeGroup() |
boolean |
hasSetModifiedDate() |
boolean |
includeLayoutContent(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
boolean |
isCachedModel()
Returns
true if this model instance was retrieved from the
entity cache. |
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 |
isEntityCacheEnabled()
Returns
true if this model's entity cache is enabled. |
boolean |
isEscapedModel()
Returns
true if this model instance is escaped. |
boolean |
isFinderCacheEnabled()
Returns
true if this model's finder cache is enabled. |
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 |
isHidden()
Returns
true if this layout is hidden. |
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 |
isLayoutPrototypeLinkEnabled()
Returns
true if this layout is layout prototype link enabled. |
boolean |
isNew()
Returns
true if this model instance does not yet exist in
the database. |
boolean |
isPortletEmbedded(String portletId,
long groupId) |
boolean |
isPrivateLayout()
Returns
true if this layout is private layout. |
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 |
persist()
Updates this model instance in the database or adds it if it does not yet
exist.
|
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(Locale defaultImportLocale) |
void |
resetOriginalValues()
Reset all original fields to current values.
|
void |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache.
|
void |
setColorSchemeId(String colorSchemeId)
Sets the color scheme ID of this layout.
|
void |
setCompanyId(long companyId)
Sets the company ID of this layout.
|
void |
setCreateDate(Date createDate)
Sets the create date of this layout.
|
void |
setCss(String css)
Sets the css of this layout.
|
void |
setDescription(String description)
Sets the description of this layout.
|
void |
setDescription(String description,
Locale locale)
Sets the localized description of this layout in the language.
|
void |
setDescription(String description,
Locale locale,
Locale defaultLocale)
Sets the localized description of this layout in the language, and sets the default locale.
|
void |
setDescriptionCurrentLanguageId(String languageId) |
void |
setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this layout from the map of locales and localized descriptions.
|
void |
setDescriptionMap(Map<Locale,String> descriptionMap,
Locale defaultLocale)
Sets the localized descriptions of this layout from the map of locales and localized descriptions, and sets the default locale.
|
void |
setExpandoBridgeAttributes(BaseModel<?> baseModel) |
void |
setExpandoBridgeAttributes(ExpandoBridge expandoBridge) |
void |
setExpandoBridgeAttributes(ServiceContext serviceContext)
Sets the expando bridge attributes for this model instance to the
attributes stored in the service context.
|
void |
setFriendlyURL(String friendlyURL)
Sets the friendly u r l of this layout.
|
void |
setGroupId(long groupId)
Sets the group ID of this layout.
|
void |
setHidden(boolean hidden)
Sets whether this layout is hidden.
|
void |
setIconImageId(long iconImageId)
Sets the icon image ID of this layout.
|
void |
setKeywords(String keywords)
Sets the keywords of this layout.
|
void |
setKeywords(String keywords,
Locale locale)
Sets the localized keywords of this layout in the language.
|
void |
setKeywords(String keywords,
Locale locale,
Locale defaultLocale)
Sets the localized keywords of this layout in the language, and sets the default locale.
|
void |
setKeywordsCurrentLanguageId(String languageId) |
void |
setKeywordsMap(Map<Locale,String> keywordsMap)
Sets the localized keywordses of this layout from the map of locales and localized keywordses.
|
void |
setKeywordsMap(Map<Locale,String> keywordsMap,
Locale defaultLocale)
Sets the localized keywordses of this layout from the map of locales and localized keywordses, and sets the default locale.
|
void |
setLastPublishDate(Date lastPublishDate)
Sets the last publish date of this layout.
|
void |
setLayoutId(long layoutId)
Sets the layout ID of this layout.
|
void |
setLayoutPrototypeLinkEnabled(boolean layoutPrototypeLinkEnabled)
Sets whether this layout is layout prototype link enabled.
|
void |
setLayoutPrototypeUuid(String layoutPrototypeUuid)
Sets the layout prototype uuid of this layout.
|
void |
setLayoutSet(LayoutSet layoutSet) |
void |
setModelAttributes(Map<String,Object> attributes) |
void |
setModifiedDate(Date modifiedDate)
Sets the modified date of this layout.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this layout.
|
void |
setName(String name)
Sets the name of this layout.
|
void |
setName(String name,
Locale locale)
Sets the localized name of this layout in the language.
|
void |
setName(String name,
Locale locale,
Locale defaultLocale)
Sets the localized name of this layout in the language, and sets the default locale.
|
void |
setNameCurrentLanguageId(String languageId) |
void |
setNameMap(Map<Locale,String> nameMap)
Sets the localized names of this layout from the map of locales and localized names.
|
void |
setNameMap(Map<Locale,String> nameMap,
Locale defaultLocale)
Sets the localized names of this layout from the map of locales and localized names, and sets the default locale.
|
void |
setNew(boolean n)
Sets whether this model instance does not yet exist in the database.
|
void |
setParentLayoutId(long parentLayoutId)
Sets the parent layout ID of this layout.
|
void |
setPlid(long plid)
Sets the plid of this layout.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this layout.
|
void |
setPrimaryKeyObj(Serializable primaryKeyObj)
Sets the primary key of this model instance.
|
void |
setPriority(int priority)
Sets the priority of this layout.
|
void |
setPrivateLayout(boolean privateLayout)
Sets whether this layout is private layout.
|
void |
setRobots(String robots)
Sets the robots of this layout.
|
void |
setRobots(String robots,
Locale locale)
Sets the localized robots of this layout in the language.
|
void |
setRobots(String robots,
Locale locale,
Locale defaultLocale)
Sets the localized robots of this layout in the language, and sets the default locale.
|
void |
setRobotsCurrentLanguageId(String languageId) |
void |
setRobotsMap(Map<Locale,String> robotsMap)
Sets the localized robotses of this layout from the map of locales and localized robotses.
|
void |
setRobotsMap(Map<Locale,String> robotsMap,
Locale defaultLocale)
Sets the localized robotses of this layout from the map of locales and localized robotses, and sets the default locale.
|
void |
setSourcePrototypeLayoutUuid(String sourcePrototypeLayoutUuid)
Sets the source prototype layout uuid of this layout.
|
void |
setThemeId(String themeId)
Sets the theme ID of this layout.
|
void |
setTitle(String title)
Sets the title of this layout.
|
void |
setTitle(String title,
Locale locale)
Sets the localized title of this layout in the language.
|
void |
setTitle(String title,
Locale locale,
Locale defaultLocale)
Sets the localized title of this layout in the language, and sets the default locale.
|
void |
setTitleCurrentLanguageId(String languageId) |
void |
setTitleMap(Map<Locale,String> titleMap)
Sets the localized titles of this layout from the map of locales and localized titles.
|
void |
setTitleMap(Map<Locale,String> titleMap,
Locale defaultLocale)
Sets the localized titles of this layout from the map of locales and localized titles, and sets the default locale.
|
void |
setType(String type)
Sets the type of this layout.
|
void |
setTypeSettings(String typeSettings)
Sets the type settings of this layout.
|
void |
setTypeSettingsProperties(UnicodeProperties typeSettingsProperties) |
void |
setUserId(long userId)
Sets the user ID of this layout.
|
void |
setUserName(String userName)
Sets the user name of this layout.
|
void |
setUserUuid(String userUuid)
Sets the user uuid of this layout.
|
void |
setUuid(String uuid)
Sets the uuid of this layout.
|
CacheModel<Layout> |
toCacheModel()
Returns a cache model object for this entity used by entity cache.
|
Layout |
toEscapedModel()
Returns a copy of this entity as an escaped model instance by wrapping it
with an
AutoEscapeBeanHandler. |
String |
toString() |
Layout |
toUnescapedModel() |
String |
toXmlString()
Returns the XML representation of this model instance.
|
public LayoutWrapper(Layout layout)
public Class<?> getModelClass()
getModelClass in interface ClassedModelpublic String getModelClassName()
getModelClassName in interface ClassedModelpublic Map<String,Object> getModelAttributes()
getModelAttributes in interface BaseModel<Layout>public void setModelAttributes(Map<String,Object> attributes)
setModelAttributes in interface BaseModel<Layout>public CacheModel<Layout> toCacheModel()
BaseModeltoCacheModel in interface BaseModel<Layout>toCacheModel in interface LayoutModelpublic ColorScheme getColorScheme() throws PortalException
getColorScheme in interface LayoutPortalExceptionpublic Group getGroup() throws PortalException
Group is Liferay's technical name for a site.
getGroup in interface LayoutPortalExceptionpublic Group getScopeGroup() throws PortalException
getScopeGroup in interface LayoutPortalExceptionpublic Layout toEscapedModel()
BaseModelAutoEscapeBeanHandler.toEscapedModel in interface BaseModel<Layout>toEscapedModel in interface LayoutModelAutoEscapeBeanHandlerpublic Layout toUnescapedModel()
toUnescapedModel in interface BaseModel<Layout>toUnescapedModel in interface LayoutModelpublic LayoutSet getLayoutSet() throws PortalException
LayoutSet.getLayoutSet in interface LayoutPortalExceptionpublic LayoutType getLayoutType()
LayoutType.getLayoutType in interface Layoutpublic Theme getTheme() throws PortalException
getTheme in interface LayoutPortalExceptionpublic boolean getHidden()
getHidden in interface LayoutModelpublic boolean getIconImage()
true if the current layout has a configured icon.getIconImage in interface Layouttrue if the current layout has a configured icon;
false otherwisepublic boolean getLayoutPrototypeLinkEnabled()
getLayoutPrototypeLinkEnabled in interface LayoutModelpublic boolean getPrivateLayout()
getPrivateLayout in interface LayoutModelpublic boolean hasAncestor(long layoutId)
throws PortalException
true if the given layout ID matches one of the
current layout's hierarchical parents.hasAncestor in interface LayoutlayoutId - 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
otherwisePortalExceptionpublic boolean hasChildren()
true if the current layout has child layouts.hasChildren in interface Layouttrue if the current layout has child layouts,
false otherwisepublic boolean hasScopeGroup()
throws PortalException
hasScopeGroup in interface LayoutPortalExceptionpublic boolean hasSetModifiedDate()
hasSetModifiedDate in interface Layoutpublic boolean includeLayoutContent(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
includeLayoutContent in interface LayoutExceptionpublic boolean isCachedModel()
BaseModeltrue if this model instance was retrieved from the
entity cache.isCachedModel in interface BaseModel<Layout>isCachedModel in interface LayoutModeltrue if this model instance was retrieved from the
entity cache; false otherwiseBaseModel.setCachedModel(boolean)public boolean isChildSelected(boolean selectable,
Layout layout)
throws PortalException
isChildSelected in interface LayoutPortalExceptionpublic boolean 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.
isContentDisplayPage in interface Layouttrue if the current layout can be used as a content
display page; false otherwisepublic boolean isCustomizable()
isCustomizable in interface Layoutpublic boolean isEscapedModel()
BaseModeltrue if this model instance is escaped.isEscapedModel in interface BaseModel<Layout>isEscapedModel in interface LayoutModeltrue if this model instance is escaped;
false otherwisepublic boolean isFirstChild()
true if the current layout is the first layout in
its parent's hierarchical list of children layouts.isFirstChild in interface Layouttrue if the current layout is the first layout in
its parent's hierarchical list of children layouts;
false otherwisepublic boolean isFirstParent()
true if the current layout is the topmost parent
layout.isFirstParent in interface Layouttrue if the current layout is the topmost parent
layout; false otherwisepublic boolean isHidden()
true if this layout is hidden.isHidden in interface LayoutModeltrue if this layout is hidden; false otherwisepublic boolean isIconImage()
isIconImage in interface Layoutpublic boolean isInheritLookAndFeel()
true if the current layout utilizes its LayoutSet's look and feel options (e.g. theme and color scheme).isInheritLookAndFeel in interface Layouttrue if the current layout utilizes its layout set's
look and feel options; false otherwisepublic boolean isLayoutPrototypeLinkActive()
true if the current layout is built from a layout
template and still maintains an active connection to it.isLayoutPrototypeLinkActive in interface Layouttrue if the current layout is built from a layout
template and still maintains an active connection to it;
false otherwisepublic boolean isLayoutPrototypeLinkEnabled()
true if this layout is layout prototype link enabled.isLayoutPrototypeLinkEnabled in interface LayoutModeltrue if this layout is layout prototype link enabled; false otherwisepublic boolean isNew()
BaseModeltrue if this model instance does not yet exist in
the database.isNew in interface BaseModel<Layout>isNew in interface LayoutModeltrue if this model instance does not yet exist in
the database; false otherwisepublic boolean isPortletEmbedded(String portletId, long groupId)
isPortletEmbedded in interface Layoutpublic boolean isPrivateLayout()
true if this layout is private layout.isPrivateLayout in interface LayoutModeltrue if this layout is private layout; false otherwisepublic 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.
isPublicLayout in interface Layouttrue if the current layout is part of the public
layout set; false otherwisepublic boolean isRootLayout()
true if the current layout is the root layout.isRootLayout in interface Layouttrue if the current layout is the root layout;
false otherwisepublic boolean isSelected(boolean selectable,
Layout layout,
long ancestorPlid)
isSelected in interface Layoutpublic boolean isSupportsEmbeddedPortlets()
true if the current layout can hold embedded
portlets.isSupportsEmbeddedPortlets in interface Layouttrue if the current layout can hold embedded
portlets; false otherwise@Deprecated public boolean isTypeArticle()
isTypeArticle in interface Layoutpublic boolean isTypeControlPanel()
isTypeControlPanel in interface Layoutpublic boolean isTypeEmbedded()
isTypeEmbedded in interface Layoutpublic boolean isTypeLinkToLayout()
isTypeLinkToLayout in interface Layoutpublic boolean isTypePanel()
isTypePanel in interface Layoutpublic boolean isTypePortlet()
isTypePortlet in interface Layoutpublic boolean isTypeSharedPortlet()
isTypeSharedPortlet in interface Layoutpublic boolean matches(javax.servlet.http.HttpServletRequest request,
String friendlyURL)
public ExpandoBridge getExpandoBridge()
BaseModelgetExpandoBridge in interface BaseModel<Layout>getExpandoBridge in interface ClassedModelgetExpandoBridge in interface LayoutModelpublic Layout getLinkedToLayout()
getLinkedToLayout in interface Layoutnull if no
linked layout could be foundpublic UnicodeProperties getTypeSettingsProperties()
getTypeSettingsProperties in interface Layoutpublic int compareTo(Layout layout)
compareTo in interface LayoutModelcompareTo in interface Comparable<Layout>public int getPriority()
getPriority in interface LayoutModelpublic int hashCode()
hashCode in interface LayoutModelhashCode in class Objectpublic Serializable getPrimaryKeyObj()
BaseModelgetPrimaryKeyObj in interface BaseModel<Layout>getPrimaryKeyObj in interface ClassedModelgetPrimaryKeyObj in interface LayoutModelpublic Object clone()
BaseModelclone in interface BaseModel<Layout>clone in interface LayoutModelclone in interface StagedModelclone in class Objectpublic String getColorSchemeId()
getColorSchemeId in interface LayoutModelpublic String getCss()
getCss in interface LayoutModelpublic String getCssText() throws PortalException
Layouts and layout sets can configure CSS that is applied in addition to the theme's CSS.
getCssText in interface LayoutPortalExceptionpublic String getDefaultLanguageId()
getDefaultLanguageId in interface LayoutModelgetDefaultLanguageId in interface LocalizedModelpublic String getDefaultThemeSetting(String key, String device, boolean inheritLookAndFeel)
getDefaultThemeSetting in interface Layoutpublic String getDescription()
getDescription in interface LayoutModelpublic String getDescription(String languageId)
getDescription in interface LayoutModellanguageId - the ID of the languagepublic String getDescription(String languageId, boolean useDefault)
getDescription in interface LayoutModellanguageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested languagepublic String getDescription(Locale locale)
getDescription in interface LayoutModellocale - the locale of the languagepublic String getDescription(Locale locale, boolean useDefault)
getDescription in interface LayoutModellocale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.public String getDescriptionCurrentLanguageId()
getDescriptionCurrentLanguageId in interface LayoutModelpublic String getDescriptionCurrentValue()
getDescriptionCurrentValue in interface LayoutModelpublic String getFriendlyURL()
getFriendlyURL in interface LayoutModelpublic String getFriendlyURL(Locale locale)
getFriendlyURL in interface Layoutlocale - the locale that the friendly URL should be retrieved forpublic String getFriendlyURLsXML()
getFriendlyURLsXML in interface Layoutpublic String getHTMLTitle(String localeLanguageId)
getHTMLTitle in interface LayoutlocaleLanguageId - the locale that the HTML title should be
retrieved forpublic String getHTMLTitle(Locale locale)
getHTMLTitle in interface Layoutlocale - the locale that the HTML title should be retrieved forpublic String getKeywords()
getKeywords in interface LayoutModelpublic String getKeywords(String languageId)
getKeywords in interface LayoutModellanguageId - the ID of the languagepublic String getKeywords(String languageId, boolean useDefault)
getKeywords in interface LayoutModellanguageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested languagepublic String getKeywords(Locale locale)
getKeywords in interface LayoutModellocale - the locale of the languagepublic String getKeywords(Locale locale, boolean useDefault)
getKeywords in interface LayoutModellocale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.public String getKeywordsCurrentLanguageId()
getKeywordsCurrentLanguageId in interface LayoutModelpublic String getKeywordsCurrentValue()
getKeywordsCurrentValue in interface LayoutModelpublic String getLayoutPrototypeUuid()
getLayoutPrototypeUuid in interface LayoutModelpublic String getName()
getName in interface LayoutModelpublic String getName(String languageId)
getName in interface LayoutModellanguageId - the ID of the languagepublic String getName(String languageId, boolean useDefault)
getName in interface LayoutModellanguageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested languagepublic String getName(Locale locale)
getName in interface LayoutModellocale - the locale of the languagepublic String getName(Locale locale, boolean useDefault)
getName in interface LayoutModellocale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.public String getNameCurrentLanguageId()
getNameCurrentLanguageId in interface LayoutModelpublic String getNameCurrentValue()
getNameCurrentValue in interface LayoutModelpublic String getRegularURL(javax.servlet.http.HttpServletRequest request) throws PortalException
getRegularURL in interface LayoutPortalExceptionpublic String getResetLayoutURL(javax.servlet.http.HttpServletRequest request) throws PortalException
getResetLayoutURL in interface LayoutPortalExceptionpublic String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request) throws PortalException
getResetMaxStateURL in interface LayoutPortalExceptionpublic String getRobots()
getRobots in interface LayoutModelpublic String getRobots(String languageId)
getRobots in interface LayoutModellanguageId - the ID of the languagepublic String getRobots(String languageId, boolean useDefault)
getRobots in interface LayoutModellanguageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested languagepublic String getRobots(Locale locale)
getRobots in interface LayoutModellocale - the locale of the languagepublic String getRobots(Locale locale, boolean useDefault)
getRobots in interface LayoutModellocale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.public String getRobotsCurrentLanguageId()
getRobotsCurrentLanguageId in interface LayoutModelpublic String getRobotsCurrentValue()
getRobotsCurrentValue in interface LayoutModelpublic String getSourcePrototypeLayoutUuid()
getSourcePrototypeLayoutUuid in interface LayoutModelpublic String getThemeId()
getThemeId in interface LayoutModelpublic String getThemeSetting(String key, String device)
getThemeSetting in interface Layoutpublic String getThemeSetting(String key, String device, boolean inheritLookAndFeel)
getThemeSetting in interface Layoutpublic String getTitle()
getTitle in interface LayoutModelpublic String getTitle(String languageId)
getTitle in interface LayoutModellanguageId - the ID of the languagepublic String getTitle(String languageId, boolean useDefault)
getTitle in interface LayoutModellanguageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested languagepublic String getTitle(Locale locale)
getTitle in interface LayoutModellocale - the locale of the languagepublic String getTitle(Locale locale, boolean useDefault)
getTitle in interface LayoutModellocale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.public String getTitleCurrentLanguageId()
getTitleCurrentLanguageId in interface LayoutModelpublic String getTitleCurrentValue()
getTitleCurrentValue in interface LayoutModelpublic String getType()
getType in interface LayoutModelpublic String getTypeSettings()
getTypeSettings in interface LayoutModelpublic String getTypeSettingsProperty(String key)
getTypeSettingsProperty in interface Layoutpublic String getTypeSettingsProperty(String key, String defaultValue)
getTypeSettingsProperty in interface Layoutpublic String getUserName()
getUserName in interface AuditedModelgetUserName in interface LayoutModelpublic String getUserUuid()
getUserUuid in interface AuditedModelgetUserUuid in interface LayoutModelpublic String getUuid()
getUuid in interface LayoutModelgetUuid in interface StagedModelpublic String toString()
toString in interface LayoutModeltoString in class Objectpublic String toXmlString()
BaseModeltoXmlString in interface BaseModel<Layout>toXmlString in interface LayoutModelpublic String[] getAvailableLanguageIds()
getAvailableLanguageIds in interface LayoutModelgetAvailableLanguageIds in interface LocalizedModelpublic Date getCreateDate()
getCreateDate in interface AuditedModelgetCreateDate in interface LayoutModelgetCreateDate in interface StagedModelpublic Date getLastPublishDate()
getLastPublishDate in interface LayoutModelgetLastPublishDate in interface StagedGroupedModelpublic Date getModifiedDate()
getModifiedDate in interface AuditedModelgetModifiedDate in interface LayoutModelgetModifiedDate in interface StagedModelpublic List<Layout> getAllChildren()
getAllChildren in interface Layoutpublic List<Layout> getAncestors() throws PortalException
getAncestors in interface LayoutPortalExceptionpublic List<Layout> getChildren()
getChildren in interface Layoutpublic List<Layout> getChildren(PermissionChecker permissionChecker) throws PortalException
getChildren in interface LayoutpermissionChecker - the user-specific context to check permissionsPortalExceptionpublic List<Portlet> getEmbeddedPortlets()
getEmbeddedPortlets in interface Layoutpublic List<Portlet> getEmbeddedPortlets(long groupId)
getEmbeddedPortlets in interface Layoutpublic Map<Locale,String> getDescriptionMap()
getDescriptionMap in interface LayoutModelpublic Map<Locale,String> getFriendlyURLMap()
getFriendlyURLMap in interface Layoutpublic Map<Locale,String> getKeywordsMap()
getKeywordsMap in interface LayoutModelpublic Map<Locale,String> getNameMap()
getNameMap in interface LayoutModelpublic Map<Locale,String> getRobotsMap()
getRobotsMap in interface LayoutModelpublic Map<Locale,String> getTitleMap()
getTitleMap in interface LayoutModelpublic long getAncestorLayoutId()
throws PortalException
getAncestorLayoutId in interface LayoutPortalExceptionpublic long getAncestorPlid()
throws PortalException
getAncestorPlid in interface LayoutPortalExceptionpublic long getCompanyId()
getCompanyId in interface AuditedModelgetCompanyId in interface LayoutModelgetCompanyId in interface ShardedModelgetCompanyId in interface StagedModelpublic long getGroupId()
getGroupId in interface GroupedModelgetGroupId in interface LayoutModelpublic long getIconImageId()
getIconImageId in interface LayoutModelpublic long getLayoutId()
getLayoutId in interface LayoutModelpublic long getMvccVersion()
getMvccVersion in interface LayoutModelgetMvccVersion in interface MVCCModelpublic long getParentLayoutId()
getParentLayoutId in interface LayoutModelpublic long getParentPlid()
throws PortalException
getParentPlid in interface Layout0 if the
current layout is the topmost parent layoutPortalExceptionpublic long getPlid()
getPlid in interface LayoutModelpublic long getPrimaryKey()
getPrimaryKey in interface LayoutModelpublic long getUserId()
getUserId in interface AuditedModelgetUserId in interface LayoutModelpublic void persist()
PersistedModelpersist in interface PersistedModelpublic void prepareLocalizedFieldsForImport()
throws LocaleException
prepareLocalizedFieldsForImport in interface LayoutModelprepareLocalizedFieldsForImport in interface LocalizedModelLocaleExceptionpublic void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
prepareLocalizedFieldsForImport in interface LayoutModelprepareLocalizedFieldsForImport in interface LocalizedModelLocaleExceptionpublic void setCachedModel(boolean cachedModel)
BaseModelsetCachedModel in interface BaseModel<Layout>setCachedModel in interface LayoutModelcachedModel - whether this model instance was retrieved from the
entity cacheEntityCachepublic void setColorSchemeId(String colorSchemeId)
setColorSchemeId in interface LayoutModelcolorSchemeId - the color scheme ID of this layoutpublic void setCompanyId(long companyId)
setCompanyId in interface AuditedModelsetCompanyId in interface LayoutModelsetCompanyId in interface ShardedModelsetCompanyId in interface StagedModelcompanyId - the company ID of this layoutpublic void setCreateDate(Date createDate)
setCreateDate in interface AuditedModelsetCreateDate in interface LayoutModelsetCreateDate in interface StagedModelcreateDate - the create date of this layoutpublic void setCss(String css)
setCss in interface LayoutModelcss - the css of this layoutpublic void setDescription(String description)
setDescription in interface LayoutModeldescription - the description of this layoutpublic void setDescription(String description, Locale locale)
setDescription in interface LayoutModeldescription - the localized description of this layoutlocale - the locale of the languagepublic void setDescription(String description, Locale locale, Locale defaultLocale)
setDescription in interface LayoutModeldescription - the localized description of this layoutlocale - the locale of the languagedefaultLocale - the default localepublic void setDescriptionCurrentLanguageId(String languageId)
setDescriptionCurrentLanguageId in interface LayoutModelpublic void setDescriptionMap(Map<Locale,String> descriptionMap)
setDescriptionMap in interface LayoutModeldescriptionMap - the locales and localized descriptions of this layoutpublic void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
setDescriptionMap in interface LayoutModeldescriptionMap - the locales and localized descriptions of this layoutdefaultLocale - the default localepublic void setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes in interface BaseModel<Layout>setExpandoBridgeAttributes in interface LayoutModelpublic void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes in interface BaseModel<Layout>setExpandoBridgeAttributes in interface LayoutModelpublic void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModelsetExpandoBridgeAttributes in interface BaseModel<Layout>setExpandoBridgeAttributes in interface LayoutModelserviceContext - the service context to be appliedServiceContext.getExpandoBridgeAttributes()public void setFriendlyURL(String friendlyURL)
setFriendlyURL in interface LayoutModelfriendlyURL - the friendly u r l of this layoutpublic void setGroupId(long groupId)
setGroupId in interface GroupedModelsetGroupId in interface LayoutModelgroupId - the group ID of this layoutpublic void setHidden(boolean hidden)
setHidden in interface LayoutModelhidden - the hidden of this layoutpublic void setIconImageId(long iconImageId)
setIconImageId in interface LayoutModeliconImageId - the icon image ID of this layoutpublic void setKeywords(String keywords)
setKeywords in interface LayoutModelkeywords - the keywords of this layoutpublic void setKeywords(String keywords, Locale locale)
setKeywords in interface LayoutModelkeywords - the localized keywords of this layoutlocale - the locale of the languagepublic void setKeywords(String keywords, Locale locale, Locale defaultLocale)
setKeywords in interface LayoutModelkeywords - the localized keywords of this layoutlocale - the locale of the languagedefaultLocale - the default localepublic void setKeywordsCurrentLanguageId(String languageId)
setKeywordsCurrentLanguageId in interface LayoutModelpublic void setKeywordsMap(Map<Locale,String> keywordsMap)
setKeywordsMap in interface LayoutModelkeywordsMap - the locales and localized keywordses of this layoutpublic void setKeywordsMap(Map<Locale,String> keywordsMap, Locale defaultLocale)
setKeywordsMap in interface LayoutModelkeywordsMap - the locales and localized keywordses of this layoutdefaultLocale - the default localepublic void setLastPublishDate(Date lastPublishDate)
setLastPublishDate in interface LayoutModelsetLastPublishDate in interface StagedGroupedModellastPublishDate - the last publish date of this layoutpublic void setLayoutId(long layoutId)
setLayoutId in interface LayoutModellayoutId - the layout ID of this layoutpublic void setLayoutPrototypeLinkEnabled(boolean layoutPrototypeLinkEnabled)
setLayoutPrototypeLinkEnabled in interface LayoutModellayoutPrototypeLinkEnabled - the layout prototype link enabled of this layoutpublic void setLayoutPrototypeUuid(String layoutPrototypeUuid)
setLayoutPrototypeUuid in interface LayoutModellayoutPrototypeUuid - the layout prototype uuid of this layoutpublic void setLayoutSet(LayoutSet layoutSet)
setLayoutSet in interface Layoutpublic void setModifiedDate(Date modifiedDate)
setModifiedDate in interface AuditedModelsetModifiedDate in interface LayoutModelsetModifiedDate in interface StagedModelmodifiedDate - the modified date of this layoutpublic void setMvccVersion(long mvccVersion)
setMvccVersion in interface LayoutModelsetMvccVersion in interface MVCCModelmvccVersion - the mvcc version of this layoutpublic void setName(String name)
setName in interface LayoutModelname - the name of this layoutpublic void setName(String name, Locale locale)
setName in interface LayoutModelname - the localized name of this layoutlocale - the locale of the languagepublic void setName(String name, Locale locale, Locale defaultLocale)
setName in interface LayoutModelname - the localized name of this layoutlocale - the locale of the languagedefaultLocale - the default localepublic void setNameCurrentLanguageId(String languageId)
setNameCurrentLanguageId in interface LayoutModelpublic void setNameMap(Map<Locale,String> nameMap)
setNameMap in interface LayoutModelnameMap - the locales and localized names of this layoutpublic void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
setNameMap in interface LayoutModelnameMap - the locales and localized names of this layoutdefaultLocale - the default localepublic void setNew(boolean n)
BaseModelsetNew in interface BaseModel<Layout>setNew in interface LayoutModeln - whether this model instance does not yet exist in the databasepublic void setParentLayoutId(long parentLayoutId)
setParentLayoutId in interface LayoutModelparentLayoutId - the parent layout ID of this layoutpublic void setPlid(long plid)
setPlid in interface LayoutModelplid - the plid of this layoutpublic void setPrimaryKey(long primaryKey)
setPrimaryKey in interface LayoutModelprimaryKey - the primary key of this layoutpublic void setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModelsetPrimaryKeyObj in interface BaseModel<Layout>setPrimaryKeyObj in interface ClassedModelsetPrimaryKeyObj in interface LayoutModelprimaryKeyObj - the primary key of this model instancepublic void setPriority(int priority)
setPriority in interface LayoutModelpriority - the priority of this layoutpublic void setPrivateLayout(boolean privateLayout)
setPrivateLayout in interface LayoutModelprivateLayout - the private layout of this layoutpublic void setRobots(String robots)
setRobots in interface LayoutModelrobots - the robots of this layoutpublic void setRobots(String robots, Locale locale)
setRobots in interface LayoutModelrobots - the localized robots of this layoutlocale - the locale of the languagepublic void setRobots(String robots, Locale locale, Locale defaultLocale)
setRobots in interface LayoutModelrobots - the localized robots of this layoutlocale - the locale of the languagedefaultLocale - the default localepublic void setRobotsCurrentLanguageId(String languageId)
setRobotsCurrentLanguageId in interface LayoutModelpublic void setRobotsMap(Map<Locale,String> robotsMap)
setRobotsMap in interface LayoutModelrobotsMap - the locales and localized robotses of this layoutpublic void setRobotsMap(Map<Locale,String> robotsMap, Locale defaultLocale)
setRobotsMap in interface LayoutModelrobotsMap - the locales and localized robotses of this layoutdefaultLocale - the default localepublic void setSourcePrototypeLayoutUuid(String sourcePrototypeLayoutUuid)
setSourcePrototypeLayoutUuid in interface LayoutModelsourcePrototypeLayoutUuid - the source prototype layout uuid of this layoutpublic void setThemeId(String themeId)
setThemeId in interface LayoutModelthemeId - the theme ID of this layoutpublic void setTitle(String title)
setTitle in interface LayoutModeltitle - the title of this layoutpublic void setTitle(String title, Locale locale)
setTitle in interface LayoutModeltitle - the localized title of this layoutlocale - the locale of the languagepublic void setTitle(String title, Locale locale, Locale defaultLocale)
setTitle in interface LayoutModeltitle - the localized title of this layoutlocale - the locale of the languagedefaultLocale - the default localepublic void setTitleCurrentLanguageId(String languageId)
setTitleCurrentLanguageId in interface LayoutModelpublic void setTitleMap(Map<Locale,String> titleMap)
setTitleMap in interface LayoutModeltitleMap - the locales and localized titles of this layoutpublic void setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)
setTitleMap in interface LayoutModeltitleMap - the locales and localized titles of this layoutdefaultLocale - the default localepublic void setType(String type)
setType in interface LayoutModeltype - the type of this layoutpublic void setTypeSettings(String typeSettings)
setTypeSettings in interface LayoutModeltypeSettings - the type settings of this layoutpublic void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
setTypeSettingsProperties in interface Layoutpublic void setUserId(long userId)
setUserId in interface AuditedModelsetUserId in interface LayoutModeluserId - the user ID of this layoutpublic void setUserName(String userName)
setUserName in interface AuditedModelsetUserName in interface LayoutModeluserName - the user name of this layoutpublic void setUserUuid(String userUuid)
setUserUuid in interface AuditedModelsetUserUuid in interface LayoutModeluserUuid - the user uuid of this layoutpublic void setUuid(String uuid)
setUuid in interface LayoutModelsetUuid in interface StagedModeluuid - the uuid of this layoutpublic StagedModelType getStagedModelType()
getStagedModelType in interface StagedModelpublic Layout getWrappedModel()
getWrappedModel in interface ModelWrapper<Layout>public boolean isEntityCacheEnabled()
BaseModeltrue if this model's entity cache is enabled.isEntityCacheEnabled in interface BaseModel<Layout>true if this model's entity cache is enabled;
false otherwisepublic boolean isFinderCacheEnabled()
BaseModeltrue if this model's finder cache is enabled.isFinderCacheEnabled in interface BaseModel<Layout>true if this model's finder cache is enabled;
false otherwisepublic void resetOriginalValues()
BaseModelresetOriginalValues in interface BaseModel<Layout>