SAP ABAP Class CL_CMP_WB_TOOL (Workbench Tool Class for Processing an Object)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO (Application Component) Workbench Tools: Editors, Painters, Modelers
     ⤷ SCCMP (Package) SAP INTERNAL USAGE: Code Composer

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_WB_ABSTRACT_TOOL	Abstract Workbench Tool Class	20110324

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_CMP_WB_TOOL_AREA	Code Composer Area	20100422
2	Inheritance (c INHERITING FROM c_ref)	CL_CMP_WB_TOOL_FUNCTION	Code Composer Area	20100505

Properties

Class	CL_CMP_WB_TOOL
Short Description	Workbench Tool Class for Processing an Object
Super Class	CL_WB_ABSTRACT_TOOL	Abstract Workbench Tool Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class	CMP_MSG
Program status
Category	0
Package	SCCMP	SAP INTERNAL USAGE: Code Composer
Created	20100317	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)
2	CL_CMP_WB_TOOL	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	SWBM	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CMP_WB_TOOL has no interface implemented.

Friends

Class CL_CMP_WB_TOOL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACTIVE_TEXT	Instance attribute	Public	☑	Type reference (TYPE)	SEU_TOOL_OBJSTATE_TEXT			20110324
2	CON_NAME_AREA	Constant	Public	☐	Type reference (TYPE)	STRING	'AREA'		20110323
3	CON_NAME_FUNCTION	Constant	Public	☐	Type reference (TYPE)	STRING	'FUNCTION'		20110323
4	CON_NAME_TEMPLATE	Constant	Public	☐	Type reference (TYPE)	STRING	'TEMPLATE'		20110323
5	CON_TRANSPORT_OBJECT	Constant	Public	☐	Type reference (TYPE)	CHAR4	'CMPT'		20110323
6	CON_WBSUBTYPE_AREA	Constant	Public	☐	Type reference (TYPE)	SEU_OBJTYP	'ARE'		20110323
7	CON_WBSUBTYPE_FUNCTION	Constant	Public	☐	Type reference (TYPE)	SEU_OBJTYP	'FUN'		20110323
8	CON_WBTYPE_TEMPLATE	Constant	Public	☐	Type reference (TYPE)	TROBJTYPE	'CMPT'		20110323
9	INACTIVE_TEXT	Instance attribute	Public	☑	Type reference (TYPE)	SEU_TOOL_OBJSTATE_TEXT			20110323
10	NAME	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20110323
11	S_MARKER_TEMPLATE	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20100503
12	S_TAB_MARKERS	Static Attribute	Private	☐	Type reference (TYPE)	TYP_TAB_MARKERS			20100503

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor		20100317
2	GET_STATE	Instance method	Public	Method		20110324
3	GET_STATE_DATA	Instance method	Public	Method		20110324
4	GET_WB_REQUEST	Instance method	Public	Method		20110324
5	INIT	Instance method	Private	Method		20100427
6	IS_ACTIVE	Instance method	Public	Method		20110323
7	IS_DIRTY	Instance method	Public	Method		20110323
8	IS_INACTIVE	Instance method	Public	Method		20110323
9	RESET_STATE	Instance method	Public	Method		20110324
10	S_BUILD_OBJKEY_EXPLICITY	Static method	Public	Method		20110323
11	S_BUILD_OBJKEY_FROM_ID_VALUE	Static method	Public	Method		20110323
12	S_CREATE_AREA_ICON	Static method	Private	Method		20101103
13	S_CREATE_FUNCTION_ICON	Static method	Private	Method		20101103
14	S_GET_MARKERS_DB	Static method	Public	Method		20110323
15	S_SET_MARKERS	Instance method	Public	Method		20110323
16	S_SET_MARKERS_DB	Instance method	Public	Method		20110323
17	S_SET_MARKER_DB	Static method	Public	Method		20110323

Events

Class CL_CMP_WB_TOOL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYP_STR_MARKER	Public	See coding			20110323	BEGIN OF typ_str_marker, templ_name TYPE c LENGTH 40, templ_line_no TYPE i, inactive TYPE xflag, END OF typ_str_marker
2	TYP_TAB_MARKERS	Public	See coding			20110323	typ_tab_markers TYPE STANDARD TABLE OF typ_str_marker WITH DEFAULT KEY

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	CON_NAME_TEMPLATE		20110323
2	Importing	P_PERSIST	Call by reference	☑	Object reference (TYPE REF TO)	IF_WB_OBJECT_PERSIST		Persistenz	20100317
3	Importing	P_UI	Call by reference	☑	Object reference (TYPE REF TO)	IF_WB_TOOL_UI		User Interface	20100317

Method CONSTRUCTOR on class CL_CMP_WB_TOOL has no exception.

Method GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_REF_STATE	Value transfer	☐	Object reference (TYPE REF TO)	IF_WB_OBJECT_STATE		Workbench: Sicht auf abstraktes Objekt	20110324

Method GET_STATE on class CL_CMP_WB_TOOL has no exception.

Method GET_STATE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STR_DATA	Value transfer	☐	Type reference (TYPE)	WBTOOL_DATA		Verwaltungsdaten eines generischen Workbench-Tools	20110324

Method GET_STATE_DATA on class CL_CMP_WB_TOOL has no exception.

Method GET_WB_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_REF_WB_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	CL_WB_REQUEST		Workbench Manager: Request	20110324

Method GET_WB_REQUEST on class CL_CMP_WB_TOOL has no exception.

Method INIT Signature

Method INIT on class CL_CMP_WB_TOOL has no parameter.
Method INIT on class CL_CMP_WB_TOOL has no exception.

Method IS_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_OBJECT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_OBJECT_DATA_MODEL			20110323
2	Importing	I_REF_TOOL_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_TOOL_DATA_MODEL			20110323
3	Returning	R_FLG_ACTIVE	Value transfer	☐	Type reference (TYPE)	XFLAG			20110323

Method IS_ACTIVE on class CL_CMP_WB_TOOL has no exception.

Method IS_DIRTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_OBJECT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_OBJECT_DATA_MODEL			20110323
2	Importing	I_REF_TOOL_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_TOOL_DATA_MODEL			20110323
3	Returning	R_FLG_DIRTY	Value transfer	☐	Type reference (TYPE)	XFLAG			20110323

Method IS_DIRTY on class CL_CMP_WB_TOOL has no exception.

Method IS_INACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_OBJECT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_OBJECT_DATA_MODEL			20110323
2	Importing	I_REF_TOOL_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_TOOL_DATA_MODEL			20110323
3	Returning	R_FLG_INACTIVE	Value transfer	☐	Type reference (TYPE)	XFLAG			20110323

Method IS_INACTIVE on class CL_CMP_WB_TOOL has no exception.

Method RESET_STATE Signature

Method RESET_STATE on class CL_CMP_WB_TOOL has no parameter.
Method RESET_STATE on class CL_CMP_WB_TOOL has no exception.

Method S_BUILD_OBJKEY_EXPLICITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA	Value transfer	☑	Type reference (TYPE)	CSEQUENCE			20110323
2	Importing	I_FUNCTION	Value transfer	☑	Type reference (TYPE)	CSEQUENCE			20110323
3	Importing	I_TEMPLATE	Value transfer	☑	Type reference (TYPE)	CSEQUENCE			20110323
4	Returning	R_OBJKEY	Value transfer	☐	Type reference (TYPE)	SEU_OBJKEY			20110323

Method S_BUILD_OBJKEY_EXPLICITY on class CL_CMP_WB_TOOL has no exception.

Method S_BUILD_OBJKEY_FROM_ID_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SUBNAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20110323
2	Importing	I_SUBTYPE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20110323
3	Importing	I_TEMPLATE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20110323
4	Returning	R_OBJKEY	Value transfer	☐	Type reference (TYPE)	SEU_OBJKEY			20110323

Method S_BUILD_OBJKEY_FROM_ID_VALUE on class CL_CMP_WB_TOOL has no exception.

Method S_CREATE_AREA_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ICON	Value transfer	☐	Type reference (TYPE)	CHAR30		30 Characters	20101103

Method S_CREATE_AREA_ICON on class CL_CMP_WB_TOOL has no exception.

Method S_CREATE_FUNCTION_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ICON	Value transfer	☐	Type reference (TYPE)	CHAR30		30 Characters	20101103

Method S_CREATE_FUNCTION_ICON on class CL_CMP_WB_TOOL has no exception.

Method S_GET_MARKERS_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TEMPL_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20110323
2	Importing	I_USERNAME	Call by reference	☐	Type reference (TYPE)	SY-UNAME	SY-UNAME		20110323
3	Returning	R_TAB_MARKERS	Value transfer	☐	Type reference (TYPE)	TYP_TAB_MARKERS			20110323

Method S_GET_MARKERS_DB on class CL_CMP_WB_TOOL has no exception.

Method S_SET_MARKERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TAB_MARKERS	Call by reference	☐	Type reference (TYPE)	TYP_TAB_MARKERS			20110323
2	Importing	I_TEMPL_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20110323

Method S_SET_MARKERS on class CL_CMP_WB_TOOL has no exception.

Method S_SET_MARKERS_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TAB_MARKERS	Call by reference	☑	Type reference (TYPE)	TYP_TAB_MARKERS			20110323
2	Importing	I_TEMPL_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20110323
3	Importing	I_USERNAME	Value transfer	☐	Type reference (TYPE)	CSEQUENCE	SY-UNAME		20110323

Method S_SET_MARKERS_DB on class CL_CMP_WB_TOOL has no exception.

Method S_SET_MARKER_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FLG_DELETE	Call by reference	☐	Type reference (TYPE)	XFLAG	'X'		20110323
2	Importing	I_STR_MARKER	Call by reference	☐	Type reference (TYPE)	TYP_STR_MARKER			20110323
3	Importing	I_USERNAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	SY-UNAME		20110323

Method S_SET_MARKER_DB on class CL_CMP_WB_TOOL has no exception.

History

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