SAP ABAP Class CL_WB_TOOL_MANAGER (Tool Reference Administration)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-UTL-BRR (Application Component) Repository Browser
     ⤷ SWBM_INTERNAL (Package) Internal Objects within SWBM

Properties

Class	CL_WB_TOOL_MANAGER
Short Description	Tool Reference Administration
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SWBM_INTERNAL	Internal Objects within SWBM
Created	19981008	SAP
Last change	20090618	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_WB_TOOL_MANAGER has no interface implemented.

Friends

Class CL_WB_TOOL_MANAGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_WB_TOOL_MANAGER		Singleton Instance	20090204
2	TOOL_REFERENCES	Instance attribute	Private	☐	Type reference (TYPE)	LTY_TOOL_REGISTRY		List of All Current Tools	19981008
3	TOOL_WINDOWS	Instance attribute	Private	☐	Type reference (TYPE)	LTY_TOOL_WINDOW_REGISTRY		Assignment Tools - Windows - Stack	19981008
4	WB_MANAGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WB_MANAGER		Reference to Workbench Manager	19981021

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_VALID_TOOL_INSTANCE	Instance method	Public	Method	Check Whether Tool Reference is Valid	19981008
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	19981023
3	CREATE_TOOL_INSTANCE	Instance method	Public	Method	Create New Tool Instance	19981008
4	DELETE_TOOL_INSTANCE	Instance method	Public	Method	Delete Tool Instance	19981008
5	DESTRUCT	Instance method	Public	Method	Destroy Tool Manager	19981125
6	GET_ACTIVE_TOOLS	Instance method	Public	Method	Read Active Tools	19981106
7	GET_ACTIVE_TOOL_IN_WINDOW	Instance method	Public	Method	Read Active Tool in One Window	19981008
8	GET_ACTIVE_WINDOWS	Instance method	Public	Method	Read Active Windows (Tools + Lazy Requests)	20000831
9	GET_INSTANCE	Static method	Public	Method	Supply Singleton Instance	20090204
10	GET_LAZY_REQUEST	Instance method	Public	Method	Return "Parked" Request for Window	20000816
11	GET_NUMBER_OF_LAUCHED_TOOLS	Instance method	Public	Method	Get number of started tools	20000816
12	GET_NUMBER_OF_TOOLS_IN_WINDOW	Instance method	Public	Method	Read List of Tools in Current Window	19981120
13	GET_SECWINDOWS_FOR_TOOL	Instance method	Public	Method	Read all Secondary Window IDs For Tool	19990208
14	GET_WINDOW_REQUEST_STACK	Instance method	Public	Method	Get Request Stack for One Window	19981008
15	REGISTER_SECWINDOW_FOR_TOOL	Instance method	Public	Method	Register Secondary Window for Tool	19990208
16	REGISTER_TOOL_FOR_WINDOW	Instance method	Public	Method	Register Tool for One Window	19981008
17	REGISTER_WINDOW	Instance method	Public	Method	Register Window	19981008
18	SET_ACTIVE_SCREEN	Instance method	Public	Method	Set Active Screen	19981027
19	SET_LAZY_REQUEST	Instance method	Public	Method	Return "Parked" Request for Window	20000816
20	SET_WB_MANAGER_REF	Instance method	Public	Method	Set Reference to Workbench Manager	20090204
21	UNREGISTER_SECWINDOW_FOR_TOOL	Instance method	Public	Method	Deregister Secondary Window for Tool	19990208
22	UNREGISTER_TOOL_FOR_WINDOW	Instance method	Public	Method	Deregister Tool For One Window	19981008
23	UNREGISTER_WINDOW	Instance method	Public	Method	Deregister Window	19981008

Events

Class CL_WB_TOOL_MANAGER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTY_TOOL_REGISTRY	Private	See coding		LTY_TOOL_REGISTRY	19981008	lty_tool_registry TYPE STANDARD TABLE OF lty_tool_reg_entry
2	LTY_TOOL_REG_ENTRY	Private	See coding		LTY_TOOL_REG_ENTRY	19981008	BEGIN OF lty_tool_reg_entry, toolname TYPE seoclsname, tool TYPE REF TO if_wb_program, window_id TYPE wmngr_window_id, secondary_windows TYPE seu_windowids, END OF lty_tool_reg_entry
3	LTY_TOOL_WINDOW_REGISTRY	Private	See coding		LTY_TOOL_WINDOW_REGISTRY	19981008	lty_tool_window_registry TYPE HASHED TABLE OF lty_tool_window_reg_entry WITH UNIQUE KEY window_id
4	LTY_TOOL_WINDOW_REG_ENTRY	Private	See coding		LTY_TOOL_WINDOW_REG_ENTRY	19981008	BEGIN OF lty_tool_window_reg_entry, window_id TYPE wmngr_window_id, request_stack TYPE REF TO cl_wb_request_stack, tool_stack TYPE REF TO cl_wb_tool_stack, * store request until window activation lazy_request TYPE REF TO cl_wb_request, END OF lty_tool_window_reg_entry

Method Signatures

Method CHECK_VALID_TOOL_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TOOL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_PROGRAM		Toolreferenz	19981008

#	Exception	Resumable	Description	Created on
1	TOOLINSTANCE_IS_NULL	☐	Toolreferenz ist leer	19981008
2	TOOL_NOT_EXISTING	☐	Tool existiert nicht	19981008

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_WB_MANAGER	Value transfer	☐	Object reference (TYPE REF TO)	IF_WB_MANAGER		Workbench Manager	19981023

Method CONSTRUCTOR on class CL_WB_TOOL_MANAGER has no exception.

Method CREATE_TOOL_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_TOOL	Value transfer	☐	Object reference (TYPE REF TO)	IF_WB_PROGRAM		Toolreferenz	19981008
2	Importing	P_TOOLNAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Name des Tools	19981008

#	Exception	Resumable	Description	Created on
1	TOOLCLASS_NOT_EXISTING	☐	Toolklasse existiert nicht	19981008

Method DELETE_TOOL_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TOOL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_PROGRAM		Toolreferenz	19981008

#	Exception	Resumable	Description	Created on
1	TOOL_NOT_EXISTING	☐	Toolreferenz existiert nicht	19981008

Method DESTRUCT Signature

Method DESTRUCT on class CL_WB_TOOL_MANAGER has no parameter.
Method DESTRUCT on class CL_WB_TOOL_MANAGER has no exception.

Method GET_ACTIVE_TOOLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_ACTIVE_TOOLS	Value transfer	☐	Type reference (TYPE)	WMNGR_TOOL_LIST		Liste der aktiven Tools	19981106

Method GET_ACTIVE_TOOLS on class CL_WB_TOOL_MANAGER has no exception.

Method GET_ACTIVE_TOOL_IN_WINDOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_TOOL	Value transfer	☐	Object reference (TYPE REF TO)	IF_WB_PROGRAM		Toolreferenz	19981008
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	WMNGR_WINDOW_ID		ID des Fensters	19981008

#	Exception	Resumable	Description	Created on
1	NO_TOOL_ACTIVE	☐	Es gibt kein aktives Tool in diesem Fenster	19981008
2	WINDOW_NOT_REGISTERED	☐	Das Fenster ist nicht registriert	19981008

Method GET_ACTIVE_WINDOWS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_ACTIVE_WINDOWS	Value transfer	☐	Type reference (TYPE)	WMNGR_WINDOW_IDS		aktive Fenster	20000831

Method GET_ACTIVE_WINDOWS on class CL_WB_TOOL_MANAGER has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	CL_WB_TOOL_MANAGER		Verwaltung von Toolreferenzen	20090204
2	Importing	P_WB_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_MANAGER		Interface für Workbench Manager	20090204

Method GET_INSTANCE on class CL_WB_TOOL_MANAGER has no exception.

Method GET_LAZY_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_LAZY_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	CL_WB_REQUEST		Lazy auszuführender Request	20000816
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	I		ID des Fensters	20000816

#	Exception	Resumable	Description	Created on
1	WINDOW_NOT_REGISTERED	☐	Fenster ist nicht registriert	20000816

Method GET_NUMBER_OF_LAUCHED_TOOLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_NUMBER	Value transfer	☐	Type reference (TYPE)	I		Anzahl gestarteter Tools	20000816

Method GET_NUMBER_OF_LAUCHED_TOOLS on class CL_WB_TOOL_MANAGER has no exception.

Method GET_NUMBER_OF_TOOLS_IN_WINDOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_NUMBER_OF_TOOLS	Value transfer	☐	Type reference (TYPE)	I		Anzahl Tools im aktiven Fenster	19981120
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	WMNGR_WINDOW_ID		ID des Fensters	19981120

#	Exception	Resumable	Description	Created on
1	WINDOW_NOT_REGISTERED	☐	Fenster existiert nicht	19981120

Method GET_SECWINDOWS_FOR_TOOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TOOL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_PROGRAM		Toolreferenz	19990208
2	Returning	P_WINDOW_IDS	Value transfer	☐	Type reference (TYPE)	SEU_WINDOWIDS		Liste der Sekundärfenster IDs	19990208

#	Exception	Resumable	Description	Created on
1	TOOL_NOT_EXISTING	☐	Toolreferenz existiert nicht	19990208

Method GET_WINDOW_REQUEST_STACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	P_REQUEST_STACK	Value transfer	☐	Object reference (TYPE REF TO)	CL_WB_REQUEST_STACK		Request Stack des Fensters	19981008
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	WMNGR_WINDOW_ID		ID des Fensters	19981008

#	Exception	Resumable	Description	Created on
1	WINDOW_NOT_REGISTERED	☐	Das Fenster ist nicht registriert	19981008

Method REGISTER_SECWINDOW_FOR_TOOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TOOL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_PROGRAM		Toolreferenz	19990208
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	WMNGR_WINDOW_ID		ID des Fensters	19990208

#	Exception	Resumable	Description	Created on
1	TOOL_NOT_ACTIVE	☐	Das Tool ist nicht aktiv / besitzt keine Visualisierung	19990210
2	TOOL_NOT_EXISTING	☐	Toolreferenz existiert nicht	19990208
3	WINDOW_ALREADY_REGISTERED	☐	Das Fenster ist bereist registriert	19990208

Method REGISTER_TOOL_FOR_WINDOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TOOL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_PROGRAM		Toolreferenz	19981008
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	WMNGR_WINDOW_ID		ID des Fensters	19981008

#	Exception	Resumable	Description	Created on
1	TOOL_NOT_EXISTING	☐	Toolreferenz existiert nicht	19981008
2	WINDOW_NOT_REGISTERED	☐	Das Fenster ist nicht registriert	19981008

Method REGISTER_WINDOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_LAZY_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	CL_WB_REQUEST		Lazy auszuführender Request	20000816
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	WMNGR_WINDOW_ID		ID des Fensters	19981008

#	Exception	Resumable	Description	Created on
1	WINDOW_ALREADY_REGISTERED	☐	Fenster ist bereits registriert	19981008

Method SET_ACTIVE_SCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_PROGRAM	Call by reference	☐	Type reference (TYPE)	SY-REPID		aktives Programm	19981027
2	Importing	P_SCREEN	Call by reference	☐	Type reference (TYPE)	SY-DYNNR		aktiver Screen	19981027

Method SET_ACTIVE_SCREEN on class CL_WB_TOOL_MANAGER has no exception.

Method SET_LAZY_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_LAZY_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	CL_WB_REQUEST		Lazy auszuführender Request	20000816
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	I		ID des Fensters	20000816

#	Exception	Resumable	Description	Created on
1	WINDOW_NOT_REGISTERED	☐	Fenster ist nicht registriert	20000816

Method SET_WB_MANAGER_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_WB_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_MANAGER		Interface für Workbench Manager	20090204

Method SET_WB_MANAGER_REF on class CL_WB_TOOL_MANAGER has no exception.

Method UNREGISTER_SECWINDOW_FOR_TOOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TOOL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_PROGRAM		Toolreferenz	19990208
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	WMNGR_WINDOW_ID		ID des Fensters	19990208

#	Exception	Resumable	Description	Created on
1	TOOL_NOT_EXISTING	☐	Toolreferenz existiert nicht	19990208
2	WINDOW_NOT_REGISTERED	☐	Das Fenster ist nicht registriert	19990208

Method UNREGISTER_TOOL_FOR_WINDOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TOOL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WB_PROGRAM		Toolreferenz	19981008
2	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	WMNGR_WINDOW_ID		ID des Fensters	19981008

#	Exception	Resumable	Description	Created on
1	TOOL_NOT_EXISTING	☐	Toolreferenz existiert nicht	19981008
2	TOOL_NOT_REGISTERED	☐	Das Tool ist nicht registriert	19981008
3	WINDOW_NOT_REGISTERED	☐	Das Fenster ist nicht registriert	19981008

Method UNREGISTER_WINDOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	WMNGR_WINDOW_ID		ID des Fensters	19981008

#	Exception	Resumable	Description	Created on
1	TOOL_ACTIVE	☐	Es ist noch ein Tool im Fenster aktiv	19981008
2	WINDOW_NOT_REGISTERED	☐	Fenster ist nicht registriert	19981008

History

Last changed by/on	SAP	20090618
SAP Release Created in