public class PageStructure extends Object implements IPageStructure, IDynPageStructure
IPageStructure,
IDynPageStructureEQUAL_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 and Description |
|---|
PageStructure(String pageLayout)
A constructor that sets a page layout.
|
| Modifier and Type | Method and Description |
|---|---|
List |
getAllIViews()
Gets the list of all the iViews in all of the containers on the page.
|
List |
getContainerIViews(String containerId)
Gets the list of iViews in a specified container on the page.
|
String |
getPageLayout()
Gets the layout ID of the dynamic page.
|
void |
setContainerIViews(String containerId,
List containerIViews)
Sets a list of iViews for a container.
|
void |
setPageLayout(String pageLayout)
Sets the layout component for the dynamic page.
|
public PageStructure(String pageLayout)
pageLayout value can either be the layout component name
or the PCD path to a specific layout instance in the system.pageLayout - a page layoutpublic void setPageLayout(String pageLayout) throws IllegalArgumentException
pageLayout value can either be the layout component name
or the PCD path to a specific layout instance in the system.setPageLayout in interface IPageStructurepageLayout - layout ID (context name or component
name) of the dynamic pageIllegalArgumentException - if the pageLayout is empty or nullIPageStructure.setPageLayout(java.lang.String)public String getPageLayout()
getPageLayout in interface IDynPageStructurepublic void setContainerIViews(String containerId, List containerIViews) throws DuplicateiViewException
setContainerIViews in interface IPageStructurecontainerId - a container ID as identified in the .jsp
file of the layoutcontainerIViews - a list of iViews in the container, sorted
according to their appearance in the
dynamic pageDuplicateiViewException - if there two iViews with the same ID in
the pagepublic List getContainerIViews(String containerId)
getContainerIViews in interface IDynPageStructurecontainerId - a container idpublic List getAllIViews()
getAllIViews in interface IDynPageStructure| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] EP-RUNTIME
|
[sap.com] tc/ep/pagebuilder/api
|
api
|
EP-PIN
|
Copyright 2021 SAP SE Complete Copyright Notice