com.sapportals.wcm.rendering.readymades

Class UICommandComponent

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

Deprecated. As of NetWeaver 7.1

public final class UICommandComponent
extends BaseCompositeComponent

Since:

EP6, SP2_CP renders the commands defined for a given resource. Depending on the used constructor, it either renders the commands defined in the given groupID or it reads out the configuration defined by the IParameters parameter.

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

UICommandComponent()
Deprecated. As of NetWeaver 7.1

UICommandComponent(IResource res, IProxy proxy, IParameterName parameterName, IParameters parameters)
Deprecated. As of NetWeaver 7.1

UICommandComponent(IResource res, IProxy proxy, String groupID, String menuType)
Deprecated. As of NetWeaver 7.1

UICommandComponent(RenderDataContainer data, IParameterName parameterName, IParameters parameters)
Deprecated. As of NetWeaver 7.1

Method Summary

protected com.sapportals.htmlb.Component	buildContent() 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, getUI, 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

UICommandComponent

public UICommandComponent(IResource res,
                          IProxy proxy,
                          IParameterName parameterName,
                          IParameters parameters)

Deprecated. As of NetWeaver 7.1

simple constructor to be used by parameterized components of the FlexUI, such as an ICollectionRenderer or an IResourceRenderer. None of the parameters must be null

Parameters:

res - the resource to render the commands for

proxy - the outer proxy, needed for creation of link targets

parameterName - defining which parameter of the parameters defines the command group to use

parameters - the parameterization used to define the output of this class

UICommandComponent

public UICommandComponent(RenderDataContainer data,
                          IParameterName parameterName,
                          IParameters parameters)

Deprecated. As of NetWeaver 7.1

simple constructor to be used by parameterized components of the FlexUI, such as an ICollectionRenderer or an IResourceRenderer. None of the parameters must be null

Parameters:

data - data container

parameterName - defining which parameter of the parameters defines the command group to use

parameters - the parameterization used to define the output of this class

UICommandComponent

public UICommandComponent(IResource res,
                          IProxy proxy,
                          String groupID,
                          String menuType)

Deprecated. As of NetWeaver 7.1

constructor to be used if no parameterization is available or is not used on purpose. None of the parameters must be null

Parameters:

res - the resource to render the commands for

proxy - the outer proxy, needed for creation of link targets

groupID - the id of the group to render

menuType - the design the commands should be rendered in, use constants from IUIMenu

UICommandComponent

public UICommandComponent()

Deprecated. As of NetWeaver 7.1

must not be used! Only needed for htmlb-Framework generic calls. Usage will lead to a runtime exception in the buildContent()-method

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 which renders the content of this composite

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