SAP ABAP Class CL_FP_FB_TEMPLATE_DESIGNER (Form Builder: Wrapper for Template Designer)

Hierarchy

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

Properties

Class	CL_FP_FB_TEMPLATE_DESIGNER
Short Description	Form Builder: Wrapper for Template Designer
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	FPUIFB
Program status	P	SAP Standard Production Program
Category	0
Package	SAFPUI	SAP Form Processing (UI)
Created	20030625	SAP
Last change	20110908	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	SOI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_FP_FB_TEMPLATE_DESIGNER has no interface implemented.

Friends

Class CL_FP_FB_TEMPLATE_DESIGNER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DOCUMENTTYPE_DOCX	Instance attribute	Private	☐	Type reference (TYPE)	SOI_DOCUMENT_TYPE	'Word.Document.12'		20080305
2	GC_DOCUMENTTYPE_XFA	Instance attribute	Private	☐	Type reference (TYPE)	SOI_DOCUMENT_TYPE	'PDFXMLDesigner.Document'		20080305
3	GC_R3_APPLICATION_NAME	Instance attribute	Private	☐	Type reference (TYPE)	CHAR100	'Template Designer'		20080305
4	MS_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	SYMSG		Structure of Message Variables	20081113
5	MV_DOCUMENTTYPE	Instance attribute	Private	☐	Type reference (TYPE)	SOI_DOCUMENT_TYPE			20081113
6	PB_OI_ERROR	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20030626
7	PB_OPEN_READONLY	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20030625
8	PB_RUN_INPLACE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20030625
9	PO_DESIGNER_SPECIFIC	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_TEMPLATE_DESIGNER			20030625
10	PO_DOCPROXY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_DOCUMENT_PROXY			20030625
11	PO_VIEWCONTROL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_CONTAINER_CONTROL			20030625
12	PS_BASEURL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20030826
13	PS_RETCODE	Instance attribute	Private	☐	Type reference (TYPE)	SOI_RET_STRING			20030625
14	RC_FAILED	Constant	Public	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20030625
15	RC_OK	Constant	Public	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20030625

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_BINDINGS	Instance method	Public	Method	Check Data Bindings in Template	20030625
2	CHECK_PREREQUISITES	Instance method	Private	Method	Check Prerequisites (Template Designer, OI, ...)	20030714
3	CLOSE	Instance method	Public	Method	Close Template Designer	20030625
4	GET_ERROR_MSG	Instance method	Public	Method	If value RC_FAILED is returned, error is retrieved here	20030626
5	GET_MIMEREP_URL	Instance method	Private	Method	Set Root of MIME Repository as BaseURL Default	20030906
6	GET_TEMPLATE	Instance method	Public	Method	Get Method for Template as XSTRING	20030625
7	HANDLE_DESIGNER_CLOSE	Instance method	Private	Event handling method	Propagate CLOSE Event of OI Document	20030625
8	HAS_CHANGED	Instance method	Public	Method	Query: Template changed?	20030625
9	HAS_DESIGNER_INTERFACE	Instance method	Private	Method	Check Template Designer-Specific Interface	20030625
10	INITIALIZE	Instance method	Public	Method	Initialize by Specifying Host Container	20030625
11	OPEN_TEMPLATE	Instance method	Public	Method	Call Template Designer (New or Modify)	20030625
12	SET_MERGETEMPLATE	Instance method	Public	Method	Merges Web Dynpro Scripting from TDS into Active Template	20080306
13	SET_SCHEMA	Instance method	Public	Method	Set XML Schema	20030625
14	SET_UI_LANGUAGE	Instance method	Private	Method	Sets UI Language By Means Of Registry Key	20030829

Events

#	Event	Type	Visibility	Description	Created on
1	DESIGNER_CLOSED	Instance Event (0)	Public (2)	Will be dropped when designer is closed	20030625

Types

Class CL_FP_FB_TEMPLATE_DESIGNER has no local type.

Method Signatures

Method CHECK_BINDINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NOT_EXISTING_CONNECTION	Call by reference	☐	Type reference (TYPE)	I		genauer Status bzgl. Existenz der Schema-Connection	20030808
2	Exporting	NOT_VALID	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Template enthält nicht-valides Data Binding	20030625
3	Exporting	RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Rückgabewert	20030625
4	Importing	SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20030625
5	Exporting	STATUS_FIELD_NODES	Call by reference	☐	Type reference (TYPE)	I		genauer Status bzgl. Felder im Template	20030808
6	Exporting	STATUS_SCHEMA_NODES	Call by reference	☐	Type reference (TYPE)	I		genauer Status bzgl. Schema Nodes	20030808

Method CHECK_BINDINGS on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method CHECK_PREREQUISITES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOCUMENT_TYPE	Call by reference	☐	Type reference (TYPE)	SOI_DOCUMENT_TYPE			20080305
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		'X': OK; ' ': Reqs. nicht gegeben	20030714

Method CHECK_PREREQUISITES on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEEP_ATD_ALIVE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	sollen Office Integration Objekte erhalten bleiben?	20030625

Method CLOSE on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method GET_ERROR_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	MSGID	Call by reference	☐	Type reference (TYPE)	SYMSGID		Nachrichtenklasse	20030626
2	Exporting	MSGNO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Nachrichtennummer	20030626
3	Exporting	MSGP1	Call by reference	☐	Type reference (TYPE)	SYMSGV		Nachrichtenvariable	20030626
4	Exporting	MSGP2	Call by reference	☐	Type reference (TYPE)	SYMSGV		Nachrichtenvariable	20030626
5	Exporting	MSGP3	Call by reference	☐	Type reference (TYPE)	SYMSGV		Nachrichtenvariable	20030626
6	Exporting	MSGP4	Call by reference	☐	Type reference (TYPE)	SYMSGV		Nachrichtenvariable	20030626

Method GET_ERROR_MSG on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method GET_MIMEREP_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	FORMS_FOLDER_URL	Value transfer	☐	Type reference (TYPE)	STRING		liefert die URL des ICF Forms Folders	20030906

Method GET_MIMEREP_URL on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method GET_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RC	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Rückgabewert	20030625
2	Exporting	TEMPLATE_XSTRING	Call by reference	☐	Type reference (TYPE)	FPCONTENT		Formularprozessierung: Inhalt von XFT, XFD, PDF etc.	20030625

Method GET_TEMPLATE on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method HANDLE_DESIGNER_CLOSE Signature

Method HANDLE_DESIGNER_CLOSE on class CL_FP_FB_TEMPLATE_DESIGNER has no parameter.
Method HANDLE_DESIGNER_CLOSE on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method HAS_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	HAS_CHANGED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		X, falls Dok geändert	20030625
2	Exporting	RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Rückgabewert	20030625

Method HAS_CHANGED on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method HAS_DESIGNER_INTERFACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Template Designer Interface vorhanden?	20030625

Method HAS_DESIGNER_INTERFACE on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GUI_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Containerbereich für den Template Designer	20030723
2	Importing	IV_FORM_TECH	Value transfer	☑	Type reference (TYPE)	FPFORMTECH		Layouttechnologie	20080305
3	Exporting	RC	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Rückgabewert (X=OK, ' '= :-( )	20030625

Method INITIALIZE on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method OPEN_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BASEURL	Call by reference	☑	Type reference (TYPE)	STRING		zum Übersteuern des MIMERep-Defaults	20030826
2	Importing	OPEN_INPLACE	Value transfer	☑	Type reference (TYPE)	ABAP_BOOL		soll der Designer inplace laufen?	20030625
3	Importing	OPEN_READONLY	Value transfer	☑	Type reference (TYPE)	ABAP_BOOL		soll der Designer im Read-Only-Modus laufen?	20030625
4	Exporting	RC	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Rückgabewert	20030625
5	Importing	TEMPLATE_XSTRING	Call by reference	☑	Type reference (TYPE)	FPCONTENT		Form Template; falls leer: neues Template	20030625
6	Importing	UILANGUAGE	Value transfer	☑	Type reference (TYPE)	LAISO		zum Übersteuern der Anmeldesprache	20030926
7	Importing	USE_MERGETEMPLATE	Value transfer	☑	Type reference (TYPE)	ABAP_BOOL		soll MergeTemplate gesetzt werden?	20080306

Method OPEN_TEMPLATE on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method SET_MERGETEMPLATE Signature

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

Method SET_MERGETEMPLATE on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method SET_SCHEMA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RC	Call by reference	☐	Type reference (TYPE)	C		Rückgabewert	20030625
2	Importing	SCHEMA_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Schema als XString	20030625
3	Importing	SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name des Schemas	20030625

Method SET_SCHEMA on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Method SET_UI_LANGUAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PS_LKEY	Value transfer	☑	Type reference (TYPE)	LAISO		Falls Anmeldesprache übersteuert werden soll	20030926
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Rückgabewert	20030829

Method SET_UI_LANGUAGE on class CL_FP_FB_TEMPLATE_DESIGNER has no exception.

Event Signatures

Event DESIGNER_CLOSED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	LATEST_TEMPLATE	Exporting	Value transfer	☑	Type reference (TYPE)	XSTRING		das zuletzt gerettete Template vor dem Designer CLOSE	20030625

History

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