|
Liferay 6.0.6 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.liferay.portal.model.LayoutWrapper
public class LayoutWrapper
This class is a wrapper for Layout
.
Layout
,
Serialized FormConstructor Summary | |
---|---|
LayoutWrapper(Layout layout)
|
Method Summary | |
---|---|
Object |
clone()
Creates a shallow clone of this model instance. |
int |
compareTo(Layout layout)
|
List<Layout> |
getAllChildren()
|
long |
getAncestorLayoutId()
|
long |
getAncestorPlid()
|
List<Layout> |
getAncestors()
|
List<Layout> |
getChildren()
|
List<Layout> |
getChildren(PermissionChecker permissionChecker)
|
ColorScheme |
getColorScheme()
|
String |
getColorSchemeId()
Gets the color scheme id of this layout. |
long |
getCompanyId()
Gets the company id of this layout. |
String |
getCss()
Gets the css of this layout. |
String |
getCssText()
|
String |
getDescription()
Gets the description of this layout. |
long |
getDlFolderId()
Gets the dl folder id of this layout. |
ExpandoBridge |
getExpandoBridge()
Gets the expando bridge for this model instance. |
String |
getFriendlyURL()
Gets the friendly u r l of this layout. |
Group |
getGroup()
|
long |
getGroupId()
Gets the group id of this layout. |
boolean |
getHidden()
Gets the hidden of this layout. |
String |
getHTMLTitle(Locale locale)
|
String |
getHTMLTitle(String localeLanguageId)
|
boolean |
getIconImage()
Gets the icon image of this layout. |
long |
getIconImageId()
Gets the icon image id of this layout. |
long |
getLayoutId()
Gets the layout id of this layout. |
long |
getLayoutPrototypeId()
Gets the layout prototype id of this layout. |
LayoutSet |
getLayoutSet()
|
LayoutType |
getLayoutType()
|
String |
getName()
Gets the name of this layout. |
String |
getName(Locale locale)
|
String |
getName(Locale locale,
boolean useDefault)
|
String |
getName(String localeLanguageId)
|
String |
getName(String localeLanguageId,
boolean useDefault)
|
long |
getParentLayoutId()
Gets the parent layout id of this layout. |
long |
getParentPlid()
|
long |
getPlid()
Gets the plid of this layout. |
long |
getPrimaryKey()
Gets the primary key of this layout. |
Serializable |
getPrimaryKeyObj()
Gets the primary key of this model instance. |
int |
getPriority()
Gets the priority of this layout. |
boolean |
getPrivateLayout()
Gets 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)
|
Group |
getScopeGroup()
|
String |
getTarget()
|
Theme |
getTheme()
|
String |
getThemeId()
Gets the theme id of this layout. |
String |
getTitle()
Gets the title of this layout. |
String |
getTitle(Locale locale)
|
String |
getTitle(Locale locale,
boolean useDefault)
|
String |
getTitle(String localeLanguageId)
|
String |
getTitle(String localeLanguageId,
boolean useDefault)
|
String |
getType()
Gets the type of this layout. |
String |
getTypeSettings()
Gets the type settings of this layout. |
UnicodeProperties |
getTypeSettingsProperties()
|
String |
getUuid()
Gets the uuid of this layout. |
ColorScheme |
getWapColorScheme()
|
String |
getWapColorSchemeId()
Gets the wap color scheme id of this layout. |
Theme |
getWapTheme()
|
String |
getWapThemeId()
Gets the wap theme id of this layout. |
Layout |
getWrappedLayout()
|
boolean |
hasAncestor(long layoutId)
|
boolean |
hasChildren()
|
int |
hashCode()
|
boolean |
hasScopeGroup()
|
boolean |
isCachedModel()
Determines if this model instance was retrieved from the entity cache. |
boolean |
isChildSelected(boolean selectable,
Layout layout)
|
boolean |
isEscapedModel()
Determines if this model instance is escaped. |
boolean |
isFirstChild()
|
boolean |
isFirstParent()
|
boolean |
isHidden()
Determines if this layout is hidden. |
boolean |
isIconImage()
Determines if this layout is icon image. |
boolean |
isInheritLookAndFeel()
|
boolean |
isInheritWapLookAndFeel()
|
boolean |
isNew()
Determines if this model instance does not yet exist in the database. |
boolean |
isPrivateLayout()
Determines if this layout is private layout. |
boolean |
isPublicLayout()
|
boolean |
isRootLayout()
|
boolean |
isSelected(boolean selectable,
Layout layout,
long ancestorPlid)
|
boolean |
isTypeArticle()
|
boolean |
isTypeControlPanel()
|
boolean |
isTypeEmbedded()
|
boolean |
isTypeLinkToLayout()
|
boolean |
isTypePanel()
|
boolean |
isTypePortlet()
|
boolean |
isTypeURL()
|
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 |
setCss(String css)
Sets the css of this layout. |
void |
setDescription(String description)
Sets the description of this layout. |
void |
setDlFolderId(long dlFolderId)
Sets the dl folder id of this layout. |
void |
setEscapedModel(boolean escapedModel)
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe. |
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 {$entity.humanName} is hidden. |
void |
setIconImage(boolean iconImage)
Sets whether this {$entity.humanName} is icon image. |
void |
setIconImageId(long iconImageId)
Sets the icon image id of this layout. |
void |
setLayoutId(long layoutId)
Sets the layout id of this layout. |
void |
setLayoutPrototypeId(long layoutPrototypeId)
Sets the layout prototype id of this layout. |
void |
setName(String name)
Sets the name of this layout. |
void |
setName(String name,
Locale 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 pk)
Sets the primary key of this layout |
void |
setPriority(int priority)
Sets the priority of this layout. |
void |
setPrivateLayout(boolean privateLayout)
Sets whether this {$entity.humanName} is private 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)
|
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 |
setUuid(String uuid)
Sets the uuid of this layout. |
void |
setWapColorSchemeId(String wapColorSchemeId)
Sets the wap color scheme id of this layout. |
void |
setWapThemeId(String wapThemeId)
Sets the wap theme id of this layout. |
Layout |
toEscapedModel()
Gets a copy of this layout as an escaped model instance by wrapping it with an AutoEscapeBeanHandler . |
String |
toString()
|
String |
toXmlString()
Gets the XML representation of this model instance. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LayoutWrapper(Layout layout)
Method Detail |
---|
public long getPrimaryKey()
LayoutModel
getPrimaryKey
in interface LayoutModel
public void setPrimaryKey(long pk)
LayoutModel
setPrimaryKey
in interface LayoutModel
pk
- the primary key of this layoutpublic String getUuid()
LayoutModel
getUuid
in interface LayoutModel
public void setUuid(String uuid)
LayoutModel
setUuid
in interface LayoutModel
uuid
- the uuid of this layoutpublic long getPlid()
LayoutModel
getPlid
in interface LayoutModel
public void setPlid(long plid)
LayoutModel
setPlid
in interface LayoutModel
plid
- the plid of this layoutpublic long getGroupId()
LayoutModel
getGroupId
in interface LayoutModel
public void setGroupId(long groupId)
LayoutModel
setGroupId
in interface LayoutModel
groupId
- the group id of this layoutpublic long getCompanyId()
LayoutModel
getCompanyId
in interface LayoutModel
public void setCompanyId(long companyId)
LayoutModel
setCompanyId
in interface LayoutModel
companyId
- the company id of this layoutpublic boolean getPrivateLayout()
LayoutModel
getPrivateLayout
in interface LayoutModel
public boolean isPrivateLayout()
LayoutModel
isPrivateLayout
in interface LayoutModel
true
if this layout is private layout; false
otherwisepublic void setPrivateLayout(boolean privateLayout)
LayoutModel
setPrivateLayout
in interface LayoutModel
privateLayout
- the private layout of this layoutpublic long getLayoutId()
LayoutModel
getLayoutId
in interface LayoutModel
public void setLayoutId(long layoutId)
LayoutModel
setLayoutId
in interface LayoutModel
layoutId
- the layout id of this layoutpublic long getParentLayoutId()
LayoutModel
getParentLayoutId
in interface LayoutModel
public void setParentLayoutId(long parentLayoutId)
LayoutModel
setParentLayoutId
in interface LayoutModel
parentLayoutId
- the parent layout id of this layoutpublic String getName()
LayoutModel
getName
in interface LayoutModel
public void setName(String name)
LayoutModel
setName
in interface LayoutModel
name
- the name of this layoutpublic String getTitle()
LayoutModel
getTitle
in interface LayoutModel
public void setTitle(String title)
LayoutModel
setTitle
in interface LayoutModel
title
- the title of this layoutpublic String getDescription()
LayoutModel
getDescription
in interface LayoutModel
public void setDescription(String description)
LayoutModel
setDescription
in interface LayoutModel
description
- the description of this layoutpublic String getType()
LayoutModel
getType
in interface LayoutModel
public void setType(String type)
LayoutModel
setType
in interface LayoutModel
type
- the type of this layoutpublic String getTypeSettings()
LayoutModel
getTypeSettings
in interface Layout
getTypeSettings
in interface LayoutModel
public void setTypeSettings(String typeSettings)
LayoutModel
setTypeSettings
in interface Layout
setTypeSettings
in interface LayoutModel
typeSettings
- the type settings of this layoutpublic boolean getHidden()
LayoutModel
getHidden
in interface LayoutModel
public boolean isHidden()
LayoutModel
isHidden
in interface LayoutModel
true
if this layout is hidden; false
otherwisepublic void setHidden(boolean hidden)
LayoutModel
setHidden
in interface LayoutModel
hidden
- the hidden of this layoutpublic String getFriendlyURL()
LayoutModel
getFriendlyURL
in interface LayoutModel
public void setFriendlyURL(String friendlyURL)
LayoutModel
setFriendlyURL
in interface LayoutModel
friendlyURL
- the friendly u r l of this layoutpublic boolean getIconImage()
LayoutModel
getIconImage
in interface LayoutModel
public boolean isIconImage()
LayoutModel
isIconImage
in interface LayoutModel
true
if this layout is icon image; false
otherwisepublic void setIconImage(boolean iconImage)
LayoutModel
setIconImage
in interface LayoutModel
iconImage
- the icon image of this layoutpublic long getIconImageId()
LayoutModel
getIconImageId
in interface LayoutModel
public void setIconImageId(long iconImageId)
LayoutModel
setIconImageId
in interface LayoutModel
iconImageId
- the icon image id of this layoutpublic String getThemeId()
LayoutModel
getThemeId
in interface LayoutModel
public void setThemeId(String themeId)
LayoutModel
setThemeId
in interface LayoutModel
themeId
- the theme id of this layoutpublic String getColorSchemeId()
LayoutModel
getColorSchemeId
in interface LayoutModel
public void setColorSchemeId(String colorSchemeId)
LayoutModel
setColorSchemeId
in interface LayoutModel
colorSchemeId
- the color scheme id of this layoutpublic String getWapThemeId()
LayoutModel
getWapThemeId
in interface LayoutModel
public void setWapThemeId(String wapThemeId)
LayoutModel
setWapThemeId
in interface LayoutModel
wapThemeId
- the wap theme id of this layoutpublic String getWapColorSchemeId()
LayoutModel
getWapColorSchemeId
in interface LayoutModel
public void setWapColorSchemeId(String wapColorSchemeId)
LayoutModel
setWapColorSchemeId
in interface LayoutModel
wapColorSchemeId
- the wap color scheme id of this layoutpublic String getCss()
LayoutModel
getCss
in interface LayoutModel
public void setCss(String css)
LayoutModel
setCss
in interface LayoutModel
css
- the css of this layoutpublic int getPriority()
LayoutModel
getPriority
in interface LayoutModel
public void setPriority(int priority)
LayoutModel
setPriority
in interface LayoutModel
priority
- the priority of this layoutpublic long getLayoutPrototypeId()
LayoutModel
getLayoutPrototypeId
in interface LayoutModel
public void setLayoutPrototypeId(long layoutPrototypeId)
LayoutModel
setLayoutPrototypeId
in interface LayoutModel
layoutPrototypeId
- the layout prototype id of this layoutpublic long getDlFolderId()
LayoutModel
getDlFolderId
in interface LayoutModel
public void setDlFolderId(long dlFolderId)
LayoutModel
setDlFolderId
in interface LayoutModel
dlFolderId
- the dl folder id of this layoutpublic Layout toEscapedModel()
LayoutModel
AutoEscapeBeanHandler
.
toEscapedModel
in interface LayoutModel
AutoEscapeBeanHandler
public boolean isNew()
BaseModel
isNew
in interface BaseModel<Layout>
isNew
in interface LayoutModel
true
if this model instance does not yet exist in
the database; false
otherwisepublic void setNew(boolean n)
BaseModel
setNew
in interface BaseModel<Layout>
setNew
in interface LayoutModel
n
- whether this model instance does not yet exist in the databasepublic boolean isCachedModel()
BaseModel
isCachedModel
in interface BaseModel<Layout>
isCachedModel
in interface LayoutModel
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
public void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<Layout>
setCachedModel
in interface LayoutModel
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
public boolean isEscapedModel()
BaseModel
isEscapedModel
in interface BaseModel<Layout>
isEscapedModel
in interface LayoutModel
true
if this model instance is escaped;
false
otherwiseBaseModel.setEscapedModel(boolean)
public void setEscapedModel(boolean escapedModel)
BaseModel
A model instance can be made escaped by wrapping it with an HTML auto
escape handler using its toEscapedModel
method. For example,
UserModel.toEscapedModel()
.
setEscapedModel
in interface BaseModel<Layout>
setEscapedModel
in interface LayoutModel
escapedModel
- whether this model instance is escapedAutoEscapeBeanHandler
public Serializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<Layout>
getPrimaryKeyObj
in interface LayoutModel
public ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<Layout>
getExpandoBridge
in interface LayoutModel
public void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<Layout>
setExpandoBridgeAttributes
in interface LayoutModel
serviceContext
- the service context to retrieve the expando bridge
attributes fromServiceContext.getExpandoBridgeAttributes(
)
public Object clone()
BaseModel
clone
in interface BaseModel<Layout>
clone
in interface LayoutModel
clone
in class Object
public int compareTo(Layout layout)
compareTo
in interface LayoutModel
compareTo
in interface Comparable<Layout>
public int hashCode()
hashCode
in interface LayoutModel
hashCode
in class Object
public String toString()
toString
in interface LayoutModel
toString
in class Object
public String toXmlString()
BaseModel
toXmlString
in interface BaseModel<Layout>
toXmlString
in interface LayoutModel
public List<Layout> getAllChildren() throws SystemException
getAllChildren
in interface Layout
SystemException
public long getAncestorLayoutId() throws PortalException, SystemException
getAncestorLayoutId
in interface Layout
PortalException
SystemException
public long getAncestorPlid() throws PortalException, SystemException
getAncestorPlid
in interface Layout
PortalException
SystemException
public List<Layout> getAncestors() throws PortalException, SystemException
getAncestors
in interface Layout
PortalException
SystemException
public List<Layout> getChildren() throws SystemException
getChildren
in interface Layout
SystemException
public List<Layout> getChildren(PermissionChecker permissionChecker) throws PortalException, SystemException
getChildren
in interface Layout
PortalException
SystemException
public ColorScheme getColorScheme() throws PortalException, SystemException
getColorScheme
in interface Layout
PortalException
SystemException
public String getCssText() throws PortalException, SystemException
getCssText
in interface Layout
PortalException
SystemException
public Group getGroup() throws PortalException, SystemException
getGroup
in interface Layout
PortalException
SystemException
public String getHTMLTitle(Locale locale)
getHTMLTitle
in interface Layout
public String getHTMLTitle(String localeLanguageId)
getHTMLTitle
in interface Layout
public LayoutSet getLayoutSet() throws PortalException, SystemException
getLayoutSet
in interface Layout
PortalException
SystemException
public LayoutType getLayoutType()
getLayoutType
in interface Layout
public String getName(Locale locale)
getName
in interface Layout
public String getName(Locale locale, boolean useDefault)
getName
in interface Layout
public String getName(String localeLanguageId)
getName
in interface Layout
public String getName(String localeLanguageId, boolean useDefault)
getName
in interface Layout
public long getParentPlid() throws PortalException, SystemException
getParentPlid
in interface Layout
PortalException
SystemException
public String getRegularURL(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
getRegularURL
in interface Layout
PortalException
SystemException
public String getResetLayoutURL(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
getResetLayoutURL
in interface Layout
PortalException
SystemException
public String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
getResetMaxStateURL
in interface Layout
PortalException
SystemException
public Group getScopeGroup() throws PortalException, SystemException
getScopeGroup
in interface Layout
PortalException
SystemException
public String getTarget()
getTarget
in interface Layout
public Theme getTheme() throws PortalException, SystemException
getTheme
in interface Layout
PortalException
SystemException
public String getTitle(Locale locale)
getTitle
in interface Layout
public String getTitle(Locale locale, boolean useDefault)
getTitle
in interface Layout
public String getTitle(String localeLanguageId)
getTitle
in interface Layout
public String getTitle(String localeLanguageId, boolean useDefault)
getTitle
in interface Layout
public UnicodeProperties getTypeSettingsProperties()
getTypeSettingsProperties
in interface Layout
public ColorScheme getWapColorScheme() throws PortalException, SystemException
getWapColorScheme
in interface Layout
PortalException
SystemException
public Theme getWapTheme() throws PortalException, SystemException
getWapTheme
in interface Layout
PortalException
SystemException
public boolean hasAncestor(long layoutId) throws PortalException, SystemException
hasAncestor
in interface Layout
PortalException
SystemException
public boolean hasChildren() throws SystemException
hasChildren
in interface Layout
SystemException
public boolean hasScopeGroup() throws PortalException, SystemException
hasScopeGroup
in interface Layout
PortalException
SystemException
public boolean isChildSelected(boolean selectable, Layout layout) throws PortalException, SystemException
isChildSelected
in interface Layout
PortalException
SystemException
public boolean isFirstChild()
isFirstChild
in interface Layout
public boolean isFirstParent()
isFirstParent
in interface Layout
public boolean isInheritLookAndFeel()
isInheritLookAndFeel
in interface Layout
public boolean isInheritWapLookAndFeel()
isInheritWapLookAndFeel
in interface Layout
public boolean isPublicLayout()
isPublicLayout
in interface Layout
public boolean isRootLayout()
isRootLayout
in interface Layout
public boolean isSelected(boolean selectable, Layout layout, long ancestorPlid)
isSelected
in interface Layout
public boolean isTypeArticle()
isTypeArticle
in interface Layout
public boolean isTypeControlPanel()
isTypeControlPanel
in interface Layout
public boolean isTypeEmbedded()
isTypeEmbedded
in interface Layout
public boolean isTypeLinkToLayout()
isTypeLinkToLayout
in interface Layout
public boolean isTypePanel()
isTypePanel
in interface Layout
public boolean isTypePortlet()
isTypePortlet
in interface Layout
public boolean isTypeURL()
isTypeURL
in interface Layout
public void setName(String name, Locale locale)
setName
in interface Layout
public void setTitle(String title, Locale locale)
setTitle
in interface Layout
public void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
setTypeSettingsProperties
in interface Layout
public Layout getWrappedLayout()
|
Liferay 6.0.6 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |