com.pega.pegarules.pub.runtime

Interface IUIComponent

public interface IUIComponent

IComponent,

Version:

$Revision: 123213 $ $Date: 2015-02-05 02:44:57 -0500 (Thu, 05 Feb 2015) $

Author:

baipc

Nested Class Summary

Nested Classes

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

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

Methods

Modifier and Type	Method and Description
void	addPreLoadScript(java.lang.String aHtmlFragment, java.lang.String aOnlyOnceName) API to add component specific scripts
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	endComponent() Ends the rendering.
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.
StringMap	getDefaultPropertyValueMap() Returns the Map of key value pair to avoid the defaults to be register with change tracker.
ClipboardPage	getMetaPage() Gets the Component meta page.
java.lang.String	getName() Gets the component name.
java.lang.String[]	getTrackedProperties() Returns the all properties marked for registering with change tracker.
boolean	isActionable() Determines whether component can be refreshable or reloaded independently.
boolean	isCurrentRootsRequire() Determines whether component should hold the current roots.
boolean	isRootMarkerRequire() Decides whether to create a root marker of templates.
boolean	isTemplate() Determines whether component is template or not.
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	setTrackedProperties(java.lang.String[] trackedProperties) Pass the list of component specific absolute property references to be registered with the change tracker e.g.

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

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

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

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.

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.