SAP ABAP Class CL_FP_HELPER (Form Objects: Help Functions)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-FP (Application Component) Forms Processing
     ⤷ SAFPAPI (Package) SAP Form Processing (API)

Properties

Class	CL_FP_HELPER
Short Description	Form Objects: Help Functions
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAFPAPI	SAP Form Processing (API)
Created	20030828	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

Class CL_FP_HELPER has no interface implemented.

Friends

Class CL_FP_HELPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_FORM_VERSION	Constant	Private	☐	Type reference (TYPE)	I	1	Form version	20031113
2	C_INTERFACE_VERSION	Constant	Private	☐	Type reference (TYPE)	I	1	Interface Version	20031113
3	C_NODE_VERSION	Constant	Private	☐	Type reference (TYPE)	I	1	Node Version	20031113

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJUST_CACHE_INFO	Static method	Public	Method	Update Cache Information in URL	20061213
2	CHECK_CHARACTER_LITERAL	Static method	Public	Method	Check Character Literal	20030828
3	CHECK_CODING	Static method	Public	Method	Check Program Lines	20040225
4	CHECK_NUMERIC_LITERAL	Static method	Public	Method	Check Numeric Literal	20030828
5	CONVERT_FORM_TO_XSTRING	Static method	Public	Method	Convert Form to XString	20031112
6	CONVERT_INTERFACE_TO_XSTRING	Static method	Public	Method	Convert Interface to XString	20031113
7	CONVERT_NODE_TO_XSTRING	Static method	Public	Method	Convert Node to XString	20031111
8	CONVERT_XSTRING_TO_FORM	Static method	Public	Method	Convert XString to Form	20031113
9	CONVERT_XSTRING_TO_INTERFACE	Static method	Public	Method	Convert XString to Interface	20031113
10	CONVERT_XSTRING_TO_NODE	Static method	Public	Method	Convert XString to Node	20031111
11	CORRECT_NODE_NAME	Static method	Public	Method	Correct Node Name	20050318
12	GET_FORM_TECHNOLOGIES	Static method	Public	Method	Returns the available layout technologies	20090114
13	GET_PARAMETER_FROM_FIELD	Static method	Public	Method	Get Parameter from Field	20031202
14	GET_WEBDAV_PATH	Static method	Public	Method	Get WebDAV Path	20101007
15	IS_CUSTOM_IMPLEMENTED	Static method	Public	Method	Replacement implementation for layout technology?	20091005
16	SET_NEW_CACHE_INFO	Static method	Public	Method	Set New Cache Information	20050804
17	SET_NEW_LAYOUT_HASH	Static method	Public	Method	Set New Layout Hash Value	20040909
18	SET_NEW_LAYOUT_ID	Static method	Public	Method	Set New Layout ID	20040909

Events

Class CL_FP_HELPER has no event.

Types

Class CL_FP_HELPER has no local type.

Method Signatures

Method ADJUST_CACHE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CACHE_INFO	Call by reference	☐	Type reference (TYPE)	STRING		Aktualisierte Cache Info	20061213
2	Exporting	E_URL	Call by reference	☐	Type reference (TYPE)	STRING		Aktualisierte URL	20061213
3	Importing	I_CACHE_INFO	Call by reference	☑	Type reference (TYPE)	STRING		Cache Info	20061213
4	Importing	I_LOCALE	Call by reference	☐	Type reference (TYPE)	STRING		Locale	20061213
5	Importing	I_URL	Call by reference	☑	Type reference (TYPE)	STRING		URL	20061213

Method ADJUST_CACHE_INFO on class CL_FP_HELPER has no exception.

Method CHECK_CHARACTER_LITERAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	SIMPLE		Wert	20030829
2	Returning	R_VALID	Value transfer	☐	Type reference (TYPE)	CHAR1		Gültiges Zeichenliteral?	20030829

Method CHECK_CHARACTER_LITERAL on class CL_FP_HELPER has no exception.

Method CHECK_CODING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_CHECKLIST	Call by reference	☐	Type reference (TYPE)	TFPCHECKLIST		Prüfergebnisse	20040225
2	Importing	I_CODING	Call by reference	☐	Type reference (TYPE)	RSWSOURCET		ABAP-Source	20040225
3	Importing	I_INPUT	Call by reference	☐	Type reference (TYPE)	TFPPARAMETER		Parameter	20040225
4	Importing	I_INTERFACE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FP_INTERFACE		Formularobjekte: Interface für Formularschnittstellen	20040225
5	Importing	I_INTERFACE_PARAMETERS	Call by reference	☑	Object reference (TYPE REF TO)	CL_FP_INTERFACE_PARAMETERS		Formularkomponenten: Schnittstellenparameter	20050223
6	Importing	I_OUTPUT	Call by reference	☐	Type reference (TYPE)	TFPPARAMETER		Parameter	20040225

Method CHECK_CODING on class CL_FP_HELPER has no exception.

Method CHECK_NUMERIC_LITERAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	SIMPLE		Wert	20030829
2	Returning	R_VALID	Value transfer	☐	Type reference (TYPE)	CHAR1		Gültiges Zahlenliteral?	20030829

Method CHECK_NUMERIC_LITERAL on class CL_FP_HELPER has no exception.

Method CONVERT_FORM_TO_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FORM	Call by reference	☐	Object reference (TYPE REF TO)	IF_FP_FORM		Formular	20031113
2	Returning	R_XSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING		XString	20031112

#	Exception	Resumable	Description	Created on
1	CX_FP_API_INTERNAL	☐	Ausnahme API (intern)	20031112

Method CONVERT_INTERFACE_TO_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INTERFACE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FP_INTERFACE		Schnittstelle	20031113
2	Returning	R_XSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING		XString	20031113

#	Exception	Resumable	Description	Created on
1	CX_FP_API_INTERNAL	☐	Ausnahme API (intern)	20031113

Method CONVERT_NODE_TO_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FP_NODE		Knoten	20031111
2	Returning	R_XSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING		XString	20031111

#	Exception	Resumable	Description	Created on
1	CX_FP_API_INTERNAL	☐	Ausnahme API (intern)	20031111
2	CX_FP_API_USAGE	☐	Ausnahme API (Verwendung)	20031111

Method CONVERT_XSTRING_TO_FORM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LANGU		Sprache	20031113
2	Importing	I_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING		XString	20031113
3	Returning	R_FORM	Value transfer	☐	Object reference (TYPE REF TO)	IF_FP_FORM		Formular	20031113

#	Exception	Resumable	Description	Created on
1	CX_FP_API_INTERNAL	☐	Ausnahme API (intern)	20031113

Method CONVERT_XSTRING_TO_INTERFACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LANGU		Sprache	20031113
2	Importing	I_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING		XString	20031113
3	Returning	R_INTERFACE	Value transfer	☐	Object reference (TYPE REF TO)	IF_FP_INTERFACE		Schnittstelle	20031113

#	Exception	Resumable	Description	Created on
1	CX_FP_API_INTERNAL	☐	Ausnahme API (intern)	20031113

Method CONVERT_XSTRING_TO_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING		XString	20031111
2	Returning	R_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_FP_NODE		Knoten	20031111

#	Exception	Resumable	Description	Created on
1	CX_FP_API_INTERNAL	☐	Ausnahme API (intern)	20031111
2	CX_FP_API_USAGE	☐	Ausnahme API (Verwendung)	20031111

Method CORRECT_NODE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_NAME	Call by reference	☐	Type reference (TYPE)	FPNODENAME		Name einer Formularkomponente	20050318

Method CORRECT_NODE_NAME on class CL_FP_HELPER has no exception.

Method GET_FORM_TECHNOLOGIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_FORM_TECHNOLOGIES	Value transfer	☐	Type reference (TYPE)	TFPFORMTECHNOLOGY		Layouttechnologien	20090114

Method GET_FORM_TECHNOLOGIES on class CL_FP_HELPER has no exception.

Method GET_PARAMETER_FROM_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_FP_CONTEXT		Kontext	20031202
2	Importing	I_FIELD	Call by reference	☐	Type reference (TYPE)	FPFIELD		Feld	20031202
3	Returning	R_PARAMETER	Value transfer	☐	Type reference (TYPE)	SFPINTERFACEPAR		Parameter	20031202

#	Exception	Resumable	Description	Created on
1	CX_FP_API_USAGE	☐	Ausnahme API (Verwendung)	20031202

Method GET_WEBDAV_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_PATH	Value transfer	☐	Type reference (TYPE)	STRING		WebDAV-Pfad	20101007

Method GET_WEBDAV_PATH on class CL_FP_HELPER has no exception.

Method IS_CUSTOM_IMPLEMENTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORMTECH	Call by reference	☐	Type reference (TYPE)	FPFORMTECH		Layouttechnologie	20091005
2	Returning	RV_IS_CUSTOM	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20091005

Method IS_CUSTOM_IMPLEMENTED on class CL_FP_HELPER has no exception.

Method SET_NEW_CACHE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_FORM	Call by reference	☐	Object reference (TYPE REF TO)	IF_FP_FORM		Formular	20050804

#	Exception	Resumable	Description	Created on
1	CX_FP_API_INTERNAL	☐	Ausnahme API (intern)	20050804

Method SET_NEW_LAYOUT_HASH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_FORM	Call by reference	☐	Object reference (TYPE REF TO)	IF_FP_FORM		Formular	20040909

#	Exception	Resumable	Description	Created on
1	CX_FP_API_INTERNAL	☐	Ausnahme API (intern)	20040909

Method SET_NEW_LAYOUT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_FORM	Call by reference	☐	Object reference (TYPE REF TO)	IF_FP_FORM		Formular	20040909

#	Exception	Resumable	Description	Created on
1	CX_FP_API_INTERNAL	☐	Ausnahme API (intern)	20040909

History

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