com.sapportals.wcm.rendering.screenflow.os

Class OneStepComponent

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.AbstractCompositeComponent
          com.sapportals.wcm.control.util.components.base.BaseCompositeComponent
              com.sapportals.wcm.rendering.screenflow.os.OneStepComponent

Direct Known Subclasses:

ConfirmComponent

Deprecated. As of NetWeaver 7.1

public abstract class OneStepComponent
extends BaseCompositeComponent

Since:

NW04, SPS4 base class for components that are rendered in the screenflows defined for commands. These components must be able to read out the user input and fire an htmlb-Event that is understood by the command. An implementation must ensure that the fired event is sent to the renderer and its actiontarget as defined in the two methods of this class. To do so, the fired event must call its super constructor and provide the rendererID as parameter. In a second step, the action target must be set as action-parameter of the fired event.
public class MyEvent extends Event { public MyEvent(String rendererID) { super(rendererID); } ... } public class MyComponent extends OneStepComponent { ... public Event onClick(Event event) { ... MyEvent result = new MyEvent(this.getRendererID()); ... result.setAction(this.getActiontarget()); ... return result; } ... }

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

OneStepComponent()
Deprecated.

Method Summary

abstract void	setActiontarget(String actiontarget) Deprecated. As of NetWeaver 7.1
abstract void	setRendererID(String renderer) Deprecated. As of NetWeaver 7.1

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

buildComposition, buildContent, 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, initFromPageContextImpl, 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

OneStepComponent

public OneStepComponent()

Deprecated.

Method Detail

setRendererID

public abstract void setRendererID(String renderer)

Deprecated. As of NetWeaver 7.1

Parameters:

renderer - the receiver of the fired event. Method is called by the control that renders this component. It is the components job to persist this information so it can be retrieved after the user has clicked a link in this class.

setActiontarget

public abstract void setActiontarget(String actiontarget)

Deprecated. As of NetWeaver 7.1

Parameters:

actiontarget - the action to be taken when a link has been clicked. Method is called by the control that renders this component. It is the components job to persist this information so it can be retrieved after the user has clicked a link in this class.

Access Rights

This class can be accessed from:

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