lumis.portal.structure

Class LayoutPropertiesHelper

java.lang.Object

lumis.portal.structure.LayoutPropertiesHelper

public class LayoutPropertiesHelper
extends Object

A Helper for persistence of layout properties.

Since:

5.6.0

Version:

$Revision: 11804 $ $Date: 2010-07-29 13:06:21 +0000 (Thu, 29 Jul 2010) $

Constructor Summary

Constructors

Constructor and Description
LayoutPropertiesHelper(ILayoutPropertiesAccessor layoutPropertiesAccessor) The constructor for LayoutPropertiesHelper.

Method Summary

Modifier and Type	Method and Description
void	setLayoutFilePath(String layoutFilePath) Changes the layout file path, updating other layout properties as appropriated.
void	setLayoutType(int layoutType) Sets the layout type for pages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutPropertiesHelper

public LayoutPropertiesHelper(ILayoutPropertiesAccessor layoutPropertiesAccessor)

The constructor for LayoutPropertiesHelper.

Parameters:

layoutPropertiesAccessor - the object used to access the layout properties.

Since:

5.6.0

Method Detail

setLayoutFilePath

public void setLayoutFilePath(String layoutFilePath)

Changes the layout file path, updating other layout properties as appropriated.

The layoutFile parameter cannot be an empty string or null. If it is null the attribute is removed and the attribute layoutType is automatically changed to PageConfig.PAGE_LAYOUT_TYPE_INHERIT if the current value is PageConfig.PAGE_LAYOUT_TYPE_LAYOUT_FILE, else if it is a valid value the attribute layoutType is automatically changed to PageConfig.PAGE_LAYOUT_TYPE_LAYOUT_FILE.

Parameters:

layoutFilePath - the path relative to the <lumisdata>/def directory.

Since:

5.6.0

setLayoutType

public void setLayoutType(int layoutType)

Sets the layout type for pages.

The layout type have to be a valid type and may not be set to PageConfig.PAGE_LAYOUT_TYPE_LAYOUT_FILE. If want to set to it, use setLayoutFilePath(String) and the layout type will be changed automatically.

This method may not be used to set the layout type to PageConfig.PAGE_LAYOUT_TYPE_LAYOUT_FILE. Use the method setLayoutFilePath(String) instead, and the layout type is changed automatically.

If set to a value different of PageConfig.PAGE_LAYOUT_TYPE_LAYOUT_FILE, the property will be removed.

Parameters:

layoutType - the layout type.

Since:

5.6.0

See Also:

setLayoutFilePath(String)