SAP ABAP Class CL_WDR_DOCU_HELPER_ASSIST (Assistance Class for WDR_DOCU_HELPER)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-ABA (Application Component) Web Dynpro ABAP
     ⤷ SWDP_RUNTIME_COMP (Package) Web Dynpro: System Components

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class	20051111
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_WDR_DOCU_HELPER	Internal Interface for WDR_DOCU_HELPER	20060912

Properties

Class	CL_WDR_DOCU_HELPER_ASSIST
Short Description	Assistance Class for WDR_DOCU_HELPER
Super Class	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SWDP_RUNTIME_COMP	Web Dynpro: System Components
Created	20051111	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)
2	CL_WDR_HELP_HANDLER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_WDR_DOCU_HELPER	☐	☐	Internal Interface for WDR_DOCU_HELPER	20060912

Friends

Class CL_WDR_DOCU_HELPER_ASSIST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	M_CURRENT_HISTORY_ENTRY	Instance attribute	Public	☑	Type reference (TYPE)	I			20060316
2	M_DOCU_CACHE	Instance attribute	Private	☐	Type reference (TYPE)	T_DOCU_INFO_TAB			20060627
3	M_DOCU_UTILITY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_WDR_DOCU_UTILITY		Docu for WebDynpro ABAP	20060629
4	M_HISTORY_TAB	Instance attribute	Private	☐	Type reference (TYPE)	T_HISTORY_TAB			20060316
5	M_KW_CACHE	Instance attribute	Private	☐	Type reference (TYPE)	T_KW_CACHE			20060627
6	M_LANGU	Instance attribute	Private	☐	Type reference (TYPE)	SYLANGU		Language Key of Current Text Environment	20051116
7	M_MAX_HISTORY	Constant	Private	☐	Type reference (TYPE)	I	10	Maximum Number of History Events	20060316
8	M_MESSAGE_MANAGER	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER		Documentation	20111004
9	M_MESSAGE_MODE	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20110823
10	M_NUMBER_OF_ENTRIES	Instance attribute	Public	☑	Type reference (TYPE)	I		Number of Entries in m_history_tab	20060628
11	M_SHOW_F1_ONLY_LIMITED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20070215
12	M_VIEW_ELEMENT_ADAPTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_NW7_VIEW_ELEMENT_ADAPTER		Adapter for Web Dynpro View Elements	20060627

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DOCU_INFO	Instance method	Private	Method	Addition of Entry to m_docu_tab	20060316
2	ADD_DOCU_OBJECT	Instance method	Public	Method	Addition of Docu to the Cache (During Navigation)	20060627
3	CHECK_F1_HELP_AVAILABLE	Instance method	Public	Method	Checks whether F1 help is available	20070219
4	GET_CURRENT_DOCU_INFO	Instance method	Private	Method	Retrieval of the Current Entry from m_docu_tab	20060316
5	GET_DDIC_BINDING	Instance method	Private	Method	Resolves DDIC info from view element adapter	20051116
6	GET_DOCU	Instance method	Public	Method	Returns Documentation	20051116
7	GET_F1_HELP_PERMISSION	Instance method	Public	Method	Can F1 help be displayed for this view element?	20070219
8	GET_KW_LINKS	Instance method	Public	Method	Returns KW Links of Web Dynpro Application	20051116
9	GET_KW_URL	Instance method	Public	Method	Creates KW URL from KW Link	20051117
10	GET_TEC_HELP_PERMISSION	Instance method	Public	Method	Can the technical help be displayed for this view element?	20070219
11	GET_TEXT	Instance method	Public	Method		20060912
12	GET_VIEW_ELEMENT_ADAPTER	Instance method	Public	Method	Returns View Element Adapter	20051117
13	GO_BACK_IN_HISTORY	Instance method	Public	Method		20060316
14	GO_FORWARD_IN_HISTORY	Instance method	Public	Method		20060316
15	INIT	Instance method	Private	Method	Initialization	20060627
16	SETUP	Instance method	Public	Method	Setup Message Manager	20111004
17	SET_IF_MESSAGE	Instance method	Public	Method	Sets IF_Message	20060912
18	SET_KW_LINKS	Instance method	Public	Method	Sets KW links externally	20051117
19	SET_LANGUAGE	Instance method	Private	Method		20060627
20	SET_MESSAGE	Instance method	Public	Method	Sets Data for Long Text of Message	20060912
21	SET_VIEW_ELEMENT_ADAPTER	Instance method	Public	Method	Sets Key for Text that Cannot Be Found	20060912

Events

Class CL_WDR_DOCU_HELPER_ASSIST has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_DOCU_INFO	Private	See coding			20060316	begin of t_docu_info, index type i, view_element_adapter type ref to cl_nw7_view_element_adapter, message type symsg, if_message type ref to if_message, docu_object type t_docu_key, header type thead, lines type tlinetab, formatted_text type string, end of t_docu_info
2	T_DOCU_INFO_TAB	Private	See coding			20060316	t_docu_info_tab type standard table of t_docu_info with default key
3	T_DOCU_KEY	Private	See coding			20060627	begin of t_docu_key, id type dokhl-id, object type dokhl-object, end of t_docu_key
4	T_HISTORY	Private	See coding			20060316	begin of t_history, index type sy-index, end of t_history
5	T_HISTORY_TAB	Private	See coding			20060316	t_history_tab type standard table of t_history with default key
6	T_KW_CACHE	Private	See coding			20060627	begin of t_kw_cache, view_element_adapter type ref to cl_nw7_view_element_adapter, kw_links type cl_wdr_help_handler=>t_name_value_tab, end of t_kw_cache
7	T_TEC_CACHE	Private	See coding			20060627	begin of t_tec_cache, view_element_adapter type ref to cl_nw7_view_element_adapter, end of t_tec_cache

Method Signatures

Method ADD_DOCU_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCU_OBJECT	Call by reference	☑	Type reference (TYPE)	T_DOCU_KEY			20060316
2	Importing	IF_MESSAGE	Call by reference	☑	Object reference (TYPE REF TO)	IF_MESSAGE		Schnittstelle zum Zugriff auf Texte von Meldungsobjekten	20060607
3	Importing	MESSAGE	Call by reference	☑	Type reference (TYPE)	SYMSG		Struktur der Message-Variablen	20060316
4	Importing	VIEW_ELEMENT_ADAPTER	Call by reference	☑	Object reference (TYPE REF TO)	CL_NW7_VIEW_ELEMENT_ADAPTER		Adapter für Web Dynpro View Elemente	20060316

Method ADD_DOCU_INFO on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method ADD_DOCU_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	DOKHL-ID		Dokumentenklasse	20060627
2	Importing	I_OBJECT	Call by reference	☐	Type reference (TYPE)	DOKHL-OBJECT		Dokumentations-Objekt	20060627

Method ADD_DOCU_OBJECT on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method CHECK_F1_HELP_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HELP_AVAILABLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070219

Method CHECK_F1_HELP_AVAILABLE on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GET_CURRENT_DOCU_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DOCU_INFO_REF	Value transfer	☐	Object reference (TYPE REF TO)	T_DOCU_INFO			20060316

Method GET_CURRENT_DOCU_INFO on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GET_DDIC_BINDING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DATAELEMENT	Call by reference	☐	Type reference (TYPE)	STRING			20051116
2	Exporting	FIELDNAME	Call by reference	☐	Type reference (TYPE)	STRING			20051116
3	Exporting	TABNAME	Call by reference	☐	Type reference (TYPE)	STRING			20051116
4	Exporting	TITLE	Call by reference	☐	Type reference (TYPE)	STRING			20051116
5	Importing	VIEW_ELEMENT	Call by reference	☑	Object reference (TYPE REF TO)	CL_WDR_VIEW_ELEMENT		WebDynpro View Element	20070326
6	Importing	VIEW_ELEMENT_ADAPTER	Call by reference	☑	Object reference (TYPE REF TO)	CL_NW7_VIEW_ELEMENT_ADAPTER		Adapter für Web Dynpro View Elemente	20060627

Method GET_DDIC_BINDING on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GET_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Lines of ITF	20060629

#	Exception	Resumable	Description	Created on
1	NO_DOCUMENTATION_AVAILABLE	☐	Keine Dokumentation verfügbar	20051116
2	NO_DOCUMENTATION_POSSIBLE	☐	Keine Dokumentation verfügbar, da das Feld kein DDIC Feld is	20070308

Method GET_F1_HELP_PERMISSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PERMISSION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070219

Method GET_F1_HELP_PERMISSION on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GET_KW_LINKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	KW_LINKS	Value transfer	☐	Type reference (TYPE)	CL_WDR_HELP_HANDLER=>T_NAME_VALUE_TAB		Liste der KW-Links	20051116

Method GET_KW_LINKS on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GET_KW_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KW_LINK	Call by reference	☐	Type reference (TYPE)	STRING			20051117
2	Returning	KW_URL	Value transfer	☐	Type reference (TYPE)	STRING			20051117

Method GET_KW_URL on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GET_TEC_HELP_PERMISSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PERMISSION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070219

Method GET_TEC_HELP_PERMISSION on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GET_TEXT Signature

Method GET_TEXT on class CL_WDR_DOCU_HELPER_ASSIST has no parameter.
Method GET_TEXT on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GET_VIEW_ELEMENT_ADAPTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VIEW_ELEMENT_ADAPTER	Value transfer	☐	Object reference (TYPE REF TO)	CL_NW7_VIEW_ELEMENT_ADAPTER		Web Dynpro: API View Element	20051117

Method GET_VIEW_ELEMENT_ADAPTER on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GO_BACK_IN_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DONE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20060316

Method GO_BACK_IN_HISTORY on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method GO_FORWARD_IN_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DONE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20060316

Method GO_FORWARD_IN_HISTORY on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method INIT Signature

Method INIT on class CL_WDR_DOCU_HELPER_ASSIST has no parameter.
Method INIT on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method SETUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER		Message-Manager	20111004

Method SETUP on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method SET_IF_MESSAGE Signature

Method SET_IF_MESSAGE on class CL_WDR_DOCU_HELPER_ASSIST has no parameter.
Method SET_IF_MESSAGE on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method SET_KW_LINKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KW_LINKS	Call by reference	☐	Type reference (TYPE)	CL_WDR_HELP_HANDLER=>T_NAME_VALUE_TAB			20051117

Method SET_KW_LINKS on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method SET_LANGUAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	LANGU		Sprachenschlüssel	20060627

Method SET_LANGUAGE on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method SET_MESSAGE Signature

Method SET_MESSAGE on class CL_WDR_DOCU_HELPER_ASSIST has no parameter.
Method SET_MESSAGE on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

Method SET_VIEW_ELEMENT_ADAPTER Signature

Method SET_VIEW_ELEMENT_ADAPTER on class CL_WDR_DOCU_HELPER_ASSIST has no parameter.
Method SET_VIEW_ELEMENT_ADAPTER on class CL_WDR_DOCU_HELPER_ASSIST has no exception.

History

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