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, MenuBarComponent, MetaPropertyComponent, OneStepComponent, PropertyComponent, PropertySelectionComposite, ResourceDetailsLink, ResourceImage, ResourceLink, ResourcePicker, 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

Fields
Modifier and Type Field and Description

protected Object request
Deprecated.
- Fields inherited from class com.sapportals.htmlb.AbstractCompositeComponent
  container

Fields
Modifier and Type	Field and Description
`protected Object`	`request` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`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

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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 ResourceBundles`	`getBundles()` Deprecated. As of NetWeaver 7.1
`protected String`	`getBundleString(String key)` Deprecated. As of NetWeaver 7.1
`protected String`	`getBundleString(String key, 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 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 which 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:
    
    parent -
    
    form -
  - getPopupUrl
```
protected String getPopupUrl()
```
    Deprecated. As of NetWeaver 7.1
    
    overwrite this method to return the url of the popup which has to be launched method getPopupUrl
    
    Returns:
    
    the url of the pop up
  - 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 which is returned from the popup. method onPopupClose
    
    Parameters:
    
    event -
    
    Returns:
    
    on pop up close event
  - 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:
    
    parameter for external submit event
  - 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:
    
    composite model
  - 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:
    
    String on click
  - 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:
    
    String on popup return
  - 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:
    
    true for closing the script, false otherwise
  - isPersistent
```
public boolean isPersistent()
```
    Deprecated. As of NetWeaver 7.1
    
    Returns:
    
    true if is persistent, false otherwise
  - 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:
    
    true if is enabled, false otherwise.
  - 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:
    
    component object for given ID
  - getDataForComponentId
```
public com.sapportals.htmlb.type.AbstractDataType getDataForComponentId(String elementId)
```
    Deprecated. As of NetWeaver 7.1
    
    Parameters:
    
    elementId -
    
    Returns:
    
    data type object for given ID
  - 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:
    
    data type object for given ID
  - 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:
    
    request object
  - 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 (without path)
    
    alternateText - an alternative text to display when image not available
    
    tooltip - the string used for displaying in the tooltip
    
    Returns:
    
    an Image object
  - getImagePath
```
protected String getImagePath(String name)
```
    Deprecated. As of NetWeaver 7.1
    
    Parameters:
    
    name -
    
    Returns:
    
    image path
  - getLocale
```
protected Locale getLocale()
```
    Deprecated. As of NetWeaver 7.1
    
    Returns:
    
    locale
  - getBundles
```
protected ResourceBundles getBundles()
```
    Deprecated. As of NetWeaver 7.1
    
    Returns:
    
    resource bundles
  - 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,
                                 ResourceBundles bundle)
```
    Deprecated. As of NetWeaver 7.1
  - getResourceContext
```
protected IResourceContext getResourceContext()
```
    Deprecated. As of NetWeaver 7.1
    
    Returns:
    
    resource context
  - getState
```
public BaseCompositeComponentState getState()
```
    Deprecated. As of NetWeaver 7.1
    
    Returns:
    
    state of base composite component
  - 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:
    
    popup height
  - getPopup_width
```
protected String getPopup_width()
```
    Deprecated. As of NetWeaver 7.1
    
    Returns:
    
    popup width
  - 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:
    
    model persistence ID
  - 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
  - getPaddingTop
```
public String getPaddingTop()
```
    Deprecated. As of NetWeaver 7.1
  - getDefaultButton
```
protected com.sapportals.htmlb.Button getDefaultButton()
```
    Deprecated. As of NetWeaver 7.1
    
    Returns:
    
    default button
  - setDefaultButton
```
protected void setDefaultButton(com.sapportals.htmlb.Button button)
```
    Deprecated. As of NetWeaver 7.1
    
    Parameters:
    
    button -

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`

Class BaseCompositeComponent

Field Summary

Fields inherited from class com.sapportals.htmlb.AbstractCompositeComponent

Constructor Summary

Method Summary

Methods inherited from class com.sapportals.htmlb.AbstractCompositeComponent

Methods inherited from class com.sapportals.htmlb.Component

Methods inherited from class java.lang.Object

Field Detail

request

Constructor Detail

BaseCompositeComponent

BaseCompositeComponent

BaseCompositeComponent

Method Detail

getBaseBundleName

createState

createContextFactory

createModel

getUI

render

buildComposition

buildContent

buildIntoForm

renderIntoForm

getPopupUrl

onPopupClose

getPopupCloseParameter

setPopupOpenButton

getCompositeModel

setCompositeModel

getOnClick

setOnClick

getOnPopupReturn

setOnPopupReturn

setCloseScript

isCloseScript

isPersistent

setPersistent

isEnabled

setEnabled

is508

initFromPageContextImpl

initFromPageContext

getComponentForId

getDataForComponentId

getDataForComponentId

setRequestPageContext

getPageContext

getRequest

getHTTPServletRequest

getRequestParameters

getRequestParameter

setRequest

getImage

getImagePath

getLocale

getBundles

getBundleString

getBundleString

getBundleString

getResourceContext

getState

setState

getPopup_height

getPopup_width

setPopup_height

setPopup_width

getModelPersistenceID

setPaddingTop

setPaddingBottom

getPaddingBottom

getPaddingTop

getDefaultButton

setDefaultButton

This class can be accessed from: