SAP NetWeaver '04

com.sapportals.wcm.rendering.layout
Class AbstractLayoutController

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.layout_api.jar]
com.sapportals.wcm.rendering.layout.AbstractLayoutController
All Implemented Interfaces:
ILayoutComponent, ILayoutController

public abstract class AbstractLayoutController
implements ILayoutController

Abstract class to implement some convenience methods for new implementations of the ILayoutController.


Field Summary
protected  com.sapportals.wdf.stack.Control[] controls
          The controls which are to be rendered by the extending class.
 
Constructor Summary
AbstractLayoutController()
           
 
Method Summary
 com.sapportals.wdf.stack.Control[] getControls()
          returns all conrols that have to be registered with the Wdf-Framework.
 IProxy getProxy()
          returns the proxy that has been set when instantiating the class.
 com.sapportals.htmlb.Component render()
          This method has to be implemented by the extending layoutcontroller, if its output is to be seen by the user
 void setProxy(IProxy proxy)
          sets the proxy-attribute for the layout-controller.
protected  void writeDebugInformation()
          adds information about its rendering to the IProxy's debug list.
 
Methods inherited from interface com.sapportals.wcm.rendering.layout.ILayoutController
getNewInstance
 

Field Detail

controls

protected com.sapportals.wdf.stack.Control[] controls
The controls which are to be rendered by the extending class.
Constructor Detail

AbstractLayoutController

public AbstractLayoutController()
Method Detail

getControls

public com.sapportals.wdf.stack.Control[] getControls()
Description copied from interface: ILayoutController
returns all conrols that have to be registered with the Wdf-Framework. If a control within the ILayoutController is not returned via this method, it can not use the Wdf-functionalities such as persistence of simple data types or the use of the WdfEventDispatcher to create Link or Button elements.
Specified by:
getControls in interface ILayoutController
Following copied from interface: com.sapportals.wcm.rendering.layout.ILayoutController
Returns:
an array of all controls inside the layoutcontroller that are to be registered with the WDF. The array must not contain null.

render

public com.sapportals.htmlb.Component render()
                                      throws com.sapportals.wdf.WdfException
This method has to be implemented by the extending layoutcontroller, if its output is to be seen by the user
Specified by:
render in interface ILayoutController
Following copied from interface: com.sapportals.wcm.rendering.layout.ILayoutController
Returns:
an htmlb-Component that is to be displayed to the user

setProxy

public void setProxy(IProxy proxy)
Description copied from interface: ILayoutComponent
sets the proxy-attribute for the layout-controller. The proxy has to be passed to classes within the ILayoutController, which want to use the proxy's services.
Specified by:
setProxy in interface ILayoutComponent

getProxy

public IProxy getProxy()
returns the proxy that has been set when instantiating the class.

writeDebugInformation

protected void writeDebugInformation()
adds information about its rendering to the IProxy's debug list. The IProxy offers this functionality to all classes involved in the rendeirng process. This abstract class adds the list of the Controls rendered.

SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.