com.sap.tc.webdynpro.progmodel.api
Interface IWDView

All Superinterfaces:

IWDController, IWDViewController

public interface IWDView

extends IWDViewController

Generic API of all views. This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Version:

$Id: //tc/WebDynproRuntime/630_VAL_REL/src/_webdynpro_progmodel/java/com/sap/tc/webdynpro/progmodel/api/IWDView.java#1 $

Method Summary

IWDViewElement	createElement(java.lang.Class viewElementInterface, java.lang.String id) Creates a new view element implementing the given interface and with the given optional ID.
IWDViewElement	getElement(java.lang.String id) Returns the view element with the given ID or null if no such element exists.
IWDViewElement	getRootElement() Returns the root element of this view's tree of view elements.
void	resetView() Resets the view's layout (i.e.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewController

firePlug, getViewInfo, requestFocus, requestFocus

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDController

getAction, getComponent, getContext, getControllerInfo, getMessage, getMessage, getName, getPackageName, getQualifiedName, getText, getText

Method Detail

createElement

public IWDViewElement createElement(java.lang.Class viewElementInterface,
                                    java.lang.String id)

Creates a new view element implementing the given interface and with the given optional ID.

Parameters:

viewElementInterface - class of an interface that belongs to the API of some UI element library

id - must be a legal identifier that does not start with an underscore; may be null, in which case an ID is determined automatically

Throws:

WDRuntimeException - in case a view element for the given ID already exists

getElement

public IWDViewElement getElement(java.lang.String id)

Returns the view element with the given ID or null if no such element exists.

getRootElement

public IWDViewElement getRootElement()

Returns the root element of this view's tree of view elements.

resetView

public void resetView()

Resets the view's layout (i.e. its tree of view elements) to the initial state declared at design time. That is, all dynamic modifications to the view layout are thrown away and the view returns to the state it was in when it was initialised.