com.sapportals.portal.pb.dynamic
Interface IPageStructure

All Known Implementing Classes:

PageStructure

public interface IPageStructure

The interface is designed for creating pages dynamically. The structure is created by a factory: in order to create a page dynamically and include it in the Portal component: In the doOnNodeReady() method of the Portal component get a IPageStructure. Init it by setting a page layout (component name or context name) and setting a java.util.List of iViews (context name or component name) for each container in the layout. The container Id is the same as the Id in the jsp file of the layout component. Then create the com. sap. portal. pagebuilder. pagebuilder context and a node from it. Put the IPageStructure on the node with value name (in the IPageStructure) and add the page node as a child. In the doContent() include the page node.

See Also:

PageStructureFactory.createPageStructure(java.lang.String)

Field Summary

static java.lang.String	EQUAL_WIDTH_LAYOUT_COMPONENT_NAME
static java.lang.String	FULL_WIDTH_LAYOUT_COMPONENT_NAME A set of constants for the default layout ocmponents
static java.lang.String	LAYOUT_CONTAINER_1 A set of constants for the container names of the default layouts
static java.lang.String	LAYOUT_CONTAINER_2
static java.lang.String	LAYOUT_CONTAINER_3
static java.lang.String	NARROW_WIDE_LAYOUT_COMPONENT_NAME
static java.lang.String	NARROW_WIDE_NARROW_LAYOUT_COMPONENT_NAME
static java.lang.String	PAGE_BUILDER_COMPONENT_NAME A constant for the page builder default component
static java.lang.String	PAGE_STRUCTURE_VALUE_NAME use this value to put the page structure on the dynamic page node
static java.lang.String	WIDE_NARROW_LAYOUT_COMPONENT_NAME

Method Summary

void	setContainerIViews(java.lang.String containerId, java.util.List containerIViews) Method setContainerIViews.
void	setPageLayout(java.lang.String pageLayout) Method setPageLayout.

Field Detail

PAGE_STRUCTURE_VALUE_NAME

public static final java.lang.String PAGE_STRUCTURE_VALUE_NAME

use this value to put the page structure on the dynamic page node

PAGE_BUILDER_COMPONENT_NAME

public static final java.lang.String PAGE_BUILDER_COMPONENT_NAME

A constant for the page builder default component

FULL_WIDTH_LAYOUT_COMPONENT_NAME

public static final java.lang.String FULL_WIDTH_LAYOUT_COMPONENT_NAME

A set of constants for the default layout ocmponents

NARROW_WIDE_LAYOUT_COMPONENT_NAME

public static final java.lang.String NARROW_WIDE_LAYOUT_COMPONENT_NAME

WIDE_NARROW_LAYOUT_COMPONENT_NAME

public static final java.lang.String WIDE_NARROW_LAYOUT_COMPONENT_NAME

EQUAL_WIDTH_LAYOUT_COMPONENT_NAME

public static final java.lang.String EQUAL_WIDTH_LAYOUT_COMPONENT_NAME

NARROW_WIDE_NARROW_LAYOUT_COMPONENT_NAME

public static final java.lang.String NARROW_WIDE_NARROW_LAYOUT_COMPONENT_NAME

LAYOUT_CONTAINER_1

public static final java.lang.String LAYOUT_CONTAINER_1

A set of constants for the container names of the default layouts

LAYOUT_CONTAINER_2

public static final java.lang.String LAYOUT_CONTAINER_2

LAYOUT_CONTAINER_3

public static final java.lang.String LAYOUT_CONTAINER_3

Method Detail

setPageLayout

public void setPageLayout(java.lang.String pageLayout)
                   throws java.lang.IllegalArgumentException

Method setPageLayout. Set the layout component for the dynamic page. The value can be either be the layout component name or the pcd path to a specific layout instance in the system.

Parameters:

pageLayout - String Id (conext name or component name) of the layout of the dynamic page. Must contain a value.

Throws:

java.lang.IllegalArgumentException - If the pageLayout is empty or null

setContainerIViews

public void setContainerIViews(java.lang.String containerId,
                               java.util.List containerIViews)
                        throws DuplicateiViewException

Method setContainerIViews. For each container defined in the jsp file of the layout component of the page, a java.util.List of iViews should be defined. The List of iViews in the container must be in the order of appearence in the dynamic page.

Parameters:

containerId - The container id of the container for the iViews as identified in the jsp file of the layout

containerIViews - a List of iViews in the container, ordered in the List according to appearence in the dynmaic page

Throws:

DuplicateiViewException - indicating that there two iViews with the same ID in the page