com.liferay.portal.model
Interface Layout

All Superinterfaces:

BaseModel, java.lang.Cloneable, java.lang.Comparable, LayoutModel, java.io.Serializable

public interface Layout
extends LayoutModel

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This interface is a model that represents the Layout table in the database.

Customize com.liferay.portal.model.impl.LayoutImpl and rerun the ServiceBuilder to generate the new methods.

Author:

Brian Wing Shun Chan

See Also:

LayoutModel, LayoutImpl, LayoutModelImpl

Method Summary

java.util.List<Layout>	getAllChildren()
long	getAncestorLayoutId()
long	getAncestorPlid()
java.util.List<Layout>	getAncestors()
java.util.List<Layout>	getChildren()
java.util.List<Layout>	getChildren(PermissionChecker permissionChecker)
ColorScheme	getColorScheme()
java.lang.String	getCssText()
Group	getGroup()
java.lang.String	getHTMLTitle(java.util.Locale locale)
java.lang.String	getHTMLTitle(java.lang.String localeLanguageId)
LayoutSet	getLayoutSet()
LayoutType	getLayoutType()
java.lang.String	getName(java.util.Locale locale)
java.lang.String	getName(java.util.Locale locale, boolean useDefault)
java.lang.String	getName(java.lang.String localeLanguageId)
java.lang.String	getName(java.lang.String localeLanguageId, boolean useDefault)
java.lang.String	getRegularURL(javax.servlet.http.HttpServletRequest request)
java.lang.String	getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
java.lang.String	getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
Group	getScopeGroup()
java.lang.String	getTarget()
Theme	getTheme()
java.lang.String	getTitle(java.util.Locale locale)
java.lang.String	getTitle(java.util.Locale locale, boolean useDefault)
java.lang.String	getTitle(java.lang.String localeLanguageId)
java.lang.String	getTitle(java.lang.String localeLanguageId, boolean useDefault)
java.lang.String	getTypeSettings()
com.liferay.portal.kernel.util.UnicodeProperties	getTypeSettingsProperties()
ColorScheme	getWapColorScheme()
Theme	getWapTheme()
boolean	hasAncestor(long layoutId)
boolean	hasScopeGroup()
boolean	isFirstChild()
boolean	isFirstParent()
boolean	isInheritLookAndFeel()
boolean	isInheritWapLookAndFeel()
boolean	isPublicLayout()
boolean	isRootLayout()
boolean	isSelected(boolean selectable, Layout layout, long ancestorPlid)
void	setName(java.lang.String name, java.util.Locale locale)
void	setTitle(java.lang.String title, java.util.Locale locale)
void	setTypeSettings(java.lang.String typeSettings)
void	setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)

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

getColorSchemeId, getCompanyId, getCss, getDescription, getDlFolderId, getFriendlyURL, getGroupId, getHidden, getIconImage, getIconImageId, getLayoutId, getName, getParentLayoutId, getPlid, getPrimaryKey, getPriority, getPrivateLayout, getThemeId, getTitle, getType, getWapColorSchemeId, getWapThemeId, isHidden, isIconImage, isPrivateLayout, setColorSchemeId, setCompanyId, setCss, setDescription, setDlFolderId, setFriendlyURL, setGroupId, setHidden, setIconImage, setIconImageId, setLayoutId, setName, setParentLayoutId, setPlid, setPrimaryKey, setPriority, setPrivateLayout, setThemeId, setTitle, setType, setWapColorSchemeId, setWapThemeId, toEscapedModel

Methods inherited from interface com.liferay.portal.model.BaseModel

clone, getExpandoBridge, getPrimaryKeyObj, isEscapedModel, isNew, setEscapedModel, setNew

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getGroup

Group getGroup()

getScopeGroup

Group getScopeGroup()
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

hasScopeGroup

boolean hasScopeGroup()
                      throws com.liferay.portal.PortalException,
                             com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

isPublicLayout

boolean isPublicLayout()

getAncestorPlid

long getAncestorPlid()

getAncestorLayoutId

long getAncestorLayoutId()

getAncestors

java.util.List<Layout> getAncestors()
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

hasAncestor

boolean hasAncestor(long layoutId)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

isFirstParent

boolean isFirstParent()

isFirstChild

boolean isFirstChild()

isRootLayout

boolean isRootLayout()

getChildren

java.util.List<Layout> getChildren()
                                   throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getAllChildren

java.util.List<Layout> getAllChildren()
                                      throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getChildren

java.util.List<Layout> getChildren(PermissionChecker permissionChecker)
                                   throws com.liferay.portal.PortalException,
                                          com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getName

java.lang.String getName(java.util.Locale locale)

getName

java.lang.String getName(java.lang.String localeLanguageId)

getName

java.lang.String getName(java.util.Locale locale,
                         boolean useDefault)

getName

java.lang.String getName(java.lang.String localeLanguageId,
                         boolean useDefault)

setName

void setName(java.lang.String name,
             java.util.Locale locale)

getTitle

java.lang.String getTitle(java.util.Locale locale)

getTitle

java.lang.String getTitle(java.lang.String localeLanguageId)

getTitle

java.lang.String getTitle(java.util.Locale locale,
                          boolean useDefault)

getTitle

java.lang.String getTitle(java.lang.String localeLanguageId,
                          boolean useDefault)

getHTMLTitle

java.lang.String getHTMLTitle(java.util.Locale locale)

getHTMLTitle

java.lang.String getHTMLTitle(java.lang.String localeLanguageId)

setTitle

void setTitle(java.lang.String title,
              java.util.Locale locale)

getLayoutType

LayoutType getLayoutType()

getTypeSettings

java.lang.String getTypeSettings()

Specified by:

getTypeSettings in interface LayoutModel

setTypeSettings

void setTypeSettings(java.lang.String typeSettings)

Specified by:

setTypeSettings in interface LayoutModel

getTypeSettingsProperties

com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties()

setTypeSettingsProperties

void setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)

getLayoutSet

LayoutSet getLayoutSet()

isInheritLookAndFeel

boolean isInheritLookAndFeel()

getTheme

Theme getTheme()

getColorScheme

ColorScheme getColorScheme()

isInheritWapLookAndFeel

boolean isInheritWapLookAndFeel()

getWapTheme

Theme getWapTheme()

getWapColorScheme

ColorScheme getWapColorScheme()

getCssText

java.lang.String getCssText()

getRegularURL

java.lang.String getRegularURL(javax.servlet.http.HttpServletRequest request)
                               throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getResetMaxStateURL

java.lang.String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
                                     throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getResetLayoutURL

java.lang.String getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
                                   throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getTarget

java.lang.String getTarget()

isSelected

boolean isSelected(boolean selectable,
                   Layout layout,
                   long ancestorPlid)