com.pega.pegarules.pub.generator

Interface IUIAssembly

public interface IUIAssembly

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	assembleControl(ClipboardPage cellPage, ClipboardPage pyGenJava)
void	assembleDynamicLayoutGroup(ClipboardPage aLayoutPage, ClipboardPage aSectionPage, ClipboardPage aPyGenJava, java.lang.Object[] aArgs)
void	assembleLayoutContainer(ClipboardPage aSectionPage, ClipboardPage aLayoutPage, ClipboardPage aPyGenJava, HashStringMap aArgs)
void	assembleLayoutGroup(ClipboardPage aSectionPage, ClipboardPage aPyGenJava, java.lang.Object[] aArgs)
void	assembleLayoutHeader(ClipboardPage aSectionPage, ClipboardPage aPg_thisSection, ClipboardPage aPyGenJava, HashStringMap aLayoutMetaProps)
void	assembleRepeatingDynamicLayout(ClipboardPage aSectionPage, ClipboardPage aLayoutPage, ClipboardPage aPyGenJava, java.lang.Object[] aArgs)
java.lang.String	assembleSectionInclude(ClipboardPage incInfoPage, java.lang.String type) Generates the section include code.
java.lang.String	assembleSectionInclude(ClipboardPage incInfoPage, java.lang.String type, ClipboardPage pyGenJava) Generates the section include code.
void	emitEmbedMetadata(java.lang.String propertyName, java.lang.String srcMetadataObjectName, java.lang.String targetMetadataObjectName) Generates the statement to embed metadata.
void	emitEmbedMetadataInArray(java.lang.String propertyName, java.lang.String srcMetadataObjectName, java.lang.String targetMetadataObjectName)
void	emitMetadata(java.lang.String propertyName, java.lang.String value, java.lang.String metadataObjectName, java.lang.String componentName) Emits the metadata add statement.
void	emitMetadataAsRaw(java.lang.String propertyName, java.lang.String value, java.lang.String metadataObjectName) Emits the metadata add statement.
void	emitMetadataAsRawIfNotEmpty(java.lang.String propertyName, java.lang.String value, java.lang.String metadataObjectName) Emits the metadata add statement.
void	emitMetadataIfNotEmpty(java.lang.String propertyName, java.lang.String value, java.lang.String metadataObjectName, java.lang.String componentName) Emits the metadata add statement.
void	emitMetadataInitialization(java.lang.String metadataObjectName) Creates new instance of Metadata without type.
void	emitNewMetadataInstance(java.lang.String metadataObjectName) Creates new instance of IUIComponent.
void	emitNewMetadataInstanceWithNull(java.lang.String metadataObjectName) Creates new instance of Metadata without instantiation.
void	emitNonTemplateMarker() Adds the variable to mark section as non template.
java.lang.String	getNonTemplateMarker() Returns the code statement to toggle pxIsNonTemplateStream boolean
java.lang.String	getStreamHash() Returns Stream hash which generates using setStreamHash
java.lang.String	getStreamUniqueID() Generates unique ID each time when we call this method
int	getUnitqueCounter()
boolean	hasNonTemplateComponent() Determines whether stream assembly has any non template components.
boolean	isTemplateComponent(ClipboardPage sectionPage) Check whether component is templatizable or not.
boolean	isTemplateComponent(java.lang.String name) Returns whether component is able to templatized.
boolean	isValidClientExpression(java.lang.String expression) Determines whether expression is capable of executing at client.
void	setStreamHash(java.lang.String hash) Sets the MD5 hash of the steam pzInsKey, updated date time

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

SECTION_INCLUDE_IN_CELL

static final java.lang.String SECTION_INCLUDE_IN_CELL

See Also:

Constant Field Values

Method Detail

assembleControl

java.lang.String assembleControl(ClipboardPage cellPage,
                                 ClipboardPage pyGenJava)

Parameters:

cellPage -

pyGenJava -

Returns:

assembled

isTemplateComponent

boolean isTemplateComponent(java.lang.String name)

Returns whether component is able to templatized.

Parameters:

name - of the component.

Returns:

boolean

assembleLayoutHeader

void assembleLayoutHeader(ClipboardPage aSectionPage,
                          ClipboardPage aPg_thisSection,
                          ClipboardPage aPyGenJava,
                          HashStringMap aLayoutMetaProps)

assembleLayoutContainer

void assembleLayoutContainer(ClipboardPage aSectionPage,
                             ClipboardPage aLayoutPage,
                             ClipboardPage aPyGenJava,
                             HashStringMap aArgs)

assembleSectionInclude

java.lang.String assembleSectionInclude(ClipboardPage incInfoPage,
                                        java.lang.String type)

Generates the section include code.

Parameters:

incInfoPage - ClipboardPage having section include information.

type - type can be cell or layout.

Returns:

method name

isTemplateComponent

boolean isTemplateComponent(ClipboardPage sectionPage)

Check whether component is templatizable or not. eq., Grid need to be template when pyNextGenGrid is true

Parameters:

sectionPage -

Returns:

boolean

emitMetadata

void emitMetadata(java.lang.String propertyName,
                  java.lang.String value,
                  java.lang.String metadataObjectName,
                  java.lang.String componentName)

Emits the metadata add statement.

Parameters:

propertyName -

value -

metadataObjectName -

componentName -

emitMetadataIfNotEmpty

void emitMetadataIfNotEmpty(java.lang.String propertyName,
                            java.lang.String value,
                            java.lang.String metadataObjectName,
                            java.lang.String componentName)

Emits the metadata add statement.

Parameters:

propertyName -

value -

metadataObjectName -

componentName -

emitNewMetadataInstance

void emitNewMetadataInstance(java.lang.String metadataObjectName)

Creates new instance of IUIComponent.

Parameters:

metadataObjectName -

emitMetadataAsRaw

void emitMetadataAsRaw(java.lang.String propertyName,
                       java.lang.String value,
                       java.lang.String metadataObjectName)

Emits the metadata add statement.

Parameters:

propertyName -

value -

metadataObjectName -

emitMetadataAsRawIfNotEmpty

void emitMetadataAsRawIfNotEmpty(java.lang.String propertyName,
                                 java.lang.String value,
                                 java.lang.String metadataObjectName)

Emits the metadata add statement.

Parameters:

propertyName -

value -

metadataObjectName -

emitEmbedMetadata

void emitEmbedMetadata(java.lang.String propertyName,
                       java.lang.String srcMetadataObjectName,
                       java.lang.String targetMetadataObjectName)

Generates the statement to embed metadata.

Parameters:

propertyName -

srcMetadataObjectName -

targetMetadataObjectName -

emitEmbedMetadataInArray

void emitEmbedMetadataInArray(java.lang.String propertyName,
                              java.lang.String srcMetadataObjectName,
                              java.lang.String targetMetadataObjectName)

Parameters:

propertyName -

srcMetadataObjectName -

targetMetadataObjectName -

emitNewMetadataInstanceWithNull

void emitNewMetadataInstanceWithNull(java.lang.String metadataObjectName)

Creates new instance of Metadata without instantiation.

Parameters:

metadataObjectName -

emitMetadataInitialization

void emitMetadataInitialization(java.lang.String metadataObjectName)

Creates new instance of Metadata without type.

Parameters:

metadataObjectName -

assembleRepeatingDynamicLayout

void assembleRepeatingDynamicLayout(ClipboardPage aSectionPage,
                                    ClipboardPage aLayoutPage,
                                    ClipboardPage aPyGenJava,
                                    java.lang.Object[] aArgs)

assembleDynamicLayoutGroup

void assembleDynamicLayoutGroup(ClipboardPage aLayoutPage,
                                ClipboardPage aSectionPage,
                                ClipboardPage aPyGenJava,
                                java.lang.Object[] aArgs)

assembleLayoutGroup

void assembleLayoutGroup(ClipboardPage aSectionPage,
                         ClipboardPage aPyGenJava,
                         java.lang.Object[] aArgs)

setStreamHash

void setStreamHash(java.lang.String hash)

Sets the MD5 hash of the steam pzInsKey, updated date time

Parameters:

hash -

getStreamHash

java.lang.String getStreamHash()

Returns Stream hash which generates using setStreamHash

Returns:

String

getStreamUniqueID

java.lang.String getStreamUniqueID()

Generates unique ID each time when we call this method

Returns:

String

getUnitqueCounter

int getUnitqueCounter()

emitNonTemplateMarker

void emitNonTemplateMarker()

Adds the variable to mark section as non template.

getNonTemplateMarker

java.lang.String getNonTemplateMarker()

Returns the code statement to toggle pxIsNonTemplateStream boolean

Returns:

indicate non template

isValidClientExpression

boolean isValidClientExpression(java.lang.String expression)

Determines whether expression is capable of executing at client.

Parameters:

expression -

Returns:

boolean

hasNonTemplateComponent

boolean hasNonTemplateComponent()

Determines whether stream assembly has any non template components.

Returns:

boolean

assembleSectionInclude

java.lang.String assembleSectionInclude(ClipboardPage incInfoPage,
                                        java.lang.String type,
                                        ClipboardPage pyGenJava)

Generates the section include code.

Parameters:

incInfoPage - ClipboardPage having section include information.

type - type can be cell or layout.

pyGenJava -

Returns:

method name