CanvasBuilder
instead@Deprecated public interface CanvasPageBuilder extends CanvasBuilder
The onus of translating the HTML document into a CQ page during the design import process is born by implementations conforming to this interface. CanvasBuilders are pluggable and the filepattern OSGi property defines the pattern of the HTML files that the CanvasBuilder is capable of translating. On encountering HTML files while decompressing the package, the design importer framework iterates over the registered CanvasBuilder implementations and tries to match the HTML file name with the implementations' filepattern. On successful match, the CanvasBuilder is brought into action to construct the CQ Page from there.
Modifier and Type | Field and Description |
---|---|
static String |
EVENT_PAGE_BUILD_COMPLETE
Deprecated.
|
EVENT_CANVAS_SCRIPT_BUILT, EVENT_CLIENTLIBS_BUILT, EVENT_COMPLETE, EVENT_COMPONENT_TREE_BUILT, EVENT_PARSE_COMPLETE, EVENT_STARTING, PN_FILEPATTERN
Modifier and Type | Method and Description |
---|---|
Page |
buildPage(InputStream htmlStream,
DesignImporterContext designImporterContext)
Deprecated.
|
Page |
buildPage(InputStream htmlStream,
DesignImporterContext designImporterContext,
CanvasPageBuildOptions pageBuildOptions)
|
build, build
static final String EVENT_PAGE_BUILD_COMPLETE
Page buildPage(InputStream htmlStream, DesignImporterContext designImporterContext) throws RepositoryException, DesignImportException
CanvasBuilder.build(java.io.InputStream, com.day.cq.wcm.designimporter.DesignImporterContext)
insteadhtmlStream
- The InputStream representing the the HTML document that needs
to be translated to CQ PagedesignImporterContext
- The context associated with the design package import requestRepositoryException
- When an exception occurs while writing to the repositoryDesignImportException
- When an import exception occursPage buildPage(InputStream htmlStream, DesignImporterContext designImporterContext, CanvasPageBuildOptions pageBuildOptions) throws RepositoryException, DesignImportException
CanvasBuilder.build(java.io.InputStream, com.day.cq.wcm.designimporter.DesignImporterContext, com.day.cq.wcm.designimporter.CanvasBuildOptions)
insteadhtmlStream
- The InputStream representing the the HTML document that needs
to be translated to CQ PagedesignImporterContext
- The context associated with the design package import requestpageBuildOptions
- Set of option flags to control the way the page(and everything around it) is builtRepositoryException
- When an exception occurs while writing to the repositoryDesignImportException
- When an import exception occurs"Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"