com.liferay.portal.kernel.model.impl

Class VirtualLayout

Object

com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<Layout>

com.liferay.portal.kernel.model.LayoutWrapper

com.liferay.portal.kernel.model.impl.VirtualLayout

All Implemented Interfaces:

AttachedModel, AuditedModel, BaseModel<Layout>, CTModel<Layout>, ClassedModel, GroupedModel, Layout, LayoutModel, LocalizedModel, ModelWrapper<Layout>, MVCCModel, PersistedModel, ShardedModel, StagedGroupedModel, StagedModel, TypedModel, WorkflowedModel, Serializable, Cloneable, Comparable<Layout>

public class VirtualLayout
extends LayoutWrapper

Author:

Raymond Augé

See Also:

Serialized Form

Field Summary

Fields inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper

model

Fields inherited from interface com.liferay.portal.kernel.model.Layout

LAYOUT_ID_ACCESSOR, PLID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
VirtualLayout(Layout sourceLayout, Group targetGroup)

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a shallow clone of this model instance.
List<Portlet>	getEmbeddedPortlets()
String	getFriendlyURL() Returns the friendly url of this layout.
String	getFriendlyURL(Locale locale) Returns the layout's friendly URL for the given locale.
Group	getGroup() Returns the current layout's group.
long	getGroupId() Returns the group ID of this layout.
Group	getHostGroup()
LayoutSet	getLayoutSet() Returns the current layout's LayoutSet.
LayoutType	getLayoutType() Returns the current layout's LayoutType.
String	getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest)
String	getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest)
String	getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest)
long	getSourceGroupId()
Layout	getSourceLayout()
long	getVirtualGroupId()
protected String	injectVirtualGroupURL(String layoutURL, Locale locale)
void	setLayoutSet(LayoutSet layoutSet)
void	setPrivateLayout(boolean privateLayout) Sets whether this layout is private layout.

Methods inherited from class com.liferay.portal.kernel.model.LayoutWrapper

cloneWithOriginalValues, fetchDraftLayout, getAllChildren, getAncestorLayoutId, getAncestorPlid, getAncestors, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getAvailableLanguageIds, getBreadcrumb, getChildren, getChildren, getClassName, getClassNameId, getClassPK, getColorScheme, getColorSchemeId, getCompanyId, getCreateDate, getCss, getCssText, getCtCollectionId, getDefaultLanguageId, getDefaultThemeSetting, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getEmbeddedPortlets, getFaviconFileEntryId, getFaviconURL, getFriendlyURLMap, getFriendlyURLsXML, getHidden, getHTMLTitle, getHTMLTitle, getIcon, getIconImage, getIconImageId, getKeywords, getKeywords, getKeywords, getKeywords, getKeywords, getKeywordsCurrentLanguageId, getKeywordsCurrentValue, getKeywordsMap, getLastPublishDate, getLayoutId, getLayoutPrototypeLinkEnabled, getLayoutPrototypeUuid, getLayoutSetPrototypeLayout, getLinkedToLayout, getMasterLayoutPlid, getModelAttributes, getModifiedDate, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getParentLayoutId, getParentPlid, getPlid, getPrimaryKey, getPriority, getPrivateLayout, getPublishDate, getRobots, getRobots, getRobots, getRobots, getRobots, getRobotsCurrentLanguageId, getRobotsCurrentValue, getRobotsMap, getScopeGroup, getSourcePrototypeLayoutUuid, getStagedModelType, getStatus, getStatusByUserId, getStatusByUserName, getStatusByUserUuid, getStatusDate, getStyleBookEntryId, getSystem, getTarget, getTheme, getThemeId, getThemeSetting, getThemeSetting, getTitle, getTitle, getTitle, getTitle, getTitle, getTitleCurrentLanguageId, getTitleCurrentValue, getTitleMap, getType, getTypeSettings, getTypeSettingsProperties, getTypeSettingsProperty, getTypeSettingsProperty, getUserId, getUserName, getUserUuid, getUuid, hasAncestor, hasChildren, hasScopeGroup, hasSetModifiedDate, includeLayoutContent, isApproved, isChildSelected, isContentDisplayPage, isCustomizable, isDenied, isDraft, isDraftLayout, isEmbeddedPersonalApplication, isExpired, isFirstChild, isFirstParent, isHidden, isIconImage, isInactive, isIncomplete, isInheritLookAndFeel, isLayoutDeleteable, isLayoutPrototypeLinkActive, isLayoutPrototypeLinkEnabled, isLayoutSortable, isLayoutUpdateable, isPending, isPortletEmbedded, isPrivateLayout, isPublicLayout, isPublished, isRootLayout, isScheduled, isSelected, isSupportsEmbeddedPortlets, isSystem, isTypeAssetDisplay, isTypeCollection, isTypeContent, isTypeControlPanel, isTypeEmbedded, isTypeLinkToLayout, isTypePanel, isTypePortlet, isTypeURL, isUnlocked, matches, persist, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setClassName, setClassNameId, setClassPK, setColorSchemeId, setCompanyId, setCreateDate, setCss, setCtCollectionId, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setFaviconFileEntryId, setFriendlyURL, setGroupId, setHidden, setIconImageId, setKeywords, setKeywords, setKeywords, setKeywordsCurrentLanguageId, setKeywordsMap, setKeywordsMap, setLastPublishDate, setLayoutId, setLayoutPrototypeLinkEnabled, setLayoutPrototypeUuid, setMasterLayoutPlid, setModelAttributes, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentLayoutId, setParentPlid, setPlid, setPrimaryKey, setPriority, setPublishDate, setRobots, setRobots, setRobots, setRobotsCurrentLanguageId, setRobotsMap, setRobotsMap, setSourcePrototypeLayoutUuid, setStatus, setStatusByUserId, setStatusByUserName, setStatusByUserUuid, setStatusDate, setStyleBookEntryId, setSystem, setThemeId, setTitle, setTitle, setTitle, setTitleCurrentLanguageId, setTitleMap, setTitleMap, setType, setTypeSettings, setTypeSettingsProperties, setUserId, setUserName, setUserUuid, setUuid, toXmlString, wrap

Methods inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper

compareTo, equals, getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, hashCode, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

getExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel

Methods inherited from interface Comparable

compareTo

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.kernel.model.ModelWrapper

getWrappedModel

Constructor Detail

VirtualLayout

public VirtualLayout(Layout sourceLayout,
                     Group targetGroup)

Method Detail

clone

public Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<Layout>

Specified by:

clone in interface StagedModel

Overrides:

clone in class BaseModelWrapper<Layout>

Returns:

the shallow clone of this model instance

getEmbeddedPortlets

public List<Portlet> getEmbeddedPortlets()

Specified by:

getEmbeddedPortlets in interface Layout

Overrides:

getEmbeddedPortlets in class LayoutWrapper

getFriendlyURL

public String getFriendlyURL()

Description copied from class: LayoutWrapper

Returns the friendly url of this layout.

Specified by:

getFriendlyURL in interface LayoutModel

Overrides:

getFriendlyURL in class LayoutWrapper

Returns:

the friendly url of this layout

getFriendlyURL

public String getFriendlyURL(Locale locale)

Description copied from class: LayoutWrapper

Returns the layout's friendly URL for the given locale.

Specified by:

getFriendlyURL in interface Layout

Overrides:

getFriendlyURL in class LayoutWrapper

Parameters:

locale - the locale that the friendly URL should be retrieved for

Returns:

the layout's friendly URL for the given locale

getGroup

public Group getGroup()

Description copied from class: LayoutWrapper

Returns the current layout's group.

Group is Liferay's technical name for a site.

Specified by:

getGroup in interface Layout

Overrides:

getGroup in class LayoutWrapper

Returns:

the current layout's group

getGroupId

public long getGroupId()

Description copied from class: LayoutWrapper

Returns the group ID of this layout.

Specified by:

getGroupId in interface GroupedModel

Specified by:

getGroupId in interface LayoutModel

Overrides:

getGroupId in class LayoutWrapper

Returns:

the group ID of this layout

getHostGroup

public Group getHostGroup()

getLayoutSet

public LayoutSet getLayoutSet()

Description copied from class: LayoutWrapper

Returns the current layout's LayoutSet.

Specified by:

getLayoutSet in interface Layout

Overrides:

getLayoutSet in class LayoutWrapper

Returns:

the current layout's layout set

getLayoutType

public LayoutType getLayoutType()

Description copied from class: LayoutWrapper

Returns the current layout's LayoutType.

Specified by:

getLayoutType in interface Layout

Overrides:

getLayoutType in class LayoutWrapper

Returns:

the current layout's layout type

getRegularURL

public String getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest)
                     throws PortalException

Specified by:

getRegularURL in interface Layout

Overrides:

getRegularURL in class LayoutWrapper

Throws:

PortalException

getResetLayoutURL

public String getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest)
                         throws PortalException

Specified by:

getResetLayoutURL in interface Layout

Overrides:

getResetLayoutURL in class LayoutWrapper

Throws:

PortalException

getResetMaxStateURL

public String getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest)
                           throws PortalException

Specified by:

getResetMaxStateURL in interface Layout

Overrides:

getResetMaxStateURL in class LayoutWrapper

Throws:

PortalException

getSourceGroupId

public long getSourceGroupId()

getSourceLayout

public Layout getSourceLayout()

getVirtualGroupId

public long getVirtualGroupId()

setLayoutSet

public void setLayoutSet(LayoutSet layoutSet)

Specified by:

setLayoutSet in interface Layout

Overrides:

setLayoutSet in class LayoutWrapper

setPrivateLayout

public void setPrivateLayout(boolean privateLayout)

Description copied from class: LayoutWrapper

Sets whether this layout is private layout.

Specified by:

setPrivateLayout in interface LayoutModel

Overrides:

setPrivateLayout in class LayoutWrapper

Parameters:

privateLayout - the private layout of this layout

injectVirtualGroupURL

protected String injectVirtualGroupURL(String layoutURL,
                                       Locale locale)