Common Controller Class Reference (SAP Library - Developing User Interfaces with Web Dynpro for Java)

Common Controller Class Reference

The Common Controller Class Reference comprises those parts all Web Dynpro controller classes have in common. The additional parts, which depend on a specific controller type, are documented within separate sections on the four Web Dynpro controller types Component, Custom, Window and View controller.

Methods

Predefined Hook Methods
	public void wdDoExit() Called by the Web Dynpro Runtime before destroying a controller instance to clean it up.
	public void wdDoInit() Called by the Web Dynpro Runtime to initialize a controller instance.
Additional public Methods based on Declaration
	public <type> <method name>([parameter { "," parameter }]) [throws {checked exception class type}] Controller method with arbitrary signature (parameters and return type). Checked or compiler-enforced exceptions can be defined for all controller methods, which are declared by an application developer. In the Web Dynpro Tools checked exceptions are added to a method definition similar to the addition of method parameters. The calling public controller method must take care of these exceptions by either catching or adding them in its own method definition (declaring them in its throws clause). Within View Controllers additional methods based on declaration are of type public. Nevertheless they cannot be called from other controllers because view controllers do not expose an IPublic-API.
	public void <event handler name>( IWDCustomEvent wdEvent, ["," parameter {"," parameter}]) Event handler method. The parameters must be compatible with the parameters of the subcribed event. The name of event handlers should start with the prefix on.
Other private Methods
	private <type> <method name>([parameter { "," parameter }]) Additional private methods can be added within the final user coding area: //@@begin others - //@@end code. These methods are not added to the controller’s IPublic-API so that they are not exposed to other controllers even when they are specified with the public visibility statement.

Member Variables

Predefined Shortcut Variables
	private final IPrivate<controller name> wdThis References the generated IPrivate interface of the internal controller class.
	private final IPrivate<controller name>.IContextNode wdContext References the root node within a controller context. Provides typed access not only to the elements of the root node but also to all nodes in the context (methods node<node name>()) and their currently selected element (methods current<node name>Element()). It also facilitates the creation of new elements for all nodes (methods create<node name>Element()).
	private final com.sap.tc.webdynpro.progmodel.api.IWDComponent wdComponentAPI A shortcut for wdThis.wdGetAPI().getComponent(). Represents the generic API of the Web Dynpro component this controller belongs to. Can be used to access additional Web Dynpro Runtime APIs associated with the IWDComponent-API like the message manager, the window manager or to dynamically add/remove event handlers.
	private final <generic controller API> wdControllerAPI A shortcut for wdThis.wdGetAPI(). Represents the generic controller API (IWDController, IWDComponent, IWDViewController and IWDWindowController) of the generic Web Dynpro counterpart for this controller.
Predefined Variables
	logger Logging location
	serialVersionUID This variable is not relevant for application code development. It is required for the SAP NetWeaver serialization framework to check the binary compatibility of serialized objects.
Private Member Variables
	private <type> <variable name> An arbitrary number of private member variables can be added within the final user coding area: //@@begin others - //@@end code