Show TOC

 IF_WD_RR_VIEWLocate this document in the navigation structure

Interface IF_WD_RR_VIEW belongs to the API for the Web Dynpro Runtime Repository .

Interface IF_WD_RR_VIEW allows access to the metadata for a Web Dynpro view.

Use

This interface is accessed, for example in a view controller of a Web Dynpro as follows:

data:
l_api         type ref to if_wd_view_controller,
l_view_info type ref to if_wd_rr_view.
l_view_api = wd_this->wd_get_api( ).
l_view_info = l_view_api->get_view_info( ).
Methods

GET_DESCRIPTION

This method returns the description text for the view.

Result

Name Description

RESULT (type STRING)

Description text of the view

Parameter

Name Description

LANGU (type SPRAS)

Language is which text is to be displayed

GET_INBOUND_PLUGS

This method returns the inbound plugs for this view.

Result

Name Description

RESULT (type WDRR_IOBOUND_PLUGS)

List of inbound plugs belonging to this view

GET_NAME

This method returns the name of the Web Dynpro view.

Result

Name Description

RESULT (Type STRING)

Name of the view

GET_OUTBOUND_PLUGS

This method returns the outbound plugs for this view.

Result

Name Description

RESULT (type WDRR_IOBOUND_PLUGS)

List of outbound plugs belonging to this view

HAS_INBOUND_PLUG

This method is used to check whether an inbound plug with the specified name exists for this view.

Result

Name Description

RESULT (type ABAP_BOOL)

Specifies whether an inbound plug exists

Parameter

Name Description

PLUG_NAME (type STRING)

Name of the inbound plug

HAS_OUTBOUND_PLUG

This method is used to check whether an outbound plug with the specified name exists for this view.

Result

Name Description

RESULT (type ABAP_BOOL)

Specifies whether an outbound plug exists

Parameter

Name Description

PLUG_NAME (type STRING)

Name of the outbound plug

Method IF_WD_RR_VIEW=>SET_LIFESPAN

This method can be used to set the lifespan of the view. You have the following options:

  • This lifespan of the view is controlled by the Web Dynpro runtime (standard behavior). The view is created as soon as it is to be displayed. At the same time, the view controller's WDDOINIT hook method runs. The view instance is not released until
    • the associated component is deleted with IF_WD_COMPONENT_USAGE~DELETE_COMPONENT
    • the application is terminated
    • the view is displayed in a popup, and the popup is closed

    In each of these cases, the view controller's WDDOINIT hook method runs.

    This setting is recommended if you make regular switches between different views.

  • The lifespan of the view is defined by its visibility. The view is created as soon as it is to be displayed. At the same time, the view controller's WDDOINIT hook method runs. If you quit the view, the view instance is released. At the same time, the view controller's WDDOEXIT hook method runs. If you display the view again, a new view instance is created, and WDDOINIT is called again.

    This setting is recommended if you do not want to display the view anymore after quitting it.

Parameter

Name Description

LIFESPAN (type STRING)

Lifespan of the view

Possible values are:

  • IF_WD_RR_VIEW=>CO_LIFESPAN_FRAMEWORK_CNTR:

    This lifespan of the view is defined by the Web Dynpro runtime (see above).

  • IF_WD_RR_VIEW=>CO_LIFESPAN_WHEN_VISIBLE:

    The lifespan of the view is defined by its visibility (see above).