Show TOC

Vordefinierte Methoden des lokalen Controller-InterfacesLocate this document in the navigation structure

Jeder Controller verfügt zusätzlich über ein Set von Methoden, die von der Laufzeit bereit gestellt werden und die Sie zum Bau von Anwendungen nutzen können. Im Gegensatz zu allen anderen Methoden des Controllers haben Sie in diesem Fall keinerlei Einfluss auf die Implementierung der Methoden. Die Zusammensetzung dieses Methoden-Sets ist abhängig vom Controller-Typ und von dessen Implementierungszustand. Im Folgenden werden einige dieser Methoden kurz erläutert

Die Methode WD_GET_API

Diese Methode besitzen alle Controller-Typen. Abhängig vom Controller-Typ gibt diese Methode eine Referenzvariable vom jeweils zugehörigen Typ an den Controller zurück:

Ig_Componentcontroller

value(Result) type ref to IF_WD_COMPONENT

If_"View_Name"

value(Result) type ref to IF_WD_VIEW_CONTROLLER

Ig_"Window_Name"

value(Result) type ref to IF_WD_VIEW_CONTROLLER

Die Methode GET_<MY_USED_CONTROLLER>_CTR

Allen Controller, für die die Verwendung eines anderen Controllers der selben Component eingetragen wurde, wird automatisch die Methode GET_<MY_USED_CONTROLLER>_CTR in das lokale Controller-Interface hinein generiert. Dabei spielt es keine Rolle, ob es sich um einen View- Component- oder Custom-Controller handelt.

Rückgabewert

Die Methode GET_<MY_USED_CONTROLLER>_CTR gibt immer eine Referenzvariable des Component-globalen Interfaces des verwendeten Controllers zurück. Der Rückgabewert ist also eine Referenzvariable vom Typ IG_<MY_USED_CONTROLLER>.

Beispiel:

Wenn Sie innerhalb eines View-Controllers Methoden des Component-globalen Interfaces eines Custom-Controllers mit Namen MY_CUST_CONTROLLER nutzen möchten, können Sie auf der Registerkarte Eigenschaften des View-Controllers eine Verwendung des gewünschten Custom-Controllers eintragen. Damit steht Ihnen im lokalen Interface des aktuellen Controllers die Methode GET_MY_CUST_CONTROLLER_CTR zur Verfügung.

method MY_CONTROLLER_METHOD .

data:     L_REF_MY_CUST_CONTROLLER type ref to IG_MY_CUST_CONTROLLER.


L_REF_MY_CUST_CONTROLLER = WD_THIS->GET_MY_CUST_CONTROLLER_CTR( ).
.
.
endmethod.
Hinweis Sie finden allgemeine Informationen zu den verschiedenen Interface-Typen sowie deren Sichtbarkeit im Rahmen einer oder mehrerer Web-Dynpro-Components im Kapitel Die verschiedenen Controller einer Web-Dynpro-Component im Werkzeughandbuch dieser Dokumentation.

Da im Falle eines View-Controllers die Verwendung des zugehörigen Component-Controllers praktisch immer sinnvoll ist, wird diese Verwendung beim Anlegen einer neuen View  automatisch eingetragen. Damit verbunden ist die automatische Erzeugung einer Referenzvariablen vom Typ IG_COMPONENTCONTROLLER: der Variablen

WD_COMP_CONTROLLER.

Diese Referenzvariable ist jedem View-Controller bekannt und sie ist daher auf der Registerkarte Attribute des View-Controllers eingetragen und kann vom Anwendungsentwickler verwendet werden. Mit ihr stehen alle Methoden des Component-globalen Interfaces des zugehörigen Component-Controllers zur Verfügung.

Lesen Sie hierzu das folgende Kapitel Controller-übergreifender Methodenaufruf.

Die Methoden WD_CPUSE_<MY_COMPONENT_USAGE> und WD_CPIFC_<MY_USED_COMPONENT>

Diese beiden Methoden sind im Zusammenhang mit der Verwendung einer Component innerhalb einer anderen Component von Bedeutung und werden daher im Teil 2 dieser Dokumentation, in den Kapiteln Component-Verwendung ohne Controller-Zugriff bzw. Component-Verwendung mit Controller-Zugriff besprochen. Sie werden für jeden Controller-Typ erzeugt sobald eine Component-Verwendung bzw. die Verwendung des Interface-Controllers einer verwendeten Component angelegt wurde.

Die Methode FIRE_<MY_PLUG>_PLG

Diese Methode ist ausschließlich in View- oder Window-Controllern enthalten sobald für den betreffenden Controller ein Outbound-Plug angelegt worden ist. Mit Hilfe dieser Methode wird ein Outbound-Plug gerufen von dem dann eine Navigation zu einem Folge-View oder -Window ausgeht.

Beispiel für

method MY_CONTROLLER_METHOD


WD_THIS->FIRE_MY_OUTBOUND_PLG(  ).


endmethod

Weitere Informationen finden Sie im Kapitel Navigation dieser Dokumentation.

Die Methode FIRE_<MY_EVENT>_EVT

Jeder Component-oder Custom-Controller, für den ein Ereignis angelegt wurde, verfügt mit dieser Methode über die Möglichkeit, dieses Ereignis auszulösen.