com.pega.pegarules.pub.runtime

Interface IUIComponent

public interface IUIComponent

IComponent,

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IUIComponent.ComponentType Maintains the component types.
static class	IUIComponent.ForceReloadType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	RELOAD_INSTANCEID Constant to identify the reload template id.
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
void	abortComponent() Aborts the rendering
void	addAdditionalBundles(java.lang.String aOnlyOnceName, java.lang.String... bundles)
void	addAdditionalFragment(java.lang.String aOnlyOnceName, java.lang.String htmlFragment)
void	addAdditionalScripts(java.lang.String aOnlyOnceName, java.lang.String... scripts)
void	addDependentBundles(java.lang.String... bundles)
void	addDependentScripts(java.lang.String... scripts)
void	addDynamicProperties(java.util.Map<java.lang.String,java.lang.String> dynamicProperties) Adds given dynamic properties map to existing dynamic properties map
void	addDynamicProperty(java.lang.String name, java.lang.String value) Adds a dynamic property to the existing map of dynamic properties
void	addPreLoadScript(java.lang.String aHtmlFragment, java.lang.String aOnlyOnceName) API to add component specific scripts
boolean	addPropertyToMetadata(java.lang.String name, java.lang.String value) Used to add properties after invoking beginComponent.
java.lang.String	beginComponent(java.lang.String name)
java.lang.String	beginComponent(java.lang.String name, ClipboardPage metaPage, java.util.Map configMap) Starts the component rendering
java.lang.String	beginComponent(java.lang.String name, ClipboardPage metaPage, java.lang.String componentUniqueId, java.util.Map configMap) Starts the component rendering
void	beginComponent(java.lang.String name, IUIComponentMetadata metadata) Starts the component rendering
void	beginComponent(java.lang.String name, IUIComponentMetadata metadata, java.util.Map configMap)
void	disablePlaceholder()
void	endComponent() Ends the rendering.
void	endComponent(java.util.Map configMap)
void	forceReload() set default force reload type to full reload
void	forceReload(StringMap criteria) Reloads the current component if criteria does not match
void	forceReloadChildren(StringMap criteria) Reloads the children components if criteria does not match
java.lang.String	getChildRefPath() Returns the childRefPath
java.lang.String	getComponentUniqueId() Gets the component unique id.
java.util.Map	getConfigMap() Gets the component config map.
java.lang.String	getContextPageRef() Returns the context page reference of current component.
StringMap	getDefaultPropertyValueMap() Returns the Map of key value pair to avoid the defaults to be register with change tracker.
java.util.Map<java.lang.String,java.lang.String>	getDynamicProperties()
StringMap	getForceReloadCriteria()
IUIComponent.ForceReloadType	getForceReloadType() returns the status of force reload
java.lang.String	getLocation()
IUIComponentMetadata	getMetadata() returns the metadata associated to this component.
ClipboardPage	getMetaPage() Gets the Component meta page.
java.lang.String	getName() Gets the component name.
java.lang.String	getSectionContextHash() Returns the unique hash bound to the section context.
java.lang.String[]	getTrackedProperties() Returns the all properties marked for registering with change tracker.
java.lang.String	getUniqueHash() Returns the unique hash bound to the component.
boolean	isActionable() Determines whether component can be refreshable or reloaded independently.
boolean	isAtomic() Check whether the component is atom or not.
boolean	isCircularReference()
boolean	isCurrentRootsRequire() Determines whether component should hold the current roots.
boolean	isPlaceholderEnabled()
boolean	isRootMarkerRequire() Decides whether to create a root marker of templates.
boolean	isTemplate() Determines whether component is template or not.
boolean	isUIComponentRendered()
void	markAsAtomic() Makes the component atom unit so that component can be pushed to stream store.
void	markAsCircularReference()
void	resetMetadata(IUIComponentMetadata metadata)
void	setChildPathReference(java.lang.String childPathRef) holds the value to insert the next child apart from pyTemplates e.q, pySection.pySectionBody(1).
void	setDefaultPropertyValueMap(StringMap nonTrackedProperties) While registering with change tracker default properties will be ignored if value matches to the tracked properties.
void	setSectionContextHash(java.lang.String uniqueHash)
void	setTrackedProperties(java.lang.String[] trackedProperties) Pass the list of component specific absolute property references to be registered with the change tracker e.g.
void	setUIComponentRuntime(com.pega.pegarules.priv.runtime.IUIComponentRuntime uiComponentRuntime)
void	setUniqueHash(java.lang.String uniqueHash)

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

RELOAD_INSTANCEID

static final java.lang.String RELOAD_INSTANCEID

Constant to identify the reload template id.

See Also:

Constant Field Values

Method Detail

beginComponent

void beginComponent(java.lang.String name,
                    IUIComponentMetadata metadata)

Starts the component rendering

Parameters:

name - Component name

metadata - IUIComponentMetadata of the component

beginComponent

java.lang.String beginComponent(java.lang.String name,
                                ClipboardPage metaPage,
                                java.util.Map configMap)

Starts the component rendering

Parameters:

name - Component name

metaPage - Clipboard Page of the component

configMap - instanceid: Unique instance id class: html class on the root marker (optional)

Returns:

Returns the page ref

beginComponent

java.lang.String beginComponent(java.lang.String name,
                                ClipboardPage metaPage,
                                java.lang.String componentUniqueId,
                                java.util.Map configMap)

Starts the component rendering

Parameters:

name - Component name

metaPage - Clipboard Page of the component

componentUniqueId - component unique id

configMap - instanceid: Unique instance id class: html class on the root marker (optional)

Returns:

Returns the page ref

endComponent

void endComponent()

Ends the rendering. It has the responsibility of arranging templates in the UI Tree

abortComponent

void abortComponent()

Aborts the rendering

getLocation

java.lang.String getLocation()

setTrackedProperties

void setTrackedProperties(java.lang.String[] trackedProperties)

Pass the list of component specific absolute property references to be registered with the change tracker e.g. pyCells().pyValue pyCells().pyModes().pyStyleNameOther

Parameters:

trackedProperties -

setChildPathReference

void setChildPathReference(java.lang.String childPathRef)

holds the value to insert the next child apart from pyTemplates e.q, pySection.pySectionBody(1). pyCells(1) output will be pyTemplates(0).pySection.pySectionBody(1).pyCells(1).pyTemplates(0)

Parameters:

childPathRef -

isTemplate

boolean isTemplate()

Determines whether component is template or not. In case of template, special processing can be done. eq., Donot add entry to the tree or make other page.

Returns:

boolean value.

isCurrentRootsRequire

boolean isCurrentRootsRequire()

Determines whether component should hold the current roots. Example: RDL require pyCurrentRoots property to process the children templates.

Returns:

boolean value.

isActionable

boolean isActionable()

Determines whether component can be refreshable or reloaded independently. eq., Section, Layout, Cell etc.,

Returns:

boolean value.

getName

java.lang.String getName()

Gets the component name.

Returns:

component name.

getMetaPage

ClipboardPage getMetaPage()

Gets the Component meta page.

Returns:

Component meta page.

getComponentUniqueId

java.lang.String getComponentUniqueId()

Gets the component unique id.

Returns:

component unique.

getConfigMap

java.util.Map getConfigMap()

Gets the component config map.

Returns:

config map.

isRootMarkerRequire

boolean isRootMarkerRequire()

Decides whether to create a root marker of templates.

Returns:

boolean.

getChildRefPath

java.lang.String getChildRefPath()

Returns the childRefPath

Returns:

childRefPath.

getTrackedProperties

java.lang.String[] getTrackedProperties()

Returns the all properties marked for registering with change tracker.

Returns:

properties.

addPreLoadScript

void addPreLoadScript(java.lang.String aHtmlFragment,
                      java.lang.String aOnlyOnceName)

API to add component specific scripts

Parameters:

aHtmlFragment - - html fragment name which has to include

aOnlyOnceName - - pega only once name, pass this if html fragment needs to be included only once. If passed null then html fragment is included always

addDependentScripts

void addDependentScripts(java.lang.String... scripts)

addDependentBundles

void addDependentBundles(java.lang.String... bundles)

addAdditionalScripts

void addAdditionalScripts(java.lang.String aOnlyOnceName,
                          java.lang.String... scripts)

addAdditionalBundles

void addAdditionalBundles(java.lang.String aOnlyOnceName,
                          java.lang.String... bundles)

addAdditionalFragment

void addAdditionalFragment(java.lang.String aOnlyOnceName,
                           java.lang.String htmlFragment)

getDefaultPropertyValueMap

StringMap getDefaultPropertyValueMap()

Returns the Map of key value pair to avoid the defaults to be register with change tracker. While registering with change tracker default properties will be ignored if value matches to the tracked properties. Here, key will be the property name and value will be default value of the property. eq., key: pyFormatName value: Standard

Returns:

Map of key value pair.

isUIComponentRendered

boolean isUIComponentRendered()

setDefaultPropertyValueMap

void setDefaultPropertyValueMap(StringMap nonTrackedProperties)

While registering with change tracker default properties will be ignored if value matches to the tracked properties. Here, key will be the property name and value will be default value of the property. eq., key: pyFormatName value: Standard

Parameters:

nonTrackedProperties - StringMap of key value pair.

addDynamicProperty

void addDynamicProperty(java.lang.String name,
                        java.lang.String value)

Adds a dynamic property to the existing map of dynamic properties

Parameters:

name -

value -

addDynamicProperties

void addDynamicProperties(java.util.Map<java.lang.String,java.lang.String> dynamicProperties)

Adds given dynamic properties map to existing dynamic properties map

Parameters:

dynamicProperties - map

getDynamicProperties

java.util.Map<java.lang.String,java.lang.String> getDynamicProperties()

Returns:

Dynamic properties map

forceReload

void forceReload()

set default force reload type to full reload

forceReload

void forceReload(StringMap criteria)

Reloads the current component if criteria does not match

Parameters:

criteria -

forceReloadChildren

void forceReloadChildren(StringMap criteria)

Reloads the children components if criteria does not match

Parameters:

criteria -

getForceReloadType

IUIComponent.ForceReloadType getForceReloadType()

returns the status of force reload

Returns:

force reload status

getForceReloadCriteria

StringMap getForceReloadCriteria()

Returns:

force reload condition map

setUIComponentRuntime

void setUIComponentRuntime(com.pega.pegarules.priv.runtime.IUIComponentRuntime uiComponentRuntime)

Parameters:

uiComponentRuntime -

addPropertyToMetadata

boolean addPropertyToMetadata(java.lang.String name,
                              java.lang.String value)

Used to add properties after invoking beginComponent.

Parameters:

name - - name of the property

value - - value of the property

Returns:

true if added else false

getMetadata

IUIComponentMetadata getMetadata()

returns the metadata associated to this component.

Returns:

IUIComponentMetadata

markAsAtomic

void markAsAtomic()

Makes the component atom unit so that component can be pushed to stream store.

isAtomic

boolean isAtomic()

Check whether the component is atom or not.

Returns:

true false

getUniqueHash

java.lang.String getUniqueHash()

Returns the unique hash bound to the component. Example: In case of section, sectionUniqueHash will be used.

Returns:

hash.

setUniqueHash

void setUniqueHash(java.lang.String uniqueHash)

Parameters:

uniqueHash - set the unique hash for this component.

getSectionContextHash

java.lang.String getSectionContextHash()

Returns the unique hash bound to the section context.

Returns:

hash.

setSectionContextHash

void setSectionContextHash(java.lang.String uniqueHash)

Parameters:

uniqueHash - set the unique hash for this section context.

getContextPageRef

java.lang.String getContextPageRef()

Returns the context page reference of current component.

Returns:

contextPageRef

beginComponent

java.lang.String beginComponent(java.lang.String name)

endComponent

void endComponent(java.util.Map configMap)

beginComponent

void beginComponent(java.lang.String name,
                    IUIComponentMetadata metadata,
                    java.util.Map configMap)

resetMetadata

void resetMetadata(IUIComponentMetadata metadata)

markAsCircularReference

void markAsCircularReference()

isCircularReference

boolean isCircularReference()

disablePlaceholder

void disablePlaceholder()

isPlaceholderEnabled

boolean isPlaceholderEnabled()