com.sapportals.portal.pb.dynamic
Class PageStructure

java.lang.Object
  |
  +--com.sapportals.portal.pb.dynamic.PageStructure

All Implemented Interfaces:

IDynPageStructure, IPageStructure

public class PageStructure

extends java.lang.Object

implements IPageStructure, IDynPageStructure

Fields inherited from interface com.sapportals.portal.pb.dynamic.IPageStructure

EQUAL_WIDTH_LAYOUT_COMPONENT_NAME, FULL_WIDTH_LAYOUT_COMPONENT_NAME, LAYOUT_CONTAINER_1, LAYOUT_CONTAINER_2, LAYOUT_CONTAINER_3, NARROW_WIDE_LAYOUT_COMPONENT_NAME, NARROW_WIDE_NARROW_LAYOUT_COMPONENT_NAME, PAGE_BUILDER_COMPONENT_NAME, PAGE_STRUCTURE_VALUE_NAME, WIDE_NARROW_LAYOUT_COMPONENT_NAME

Constructor Summary

PageStructure(java.lang.String pageLayout)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PageStructure

public PageStructure(java.lang.String pageLayout)

Method Detail

setPageLayout

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

Description copied from interface: IPageStructure

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.

Specified by:

setPageLayout in interface IPageStructure

Following copied from interface: com.sapportals.portal.pb.dynamic.IPageStructure

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

getPageLayout

public java.lang.String getPageLayout()

Description copied from interface: IDynPageStructure

Method getPageLayout.

Specified by:

getPageLayout in interface IDynPageStructure

Following copied from interface: com.sapportals.portal.pb.dynamic.IDynPageStructure

Returns:

String The layout Id of the dynamic page

setContainerIViews

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

Description copied from interface: IPageStructure

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.

Specified by:

setContainerIViews in interface IPageStructure

Following copied from interface: com.sapportals.portal.pb.dynamic.IPageStructure

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

getContainerIViews

public java.util.List getContainerIViews(java.lang.String containerId)

Description copied from interface: IDynPageStructure

Method getContainerIViews. Get the List of iViews in a specific container in the page

Specified by:

getContainerIViews in interface IDynPageStructure

Following copied from interface: com.sapportals.portal.pb.dynamic.IDynPageStructure

Parameters:

containerID -

Returns:

List containing Strings of iView Ids

getAllIViews

public java.util.List getAllIViews()

Description copied from interface: IDynPageStructure

Method getAllIViews. Get the List of all iViews in all of the contianers in the page

Specified by:

getAllIViews in interface IDynPageStructure

Following copied from interface: com.sapportals.portal.pb.dynamic.IDynPageStructure

Returns:

List containing Strings of iVeiw Ids