Web Dynpro API Documentation

Package com.sap.tc.webdynpro.progmodel.api

Contains interfaces and classes that form the core programming model for Web Dynpro applications.

See:
          Description

Interface Summary
IWDAction Offers access to actions of a controller.
IWDApplication Generic API of a Web Dynpro Application.
IWDAttributeInfo Structure information for a context attribute.
IWDBoundValueSet IWDBoundValueSet is a utility class that can bind a DropDownByKey UI element to a context node.
IWDBoundValueSet.IWDFilterListener Optional interface in case the application needs to implement a filter function for large valuesets used in an evs component.
IWDComponent Generic API of all Web Dynpro component controllers.
IWDComponentUsage API of component usages.
IWDContext Access to the context data of a controller.
IWDController Generic API of all Web Dynpro controllers.
IWDCustomEvent API of Custom Events provided to Controller Event Handlers.
IWDExternalControllerInterface Common Interface for all External Interfaces of Controllers.
IWDLayout Web Dynpro Layout API.
IWDLayoutData Web Dynpro LayoutData API.
IWDMessage Simple marker interface for messages
IWDMessageManager IWDMessageManager is used for reporting runtime exceptions that will not lead to a termination of the current Web Dynpro Component, but the error(s) is/are presented to the end user in a configurable manner.
IWDModifiableBinaryType The interface IWDModifiableBinaryType represents a special Web Dynpro implementation of the Java DDIC's binary type.
IWDNode Application Interface implemented by context nodes.
IWDNodeCollectionDisposer Interface used to set up a dynamic dispose "function".
IWDNodeCollectionSupplier Interface used to set up a dynamic supply "function".
IWDNodeElement Functionality that is common to all elements in any context node and that can be used by Web Dynpro applications.
IWDNodeInfo Represents the static structural aspect of a Node and its NodeElements at runtime keeping the meta data as defined at design time.
IWDNodeNotificationListener A listener that can receive notifications that are passed along the mapping via IWDNode.notifyAllMappedNodes(Object).
IWDOnDemandValueSetService Interface for providing a loadable valueset on demand
IWDOVSContextNotificationListener Callback interface that must be implemented by applications that use a context based OVS.
IWDOVSNotificationListener Callback interface that must be implemented by applications that use an OVS based on an ICMIQuery.
IWDPublicControllerInterface Common Interface for all Public Interfaces of Controllers.
IWDTextAccessor Provides access to translatable texts.
IWDUIElement Web Dynpro UIElement API.
IWDUIElementContainer Web Dynpro UIElementContainer API.
IWDValidationCheck IWDValidationCheck offers access to the Web Dynpro validation managemnt service.
IWDValueFilter Simple access interface for valueset filter arguments.
IWDValueSetSource Base interface for IWDValueSupplier and IWDBoundValueSet.IWDFilterListener.
IWDValueSupplier Interface for dynamic reload of valuesets on demand.
IWDView Generic API of all views.
IWDViewContainer Web Dynpro ViewContainer marker interface.
IWDViewController Generic API of all view controllers.
IWDViewElement Generic API of all view elements, visible or otherwise.
WDCopyService.IWDCopyService Describes the features required from the internal copy service implementation.
WDValueServices.IWDValueServices Interface to the framework class doing the work.
 

Class Summary
WDCopyService This class implements the well known ABAP feature "MOVE_CORRESPONDING".
WDMessage Base class for all kinds of messages used in conjunction with the Web Dynpro message manager.
WDOVSContextNotificationAdapter Abstract "do nothing" implementation of the IWDOVSContextNotificationListener interface.
WDOVSNotificationAdapter Abstract "do nothing" implementation of the IWDOVSNotificationListener interface.
WDSimpleValueSupplier Default implementation of IWDValueSupplier.
WDValueServices Helper class to create some special value sets.
WDVisibility Enumeration type WDVisibility.
 

Package com.sap.tc.webdynpro.progmodel.api Description

Contains interfaces and classes that form the core programming model for Web Dynpro applications. Instances of these interfaces are provided to the application where needed, so no factories exist for most of them.

Application dependent Subinterfaces

For applications that are build with the Web Dynpro development workbench, typed subinterfaces of IWDController, IWDContext, IWDNode and IWDNodeElement will be generated were appropriate. Thereby the need to cast from a generic type (as java.lang.Object) to a more concrete, application dependent one (like com.sap.BusinessPartner), is reduced. Nevertheless can application developers use the generic functionality as well.

Dynamically Modifiying the Context Structure at Runtime

The context of a controller normally gets declared at design time and a generated typed version is used at runtime. But in those cases where the context structure needed for a controller is not or not fully known at design time, it can be defined/modified at runtime. Therefore the structure information declared at design time is provided at runtime as well (see IWDContext.getRootNodeInfo(), IWDNode.getNodeInfo(), IWDNodeInfo and IWDAttributeInfo). It can be enriched at runtime by adding nodes or attributes as needed. After modifiying the structure information, the added context elements can then be accessed with the generic access methods IWDNode.getChildNode(String,int), IWDNodeElement.getAttributeValue(String) and IWDNodeElement.setAttributeValue(String,Object)


Web Dynpro API Documentation

Copyright © 2004 SAP AG. Automatically generated Thu Mar 3 2005, 22:15