public interface PageBuilder
This interface can be used to create Page
s and PageComponent
s. A page is basically designed as a list
of optionally nested PageComponent
s. Use the PageBuilderFactory
service to get a PageBuilder
instance.
This interface must not be implemented by clients.
Modifier and Type | Method and Description |
---|---|
PageComponent |
createComponent(java.lang.String resourceType)
Convenience method to create a
PageComponent for a resource type. |
PageComponent |
createComponent(java.lang.String resourceType,
ValueMap properties)
Convenience method to create a
PageComponent for a resource type and the given properties. |
PageComponent |
createComponent(java.lang.String resourceType,
ValueMap properties,
java.lang.String nameHint)
Factory method to create a new
PageComponent . |
Page |
createPage(java.lang.String pageRoot,
java.lang.String pageName,
java.lang.String pageTitle,
java.lang.String templatePath,
java.lang.String designPath,
java.util.List<PageComponent> components)
Create a new
Page . |
Page |
recreatePage(java.lang.String pageRoot,
java.lang.String pageName,
java.lang.String pageTitle,
java.lang.String templatePath,
java.lang.String designPath,
java.util.List<PageComponent> components)
Recreate a
Page . |
PageComponent createComponent(java.lang.String resourceType)
PageComponent
for a resource type.resourceType
- The PageComponent
s resource typePageComponent
PageComponent createComponent(java.lang.String resourceType, ValueMap properties)
PageComponent
for a resource type and the given properties.resourceType
- The PageComponent
s resource typeproperties
- The PageComponent
s propertiesPageComponent
PageComponent createComponent(java.lang.String resourceType, ValueMap properties, java.lang.String nameHint)
PageComponent
.resourceType
- The PageComponent
s resource typeproperties
- The PageComponent
s propertiesnameHint
- The name hint for the PageComponent
PageComponent
Page createPage(java.lang.String pageRoot, java.lang.String pageName, java.lang.String pageTitle, java.lang.String templatePath, java.lang.String designPath, java.util.List<PageComponent> components) throws WCMException
Page
.pageRoot
- The page rootpageName
- The page namepageTitle
- The page titletemplatePath
- The path to the template to usedesignPath
- The path to the design to usecomponents
- List of optionally nested PageComponent
s that make up the page.WCMException
- exception caused while creating the page.Page recreatePage(java.lang.String pageRoot, java.lang.String pageName, java.lang.String pageTitle, java.lang.String templatePath, java.lang.String designPath, java.util.List<PageComponent> components) throws WCMException
Page
.pageRoot
- The page rootpageName
- The page namepageTitle
- The page titletemplatePath
- The path to the template to usedesignPath
- The path to the design to usecomponents
- List of optionally nested PageComponent
s that make up the page.WCMException
- exception caused while creating the page.Copyright © 2010 - 2020 Adobe. All Rights Reserved