com.sapportals.wcm.control.util.components.base

Class BaseCompositeComponent

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

Direct Known Subclasses:

CollectionRendererDecorator, CommandRenderer, ContextDisplay, EmptyCollectionInfo, InternalTree, MenuBarComponent, MetaPropertyComponent, OneStepComponent, PersistenceShrinkComponent, PropertyComponent, PropertySelectionComposite, RenderInfoLink, ResourceDetailsLink, ResourceImage, ResourceLink, ResourcePicker, RIDPersistenceComponent, UICommandComponent

Deprecated. As of NetWeaver 7.1

public abstract class BaseCompositeComponent
extends com.sapportals.htmlb.AbstractCompositeComponent

This is the base class for composite components which provides some extra functions to deal with ResourceBundles and ResourceContexts.

Field Summary

protected Object

request Deprecated.

Fields inherited from class com.sapportals.htmlb.AbstractCompositeComponent

container

Constructor Summary

BaseCompositeComponent()
Deprecated. As of NetWeaver 7.1

BaseCompositeComponent(String id)
Deprecated. As of NetWeaver 7.1

BaseCompositeComponent(String id, com.sapportals.htmlb.rendering.IPageContext pc)
Deprecated. As of NetWeaver 7.1

Method Summary

void	buildComposition() Deprecated. As of NetWeaver 7.1
protected abstract com.sapportals.htmlb.Component	buildContent() Deprecated. As of NetWeaver 7.1
protected void	buildIntoForm(com.sapportals.htmlb.FormLayout form) Deprecated. As of NetWeaver 7.1
protected IContextFactory	createContextFactory() Deprecated. As of NetWeaver 7.1
protected ContextModel	createModel(Object request) Deprecated. As of NetWeaver 7.1
protected BaseCompositeComponentState	createState() Deprecated. As of NetWeaver 7.1
protected String	getBaseBundleName() Deprecated. As of NetWeaver 7.1
protected com.sapportals.wcm.util.resource.ResourceBundles	getBundles() Deprecated. As of NetWeaver 7.1
protected String	getBundleString(String key) Deprecated. As of NetWeaver 7.1
protected String	getBundleString(String key, com.sapportals.wcm.util.resource.ResourceBundles bundle) Deprecated. As of NetWeaver 7.1
protected String	getBundleString(String key, String baseName) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	getComponentForId(String elementId) Deprecated. As of NetWeaver 7.1
protected ContextModel	getCompositeModel() Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.type.AbstractDataType	getDataForComponentId(String elementId) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.type.AbstractDataType	getDataForComponentId(String tableId, String elementId, int row) Deprecated. As of NetWeaver 7.1
protected com.sapportals.htmlb.Button	getDefaultButton() Deprecated. As of NetWeaver 7.1
protected HttpServletRequest	getHTTPServletRequest() Deprecated. As of NetWeaver 7.1
protected com.sapportals.htmlb.Image	getImage(String fileName, String alternateText, String tooltip) Deprecated. As of NetWeaver 7.1
protected String	getImagePath(String name) Deprecated. As of NetWeaver 7.1
protected Locale	getLocale() Deprecated. As of NetWeaver 7.1
protected String	getModelPersistenceID() Deprecated. As of NetWeaver 7.1
String	getOnClick() Deprecated. As of NetWeaver 7.1
String	getOnPopupReturn() Deprecated. As of NetWeaver 7.1
String	getPaddingBottom() Deprecated. As of NetWeaver 7.1
String	getPaddingTop() Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.rendering.IPageContext	getPageContext() Deprecated. As of NetWeaver 7.1
protected String	getPopup_height() Deprecated. As of NetWeaver 7.1
protected String	getPopup_width() Deprecated. As of NetWeaver 7.1
protected String	getPopupCloseParameter() Deprecated. As of NetWeaver 7.1
protected String	getPopupUrl() Deprecated. As of NetWeaver 7.1
protected Object	getRequest() Deprecated. As of NetWeaver 7.1
protected String	getRequestParameter(String key) Deprecated. As of NetWeaver 7.1
protected Map	getRequestParameters() Deprecated. As of NetWeaver 7.1
protected IResourceContext	getResourceContext() Deprecated. As of NetWeaver 7.1
BaseCompositeComponentState	getState() Deprecated. As of NetWeaver 7.1
String	getUI() Deprecated. As of NetWeaver 7.1
protected void	initFromPageContext(com.sapportals.htmlb.rendering.IPageContext pc, String baseId) Deprecated. As of NetWeaver 7.1
protected abstract void	initFromPageContextImpl(com.sapportals.htmlb.rendering.IPageContext pc, String baseId) Deprecated. As of NetWeaver 7.1
protected boolean	is508() Deprecated. As of NetWeaver 7.1
protected boolean	isCloseScript() Deprecated. As of NetWeaver 7.1
boolean	isEnabled() Deprecated. As of NetWeaver 7.1
boolean	isPersistent() Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.event.Event	onPopupClose(com.sapportals.htmlb.event.Event event) Deprecated. As of NetWeaver 7.1
void	render(com.sapportals.htmlb.rendering.IPageContext pc) Deprecated. As of NetWeaver 7.1
void	renderIntoForm(com.sapportals.htmlb.Container parent, com.sapportals.htmlb.FormLayout form) Deprecated. As of NetWeaver 7.1
protected void	setCloseScript(boolean b) Deprecated. As of NetWeaver 7.1
protected void	setCompositeModel(ContextModel model) Deprecated. As of NetWeaver 7.1
protected void	setDefaultButton(com.sapportals.htmlb.Button button) Deprecated. As of NetWeaver 7.1
void	setEnabled(boolean b) Deprecated. As of NetWeaver 7.1
void	setOnClick(String string) Deprecated. As of NetWeaver 7.1
void	setOnPopupReturn(String string) Deprecated. As of NetWeaver 7.1
void	setPaddingBottom(String paddingBottom) Deprecated. As of NetWeaver 7.1
void	setPaddingTop(String paddingTop) Deprecated. As of NetWeaver 7.1
void	setPersistent(boolean b) Deprecated. As of NetWeaver 7.1
protected void	setPopup_height(String string) Deprecated. As of NetWeaver 7.1
protected void	setPopup_width(String string) Deprecated. As of NetWeaver 7.1
void	setPopupOpenButton(com.sapportals.htmlb.Button openButton) Deprecated. As of NetWeaver 7.1
void	setRequest(Object object) Deprecated. As of NetWeaver 7.1
protected void	setRequestPageContext(com.sapportals.htmlb.rendering.IPageContext context) Deprecated. As of NetWeaver 7.1
void	setState(BaseCompositeComponentState state) Deprecated. As of NetWeaver 7.1

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

Field Detail

request

protected Object request

Deprecated.

Constructor Detail

BaseCompositeComponent

public BaseCompositeComponent()

Deprecated. As of NetWeaver 7.1

the constructor wich is used to reconstruct the component from the request.

BaseCompositeComponent

public BaseCompositeComponent(String id)

Deprecated. As of NetWeaver 7.1

the constructor wich has to be used while rendering the component. A standard model is created in this constructor.

Parameters:

id - a unique id for the component

BaseCompositeComponent

public BaseCompositeComponent(String id,
                              com.sapportals.htmlb.rendering.IPageContext pc)

Deprecated. As of NetWeaver 7.1

the constructor wich has to be used while rendering the component. A standard model is created in this constructor.

Parameters:

id - a unique id for the component

Method Detail

getBaseBundleName

protected String getBaseBundleName()

Deprecated. As of NetWeaver 7.1

createState

protected BaseCompositeComponentState createState()

Deprecated. As of NetWeaver 7.1

createContextFactory

protected IContextFactory createContextFactory()

Deprecated. As of NetWeaver 7.1

createModel

protected ContextModel createModel(Object request)

Deprecated. As of NetWeaver 7.1

getUI

public String getUI()

Deprecated. As of NetWeaver 7.1

Specified by:

getUI in class com.sapportals.htmlb.Component

render

public void render(com.sapportals.htmlb.rendering.IPageContext pc)

Deprecated. As of NetWeaver 7.1

Overrides:

render in class com.sapportals.htmlb.AbstractCompositeComponent

buildComposition

public final void buildComposition()

Deprecated. As of NetWeaver 7.1

This method is called during the rendering process of the component. It is final in this class. Within this method, the buildContent <\code> method is called.

Specified by:

buildComposition in class com.sapportals.htmlb.AbstractCompositeComponent

buildContent

protected abstract com.sapportals.htmlb.Component buildContent()

Deprecated. As of NetWeaver 7.1

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

Returns:

the Component wich renders the content of this composite

buildIntoForm

protected void buildIntoForm(com.sapportals.htmlb.FormLayout form)

Deprecated. As of NetWeaver 7.1

renderIntoForm

public final void renderIntoForm(com.sapportals.htmlb.Container parent,
                                 com.sapportals.htmlb.FormLayout form)

Deprecated. As of NetWeaver 7.1

Parameters:

layout -

getPopupUrl

protected String getPopupUrl()

Deprecated. As of NetWeaver 7.1

overwrite this method to return the url of the popup wich has to be launched method getPopupUrl

Returns:

onPopupClose

public com.sapportals.htmlb.event.Event onPopupClose(com.sapportals.htmlb.event.Event event)

Deprecated. As of NetWeaver 7.1

overwrite this method to handle the ExternalSubmitEvent wich is returned from the popup. method onPopupClose

Parameters:

event -

Returns:

getPopupCloseParameter

protected String getPopupCloseParameter()

Deprecated. As of NetWeaver 7.1

this method is called during the event handler of the popup close event. Overwrite this method to return the parameter for the external submit event. temporary solution. method getPopupCloseParameter

Returns:

setPopupOpenButton

public void setPopupOpenButton(com.sapportals.htmlb.Button openButton)

Deprecated. As of NetWeaver 7.1

This method is used from the external component or control to connect a button to this component. method setPopupOpenButton

Parameters:

openButton -

getCompositeModel

protected ContextModel getCompositeModel()

Deprecated. As of NetWeaver 7.1

method getCompositeModel

Returns:

setCompositeModel

protected void setCompositeModel(ContextModel model)

Deprecated. As of NetWeaver 7.1

method setCompositeModel

Parameters:

model -

getOnClick

public String getOnClick()

Deprecated. As of NetWeaver 7.1

method getOnClick

Returns:

setOnClick

public void setOnClick(String string)

Deprecated. As of NetWeaver 7.1

method setOnClick

Parameters:

string -

getOnPopupReturn

public String getOnPopupReturn()

Deprecated. As of NetWeaver 7.1

method getOnClose

Returns:

setOnPopupReturn

public void setOnPopupReturn(String string)

Deprecated. As of NetWeaver 7.1

method setOnClose

Parameters:

string -

setCloseScript

protected void setCloseScript(boolean b)

Deprecated. As of NetWeaver 7.1

method setCloseScript

Parameters:

b -

isCloseScript

protected boolean isCloseScript()

Deprecated. As of NetWeaver 7.1

method isCloseScript

Returns:

isPersistent

public boolean isPersistent()

Deprecated. As of NetWeaver 7.1

Returns:

setPersistent

public void setPersistent(boolean b)

Deprecated. As of NetWeaver 7.1

Parameters:

b -

isEnabled

public boolean isEnabled()

Deprecated. As of NetWeaver 7.1

Returns:

setEnabled

public void setEnabled(boolean b)

Deprecated. As of NetWeaver 7.1

Parameters:

b -

is508

protected boolean is508()

Deprecated. As of NetWeaver 7.1

initFromPageContextImpl

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

Deprecated. As of NetWeaver 7.1

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.

initFromPageContext

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

Deprecated. As of NetWeaver 7.1

This method is called, when the component is restored from the page context. In this class the model of the component is restored and the resource context is set. This method has to be called from derived classes before they do their own initialization.

Overrides:

initFromPageContext in class com.sapportals.htmlb.Component

getComponentForId

public com.sapportals.htmlb.Component getComponentForId(String elementId)

Deprecated. As of NetWeaver 7.1

Parameters:

elementId -

Returns:

getDataForComponentId

public com.sapportals.htmlb.type.AbstractDataType getDataForComponentId(String elementId)

Deprecated. As of NetWeaver 7.1

Parameters:

elementId -

Returns:

getDataForComponentId

public com.sapportals.htmlb.type.AbstractDataType getDataForComponentId(String tableId,
                                                                        String elementId,
                                                                        int row)

Deprecated. As of NetWeaver 7.1

Parameters:

tableId -

elementId -

row -

Returns:

setRequestPageContext

protected final void setRequestPageContext(com.sapportals.htmlb.rendering.IPageContext context)

Deprecated. As of NetWeaver 7.1

method setOldPageContext

Parameters:

context -

getPageContext

public com.sapportals.htmlb.rendering.IPageContext getPageContext()

Deprecated. As of NetWeaver 7.1

Overrides:

getPageContext in class com.sapportals.htmlb.AbstractCompositeComponent

getRequest

protected Object getRequest()

Deprecated. As of NetWeaver 7.1

Returns:

getHTTPServletRequest

protected HttpServletRequest getHTTPServletRequest()

Deprecated. As of NetWeaver 7.1

getRequestParameters

protected Map getRequestParameters()

Deprecated. As of NetWeaver 7.1

getRequestParameter

protected String getRequestParameter(String key)

Deprecated. As of NetWeaver 7.1

setRequest

public void setRequest(Object object)

Deprecated. As of NetWeaver 7.1

Parameters:

object -

getImage

protected com.sapportals.htmlb.Image getImage(String fileName,
                                              String alternateText,
                                              String tooltip)

Deprecated. As of NetWeaver 7.1

Gets the specified image.

Parameters:

fileName - the name of the imagefile (wihout path)

altenateText - an alternative text to display when image not available

tooltip - the string used for displaying in the tooltip

Returns:

an Image object

Throws:

WcmException - if URL generator could not be retrieved

getImagePath

protected String getImagePath(String name)

Deprecated. As of NetWeaver 7.1

Parameters:

name -

Returns:

getLocale

protected Locale getLocale()

Deprecated. As of NetWeaver 7.1

Returns:

getBundles

protected com.sapportals.wcm.util.resource.ResourceBundles getBundles()

Deprecated. As of NetWeaver 7.1

Returns:

getBundleString

protected String getBundleString(String key)

Deprecated. As of NetWeaver 7.1

returns a bundle string with the locale from the current resource context

getBundleString

protected String getBundleString(String key,
                                 String baseName)

Deprecated. As of NetWeaver 7.1

getBundleString

protected String getBundleString(String key,
                                 com.sapportals.wcm.util.resource.ResourceBundles bundle)

Deprecated. As of NetWeaver 7.1

getResourceContext

protected IResourceContext getResourceContext()

Deprecated. As of NetWeaver 7.1

Returns:

getState

public BaseCompositeComponentState getState()

Deprecated. As of NetWeaver 7.1

Returns:

setState

public void setState(BaseCompositeComponentState state)

Deprecated. As of NetWeaver 7.1

Parameters:

state -

getPopup_height

protected String getPopup_height()

Deprecated. As of NetWeaver 7.1

Returns:

getPopup_width

protected String getPopup_width()

Deprecated. As of NetWeaver 7.1

Returns:

setPopup_height

protected void setPopup_height(String string)

Deprecated. As of NetWeaver 7.1

Parameters:

string -

setPopup_width

protected void setPopup_width(String string)

Deprecated. As of NetWeaver 7.1

Parameters:

string -

getModelPersistenceID

protected String getModelPersistenceID()

Deprecated. As of NetWeaver 7.1

Returns:

setPaddingTop

public void setPaddingTop(String paddingTop)

Deprecated. As of NetWeaver 7.1

setPaddingBottom

public void setPaddingBottom(String paddingBottom)

Deprecated. As of NetWeaver 7.1

getPaddingBottom

public String getPaddingBottom()

Deprecated. As of NetWeaver 7.1

Returns:

getPaddingTop

public String getPaddingTop()

Deprecated. As of NetWeaver 7.1

Returns:

getDefaultButton

protected com.sapportals.htmlb.Button getDefaultButton()

Deprecated. As of NetWeaver 7.1

Returns:

setDefaultButton

protected void setDefaultButton(com.sapportals.htmlb.Button button)

Deprecated. As of NetWeaver 7.1

Parameters:

button -

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