com.pega.pegarules.pub.context

Interface IDesignTemplateUtils

public interface IDesignTemplateUtils

Utilities interface for supporting design templating of section rules.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
void	buildRegions(ClipboardPage ruleformPage) Builds list of regions for a design template.
void	buildRegions(PublicAPI tools, ClipboardPage ruleformPage) Builds list of regions for a design template.
void	changeDesignTemplateRegions(PublicAPI tools, ClipboardPage newDesignTemplatePage, ClipboardPage primary)
void	convertRegionToSectionModel(ClipboardPage content, ClipboardPage designTemplate) Used to convert a section from using a template.
IDesignTemplateEditing	getDesignTemplateEditing() Accessor for grabbing a reference to the DesignTemplateEditing interface
boolean	isCellPresentInSection(ClipboardPage sectionToSearch, java.lang.String currentValue) determines if the passed in section contains the passed in currentValue as in pyValue in one of the cells of the section
void	mergeModels(ClipboardPage content, ClipboardPage designTemplate) Combines a content section page with a design template page to result in a standard section page.
void	moveCellToRegion(PublicAPI tools, ClipboardPage cellPage, ClipboardPage sectionPage) Takes the given cell and places it in the correct region

Field Detail

VERSION

static final java.lang.String VERSION

Method Detail

mergeModels

void mergeModels(ClipboardPage content,
                 ClipboardPage designTemplate)

Combines a content section page with a design template page to result in a standard section page. Copies the content's cells from the regions to corrected location defined as the matching region.

Parameters:

content - The clipboard page for a content section.

designTemplate - The clipboard page for a design template section.

convertRegionToSectionModel

void convertRegionToSectionModel(ClipboardPage content,
                                 ClipboardPage designTemplate)

Used to convert a section from using a template. Combines a content section page with a design template page to result in a standard section page. Copies the content's cells from the regions to corrected location defined as the matching region. Cleans up region data.

Parameters:

content - The clipboard page for a content section.

designTemplate - The clipboard page for a design template section.

buildRegions

void buildRegions(ClipboardPage ruleformPage)

Builds list of regions for a design template.

Parameters:

ruleformPage - The top level page of the section rule.

buildRegions

void buildRegions(PublicAPI tools,
                  ClipboardPage ruleformPage)

Builds list of regions for a design template.

Parameters:

tools - A reference to the PublicAPI

ruleformPage - The top level page of the section rule.

changeDesignTemplateRegions

void changeDesignTemplateRegions(PublicAPI tools,
                                 ClipboardPage newDesignTemplatePage,
                                 ClipboardPage primary)

Parameters:

tools - A reference to the PublicAPI

newDesignTemplatePage - The new template being switched to in a section

primary - The primary section page

moveCellToRegion

void moveCellToRegion(PublicAPI tools,
                      ClipboardPage cellPage,
                      ClipboardPage sectionPage)

Takes the given cell and places it in the correct region

Parameters:

tools - A reference to the PublicAPI

cellPage - The page contains the cell data to be added to the section page's region

sectionPage - The primary section page which contains data regarding the regions

getDesignTemplateEditing

IDesignTemplateEditing getDesignTemplateEditing()

Accessor for grabbing a reference to the DesignTemplateEditing interface

Returns:

reference an instance of the DesignTemplateEditing interface (IDesignTemplateEditing)

isCellPresentInSection

boolean isCellPresentInSection(ClipboardPage sectionToSearch,
                               java.lang.String currentValue)

determines if the passed in section contains the passed in currentValue as in pyValue in one of the cells of the section

Parameters:

sectionToSearch - the section to search in (loops over regions and cells)

currentValue - the value to search for that matches the .pyValue property

Returns:

true if the current value was found in the section passed in