Window:
Inbound and Outbound Plugs
Just like each
view, each window has a number of inbound and outbound plugs. You can find
basic information about the plugs of a window in
Window
Plugs.
On the Inbound Plugs tab page you can create a number of inbound plugs for the window that is currently being edited. Enter a new name for this plug and add a description of it.
The properties of a window’s inbound plug differ from a view’s inbound plugs by the characteristics Interface and Startup or Resume that can be maintained:
● Interface
This checkbox
determines whether the window’s inbound plug only is used for navigation
within the component, or whether the inbound plug should also be visible
externally as part of the
component
interface. If the Interface checkbox is selected, the inbound plug
that is now externally visible is also displayed as part of the interface view
belonging to the window in the object list node Component
Interface. The inbound
plug can only be changed in the window editor, however.
● Startup and Resume
The properties Startup and Resume are only relevant to inbound plugs of the interface view.
If the property
Startup is selected for such an inbound plug, this means
that a Web Dynpro application can be started using this plug. When you create
a
Web Dynpro
Application, you can only select these interface view inbound plugs that
are selected as a startup plug. Such inbound plugs that do not have the
Startup property are available exclusively for navigation
to an already-running application. See also
Web Dynpro Window
and
Suspend/Resume
Calls.
Unlike outbound
plugs, inbound plugs can be equipped with an event handler. This
event handler of
an inbound plug is always called if the window is controlled using precisely
this plug. The wdEvent object of this handler method has the parameter
IF_WD_APPLICATION=>ALL_URL_PARAMETERS of type IHTTPNVP. All
application-specific URL parameters are stored in this table. For more
information, see
Window: Inbound and
Outbound Plugs..
If an inbound
plug has importing parameters, values must be available at runtime for
these parameters. You can provide these values either by defining default
values at design time, or transferring them as URL parameters with the
application call URL (see
Calling Web Dynpro
Applications with Parameters)
Parallel to inbound plugs, a window can have outbound plugs. You can use an outbound plug to leave a window for a view of an embedding window. Outbound plugs can be called in two different ways:
● Using the generated method WD_THIS®FIRE_<MY_OUTBOUND>_PLG.
●
Using the generic
method FIRE_PLUG of API
IF_WD_VIEW_CONTROLLER
for the current controller.
Even the outbound plugs of a window have two additional checkboxes compared with a view’s plugs:
● Interface
This checkbox determines whether the window’s outbound plug alone is used for navigation within the component, or whether the outbound plug should also be visible externally as part of the component interface. If the Interface checkbox is selected, the outbound plug that is now externally visible is also displayed as part of the interface view belonging to the window in the object list node Component Interface. The outbound plug can only be changed in the window editor, however.
● Exit and Suspend
The properties Exit and Suspend are only relevant to outbound plugs of the interface view.
If an
embedded window is exited via a plug flagged with the property Exit, the component associated with this window is
automatically closed. Calling an exit plug in the outermost component of a
component usage chain leads to the whole Web Dynpro application ending. For
further information, refer to
Web Dynpro
Window.
You can specify
importing parameters for all outbound plugs of an interface view. These
parameters are passed to the outbound plug when method WD_THIS®FIRE_<MY_OUTBOUND>_PLG is called. More
information:
WD_THIS and the Local
Controller Interface.
All parameters of an outbound plug must be of type STRING or TIHTTPNVP.
The special
parameter URL can be defined for an exit plug. If it is, once the plug
has been triggered and the Web Dynpro application closed, the page specified
in the parameter is opened. If the parameter is not defined, a standard exit
page is opened. You can also define an exit page in transaction SICF (see
Application
Logoff Page).
For resume plugs a value this parameter must be assigned a value.
