SAP ABAP Class CL_WDR_DDIC_SEARCH_HELP (Class to handle DDIC search helps)

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 - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_WDR_COLLECTIVE_SEARCH_HELP	Class to handle collective DDIC search helps	20050418
2	Inheritance (c INHERITING FROM c_ref)	CL_WDR_ELEMENTARY_SEARCH_HELP	Class to handle elementary DDIC search helps	20050418

Properties

Class	CL_WDR_DDIC_SEARCH_HELP
Short Description	Class to handle DDIC search helps
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	20050418	SAP
Last change	20131127	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_DDIC_SEARCH_HELP	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	SHLP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_WDR_DDIC_SEARCH_HELP has no interface implemented.

Friends

Class CL_WDR_DDIC_SEARCH_HELP has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONTEXT_MANAGER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_WDR_SHLP_CONTEXT_MANAGER		Maps Application Data to Search Help Interface	20060308
2	DISPLAY_MANAGER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_WDR_SHLP_DISPLAY_MANAGER		Controls Display of Value Help	20060308
3	M_SHLP	Instance attribute	Protected	☐	Type reference (TYPE)	SHLP_DESCR		Description of Search Help	20050525
4	M_SHLP_TAB	Instance attribute	Protected	☐	Type reference (TYPE)	SHLP_DESCR_TAB_T			20050525

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20050418
2	CREATE_SEARCH_HELP	Static method	Public	Method		20050418
3	CREATE_SEARCH_HELP_FROM_FIELD	Static method	Public	Method		20110126
4	CREATE_SEARCH_HELP_FROM_SHLP	Static method	Public	Method		20110126
5	CREATE_SEARCH_HELP_FROM_STRUCT	Static method	Public	Method		20110126
6	DISPLAY	Instance method	Public	Method		20060308
7	GET_DISPONLY	Instance method	Public	Method		20080901
8	GET_HAS_DEPENDEND_FIELDS	Instance method	Public	Method		20130704
9	GET_NAME	Instance method	Public	Method		20050504
10	GET_SHORT_TITLE	Instance method	Public	Method	Use this to differentiate elem. shlps in coll. shlps	20050614
11	GET_TITLE	Instance method	Public	Method	Use this for the titlebar of the shlp window	20050504
12	GET_TYPE	Instance method	Public	Method		20091215

Events

#	Event	Type	Visibility	Description	Created on
1	MESSAGE	Static Event (1)	Public (2)		20110415

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	RECORD_TAB_T	Public	See coding			20050525	record_tab_t TYPE STANDARD TABLE OF seahlpres
2	SELOPT_DESCR_LINE	Public	See coding			20050817	BEGIN OF selopt_descr_line, sfl TYPE shlp_selfld_line, read_only TYPE abap_bool, END OF selopt_descr_line
3	SELOPT_DESCR_TAB	Public	See coding			20050817	selopt_descr_tab TYPE STANDARD TABLE OF selopt_descr_line WITH DEFAULT KEY

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTEXT_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_SHLP_CONTEXT_MANAGER		Bildet die Anwendungsdaten auf das Suchhilfe Interface ab	20060308
2	Importing	DISPLAY_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_SHLP_DISPLAY_MANAGER		Steuert die Anzeige der Wertehilfe	20060308
3	Importing	SHLP	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR		Beschreibung einer Suchhilfe	20050525
4	Importing	SHLP_TAB	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_TAB_T			20050525

Method CONSTRUCTOR on class CL_WDR_DDIC_SEARCH_HELP has no exception.

Method CREATE_SEARCH_HELP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTEXT_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_SHLP_CONTEXT_MANAGER		Bildet die Anwendungsdaten auf das Suchhilfe Interface ab	20060308
2	Importing	DISPLAY_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_SHLP_DISPLAY_MANAGER		Steuert die Anzeige der Wertehilfe	20060308
3	Importing	HELP_ID	Call by reference	☑	Type reference (TYPE)	STRING			20060309
4	Returning	SEARCH_HELP	Value transfer	☐	Object reference (TYPE REF TO)	CL_WDR_DDIC_SEARCH_HELP		handle to search help object	20050418
5	Importing	SHLPNAME	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		name of the search help	20050418

#	Exception	Resumable	Description	Created on
1	CX_WDR_VALUE_HELP	☐	Web Dynpro Value Help Processor Exception	20050530

Method CREATE_SEARCH_HELP_FROM_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTEXT_MANAGER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WDR_SHLP_CONTEXT_MANAGER		Bildet die Anwendungsdaten auf das Suchhilfe Interface ab	20110126
2	Importing	DISPLAY_MANAGER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WDR_SHLP_DISPLAY_MANAGER		Steuert die Anzeige der Wertehilfe	20110126
3	Importing	FIELD	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20110126
4	Returning	SEARCH_HELP	Value transfer	☐	Object reference (TYPE REF TO)	CL_WDR_DDIC_SEARCH_HELP		handle to search help object	20110126

#	Exception	Resumable	Description	Created on
1	CX_WDR_VALUE_HELP	☐	Web Dynpro Value Help Processor Exception	20110126

Method CREATE_SEARCH_HELP_FROM_SHLP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTEXT_MANAGER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WDR_SHLP_CONTEXT_MANAGER		Bildet die Anwendungsdaten auf das Suchhilfe Interface ab	20110126
2	Importing	DISPLAY_MANAGER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WDR_SHLP_DISPLAY_MANAGER		Steuert die Anzeige der Wertehilfe	20110126
3	Returning	SEARCH_HELP	Value transfer	☐	Object reference (TYPE REF TO)	CL_WDR_DDIC_SEARCH_HELP		handle to search help object	20110126
4	Importing	SHLPNAME	Call by reference	☐	Type reference (TYPE)	SHLPNAME		Name einer Suchhilfe	20110126

#	Exception	Resumable	Description	Created on
1	CX_WDR_VALUE_HELP	☐	Web Dynpro Value Help Processor Exception	20110126

Method CREATE_SEARCH_HELP_FROM_STRUCT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTEXT_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_SHLP_CONTEXT_MANAGER		Bildet die Anwendungsdaten auf das Suchhilfe Interface ab	20110126
2	Importing	DISPLAY_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WDR_SHLP_DISPLAY_MANAGER		Steuert die Anzeige der Wertehilfe	20110126
3	Importing	FIELDNAME	Call by reference	☐	Type reference (TYPE)	STRING			20110126
4	Returning	SEARCH_HELP	Value transfer	☐	Object reference (TYPE REF TO)	CL_WDR_DDIC_SEARCH_HELP		handle to search help object	20110126
5	Importing	STRUCTURE	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20110126

#	Exception	Resumable	Description	Created on
1	CX_WDR_VALUE_HELP	☐	Web Dynpro Value Help Processor Exception	20110126

Method DISPLAY Signature

Method DISPLAY on class CL_WDR_DDIC_SEARCH_HELP has no parameter.
Method DISPLAY on class CL_WDR_DDIC_SEARCH_HELP has no exception.

Method GET_DISPONLY Signature

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

Method GET_DISPONLY on class CL_WDR_DDIC_SEARCH_HELP has no exception.

Method GET_HAS_DEPENDEND_FIELDS Signature

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

Method GET_HAS_DEPENDEND_FIELDS on class CL_WDR_DDIC_SEARCH_HELP has no exception.

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NAME	Value transfer	☐	Type reference (TYPE)	SHLPNAME		Name einer Suchhilfe	20050504

Method GET_NAME on class CL_WDR_DDIC_SEARCH_HELP has no exception.

Method GET_SHORT_TITLE Signature

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

Method GET_SHORT_TITLE on class CL_WDR_DDIC_SEARCH_HELP has no exception.

Method GET_TITLE Signature

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

Method GET_TITLE on class CL_WDR_DDIC_SEARCH_HELP has no exception.

Method GET_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TYPE	Value transfer	☐	Type reference (TYPE)	DDSHLPTYP		Typ der Eingabehilfe (Siehe Festwerte)	20091215

Method GET_TYPE on class CL_WDR_DDIC_SEARCH_HELP has no exception.

Event Signatures

Event MESSAGE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	MSGID	Exporting	Value transfer	☐	Type reference (TYPE)	SYST-MSGID		Nachrichtenklasse	20110415
2	MSGNO	Exporting	Value transfer	☐	Type reference (TYPE)	SYST-MSGNO		Nachrichtennummer	20110415
3	MSGTY	Exporting	Value transfer	☐	Type reference (TYPE)	SYST-MSGTY		Nachrichtentyp	20110415
4	P1	Exporting	Value transfer	☐	Type reference (TYPE)	SYST-MSGV1		Nachrichtenvariable	20110415
5	P2	Exporting	Value transfer	☐	Type reference (TYPE)	SYST-MSGV2		Nachrichtenvariable	20110415
6	P3	Exporting	Value transfer	☐	Type reference (TYPE)	SYST-MSGV3		Nachrichtenvariable	20110415
7	P4	Exporting	Value transfer	☐	Type reference (TYPE)	SYST-MSGV4		Nachrichtenvariable	20110415

History

Last changed by/on	SAP	20131127
SAP Release Created in