|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object lumis.portal.structure.StructureElement lumis.portal.page.PageConfig
@StableMinor(version="6.2", sinceVersion="5.0") public class PageConfig
Represents a Page object
Constructor Summary | |
---|---|
PageConfig()
|
Method Summary | |
---|---|
protected void |
applyPropertyBagChanges()
Apply the changes made to the properties managed by this element to the property bag persistence entities. |
PageConfig |
clone()
|
void |
deserialize(Node pageNode)
|
String |
getAccessControlListId()
|
int |
getCacheType()
|
int |
getCenterPage()
|
String |
getChannelId()
|
String |
getDescription()
|
String |
getFriendlyId()
Returns the page's friendly identifier. |
String |
getId()
|
boolean |
getInheritsMetaTags()
|
boolean |
getInheritsStylesheets()
|
String |
getKeywords()
|
String |
getLayout()
|
String |
getLayoutFilePath()
Returns the path for the layout file for use by this page. |
int |
getLayoutType()
|
protected Pattern |
getManagedPropertiesPattern()
Returns the property name spaces. |
String |
getName()
|
String |
getPageWebResourceDataProviderClassName()
Returns the class name for the page web resource data provider. |
int |
getPageWebResourceDataProviderType()
Returns the page web resource data provider type. |
String |
getParentTemplateId()
|
int |
getPosition()
|
String |
getPropertyBagId()
Returns the property bag identifier. |
int |
getProtocol()
|
String |
getRuntimeDataProviderClassName()
Deprecated. Since 5.0.0 replaced by getPageWebResourceDataProviderClassName() . |
int |
getRuntimeDataProviderType()
Deprecated. Since 5.0.0 replaced by getPageWebResourceDataProviderType() . |
int |
getServerSideIncludeType()
Returns whether the server side include directives are processed for this page. |
String |
getTitle()
|
int |
getType()
|
boolean |
isAutomaticFriendlyId()
Returns whether the page is going to use automatic generated friendly identifier or not. |
boolean |
isHidden()
|
boolean |
isIdentical(PageConfig pageConfig)
Returns true if all properties of this object are equals to the properties of the given object. |
boolean |
isOverrideServerSideInclude()
Indicates whether the server side include type should be calculated automatically by the framework. |
boolean |
isTemplate()
|
protected void |
loadPropertyBagValues()
Loads the values of the property bag of this element. |
protected boolean |
mayUseFriendlyId(String friendlyId)
Indicates if the element may use the given friendly identifier. |
void |
serialize(PageConfig pageConfig,
OutputStream outputStream)
|
void |
setAccessControlListId(String accessControlListId)
|
void |
setAutoGeneratedFriendlyId()
Generates a new friendly identifier and sets it as the friendly identifier of this page. |
void |
setAutomaticFriendlyId(boolean automaticFriendlyId)
Indicates whether the page is going to use automatic generated friendly identifier or not. |
void |
setCacheType(int cacheType)
|
void |
setCenterPage(int centerPage)
|
void |
setChannelId(String channelId)
|
void |
setDescription(String description)
|
void |
setFriendlyId(String friendlyId)
Sets the page's friendly identifier. |
void |
setHidden(boolean hidden)
|
void |
setId(String id)
|
void |
setInheritsMetaTags(boolean inheritsMetaTags)
|
void |
setInheritsStylesheets(boolean inheritsStylesheets)
|
void |
setKeywords(String keywords)
|
void |
setLayout(String layout)
|
void |
setLayoutFile(String layoutFile)
Sets the path for the layout file. |
void |
setLayoutType(int layoutType)
Sets the layout type. |
void |
setName(String name)
|
void |
setOverrideServerSideInclude(boolean overrideServerSideInclude)
Sets whether the server side include type should be calculated automatically by the framework. |
void |
setPageWebResourceDataProviderClassName(String dataProviderClassName)
Sets the page web resource data provider class name. |
void |
setPageWebResourceDataProviderType(int dataProviderType)
Sets the page web resource data provider type. |
void |
setParentTemplateId(String parentTemplateId)
|
void |
setPosition(int position)
|
protected void |
setPropertyBagId(String propertyBagId)
Sets the property bag identifier. |
void |
setProtocol(int protocol)
|
void |
setRuntimeDataProviderClassName(String runtimeDataProviderClassName)
Deprecated. Since 5.0.0 replaced by setPageWebResourceDataProviderClassName(String) . |
void |
setRuntimeDataProviderType(int runtimeDataProviderType)
Deprecated. Since 5.0.0 replaced by setPageWebResourceDataProviderType(int) . |
void |
setServerSideIncludeType(int serverSideIncludeType)
Sets whether the server side include directives should be processed for this page. |
void |
setTemplate(boolean isTemplate)
|
void |
setTitle(String title)
|
void |
setType(int type)
|
Methods inherited from class lumis.portal.structure.StructureElement |
---|
getAutomaticFriendlyId, getFriendlyIdBaseValue, getFriendlyIdMaxLength, getFriendlyIdValueForCounter, getPropertyValue, isManagedProperty, removeProperty, serializePropertyBag, setPropertyValue, stripAccents |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int PAGE_TYPE_USER
public static final int PAGE_TYPE_ADMIN
public static final String PAGE_MAIN
public static final String PAGE_ID_ADMIN_SERVICES
public static final String PAGE_ID_ADMIN_PAGES
public static final String PAGE_ID_ADMIN_ACCESS
public static final String PAGE_ID_ADMIN_SUBCHANNELS
public static final String PAGE_ID_ADMIN_PAGE_TEMPLATES
public static final String PAGE_ID_ADMIN_CHANNEL_TEMPLATES
public static final String PAGE_ID_ADMIN_GROUPS
public static final String PAGE_ID_ADMIN_USERS
public static final String PAGE_ID_ADMIN_LOCALGROUPS
public static final String PAGE_ID_ADMIN_LOCALUSERS
public static final String PAGE_ID_ADMIN_BLANK
public static final int PAGE_CACHE_TYPE_DISABLED
public static final int PAGE_CACHE_TYPE_ALL_USERS
public static final int PAGE_CACHE_TYPE_ONLY_GUEST
public static final int PAGE_CACHE_TYPE_INHERIT
public static final int PAGE_CENTER_NO
public static final int PAGE_CENTER_YES
public static final int PAGE_CENTER_INHERIT
public static final int PAGE_LAYOUT_TYPE_INHERIT
public static final int PAGE_LAYOUT_TYPE_WITH_TABLES
public static final int PAGE_LAYOUT_TYPE_TABLELESS
public static final int PAGE_LAYOUT_TYPE_LAYOUT_FILE
public static final String LAYOUT_FILE_PATH_PROPERTY_NAME
public static final int PAGE_SERVER_SIDE_INCLUDE_NO
public static final int PAGE_SERVER_SIDE_INCLUDE_YES
public static final int PAGE_PROTOCOL_INHERIT
public static final int PAGE_PROTOCOL_HTTP
public static final int PAGE_PROTOCOL_HTTPS
public static final int PAGE_PROTOCOL_ALL
public static final String PAGE_PROTOCOL_HTTP_NAME
public static final String PAGE_PROTOCOL_HTTPS_NAME
@Deprecated public static final int PAGE_RUNTIME_DATA_PROVIDER_TYPE_INHERIT
#PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT()
.@Deprecated public static final int PAGE_RUNTIME_DATA_PROVIDER_TYPE_DEFAULT
#PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT()
.@Deprecated public static final int PAGE_RUNTIME_DATA_PROVIDER_TYPE_CONTENT
#PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT()
.@Deprecated public static final int PAGE_RUNTIME_DATA_PROVIDER_TYPE_CUSTOM
#PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM()
.public static final int PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT
public static final int PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT
public static final int PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT
public static final int PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM
Constructor Detail |
---|
public PageConfig()
Method Detail |
---|
protected Pattern getManagedPropertiesPattern()
StructureElement
getManagedPropertiesPattern
in class StructureElement
protected void loadPropertyBagValues() throws PortalException
StructureElement
Only the properties that can be changed are actually loaded.
loadPropertyBagValues
in class StructureElement
PortalException
StructureElement.isManagedProperty(String)
protected void applyPropertyBagChanges() throws PortalException
StructureElement
applyPropertyBagChanges
in class StructureElement
PortalException
StructureElement.isManagedProperty(String)
public String getLayoutFilePath()
The layout file may be inherited to child elements.
If getLayoutType()
is not PAGE_LAYOUT_TYPE_LAYOUT_FILE
(or inherited it),
this method will return null
since no layout file is to be used.
<lumisdata>/def
directory,
possibly inherited from parent channel; or null
if no layout file is to be used.#getLayoutPagesType()
,
setLayoutFile(String)
public void setLayoutFile(String layoutFile)
The layout file may be inherited to child elements.
When the layout file is set, getLayoutType()
is automatically changed to
PAGE_LAYOUT_TYPE_LAYOUT_FILE
.
layoutFile
- the path relative to the <lumisdata>/def
directory.setLayoutType(int)
public String getId()
public void setId(String id)
Id
- The pageId to set.public String getName()
public void setName(String name)
name
- The name to set.public String getDescription()
public void setDescription(String description)
description
- The description to set.public String getLayout()
public void setLayout(String layout)
layout
- The layout to set.public String getChannelId()
public void setChannelId(String channelId)
channelId
- The channelId to set.public int getCacheType()
public void setCacheType(int cacheType)
cacheType
- The type of cache to set.public boolean isHidden()
public void setHidden(boolean hidden)
hidden
- The hidden to set.public boolean getInheritsStylesheets()
public boolean getInheritsMetaTags()
public void setInheritsStylesheets(boolean inheritsStylesheets)
inheritsStylesheets
- The inheritsStylesheets to set.public void setInheritsMetaTags(boolean inheritsMetaTags)
inheritsMetaTags
- The inheritsMetaTags to set.public int getProtocol()
public void setProtocol(int protocol)
protocol
- The protocol to set.public String getKeywords()
public void setKeywords(String keywords)
keywords
- The keywords to set.public String getTitle()
public void setTitle(String title)
title
- The title to set.public String getParentTemplateId()
public void setParentTemplateId(String parentTemplateId)
parentTemplateId
- The parentTemplateId to set.public int getPosition()
public void setPosition(int position)
position
- The position to set.public int getType()
public void setType(int type)
position
- The position to set.public boolean isTemplate()
public void setTemplate(boolean isTemplate)
isTemplate
- The isTemplate to set.public String getAccessControlListId()
public void setAccessControlListId(String accessControlListId)
public String getPropertyBagId()
StructureElement
getPropertyBagId
in class StructureElement
protected void setPropertyBagId(String propertyBagId)
This method should be used only for non-persisted page, because this property value may not be changed.
propertyBagId
- The propertyBagId to set.public int getCenterPage()
public void setCenterPage(int centerPage)
public int getLayoutType()
public void setLayoutType(int layoutType)
To set PAGE_LAYOUT_TYPE_LAYOUT_FILE
value use the method setLayoutFile(String)
,
and the layout type is changed automatically. PAGE_LAYOUT_TYPE_LAYOUT_FILE
cannot
be set directly with this method.
If set to a value different of PAGE_LAYOUT_TYPE_LAYOUT_FILE
, the getLayoutFilePath()
will
be changed to null
.
layoutType
- the page layout type.
IllegalArgumentException
- If called with the argument PAGE_LAYOUT_TYPE_LAYOUT_FILE
.setLayoutFile(String).
public void serialize(PageConfig pageConfig, OutputStream outputStream) throws PortalException
PortalException
public void deserialize(Node pageNode) throws PortalException
PortalException
public PageConfig clone()
clone
in interface ICloneableCacheEntry
clone
in interface ICloneableConfig<PageConfig>
clone
in class Object
public boolean isOverrideServerSideInclude()
By default this value is false.
getServerSideIncludeType()
public void setOverrideServerSideInclude(boolean overrideServerSideInclude)
overrideServerSideInclude
- false if server-side include type is calculated by the framework. true otherwise.getServerSideIncludeType()
public int getServerSideIncludeType()
public void setServerSideIncludeType(int serverSideIncludeType)
serverSideIncludeType
- either 0 or 1@Deprecated public int getRuntimeDataProviderType()
getPageWebResourceDataProviderType()
.
@Deprecated public void setRuntimeDataProviderType(int runtimeDataProviderType)
setPageWebResourceDataProviderType(int)
.
runtimeDataProviderType
- the runtime data provider type.@Deprecated public String getRuntimeDataProviderClassName()
getPageWebResourceDataProviderClassName()
.
@Deprecated public void setRuntimeDataProviderClassName(String runtimeDataProviderClassName)
setPageWebResourceDataProviderClassName(String)
.
runtimeDataProviderClassName
- the class name to be set.public String getPageWebResourceDataProviderClassName()
This value should only be used if the page web resource data provider type is
PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM
.
public void setPageWebResourceDataProviderClassName(String dataProviderClassName)
dataProviderClassName
- the class name to be set.public int getPageWebResourceDataProviderType()
The possible values are
PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT
or
PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT
or
PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT
or
PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM
public void setPageWebResourceDataProviderType(int dataProviderType)
The possible values are
PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT
or
PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT
or
PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT
or
PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM
dataProviderType
- the page web resource data provider type.public void setFriendlyId(String friendlyId)
friendlyId
- the page's friendly identifier.public void setAutoGeneratedFriendlyId()
This method requires an active transaction.
setFriendlyId(String)
public String getFriendlyId()
public void setAutomaticFriendlyId(boolean automaticFriendlyId)
automaticFriendlyId
- indicates whether the page is going to use automatic generated
friendly identifier or not.public boolean isAutomaticFriendlyId()
public boolean isIdentical(PageConfig pageConfig)
pageConfig
- the object to compare the properties with.
protected boolean mayUseFriendlyId(String friendlyId) throws PortalException
StructureElement
mayUseFriendlyId
in class StructureElement
friendlyId
- the friendly identifier.
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |