com.sapportals.wcm.rendering.collection
Class CollectionRendererDecorator

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.collection_api.jar]

com.sapportals.wcm.rendering.collection.CollectionRendererDecorator

public final class CollectionRendererDecorator

Since:

EP6, SP2_CP Copyright (c) SAP AG 2003 renders decorations around the output of an ICollectionRenderer, using the configuration settings supplied by this renderer. This class does not use or offer any persistence mechanisms.

Constructor Summary

CollectionRendererDecorator()
Standard constructor that is only used by the HTMLB framework to recreate components after a server roundtrip.

CollectionRendererDecorator(com.sapportals.htmlb.Component comp, ICollectionRenderer renderer, IProxy proxy, ComponentValueMap valueMap)
constructor to use when using this class within the rendering process.

CollectionRendererDecorator(com.sapportals.htmlb.Component comp, ICollectionRenderer renderer, IProxy proxy, ComponentValueMap valueMap, IResource res)
constructor to use when using this class within the rendering process.

Method Summary

protected com.sapportals.htmlb.Component	buildContent()
java.lang.String	getUI()
protected void	initFromPageContextImpl(com.sapportals.htmlb.rendering.IPageContext pc, java.lang.String baseId)

Constructor Detail

CollectionRendererDecorator

public CollectionRendererDecorator()

Standard constructor that is only used by the HTMLB framework to recreate components after a server roundtrip. Must not be used in the rendering process. If done, a NullPointerException will be raised in a later method call.

CollectionRendererDecorator

public CollectionRendererDecorator(com.sapportals.htmlb.Component comp,
                                   ICollectionRenderer renderer,
                                   IProxy proxy,
                                   ComponentValueMap valueMap)

constructor to use when using this class within the rendering process. None of these parameters must be null. This is a convenience constructor which uses the #IProxy.getResource() method to retrieve the resource needed by the component.

Parameters:

comp - the current component that is to be decorated.

renderer - that is used to retrieve the configuration from. It is also passed to the IComponents that might be rendered by this class

proxy - the outer proxy that is used throughout the rendering process

valueMap - holding all information needed by IComponent instances to do their rendering. It might be empty.

CollectionRendererDecorator

public CollectionRendererDecorator(com.sapportals.htmlb.Component comp,
                                   ICollectionRenderer renderer,
                                   IProxy proxy,
                                   ComponentValueMap valueMap,
                                   IResource res)

constructor to use when using this class within the rendering process. None of these parameters must be null

Parameters:

comp - the current component that is to be decorated.

renderer - that is used to retrieve the configuration from. It is also passed to the IComponents that might be rendered by this class

proxy - the outer proxy that is used throughout the rendering process

valueMap - holding all information needed by IComponent instances to do their rendering. It might be empty.

res - the resource that is used by the component to be rendered. Some components might not need this parameter.

Method Detail

buildContent

protected com.sapportals.htmlb.Component buildContent()

getUI

public java.lang.String getUI()

initFromPageContextImpl

protected void initFromPageContextImpl(com.sapportals.htmlb.rendering.IPageContext pc,
                                       java.lang.String baseId)