SAP ABAP Class CL_GUI_BTFEDITOR (SAP BTF Editor Control Proxy Class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-BTF (Application Component) Business Text Framework
     ⤷ SBTF (Package) Business Text Framework

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_GUI_CONTROL	Proxy Class for Control in GUI	20011011
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BTF_EDITOR_CONSTANTS	SAP BTF Editor Constants Interface	20011120
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DRAGDROP	Drag and Drop Interface for Controls	20011015

Properties

Class	CL_GUI_BTFEDITOR
Short Description	SAP BTF Editor Control Proxy Class
Super Class	CL_GUI_CONTROL	Proxy Class for Control in GUI
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	SBTF	Business Text Framework
Created	20011011	SAP
Last change	20041228	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_BTF_EDITOR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CNDD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	CNDP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	CNTL	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BTF_EDITOR_CONSTANTS	☐	☐	SAP BTF Editor Constants Interface	20011120
2	IF_DRAGDROP	☐	☐	Drag and Drop Interface for Controls	20011015

Friends

#	Friend	Modeled only	Created on	Description
1	CL_BTF_EDITOR	☐	20011120	SAP BTF Editor Class

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_FALSE	Constant	Public	☐	Type reference (TYPE)	I	0	False	20011012
2	CO_GUI_TYPE_JAVAGUI	Constant	Protected	☐	Type reference (TYPE)	I	3	GuiType JavaGUI	20011012
3	CO_GUI_TYPE_WEBGUI	Constant	Protected	☐	Type reference (TYPE)	I	2	GuiType WebGUI	20011012
4	CO_GUI_TYPE_WINGUI	Constant	Protected	☐	Type reference (TYPE)	I	1	GuiType WinGUI	20011012
5	CO_TRUE	Constant	Public	☐	Type reference (TYPE)	I	1	True	20011012
6	CO_UI_MODE_WEBGUI	Constant	Protected	☐	Type reference (TYPE)	I	2	UImode for WebGUI	20011012
7	CO_UI_MODE_WINGUI	Constant	Protected	☐	Type reference (TYPE)	I	1	UImode for WinGUI	20011012
8	M_DESIGN_MODE	Instance attribute	Public	☐	Type reference (TYPE)	I	IF_BTF_EDITOR_CONSTANTS~CO_DESIGN_MODE_ON	DesignMode	20011012
9	M_DP_HANDLE	Instance attribute	Protected	☐	Type reference (TYPE)	CNTL_HANDLE		Handle to data provider	20011011
10	M_DRAGDROP	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_DRAGDROP		DragDrop	20011015
11	M_EXTERNAL_EDITOR	Instance attribute	Public	☐	Type reference (TYPE)	STRING	'NOTEPAD.EXE'	ExternalEditor	20011023
12	M_FIND_EVENT	Instance attribute	Public	☐	Type reference (TYPE)	I	0	FindEvent	20020213
13	M_GUI_TYPE	Instance attribute	Protected	☐	Type reference (TYPE)	I		GuiType	20011012
14	M_IMAGE_OPERATIONS	Instance attribute	Public	☐	Type reference (TYPE)	I	0	ImageOperations	20020111
15	M_LOCAL_OPERATIONS	Instance attribute	Public	☐	Type reference (TYPE)	I	0	LocalOperations	20011120
16	M_LOCAL_PRINTING	Instance attribute	Public	☐	Type reference (TYPE)	I	0	LocalPrinting	20011120
17	M_TAB_CONTROL	Instance attribute	Public	☐	Type reference (TYPE)	I	0	TblControl	20011012
18	M_TEXTEDIT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_TEXTEDIT		TextEdit Control (Fallback)	20011012
19	M_UI_MODE	Instance attribute	Protected	☐	Type reference (TYPE)	I	CO_UI_MODE_WINGUI	UImode	20011012
20	M_VERSION	Instance attribute	Private	☐	Type reference (TYPE)	I		BTF Editor Control version	20011011
21	M_WINDOWS_FONTS	Instance attribute	Public	☐	Type reference (TYPE)	I	0	WindowsFonts	20011120

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20011011
2	DO_FIND_AND_REPLACE	Instance method	Public	Method	Find and Replace	20020214
3	DO_FIND_NEXT	Instance method	Public	Method	Find Next	20020215
4	GET_DOCUMENT	Instance method	Public	Method	Get Document	20011012
5	GET_IS_MODIFIED	Instance method	Public	Method	Get IsModified	20011012
6	GET_SELECTED_TEXT	Instance method	Public	Method	Get SelectedText	20020213
7	INIT	Instance method	Public	Method	Initialization	20011011
8	INIT_FIND_AND_REPLACE	Instance method	Public	Method	Initialize Find and Replace	20020214
9	INSERT_HTML	Instance method	Public	Method	Insert Html	20011016
10	OPEN_REPLACE_DIALOG	Instance method	Protected	Method	Open Dialog for 'Find and Replace'	20020213
11	SET_DESIGN_MODE	Instance method	Public	Method	Set DesignMode	20011012
12	SET_DOCUMENT	Instance method	Public	Method	Set Document	20011012
13	SET_DRAGDROP	Instance method	Public	Method	Set DragDrop	20011015
14	SET_EXTERNAL_EDITOR	Instance method	Public	Method	Set ExternalEditor	20011023
15	SET_FIND_EVENT	Instance method	Public	Method	Set FindEvent	20020213
16	SET_IMAGE_OPERATIONS	Instance method	Public	Method	Set ImageOperations	20020111
17	SET_IS_MODIFIED	Instance method	Public	Method	Set IsModified	20011012
18	SET_LOCAL_OPERATIONS	Instance method	Public	Method	Set LocalOperations	20011120
19	SET_LOCAL_PRINTING	Instance method	Public	Method	Set LocalPrinting	20011120
20	SET_STRINGVALUES	Instance method	Protected	Method	Set StringValues	20011011
21	SET_TAB_CONTROL	Instance method	Public	Method	Set TabControl	20011012
22	SET_UI_MODE	Instance method	Protected	Method	Set UIMode	20011012
23	SET_WINDOWS_FONTS	Instance method	Public	Method	Set WindowsFonts	20011120
24	TEXTEDIT_ON_DROP	Instance method	Protected	Event handling method	TextEdit on drop event handler	20011016
25	TEXTEDIT_ON_GET_FLAVOR	Instance method	Protected	Event handling method	TextEdit on get flavor event handler	20011016

Events

#	Event	Type	Visibility	Description	Created on
1	DROP	Instance Event (0)	Public (2)	Drop event	20011015
2	FUNCTIONCLICKED	Instance Event (0)	Public (2)	FunctionClicked Event	20020121
3	GETFLAVOR	Instance Event (0)	Public (2)	GetFlavor event	20011015

Types

Class CL_GUI_BTFEDITOR has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LIFETIME	Call by reference	☑	Type reference (TYPE)	I		Lifetime	20011011
2	Importing	NAME	Value transfer	☑	Type reference (TYPE)	STRING		Name	20011011
3	Importing	PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Parent container	20011011
4	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I		Shell style	20011011

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011011
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20011011

Method DO_FIND_AND_REPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALL	Call by reference	☐	Type reference (TYPE)	I		Alle ersetzen	20020214
2	Importing	DIRECTION_DOWN	Call by reference	☐	Type reference (TYPE)	I		Richtung nach unten	20020214
3	Importing	FIND_WHAT	Call by reference	☐	Type reference (TYPE)	STRING		Suchen nach	20020214
4	Importing	MATCH_CASE	Call by reference	☐	Type reference (TYPE)	I		Gross-/Kleinschreibung beachten	20020214
5	Importing	REPLACE	Call by reference	☐	Type reference (TYPE)	I		Ersetzen	20020214
6	Importing	REPLACE_WITH	Call by reference	☐	Type reference (TYPE)	STRING		Ersetzen durch	20020214
7	Exporting	SUCCESS	Call by reference	☐	Type reference (TYPE)	I		Erfolgreich	20020214
8	Importing	WHOLE_WORD	Call by reference	☐	Type reference (TYPE)	I		Nur ganzes Word suchen	20020214

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20020214
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020214

Method DO_FIND_NEXT Signature

Method DO_FIND_NEXT on class CL_GUI_BTFEDITOR has no parameter.
Method DO_FIND_NEXT on class CL_GUI_BTFEDITOR has no exception.

Method GET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DOCUMENT	Value transfer	☐	Type reference (TYPE)	XSTRING		Document	20011012
2	Exporting	ENCODING	Call by reference	☐	Type reference (TYPE)	STRING		Codierung	20020415

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011012

Method GET_IS_MODIFIED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_MODIFIED	Value transfer	☐	Type reference (TYPE)	I		IsModified	20011012

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011012

Method GET_SELECTED_TEXT Signature

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

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20020213
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020213

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESIGN_MODE	Call by reference	☐	Attribute reference (LIKE)	M_DESIGN_MODE	IF_BTF_EDITOR_CONSTANTS~CO_DESIGN_MODE_ON	DesignMode	20011012

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011011

Method INIT_FIND_AND_REPLACE Signature

Method INIT_FIND_AND_REPLACE on class CL_GUI_BTFEDITOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20020214
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020214

Method INSERT_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HTML	Call by reference	☐	Type reference (TYPE)	STRING		Html	20011016

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011016

Method OPEN_REPLACE_DIALOG Signature

Method OPEN_REPLACE_DIALOG on class CL_GUI_BTFEDITOR has no parameter.
Method OPEN_REPLACE_DIALOG on class CL_GUI_BTFEDITOR has no exception.

Method SET_DESIGN_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESIGN_MODE	Call by reference	☐	Attribute reference (LIKE)	M_DESIGN_MODE	IF_BTF_EDITOR_CONSTANTS~CO_DESIGN_MODE_ON	DesignMode	20011012

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011012

Method SET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Document	20011012
2	Importing	ENCODING	Call by reference	☐	Type reference (TYPE)	STRING		Codierung	20020415

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011012

Method SET_DRAGDROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DRAGDROP	Call by reference	☐	Object reference (TYPE REF TO)	CL_DRAGDROP		DragDrop	20011015

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011015

Method SET_EXTERNAL_EDITOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXTERNAL_EDITOR	Call by reference	☐	Attribute reference (LIKE)	M_EXTERNAL_EDITOR		ExternalEditor	20011023

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011023
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020124

Method SET_FIND_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIND_EVENT	Call by reference	☐	Attribute reference (LIKE)	M_FIND_EVENT	0	FindEvent	20020213

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20020213
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020213

Method SET_IMAGE_OPERATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IMAGE_OPERATIONS	Call by reference	☐	Attribute reference (LIKE)	M_IMAGE_OPERATIONS	0	ImageOperations	20020111

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20020111
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020124

Method SET_IS_MODIFIED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MODIFIED	Call by reference	☐	Type reference (TYPE)	I	CO_FALSE	IsModified	20011012

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011012

Method SET_LOCAL_OPERATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOCAL_OPERATIONS	Call by reference	☐	Attribute reference (LIKE)	M_LOCAL_OPERATIONS	0	LocalOperations	20011120

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011120
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020124

Method SET_LOCAL_PRINTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOCAL_PRINTING	Call by reference	☐	Attribute reference (LIKE)	M_LOCAL_PRINTING	0	LocalPrinting	20011120

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011120
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020124

Method SET_STRINGVALUES Signature

Method SET_STRINGVALUES on class CL_GUI_BTFEDITOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011011
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020124

Method SET_TAB_CONTROL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TAB_CONTROL	Call by reference	☐	Attribute reference (LIKE)	M_TAB_CONTROL	0	TabControl	20011012

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011012
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020124

Method SET_UI_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	UI_MODE	Call by reference	☐	Attribute reference (LIKE)	M_UI_MODE	CO_UI_MODE_WINGUI	UImode	20011012

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011012
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020124

Method SET_WINDOWS_FONTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATIC_FONTS	Call by reference	☑	Type reference (TYPE)	BTF_CONFIG_TABLE		Static fonts	20020612
2	Importing	WINDOWS_FONTS	Call by reference	☐	Attribute reference (LIKE)	M_WINDOWS_FONTS	0	WindowsFonts	20011120

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Control error	20011120
2	GUI_TYPE_NOT_SUPPORTED	☐	This type of GUI is not supported!	20020124

Method TEXTEDIT_ON_DROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DRAGDROP_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20011016
2	Importing	INDEX	Call by reference	☐	Attribute reference (LIKE)				20011016
3	Importing	LINE	Call by reference	☐	Attribute reference (LIKE)				20011016
4	Importing	POS	Call by reference	☐	Attribute reference (LIKE)				20011016

Method TEXTEDIT_ON_DROP on class CL_GUI_BTFEDITOR has no exception.

Method TEXTEDIT_ON_GET_FLAVOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DRAGDROP_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20011016
2	Importing	FLAVORS	Call by reference	☐	Attribute reference (LIKE)				20011016
3	Importing	INDEX	Call by reference	☐	Attribute reference (LIKE)				20011016
4	Importing	LINE	Call by reference	☐	Attribute reference (LIKE)				20011016
5	Importing	POS	Call by reference	☐	Attribute reference (LIKE)				20011016

Method TEXTEDIT_ON_GET_FLAVOR on class CL_GUI_BTFEDITOR has no exception.

Event Signatures

Event DROP Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAGDROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		DragDrop object	20011015

Event FUNCTIONCLICKED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Value transfer	☐	Type reference (TYPE)	UI_FUNC		FCode	20020121

Event GETFLAVOR Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAGDROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		DragDrop object	20011015
2	FLAVORS	Exporting	Value transfer	☐	Type reference (TYPE)	CNDD_FLAVORS		Flavors	20011015

History

Last changed by/on	SAP	20041228
SAP Release Created in	620