com.sapportals.wcm.rendering.collection

Class CollectionRendererDecorator

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.AbstractCompositeComponent
          com.sapportals.wcm.control.util.components.base.BaseCompositeComponent
              com.sapportals.wcm.rendering.collection.CollectionRendererDecorator

Deprecated. As of NetWeaver 7.1

public final class CollectionRendererDecorator
extends BaseCompositeComponent

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.

Field Summary

Fields inherited from class com.sapportals.wcm.control.util.components.base.BaseCompositeComponent

request

Fields inherited from class com.sapportals.htmlb.AbstractCompositeComponent

container

Constructor Summary

CollectionRendererDecorator()
Deprecated. As of NetWeaver 7.1

CollectionRendererDecorator(com.sapportals.htmlb.Component comp, ICollectionRenderer renderer, IProxy proxy, ComponentValueMap valueMap)
Deprecated. As of NetWeaver 7.1

CollectionRendererDecorator(com.sapportals.htmlb.Component comp, ICollectionRenderer renderer, IProxy proxy, ComponentValueMap valueMap, IResource res)
Deprecated. As of NetWeaver 7.1

Method Summary

protected com.sapportals.htmlb.Component	buildContent() Deprecated. As of NetWeaver 7.1
String	getUI() Deprecated. As of NetWeaver 7.1
protected void	initFromPageContextImpl(com.sapportals.htmlb.rendering.IPageContext pc, String baseId) Deprecated. As of NetWeaver 7.1

Methods inherited from class com.sapportals.wcm.control.util.components.base.BaseCompositeComponent

buildComposition, buildIntoForm, createContextFactory, createModel, createState, getBaseBundleName, getBundles, getBundleString, getBundleString, getBundleString, getComponentForId, getCompositeModel, getDataForComponentId, getDataForComponentId, getDefaultButton, getHTTPServletRequest, getImage, getImagePath, getLocale, getModelPersistenceID, getOnClick, getOnPopupReturn, getPaddingBottom, getPaddingTop, getPageContext, getPopup_height, getPopup_width, getPopupCloseParameter, getPopupUrl, getRequest, getRequestParameter, getRequestParameters, getResourceContext, getState, initFromPageContext, is508, isCloseScript, isEnabled, isPersistent, onPopupClose, render, renderIntoForm, setCloseScript, setCompositeModel, setDefaultButton, setEnabled, setOnClick, setOnPopupReturn, setPaddingBottom, setPaddingTop, setPersistent, setPopup_height, setPopup_width, setPopupOpenButton, setRequest, setRequestPageContext, setState

Methods inherited from class com.sapportals.htmlb.AbstractCompositeComponent

createCompositeComponentId, preRender, unEscape

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromShortId, initializeFromId, isJsObjectNeeded, renderAsString, requiresForm, setId, setJsObjectNeeded, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionRendererDecorator

public CollectionRendererDecorator()

Deprecated. As of NetWeaver 7.1

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)

Deprecated. As of NetWeaver 7.1

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)

Deprecated. As of NetWeaver 7.1

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()

Deprecated. As of NetWeaver 7.1

Description copied from class: BaseCompositeComponent

Overwrite this method to return the content of the composite component. When this method is called, the model is valid and can be used to get the data. method buildContent

Specified by:

buildContent in class BaseCompositeComponent

Returns:

the Component wich renders the content of this composite

getUI

public String getUI()

Deprecated. As of NetWeaver 7.1

Overrides:

getUI in class BaseCompositeComponent

initFromPageContextImpl

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

Deprecated. As of NetWeaver 7.1

Description copied from class: BaseCompositeComponent

this method is called from the initFromPageContext method. Overwrite this method in order to do some own initializations. When this method is called, the model is fully recontructed and the resource context is set.

Specified by:

initFromPageContextImpl in class BaseCompositeComponent

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM