com.liferay.portal.model.impl
Class LayoutImpl

java.lang.Object
  extended bycom.liferay.portal.model.impl.BaseModelImpl
      extended bycom.liferay.portal.model.impl.LayoutModelImpl
          extended bycom.liferay.portal.model.impl.LayoutImpl
All Implemented Interfaces:
com.liferay.portal.model.BaseModel, java.lang.Cloneable, java.lang.Comparable, com.liferay.portal.model.Layout, com.liferay.portal.model.LayoutModel, java.io.Serializable

public class LayoutImpl
extends LayoutModelImpl
implements com.liferay.portal.model.Layout

View Source

Author:
Brian Wing Shun Chan
See Also:
Serialized Form

Field Summary
static long DEFAULT_PARENT_LAYOUT_ID
           
static long DEFAULT_PLID
           
static java.lang.String TYPE_ARTICLE
           
static java.lang.String TYPE_EMBEDDED
           
static java.lang.String TYPE_PORTLET
           
static java.lang.String TYPE_URL
           
static java.lang.String[] TYPES
           
 
Fields inherited from class com.liferay.portal.model.impl.LayoutModelImpl
LOCK_EXPIRATION_TIME, TABLE_COLUMNS, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, XSS_ALLOW_BY_MODEL, XSS_ALLOW_COLORSCHEMEID, XSS_ALLOW_CSS, XSS_ALLOW_DESCRIPTION, XSS_ALLOW_FRIENDLYURL, XSS_ALLOW_NAME, XSS_ALLOW_THEMEID, XSS_ALLOW_TITLE, XSS_ALLOW_TYPE, XSS_ALLOW_TYPESETTINGS, XSS_ALLOW_WAPCOLORSCHEMEID, XSS_ALLOW_WAPTHEMEID
 
Fields inherited from class com.liferay.portal.model.impl.BaseModelImpl
XSS_ALLOW
 
Constructor Summary
LayoutImpl()
           
 
Method Summary
 long getAncestorLayoutId()
           
 long getAncestorPlid()
           
 java.util.List getAncestors()
           
 java.util.List getChildren()
           
 java.util.List getChildren(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker)
           
 com.liferay.portal.model.ColorScheme getColorScheme()
           
 java.lang.String getCssText()
           
 java.lang.String getDefaultFriendlyURL()
           
 com.liferay.portal.model.Group getGroup()
           
 java.lang.String getHTMLTitle(java.util.Locale locale)
           
 java.lang.String getHTMLTitle(java.lang.String localeLanguageId)
           
 com.liferay.portal.model.LayoutSet getLayoutSet()
           
 com.liferay.portal.model.LayoutType getLayoutType()
           
 java.lang.String getName(java.util.Locale locale)
           
 java.lang.String getName(java.lang.String localeLanguageId)
           
 java.lang.String getRegularURL(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getResetLayoutURL(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getResetMaxStateURL(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getTarget()
           
 com.liferay.portal.model.Theme getTheme()
           
 java.lang.String getTitle(java.util.Locale locale)
           
 java.lang.String getTitle(java.lang.String localeLanguageId)
           
 java.lang.String getTypeSettings()
           
 java.util.Properties getTypeSettingsProperties()
           
 com.liferay.portal.model.ColorScheme getWapColorScheme()
           
 com.liferay.portal.model.Theme getWapTheme()
           
 boolean hasAncestor(long layoutId)
           
 boolean isFirstChild()
           
 boolean isFirstParent()
           
 boolean isInheritLookAndFeel()
           
 boolean isInheritWapLookAndFeel()
           
 boolean isRootLayout()
           
 boolean isSelected(boolean selectable, com.liferay.portal.model.Layout layout, long ancestorPlid)
           
 boolean isShared()
          Deprecated. Will always return true.
 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(java.util.Properties typeSettingsProperties)
           
static int validateFriendlyURL(java.lang.String friendlyURL)
           
static void validateFriendlyURLKeyword(java.lang.String friendlyURL)
           
 
Methods inherited from class com.liferay.portal.model.impl.LayoutModelImpl
clone, compareTo, equals, getColorSchemeId, getCompanyId, getCss, getDescription, getDlFolderId, getFriendlyURL, getGroupId, getHidden, getIconImage, getIconImageId, getLayoutId, getName, getParentLayoutId, getPlid, getPrimaryKey, getPrimaryKeyObj, getPriority, getPrivateLayout, getThemeId, getTitle, getType, getWapColorSchemeId, getWapThemeId, hashCode, 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
 
Methods inherited from class com.liferay.portal.model.impl.BaseModelImpl
isNew, setNew
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
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
 
Methods inherited from interface com.liferay.portal.model.BaseModel
clone, getPrimaryKeyObj, isNew, setNew
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

DEFAULT_PLID

public static final long DEFAULT_PLID
See Also:
Constant Field Values

DEFAULT_PARENT_LAYOUT_ID

public static final long DEFAULT_PARENT_LAYOUT_ID
See Also:
Constant Field Values

TYPES

public static final java.lang.String[] TYPES

TYPE_PORTLET

public static final java.lang.String TYPE_PORTLET
See Also:
Constant Field Values

TYPE_EMBEDDED

public static final java.lang.String TYPE_EMBEDDED
See Also:
Constant Field Values

TYPE_URL

public static final java.lang.String TYPE_URL
See Also:
Constant Field Values

TYPE_ARTICLE

public static final java.lang.String TYPE_ARTICLE
See Also:
Constant Field Values
Constructor Detail

LayoutImpl

public LayoutImpl()
Method Detail

validateFriendlyURL

public static int validateFriendlyURL(java.lang.String friendlyURL)

validateFriendlyURLKeyword

public static void validateFriendlyURLKeyword(java.lang.String friendlyURL)
                                       throws com.liferay.portal.LayoutFriendlyURLException
Throws:
com.liferay.portal.LayoutFriendlyURLException

getGroup

public com.liferay.portal.model.Group getGroup()
Specified by:
getGroup in interface com.liferay.portal.model.Layout

isShared

public boolean isShared()
Deprecated. Will always return true.

Specified by:
isShared in interface com.liferay.portal.model.Layout

getAncestorPlid

public long getAncestorPlid()
Specified by:
getAncestorPlid in interface com.liferay.portal.model.Layout

getAncestorLayoutId

public long getAncestorLayoutId()
Specified by:
getAncestorLayoutId in interface com.liferay.portal.model.Layout

getAncestors

public java.util.List getAncestors()
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException
Specified by:
getAncestors in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

hasAncestor

public boolean hasAncestor(long layoutId)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException
Specified by:
hasAncestor in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

isFirstParent

public boolean isFirstParent()
Specified by:
isFirstParent in interface com.liferay.portal.model.Layout

isFirstChild

public boolean isFirstChild()
Specified by:
isFirstChild in interface com.liferay.portal.model.Layout

isRootLayout

public boolean isRootLayout()
Specified by:
isRootLayout in interface com.liferay.portal.model.Layout

getChildren

public java.util.List getChildren()
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException
Specified by:
getChildren in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getChildren

public java.util.List getChildren(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException
Specified by:
getChildren in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getName

public java.lang.String getName(java.util.Locale locale)
Specified by:
getName in interface com.liferay.portal.model.Layout

getName

public java.lang.String getName(java.lang.String localeLanguageId)
Specified by:
getName in interface com.liferay.portal.model.Layout

setName

public void setName(java.lang.String name,
                    java.util.Locale locale)
Specified by:
setName in interface com.liferay.portal.model.Layout

getTitle

public java.lang.String getTitle(java.util.Locale locale)
Specified by:
getTitle in interface com.liferay.portal.model.Layout

getTitle

public java.lang.String getTitle(java.lang.String localeLanguageId)
Specified by:
getTitle in interface com.liferay.portal.model.Layout

getHTMLTitle

public java.lang.String getHTMLTitle(java.util.Locale locale)
Specified by:
getHTMLTitle in interface com.liferay.portal.model.Layout

getHTMLTitle

public java.lang.String getHTMLTitle(java.lang.String localeLanguageId)
Specified by:
getHTMLTitle in interface com.liferay.portal.model.Layout

setTitle

public void setTitle(java.lang.String title,
                     java.util.Locale locale)
Specified by:
setTitle in interface com.liferay.portal.model.Layout

getLayoutType

public com.liferay.portal.model.LayoutType getLayoutType()
Specified by:
getLayoutType in interface com.liferay.portal.model.Layout

getTypeSettings

public java.lang.String getTypeSettings()
Specified by:
getTypeSettings in interface com.liferay.portal.model.Layout
Overrides:
getTypeSettings in class LayoutModelImpl

setTypeSettings

public void setTypeSettings(java.lang.String typeSettings)
Specified by:
setTypeSettings in interface com.liferay.portal.model.Layout
Overrides:
setTypeSettings in class LayoutModelImpl

getTypeSettingsProperties

public java.util.Properties getTypeSettingsProperties()
Specified by:
getTypeSettingsProperties in interface com.liferay.portal.model.Layout

setTypeSettingsProperties

public void setTypeSettingsProperties(java.util.Properties typeSettingsProperties)
Specified by:
setTypeSettingsProperties in interface com.liferay.portal.model.Layout

getDefaultFriendlyURL

public java.lang.String getDefaultFriendlyURL()
Specified by:
getDefaultFriendlyURL in interface com.liferay.portal.model.Layout

getLayoutSet

public com.liferay.portal.model.LayoutSet getLayoutSet()
Specified by:
getLayoutSet in interface com.liferay.portal.model.Layout

isInheritLookAndFeel

public boolean isInheritLookAndFeel()
Specified by:
isInheritLookAndFeel in interface com.liferay.portal.model.Layout

getTheme

public com.liferay.portal.model.Theme getTheme()
                                        throws com.liferay.portal.PortalException,
                                               com.liferay.portal.SystemException
Specified by:
getTheme in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getColorScheme

public com.liferay.portal.model.ColorScheme getColorScheme()
                                                    throws com.liferay.portal.PortalException,
                                                           com.liferay.portal.SystemException
Specified by:
getColorScheme in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

isInheritWapLookAndFeel

public boolean isInheritWapLookAndFeel()
Specified by:
isInheritWapLookAndFeel in interface com.liferay.portal.model.Layout

getWapTheme

public com.liferay.portal.model.Theme getWapTheme()
                                           throws com.liferay.portal.PortalException,
                                                  com.liferay.portal.SystemException
Specified by:
getWapTheme in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getWapColorScheme

public com.liferay.portal.model.ColorScheme getWapColorScheme()
                                                       throws com.liferay.portal.PortalException,
                                                              com.liferay.portal.SystemException
Specified by:
getWapColorScheme in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCssText

public java.lang.String getCssText()
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException
Specified by:
getCssText in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getRegularURL

public java.lang.String getRegularURL(javax.servlet.http.HttpServletRequest req)
                               throws com.liferay.portal.PortalException,
                                      com.liferay.portal.SystemException
Specified by:
getRegularURL in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getResetMaxStateURL

public java.lang.String getResetMaxStateURL(javax.servlet.http.HttpServletRequest req)
                                     throws com.liferay.portal.PortalException,
                                            com.liferay.portal.SystemException
Specified by:
getResetMaxStateURL in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getResetLayoutURL

public java.lang.String getResetLayoutURL(javax.servlet.http.HttpServletRequest req)
                                   throws com.liferay.portal.PortalException,
                                          com.liferay.portal.SystemException
Specified by:
getResetLayoutURL in interface com.liferay.portal.model.Layout
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getTarget

public java.lang.String getTarget()
Specified by:
getTarget in interface com.liferay.portal.model.Layout

isSelected

public boolean isSelected(boolean selectable,
                          com.liferay.portal.model.Layout layout,
                          long ancestorPlid)
Specified by:
isSelected in interface com.liferay.portal.model.Layout