SAP ABAP Class CL_WDR_HELP_HANDLER (Web Dynpro: Framework Help Call)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-ABA-RUN (Application Component) Web Dynpro ABAP Runtime
     ⤷ SWDP_RUNTIME_CORE (Package) Web Dynpro Runtime: Core Functions

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_NW7_HANDLE_AFTER_UPDATE	Handle After Update	20100630
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_WDR_ADAPTER_EVENT_HANDLER	Event Handler for SSR Client Events X	20070817
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_WDR_CONTEXT_MENU_HANDLER	Context Menu Handler	20070817

Properties

Class	CL_WDR_HELP_HANDLER
Short Description	Web Dynpro: Framework Help Call
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWDP_RUNTIME_CORE	Web Dynpro Runtime: Core Functions
Created	20060711	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_NW7_HANDLE_AFTER_UPDATE	☐	☐	Handle After Update	20100630
2	IF_WDR_ADAPTER_EVENT_HANDLER	☐	☐	Event Handler for SSR Client Events X	20070817
3	IF_WDR_CONTEXT_MENU_HANDLER	☐	☐	Context Menu Handler	20070817

Friends

Class CL_WDR_HELP_HANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_DISPLAY_METHOD	Constant	Public	☐	See coding				20090603
2	MC_ID_F1_HELP_HANDLER	Constant	Public	☐	Type reference (TYPE)	STRING	'40A92A054D645D4EE10000000A1552AC'	ID of F1 Handler	20070820
3	M_DISPLAY_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20090603
4	M_F1_VIEW_ELEMENT_ADAPTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_NW7_VIEW_ELEMENT_ADAPTER		Adapter for Web Dynpro View Elements	20071106
5	M_OPEN_F1_HELP_REQUESTED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20071106
6	M_REGISTERED_EVENTS	Static Attribute	Public	☐	See coding				20060711
7	M_VIEW_ELEMENT_ADAPTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_NW7_VIEW_ELEMENT_ADAPTER		Adapter for Web Dynpro View Elements	20070817
8	M_VIEW_ELEMENT_ADAPTER_FIRST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_NW7_VIEW_ELEMENT_ADAPTER		Local UR Test	20100817
9	M_VIEW_ELEMENT_ADAPTER_MANAGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_WDR_VIEW_ELEM_ADAPTER_MNG		Adapter Manager for Conversion of WD View Elements	20070817

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COLLECT_HELP_LINKS	Static method	Public	Method	Collects HelpLinks from all visible windows and the appl.	20061114
2	COLLECT_HELP_LINKS_RECURS	Static method	Private	Method	Collects HelpLinks - recursive part	20061114
3	CONSTRUCTOR	Instance method	Public	Constructor		20070817
4	CREATE_HELPLINKS_QUERYSTRING	Static method	Private	Method	Generates the query string for HelpLinks	20070115
5	EVENT_REGISTERED	Static method	Public	Method		20060711
6	GET_HELPCENTER_DATA_FOR_CHIPS	Static method	Public	Method		20090121
7	GET_HELPCENTER_DISPLAY_METHOD	Static method	Public	Method		20090603
8	GET_HELP_CENTER_URL	Static method	Public	Method	Returns internal URL for help center (including parameters)	20060711
9	ON_CTRL_HELP_REQUEST	Instance method	Private	Method	Ctrl+F1 pressed	20060711
10	ON_HELP_REQUEST	Instance method	Private	Method	F1 pressed	20060711
11	ON_TEC_HELP_REQUEST	Instance method	Private	Method	Technical Help Called NEW	20100812
12	SAVE_EXPLANATION	Static method	Public	Method	Saves explanation by pass by value or toggle	20060711
13	SAVE_EXPLANATION_EXTERNAL	Static method	Public	Method	Saves explanation if event came from outside	20060713
14	SET_CONTENT	Instance method	Public	Method		20071106

Events

Class CL_WDR_HELP_HANDLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_NAME_VALUE	Public	See coding			20061114	begin of t_name_value, name type string, value type string, text_key type sotr_conc, is_curr type abap_bool, is_appl type abap_bool, end of t_name_value
2	T_NAME_VALUE_TAB	Public	See coding			20061114	t_name_value_tab type standard table of t_name_value with default key

Method Signatures

Method COLLECT_HELP_LINKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_HELP_LINKS	Value transfer	☐	Type reference (TYPE)	T_NAME_VALUE_TAB			20061114
2	Importing	INCLUDE_APPL_LINK	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20061114
3	Importing	IR_CURR_VIEW	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_VIEW		Web Dynpro: API eines Views	20061114

Method COLLECT_HELP_LINKS on class CL_WDR_HELP_HANDLER has no exception.

Method COLLECT_HELP_LINKS_RECURS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ET_HELP_LINKS	Call by reference	☐	Type reference (TYPE)	T_NAME_VALUE_TAB			20061114
2	Importing	IR_SHOW_WINDOW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_RR_WINDOW			20061114
3	Importing	IR_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW_CONTROLLER		Web Dynpro: View Controller	20061114

Method COLLECT_HELP_LINKS_RECURS on class CL_WDR_HELP_HANDLER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20070817

Method CONSTRUCTOR on class CL_WDR_HELP_HANDLER has no exception.

Method CREATE_HELPLINKS_QUERYSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPL_LINK_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'APPL_LINKS'		20080410
2	Exporting	EV_APPL_LINK	Call by reference	☐	Type reference (TYPE)	STRING			20090807
3	Exporting	EV_URL_PARAMETER	Value transfer	☐	Type reference (TYPE)	STRING			20070115
4	Exporting	EV_WINDOW_LINK	Call by reference	☐	Type reference (TYPE)	STRING			20090807
5	Importing	IR_CURR_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW		Web Dynpro: API eines Views	20070115
6	Importing	IT_URL_PARAMETER	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Tabelle Name/Wert-Paare	20070115

Method CREATE_HELPLINKS_QUERYSTRING on class CL_WDR_HELP_HANDLER has no exception.

Method EVENT_REGISTERED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20060711
2	Importing	NAMESPACE	Call by reference	☐	Type reference (TYPE)	STRING			20060711
3	Importing	VALUE	Call by reference	☑	Type reference (TYPE)	STRING			20070117

Method EVENT_REGISTERED on class CL_WDR_HELP_HANDLER has no exception.

Method GET_HELPCENTER_DATA_FOR_CHIPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	APPL_LINKS	Call by reference	☐	Type reference (TYPE)	STRING			20090121
2	Exporting	APPL_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20090121
3	Exporting	WINDOW_LINKS	Call by reference	☐	Type reference (TYPE)	STRING			20090121

Method GET_HELPCENTER_DATA_FOR_CHIPS on class CL_WDR_HELP_HANDLER has no exception.

Method GET_HELPCENTER_DISPLAY_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DISPLAY_METHOD	Value transfer	☐	Type reference (TYPE)	STRING			20090603

Method GET_HELPCENTER_DISPLAY_METHOD on class CL_WDR_HELP_HANDLER has no exception.

Method GET_HELP_CENTER_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	URL	Value transfer	☐	Type reference (TYPE)	STRING			20060711
2	Importing	VIEW	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_VIEW		Web Dynpro: API eines Views	20061109

Method GET_HELP_CENTER_URL on class CL_WDR_HELP_HANDLER has no exception.

Method ON_CTRL_HELP_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HIDE_MORE_FIELDHELP	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Datenelementdokumenation nur auf explizite Anforderung zeige	20070220
2	Importing	VIEW_ELEMENT_ADAPTER	Call by reference	☐	Object reference (TYPE REF TO)	IF_NW7_VIEW_ELEMENT_ADAPTER		Adapter für Web Dynpro View Elemente	20060711

Method ON_CTRL_HELP_REQUEST on class CL_WDR_HELP_HANDLER has no exception.

Method ON_HELP_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	VIEW_ELEMENT_ADAPTER	Call by reference	☐	Object reference (TYPE REF TO)	IF_NW7_VIEW_ELEMENT_ADAPTER		Web Dynpro: API eines Views	20060711

Method ON_HELP_REQUEST on class CL_WDR_HELP_HANDLER has no exception.

Method ON_TEC_HELP_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_VIEW_ELEMENT_ADAPTER	Call by reference	☐	Object reference (TYPE REF TO)	IF_NW7_VIEW_ELEMENT_ADAPTER		Stellvertreter View Element Adapter mit View Element	20100812
2	Importing	I_VIEW_ELEMENT_ADAPTER_FIRST	Call by reference	☐	Object reference (TYPE REF TO)	IF_NW7_VIEW_ELEMENT_ADAPTER		Selektierter View Element Adapter	20100817

Method ON_TEC_HELP_REQUEST on class CL_WDR_HELP_HANDLER has no exception.

Method SAVE_EXPLANATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPLANATION	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20060711

Method SAVE_EXPLANATION on class CL_WDR_HELP_HANDLER has no exception.

Method SAVE_EXPLANATION_EXTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPLANATION	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20060713

Method SAVE_EXPLANATION_EXTERNAL on class CL_WDR_HELP_HANDLER has no exception.

Method SET_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT_COMMAND_QUEUE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_CLIENT_COMMAND		Kommando für den Client (UPDATE)	20071106

Method SET_CONTENT on class CL_WDR_HELP_HANDLER has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	710