com.sapportals.wcm.rendering.layout
Interface ILayoutController

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

All Superinterfaces:

ILayoutComponent

All Known Implementing Classes:

AbstractLayoutController, AbstractLayoutComposer

public interface ILayoutController

extends ILayoutComponent

Acts as a thin layer to allow a flexible arrangement of Control instances. It also allows to mix plain Components with Controlss. Depending on the current ICollection or ITypedResourceList, the and the parameters stemming from the current iView/URL, the LayoutControllerFactory returns a new instance of an ILayoutController. An implementing class can use different techniques to render its output. Note, that the interface does not offer any functionality for persisting information. If persistence through the Wdf-Framework is needed for a certain implementation, the implementing class has to extend the Control class and register itself via its own getControls method through the IProxy.

Method Summary

com.sapportals.wdf.stack.Control[]	getControls() returns all conrols that have to be registered with the Wdf-Framework.
ILayoutController	getNewInstance() returns a new instance of the implementing class.
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 ILayoutController 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.

getControls

public com.sapportals.wdf.stack.Control[] getControls()

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.

render

public com.sapportals.htmlb.Component render()
                                      throws com.sapportals.wdf.WdfException

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