SAP ABAP Class CL_F4CUSTOM (Personalize search helps)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-DIC-F4 (Application Component) F4 Help
     ⤷ SDSH (Package) ABAP Dictionary internal: Poss.entries (F4)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_F4CUSTOM	Interface for customizing F4 help	00000000

Properties

Class	CL_F4CUSTOM
Short Description	Personalize search helps
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SDSH	ABAP Dictionary internal: Poss.entries (F4)
Created	19980818	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

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

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_F4CUSTOM	☐	☐	Interface for customizing F4 help	00000000

Friends

#	Friend	Modeled only	Created on	Description
1	CL_WDR_F4CUSTOM	☐	20050503

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACTIVEX	Instance attribute	Private	☐	Type reference (TYPE)	F4SETTING		ActiveX settings	19981203
2	COUNT_INSTANCE	Static Attribute	Private	☐	Type reference (TYPE)	I		Instance counter	19980907
3	C_F4WIDTH	Static Attribute	Private	☐	Type reference (TYPE)	I	'255'	Standard width hit list	19990330
4	C_MAXRECORDS	Static Attribute	Private	☐	Type reference (TYPE)	I	'500'	Standard number of hits	19990330
5	F4_CALL_MODE	Instance attribute	Public	☐	Type reference (TYPE)	DDF4PSFLAG		Call of hit list	19991111
6	INDXKEY	Instance attribute	Private	☐	Type reference (TYPE)	INDXKEYTYPE		INDX key	19980908
7	OPTIMIZE_COL	Instance attribute	Private	☐	Type reference (TYPE)	DDF4PSFLAG		Flag standard optimization	19980930
8	OPTIMIZE_SET	Instance attribute	Private	☐	Type reference (TYPE)	DDF4PSFLAG		Indicator	19980930
9	OWN_REFERENCE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_F4CUSTOM		Own reference	19980910
10	PERSONAL_EXIST	Instance attribute	Private	☐	Type reference (TYPE)	DDF4PSFLAG		Indicator	19980928
11	PERS_SHLP_OBJ	Instance attribute	Private	☐	Type reference (TYPE)	PERS_SHLP		Personalization	19980908
12	PERS_SHLP_OBJ_ALL	Instance attribute	Private	☐	Type reference (TYPE)	PERS_SHLP_ALL		General personalization	19980909
13	PERS_SHLP_OBJ_SYS	Static Attribute	Private	☐	Type reference (TYPE)	PERS_SHLP_ALL		System setting	19990330
14	P_ACTIVEX_SETTING	Constant	Public	☐	Type reference (TYPE)	DDF4PSPROP	'P_ACTIVEX_SETTING'	Constant for ActiveX settings	19991110
15	P_ALL_SETTING	Constant	Public	☐	Type reference (TYPE)	DDF4PSPROP	'P_ALL_SETTING'	Constant for general user settings	19991110
16	P_SYS_SETTING	Constant	Public	☐	Type reference (TYPE)	DDF4PSPROP	'P_SYS_SETTING'	Constant for system settings	19991110
17	REF_INSTANCE	Static Attribute	Private	☐	Type reference (TYPE)	TYPE_REF_TO_OBJ_TAB		Reference table	19980907
18	STANDARD_FIELDDESCR	Instance attribute	Private	☐	Type reference (TYPE)	SHLP_DESCR_T-FIELDDESCR		Dfies	19980930
19	STANDARD_FIELDPROP	Instance attribute	Private	☐	Type reference (TYPE)	SHLP_DESCR_T-FIELDPROP		Field prop.	19981008
20	STANDARD_SHLP	Instance attribute	Private	☐	Type reference (TYPE)	PERS_SHLP		Standard settings	19980924
21	STANDARD_TITLE	Instance attribute	Private	☐	Type reference (TYPE)	DD04V-DDTEXT		Standard_title	19981022

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_CONSISTENCE	Instance method	Private	Method	Checks Consistency of Personalization and Search Help	19990118
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	19990330
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	19980901
4	CREATE_F4_CUST_OBJ	Instance method	Private	Method	Mix personalization in SHLP structure of F4 processor	19980818
5	FREE	Static method	Public	Method	Delete an object reference	19980908
6	GET_ACTIVEX_SETTING	Instance method	Private	Method	Determine user's ActiveX settings	19981203
7	GET_EXIST_REFERENCE	Static method	Public	Method	Determine reference	19980907
8	GET_GLOBAL_SETTING	Static method	Private	Method	Defines global settings	19990330
9	GET_PROPERTY_VALUE	Instance method	Private	Method	Determine value of a property	19980907
10	GET_SET_FROM_INDX	Instance method	Private	Method	Read INDX entry	19980903
11	GET_SYS_ACTIVEX_SETTING	Instance method	Private	Method	Determine system ActiveX settings	19981203
12	GET_SYS_PROPERTY_VALUE	Static method	Public	Method	Defines system setting	19990330
13	MAKE_NEW_HITLIST	Instance method	Private	Method	Calculate new hit list	19980910
14	MERGE_SETTINGS_ALT	Instance method	Private	Method	Mix general and special settings	19980917
15	MODIFY_HITLIST	Instance method	Private	Method	Modify hit list	19980902
16	NEW_GEN_SETTINGS	Instance method	Private	Event handling method	Event handler	19980909
17	SAVE_ACTIVEX_SETTING	Instance method	Private	Method	Save user's ActiveX settings	19981203
18	SAVE_GLOBAL_SETTING	Static method	Private	Method	Stores global settings	19990330
19	SAVE_SETTINGS	Instance method	Private	Method	Store personal settings	19991111
20	SET_DFIES_OPT_COL	Instance method	Private	Method	Change DFIES with regard to optimized representation of fld	19980929
21	SET_FIELD_POSITION	Instance method	Private	Method	Store position of fields of hit list	19990107
22	SET_PROPERTY_VALUE	Instance method	Private	Method	Sets value of an attribute	19991111
23	SET_STANDARD_SETTINGS	Instance method	Private	Method	Determine standard shlp_pers structure	19980924
24	SHOW_F4_PERS_DIALOG	Instance method	Private	Method	F4 personalization dialog	19980831

Events

#	Event	Type	Visibility	Description	Created on
1	NEW_GENERELL_SETTINGS	Instance Event (0)	Private (0)	The general settings were changed	19980909

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1		Protected	Type reference (TYPE)	C		19980901
2	INDXKEYTYPE	Private	See coding		Structure index key	19980909	BEGIN OF indxkeytype , mandant TYPE sy-mandt, username TYPE sy-uname, shlpname TYPE shlpname, shlptype TYPE ddshdescr-shlptype, END OF indxkeytype
3	INDX_OBJ	Private	Type reference (TYPE)	DDF4PSINDX	INDX_OBJ	19980901
4	PERS_SHLP	Private	See coding		Type for search help-specific settings	19980901	BEGIN OF pers_shlp, * shlpname type shlpname, * username type sy-uname, * mandant type sy-mandt, dialogtype TYPE ddf4psflag, maxrecords TYPE ddshmaxrec, nolimit TYPE ddf4psflag, pvalues TYPE ddf4psflag, tlpopup_x TYPE i, tlpopup_y TYPE i, shortcut TYPE ddf4psflag, hitlist TYPE STANDARD TABLE OF shfprop WITH DEFAULT KEY, notfilterpvalues(1) type c, END OF pers_shlp
5	PERS_SHLP_ALL	Private	Type reference (TYPE)	DDF4PSALLS	Type	19980909
6	SHFPROP	Private	See coding		Structure for hit list	19980831	BEGIN OF shfprop, fieldname TYPE shlpfield, shlplispos TYPE shlplispos, leng TYPE outputlen, fieldtext TYPE scrtext_m, optimize TYPE ddf4psflag, END OF shfprop
7	TABDDSHFPROP	Private	See coding		Table type for field prop.	19980902	tabddshfprop TYPE STANDARD TABLE OF ddshfprop
8	TABSHFPROP	Private	See coding		Table Type	19980902	tabshfprop TYPE STANDARD TABLE OF shfprop
9	TYPE_REF_TO_OBJ	Private	See coding		Type for references already created	19980908	BEGIN OF type_ref_to_obj , mandant TYPE sy-mandt, username TYPE sy-uname, shlpname TYPE shlpname, shlptype TYPE ddshdescr-shlptype, reference TYPE REF TO cl_f4custom, END OF type_ref_to_obj
10	TYPE_REF_TO_OBJ_TAB	Private	See coding		Table	19980908	type_ref_to_obj_tab TYPE STANDARD TABLE OF type_ref_to_obj

Method Signatures

Method CHECK_CONSISTENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELDPROP	Call by reference	☐	Type reference (TYPE)	TABDDSHFPROP		Fieldprop	19990118
2	Importing	INDXKEY	Call by reference	☐	Type reference (TYPE)	INDXKEYTYPE		Key	19990118
3	Changing	P_SETTINGS	Call by reference	☐	Type reference (TYPE)	PERS_SHLP		Settings	19990118
4	Changing	P_SETTINGS_ALL	Call by reference	☐	Type reference (TYPE)	PERS_SHLP_ALL		generelly settings	19990118

Method CHECK_CONSISTENCE on class CL_F4CUSTOM has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_F4CUSTOM has no parameter.
Method CLASS_CONSTRUCTOR on class CL_F4CUSTOM has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CALLCONTROL	Call by reference	☑	Type reference (TYPE)	DDSHF4CTRL		Callcontrol	19980924
2	Importing	MANDANT	Call by reference	☑	Type reference (TYPE)	SY-MANDT		Mandant	19980908
3	Importing	REFERENCE	Call by reference	☑	Object reference (TYPE REF TO)	CL_F4CUSTOM		Referenz	19980907
4	Importing	SHLP_TAB	Call by reference	☑	Type reference (TYPE)	SHLP_DESCR_T		Standard Suchhilfe	19980924
5	Importing	USERNAME	Call by reference	☑	Type reference (TYPE)	SY-UNAME		User	19980908

#	Exception	Resumable	Description	Created on
1	NO_PERSONAL_SETTINGS	☐	Keine persönliche Einstellungen vorhanden.	19980908

Method CREATE_F4_CUST_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CALLCONTROL	Call by reference	☐	Type reference (TYPE)	DDSHF4CTRL		Kontrollstruktur	19980907
2	Importing	MANDANT	Call by reference	☑	Type reference (TYPE)	SY-MANDT		Mandant	19980831
3	Changing	SHLP_TAB	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_T		Suchhilfe	19980831
4	Importing	USERNAME	Call by reference	☑	Type reference (TYPE)	SY-UNAME		User	19980831

Method CREATE_F4_CUST_OBJ on class CL_F4CUSTOM has no exception.

Method FREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	REFERENCE_TO_DEL	Call by reference	☐	Object reference (TYPE REF TO)	CL_F4CUSTOM		Objektreferenz	19980908

Method FREE on class CL_F4CUSTOM has no exception.

Method GET_ACTIVEX_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ACTIVEXSETTING	Call by reference	☐	Type reference (TYPE)	F4SETTING		ActiveX Einstellungen	19981203

Method GET_ACTIVEX_SETTING on class CL_F4CUSTOM has no exception.

Method GET_EXIST_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MANDANT	Call by reference	☐	Type reference (TYPE)	SY-MANDT		Mandant	19980908
2	Returning	REFERENCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_F4CUSTOM		Referenz	19980908
3	Importing	SHLPNAME	Call by reference	☐	Type reference (TYPE)	SHLPNAME		Suchhilfe	19980908
4	Importing	SHLPTYPE	Value transfer	☐	Type reference (TYPE)	DDSHDESCR-SHLPTYPE		Typ der Suchhilfe	19981202
5	Importing	USERNAME	Call by reference	☐	Type reference (TYPE)	SY-UNAME		User	19980908

#	Exception	Resumable	Description	Created on
1	NO_INSTANCE	☐	Zu einer Suchilfe existiert noch kein Personalisierungsobj.	19980908

Method GET_GLOBAL_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	GLOBAL_SETTING	Value transfer	☐	Type reference (TYPE)	PERS_SHLP_ALL		Systemeinstellungen	19990330

Method GET_GLOBAL_SETTING on class CL_F4CUSTOM has no exception.

Method GET_PROPERTY_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROPERTY_NAME	Value transfer	☐	Type reference (TYPE)	DDF4PSPROP		Property	19980907
2	Exporting	PROPERTY_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Wert	19980907

Method GET_PROPERTY_VALUE on class CL_F4CUSTOM has no exception.

Method GET_SET_FROM_INDX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDXKEY	Call by reference	☐	Type reference (TYPE)	INDXKEYTYPE		Key	19980903
2	Importing	OPERATION	Call by reference	☐	Type reference (TYPE)	CHAR2		Operation	19980903
3	Changing	P_SETTINGS	Call by reference	☐	Type reference (TYPE)	PERS_SHLP		Settings	19980903
4	Changing	P_SETTINGS_ALL	Call by reference	☑	Type reference (TYPE)	PERS_SHLP_ALL		generelly settings	19980909

#	Exception	Resumable	Description	Created on
1	NO_PERSONAL_SETTINGS	☐	Keine persönlichen Einstellungen vorhanden	19980908

Method GET_SYS_ACTIVEX_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ACTIVEX	Call by reference	☐	Type reference (TYPE)	CHAR10		System ActiveX	19981203

Method GET_SYS_ACTIVEX_SETTING on class CL_F4CUSTOM has no exception.

Method GET_SYS_PROPERTY_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROPERTY_NAME	Call by reference	☐	Type reference (TYPE)	DDF4PSPROP		Property	19990330
2	Exporting	PROPERTY_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Value	19990330

Method GET_SYS_PROPERTY_VALUE on class CL_F4CUSTOM has no exception.

Method MAKE_NEW_HITLIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	NEW_HITLIST	Call by reference	☐	Type reference (TYPE)	TABSHFPROP		Neue Hitlist	19981019
2	Importing	OLD_HITLIST	Call by reference	☐	Type reference (TYPE)	TABSHFPROP		Alte Hitliste	19980910

Method MAKE_NEW_HITLIST on class CL_F4CUSTOM has no exception.

Method MERGE_SETTINGS_ALT Signature

Method MERGE_SETTINGS_ALT on class CL_F4CUSTOM has no parameter.
Method MERGE_SETTINGS_ALT on class CL_F4CUSTOM has no exception.

Method MODIFY_HITLIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	FIELDDESCR	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_T-FIELDDESCR		Dfies	19980908
2	Changing	FIELDPROP	Call by reference	☐	Type reference (TYPE)	TABDDSHFPROP		Fieldprop	19980902
3	Importing	HITLIST	Call by reference	☐	Type reference (TYPE)	TABSHFPROP		pers. Trefferliste	19980902

Method MODIFY_HITLIST on class CL_F4CUSTOM has no exception.

Method NEW_GEN_SETTINGS Signature

Method NEW_GEN_SETTINGS on class CL_F4CUSTOM has no parameter.
Method NEW_GEN_SETTINGS on class CL_F4CUSTOM has no exception.

Method SAVE_ACTIVEX_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTIVEXSETTING	Call by reference	☐	Type reference (TYPE)	F4SETTING		ActiveX Einstellungen	19981203

Method SAVE_ACTIVEX_SETTING on class CL_F4CUSTOM has no exception.

Method SAVE_GLOBAL_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEW_GLOBAL_SETTING	Value transfer	☐	Type reference (TYPE)	PERS_SHLP_ALL		new global settings	19990330
2	Importing	OLD_GLOBAL_SETTING	Value transfer	☐	Type reference (TYPE)	PERS_SHLP_ALL		old global settings	19990330

Method SAVE_GLOBAL_SETTING on class CL_F4CUSTOM has no exception.

Method SAVE_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	NEW_ACTIVEX	Call by reference	☐	Type reference (TYPE)	F4SETTING		Neue ActiveX Einstellungen	19991111
2	Changing	NEW_PERS_SHLP_OBJ	Call by reference	☐	Type reference (TYPE)	PERS_SHLP		Neue persönlichen Einstellungen	19991111
3	Changing	NEW_PERS_SHLP_OBJ_ALL	Call by reference	☐	Type reference (TYPE)	PERS_SHLP_ALL		Neue allgemeine pers. Einstellungen	19991111
4	Changing	NEW_PERS_SHLP_OBJ_SYS	Call by reference	☐	Type reference (TYPE)	PERS_SHLP_ALL		Neue Systemeinstellungen1	19991111

Method SAVE_SETTINGS on class CL_F4CUSTOM has no exception.

Method SET_DFIES_OPT_COL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RCODE	Value transfer	☐	Type reference (TYPE)	SY-SUBRC		Return Code	19980930
2	Changing	SHLP_FIELDDESCR	Call by reference	☐	Type reference (TYPE)	ANY		DFIES Struktur	19980929

Method SET_DFIES_OPT_COL on class CL_F4CUSTOM has no exception.

Method SET_FIELD_POSITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELDPROP	Call by reference	☐	Type reference (TYPE)	TABDDSHFPROP		Fieldprop aus SHLP Struktur	19990107

Method SET_FIELD_POSITION on class CL_F4CUSTOM has no exception.

Method SET_PROPERTY_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROPERTY_NAME	Value transfer	☐	Type reference (TYPE)	DDF4PSPROP		Name der Eigenschaft	19991111
2	Importing	PROPERTY_VALUE	Value transfer	☐	Type reference (TYPE)	ANY		Wert	19991111

Method SET_PROPERTY_VALUE on class CL_F4CUSTOM has no exception.

Method SET_STANDARD_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CALLCONTROL	Call by reference	☑	Type reference (TYPE)	DDSHF4CTRL		Callcontrol	19980924
2	Importing	SHLP_TAB	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_T		Standard SHLP	19980924

Method SET_STANDARD_SETTINGS on class CL_F4CUSTOM has no exception.

Method SHOW_F4_PERS_DIALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FCODE	Call by reference	☐	Type reference (TYPE)	SY-UCOMM		Fkt. Code Dialog	19981102
2	Importing	MANDANT	Call by reference	☐	Type reference (TYPE)	SY-MANDT		Mandant	19980901
3	Importing	OCX_MODE	Call by reference	☑	Type reference (TYPE)	DDF4PSFLAG		OCX Flag	19981026
4	Importing	SHLP_TAB	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_T		Suchhilfe	19980901
5	Importing	USERNAME	Call by reference	☐	Type reference (TYPE)	SY-UNAME		USer	19980901

Method SHOW_F4_PERS_DIALOG on class CL_F4CUSTOM has no exception.

Event Signatures

Event NEW_GENERELL_SETTINGS Signature
Event NEW_GENERELL_SETTINGS on class CL_F4CUSTOM has no parameter.

History

Last changed by/on	SAP	20130531
SAP Release Created in