SAP NetWeaver '04

com.sapportals.wcm.rendering.layout
Interface ILayoutComposer

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.layout_api.jar]
All Superinterfaces:
ILayoutComponent

public interface ILayoutComposer
extends ILayoutComponent


Method Summary
 ILayoutComposer getNewInstance()
          returns a new instance of the implementing class.
 ILayoutObject[] getRenderer()
          returns all conrols that have to be registered with the Wdf-Framework.
 IResourceListProvider[] getResourceListProvider()
           
 void init()
           
 void readInputData(com.sapportals.htmlb.page.DynPage page)
           
 com.sapportals.htmlb.Component render()
          creates and returns the visible components for the user.
 
Methods inherited from interface com.sapportals.wcm.rendering.layout.ILayoutComponent
setProxy
 

Method Detail

getNewInstance

public ILayoutComposer getNewInstance()
returns a new instance of the implementing class. This method is used by the LayoutControllerFactory. The Factory holds one instance of the implementing class and calls its getNewInstance method. This allows the implementing class to set parameters at the newly created instance. It also reduces calls of the Class.forName() to gain performance.
Returns:
a new instance of the implementing class, never returns null.

render

public com.sapportals.htmlb.Component render()
                                      throws WcmException
creates and returns the visible components for the user. It is called, when the control that holds this instance (usually the IProxy is rendered by the Wdf-Framework. See the Wdf-Framework for details.
Returns:
an htmlb-Component that is to be displayed to the user

getRenderer

public ILayoutObject[] getRenderer()
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.
Returns:
an array of all controls inside the layoutcontroller that are to be registered with the WDF. The array must not contain null.

getResourceListProvider

public IResourceListProvider[] getResourceListProvider()

init

public void init()
          throws WcmException

readInputData

public void readInputData(com.sapportals.htmlb.page.DynPage page)

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.