com.sapportals.portal.pb.dynamic

Interface IPageStructure

All Known Implementing Classes:

PageStructure

public interface IPageStructure

The interface that creates pages dynamically. The structure is created by PageStructureFactory.
In order to create a page dynamically and include it in the portal component:

• In the doOnNodeReady method of the portal component, get an IPageStructure.
• Initialize it by setting a page layout and setting a list of iViews for each container in the layout. The container ID is the same as the ID in the .jsp file of the layout component.
• Create a new POM node.
• Put the IPageStructure on the node, and add the node as a child to the current POM node.
• In the doContent, include the page node in the request.

See Also:

PageStructureFactory.createPageStructure(java.lang.String)

Field Summary

static String	EQUAL_WIDTH_LAYOUT_COMPONENT_NAME A constant that defines the equal width default layout component.
static String	FULL_WIDTH_LAYOUT_COMPONENT_NAME A constant that defines the full width default layout component.
static String	LAYOUT_CONTAINER_1 A constant that defines the first column container names for the default layouts.
static String	LAYOUT_CONTAINER_2 A constant that defines the second column container names for the default layouts.
static String	LAYOUT_CONTAINER_3 A constant that defines the third column container names for the default layouts.
static String	NARROW_WIDE_LAYOUT_COMPONENT_NAME A constant that defines the narrow-wide default layout component.
static String	NARROW_WIDE_NARROW_LAYOUT_COMPONENT_NAME A constant that defines the narrow-wide-narrow default layout component.
static String	PAGE_BUILDER_COMPONENT_NAME A constant that defines the page builder default component.
static String	PAGE_STRUCTURE_VALUE_NAME A constant for the page structure placed on the dynamic page node.
static String	WIDE_NARROW_LAYOUT_COMPONENT_NAME A constant that defines the wide-narrow default layout component.

Method Summary

void	setContainerIViews(String containerId, List containerIViews) Method setContainerIViews.
void	setPageLayout(String pageLayout) Sets the layout component for the dynamic page.

Field Detail

PAGE_STRUCTURE_VALUE_NAME

static final String PAGE_STRUCTURE_VALUE_NAME

A constant for the page structure placed on the dynamic page node.
com.sap.portal.pb.dynamic.pageStructure

See Also:

Constant Field Values

PAGE_BUILDER_COMPONENT_NAME

static final String PAGE_BUILDER_COMPONENT_NAME

A constant that defines the page builder default component.
com.sap.portal.pagebuilder.pageBuilder

See Also:

Constant Field Values

FULL_WIDTH_LAYOUT_COMPONENT_NAME

static final String FULL_WIDTH_LAYOUT_COMPONENT_NAME

A constant that defines the full width default layout component.
com.sap.portal.layouts.default.fullWidth

See Also:

Constant Field Values

NARROW_WIDE_LAYOUT_COMPONENT_NAME

static final String NARROW_WIDE_LAYOUT_COMPONENT_NAME

A constant that defines the narrow-wide default layout component.
com.sap.portal.layouts.default.narrowWide

See Also:

Constant Field Values

WIDE_NARROW_LAYOUT_COMPONENT_NAME

static final String WIDE_NARROW_LAYOUT_COMPONENT_NAME

A constant that defines the wide-narrow default layout component.
com.sap.portal.layouts.default.wideNarrow

See Also:

Constant Field Values

EQUAL_WIDTH_LAYOUT_COMPONENT_NAME

static final String EQUAL_WIDTH_LAYOUT_COMPONENT_NAME

A constant that defines the equal width default layout component.
com.sap.portal.layouts.default.equalWidths

See Also:

Constant Field Values

NARROW_WIDE_NARROW_LAYOUT_COMPONENT_NAME

static final String NARROW_WIDE_NARROW_LAYOUT_COMPONENT_NAME

A constant that defines the narrow-wide-narrow default layout component.
com.sap.portal.layouts.default.narrowWideNarrow

See Also:

Constant Field Values

LAYOUT_CONTAINER_1

static final String LAYOUT_CONTAINER_1

A constant that defines the first column container names for the default layouts.
column1

See Also:

Constant Field Values

LAYOUT_CONTAINER_2

static final String LAYOUT_CONTAINER_2

A constant that defines the second column container names for the default layouts.
column2

See Also:

Constant Field Values

LAYOUT_CONTAINER_3

static final String LAYOUT_CONTAINER_3

A constant that defines the third column container names for the default layouts.
column3

See Also:

Constant Field Values

Method Detail

setPageLayout

void setPageLayout(String pageLayout)
                   throws IllegalArgumentException

Sets the layout component for the dynamic page. The pageLayout value can either be the layout component name or the PCD path to a specific layout instance in the system.

Parameters:

pageLayout - layout ID (context name or component name) of the dynamic page

Throws:

IllegalArgumentException - if the pageLayout is empty or null

setContainerIViews

void setContainerIViews(String containerId,
                        List containerIViews)
                        throws DuplicateiViewException

Method setContainerIViews. Sets a list of iViews for a container. This list should be set for each container defined in the .jsp file of the layout component of the page.
The list of iViews in the container must be in the same order as they appear in the dynamic page.

Parameters:

containerId - a container ID as identified in the .jsp file of the layout

containerIViews - a list of iViews in the container, sorted according to their appearance in the dynamic page

Throws:

DuplicateiViewException - if there two iViews with the same ID in the page

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/pagebuilder/api	api	EP-PIN