SAP ABAP Class CL_WAPI_WF_TOOLBOX (Actions on Work Item During Execution)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-BMT-WFM (Application Component) SAP Business Workflow
     SWL (Package) Business Workflow: Worklist Client
Properties
Class CL_WAPI_WF_TOOLBOX  
Short Description Actions on Work Item During Execution    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status P  SAP Standard Production Program 
Category 0   
Package SWL   Business Workflow: Worklist Client 
Created 19990130   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 CNTL Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
2 ICON Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
3 SWLC Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_WAPI_WF_TOOLBOX has no interface implemented.
Friends
Class CL_WAPI_WF_TOOLBOX has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 C_BUTTON_STYLE_WITHOUT_TEXT Constant Public Type reference (TYPE) I 0 Small Buttons 19990130
2 C_BUTTON_STYLE_WITH_TEXT Constant Public Type reference (TYPE) I 1 Big Buttons 19990130
3 C_FUNCTION_FORWARD_AVAILABLE Constant Public Type reference (TYPE) I 1 Enable Forwarding of Work Items 19990201
4 C_FUNCTION_MAIL_SEND_AVAILABLE Constant Public Type reference (TYPE) I 4 Enable Sending of Mails Regarding a Work Item 19990324
5 C_FUNCTION_RESUBMIT_AVAILABLE Constant Public Type reference (TYPE) I 2 Enable Resubmission of Work Items 19990201
6 C_MODE_INPLACE_BUTTON_ONLY Constant Public Type reference (TYPE) I 4 Show Only a Menu Button Embedded 19990413
7 C_MODE_INPLACE_WITHOUT_INFO Constant Public Type reference (TYPE) I 0 Show Only Toolbar Embedded 19990201
8 C_MODE_INPLACE_WITH_INFO Constant Public Type reference (TYPE) I 1 Show Toolbar and Text and Links Embedded 19990201
9 C_MODE_MODELESS Constant Public Type reference (TYPE) I 2 Show Toolbar and Text and Links in Modeless Window 19990130
10 C_SHOW_SEPARATOR Constant Public Type reference (TYPE) I 1 Show Separators Between Buttons 19990325
11 IMPORTED_ADDITIONAL_FUNCTIONS Instance attribute Protected Type reference (TYPE) I 0 Imported Additional Functions 19990201
12 IMPORTED_BUTTON_STYLE Instance attribute Protected Type reference (TYPE) I 0 Imported Button Mode 19990130
13 IMPORTED_CONTAINER Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_CONTAINER Imported Container 19990130
14 IMPORTED_DO_COMMIT Instance attribute Protected Type reference (TYPE) XFLAG SPACE Imported commit work permission 19991206
15 IMPORTED_DYNNR Instance attribute Protected Type reference (TYPE) SY-DYNNR Calling Screen 19990130
16 IMPORTED_MODE Instance attribute Protected Type reference (TYPE) I 0 Imported Mode 19990130
17 IMPORTED_REPID Instance attribute Protected Type reference (TYPE) SY-REPID Calling Program 19990130
18 IMPORTED_SEPARATOR_ENABLING Instance attribute Protected Type reference (TYPE) I 0 Imported Enabling of Separators 19990325
19 IMPORTED_WI_ID Instance attribute Protected Type reference (TYPE) SWW_WIID Imported Work Item ID 19990130
20 MY_CONTAINER_BOTTOM Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_CONTAINER Container in Splitter Lower Area 19990130
21 MY_CONTAINER_TOP Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_CONTAINER Container in Splitter Upper Area 19990130
22 MY_DIALOG Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_DIALOGBOX_CONTAINER Container Modeless Dialog 19990130
23 MY_DYNP_CONTAINER Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_CUSTOM_CONTAINER Container for popup dynpro 20000329
24 MY_PROTOCOL_ACTIONS Instance attribute Protected Type reference (TYPE) SWLTPM_CVI Log Actions 19990204
25 MY_PROTOCOL_ALV_ACTIONS Instance attribute Protected Type reference (TYPE) SWLTPM_CVI Log Actions Currently Shown 19990204
26 MY_PROTOCOL_CONTAINER_BOTTOM Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_CONTAINER Log Container Lower Area 19990130
27 MY_PROTOCOL_CONTAINER_TOP Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_CONTAINER Log Container Upper Area 19990130
28 MY_PROTOCOL_GRID Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_ALV_GRID Log Grid 19990203
29 MY_PROTOCOL_HTML Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_HTML_VIEWER Log HTML 19990204
30 MY_PROTOCOL_ITEMS Instance attribute Protected Type reference (TYPE) SWL_TREEIT_T Log Tree Items 19990204
31 MY_PROTOCOL_NODES Instance attribute Protected Type reference (TYPE) TREEV_NTAB Log Tree Nodes 19990204
32 MY_PROTOCOL_SPLITTER Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_SPLITTER_CONTAINER Splitter Control for Workflow Log 19990130
33 MY_PROTOCOL_STEPS Instance attribute Protected Type reference (TYPE) SWLTPM_CVH Log Steps 19990204
34 MY_SPLITTER Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_SPLITTER_CONTAINER Splitter Control 19990130
35 MY_TOOLBAR Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_TOOLBAR Toolbar Control 19990130
36 MY_WORKITEM_HTML Instance attribute Protected Object reference (TYPE REF TO) CL_GUI_HTML_VIEWER HTML Control 19990204
37 NON_TOOLBOX_DIALOG_OPEN Instance attribute Protected Type reference (TYPE) I Indicated if Additional Dialog Open 19990130
38 OPEN_WIM_CHANNEL Instance attribute Protected Type reference (TYPE) CHAR01 Channel to Enqueue WIM Open? 20010228
39 PREVIEW_OBJECTS Instance attribute Protected Type reference (TYPE) SWLOBJECTS_T Objects Shown in Preview 19990130
40 PROTOCOL_ACTIONS Instance attribute Protected Type reference (TYPE) SWLTPM_CVI Actions for Log Grid 19990204
41 PROTOCOL_ACTIONS_SELECTED Instance attribute Protected Type reference (TYPE) SWLTPMRCVI Actions Shown in Log Grid 19990204
42 PROTOCOL_OBJECTS Instance attribute Protected Type reference (TYPE) SWLTPM_OVH Objects Shown in Log HTML 19990204
43 PROTOCOL_STEPS Instance attribute Protected Type reference (TYPE) SWLTPM_CVH Steps Shown in Log HTML 19990204
44 ST_DOCUMENT_ID_CONTENT Instance attribute Protected Type reference (TYPE) SWR_MIMEO Static Var 19990317
45 ST_FRAMESET_URL Instance attribute Protected Type reference (TYPE) SWL_URL Static Var 19990317
46 ST_NOTES_MENU Instance attribute Protected Object reference (TYPE REF TO) CL_CTMENU Static Var 19990317
47 ST_TOOLBOX_MENU Instance attribute Protected Object reference (TYPE REF TO) CL_CTMENU Static Var 19990413
48 WE_ARE_ON_WEBGUI Instance attribute Protected Type reference (TYPE) CHAR01 Webgui or not Webgui 20000202
49 WI_HEADER Instance attribute Protected Type reference (TYPE) SWWWIHEAD Work Item Header 19990130
50 WORKITEM_OBJECTS Instance attribute Protected Type reference (TYPE) SWLOBJECTS_T Objects Shown in Preview 19990204
51 WTB_INSTANCE_COUNT Static Attribute Protected Type reference (TYPE) I 0 Counter for instances 19991216
Methods
# Method Level Visibility Method type Description Created on
1 CLOSE_CRITICAL_METHOD Instance method Protected Method Closes Channel for a Critical Method (Enqueue in WIM) 20010228
2 CONSTRUCTOR Instance method Public Constructor Creates an Embedded or Modeless Workflow Toolbox 19990130
3 CREATE_SPLITTER Instance method Protected Method Creates Splitter 19990130
4 CREATE_TOOLBOX_FUNCTIONS Instance method Protected Method Delivers Table of Available Buttons with Icons and Texts 19990413
5 FREE Instance method Public Method Deletes a Toolbox Instance 19990301
6 GET_DYNP_CONTAINER Instance method Protected Method Crete a Dynpro Container 20000412
7 GET_WTB_INSTANCE_COUNT Static method Public Method Gets Attribute WTB_INSTANCE_COUNT 19991216
8 HANDLER_DIALOG_CLOSE Instance method Protected Event handling method Handler 19990130
9 HANDLER_PROTOCOL_GRID Instance method Protected Event handling method Handler 19990203
10 HANDLER_PROTOCOL_HTML Instance method Protected Event handling method Handler 19990204
11 HANDLER_TOOLBAR_DROPDOWN Instance method Protected Event handling method Handler 19990130
12 HANDLER_TOOLBAR_FUNCTION Instance method Protected Event handling method Handler 19990130
13 HANDLER_WORKITEM_HTML Instance method Protected Event handling method Handler 19990204
14 INITIALIZE Instance method Protected Method Initializes the Toolbox 19990131
15 MAINTAIN_DIALOGBOX Instance method Protected Method Maintains Dialog Box 19990201
16 MAINTAIN_GRID Instance method Protected Method Maintains Grid 19990204
17 MAINTAIN_HTML Instance method Protected Method Maintains HTML 19990130
18 MAINTAIN_PROTOCOL Instance method Protected Method Maintains Workflow Log (Log Splitter, HTML, Grid) 19990131
19 MAINTAIN_TOOLBAR Instance method Protected Method Maintains Toolbar 19990130
20 OPEN_CRITICAL_METHOD Instance method Protected Method Opens Channel for a Critical Method (Enqueue in WIM) 20010228
21 REFRESH Instance method Public Method Refreshes an Existing Embedded or Modeless Workflow Toolbox 19990130
22 START_DYNP Instance method Protected Method Screen 20000329
Events
# Event Type Visibility Description Created on
1 USER_TOOK_WORKITEM_AWAY Instance Event
(0)
Public
(2)
You MUST Leave Your Transaction with Cancel (No Commits)! 19990201
Types
Class CL_WAPI_WF_TOOLBOX has no local type.
Method Signatures

Method CLOSE_CRITICAL_METHOD Signature

Method CLOSE_CRITICAL_METHOD on class CL_WAPI_WF_TOOLBOX has no parameter.
Method CLOSE_CRITICAL_METHOD on class CL_WAPI_WF_TOOLBOX has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_ADD_FUNCTIONS Value transfer Type reference (TYPE) I 0 enable additional functions? 19990201
2 Importing I_ADD_SEPARATOR Value transfer Type reference (TYPE) I 0 show separators between buttons 19990325
3 Importing I_BUTTON_STYLE Value transfer Type reference (TYPE) I 0 show buttons with texts? 19990130
4 Importing I_CONTAINER Value transfer Object reference (TYPE REF TO) CL_GUI_CONTAINER container for implaced toolbox 19990130
5 Importing I_DO_COMMIT Value transfer Type reference (TYPE) XFLAG 'X' allow commit work during toolbox actions 19991206
6 Importing I_DYNNR Value transfer Type reference (TYPE) SY-DYNNR calling screen 19990130
7 Importing I_MODE Value transfer Type reference (TYPE) I 0 toolbox mode {small implaced, big implaced; modeless}? 19990130
8 Importing I_REPID Value transfer Type reference (TYPE) SY-REPID calling program 19990130
9 Importing I_WI_ID Value transfer Type reference (TYPE) SWW_WIID wi 19990202
# Exception Resumable Description Created on
1 CONTAINER_MISSING you set mode to implaced, but you didn't import a container 19990130
2 ERROR_WORKITEM_READ could not read workitem 19990130
3 MODELESS_NOT_AVAILABLE no modeless toolbox for webgui 20000202
4 WRONG_ADDITIONAL_FUNCTIONS only use (add) defined functions (class attributes!) 19990201
5 WRONG_MODE only use defined modes (take class attributes!) 19990130

Method CREATE_SPLITTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_BOTTOM_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER row 2 19990130
2 Exporting E_SPLITTER Call by reference Object reference (TYPE REF TO) CL_GUI_SPLITTER_CONTAINER splitter 19990130
3 Exporting E_TOP_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER row 1 19990130
4 Importing I_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER container for spliiter 19990204
5 Importing I_IS_TOOLBAR_SPLITTER Value transfer Type reference (TYPE) I 1 manages splitter settings for toolbar 19990131

Method CREATE_SPLITTER on class CL_WAPI_WF_TOOLBOX has no exception.

Method CREATE_TOOLBOX_FUNCTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_BUTTONS Value transfer Type reference (TYPE) SWLC_TB_BUTTONS table of available buttons 19990413

Method CREATE_TOOLBOX_FUNCTIONS on class CL_WAPI_WF_TOOLBOX has no exception.

Method FREE Signature

Method FREE on class CL_WAPI_WF_TOOLBOX has no parameter.
Method FREE on class CL_WAPI_WF_TOOLBOX has no exception.

Method GET_DYNP_CONTAINER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_DYNP_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CUSTOM_CONTAINER dynp container 20000412

Method GET_DYNP_CONTAINER on class CL_WAPI_WF_TOOLBOX has no exception.

Method GET_WTB_INSTANCE_COUNT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_WTB_INSTANCE Value transfer Type reference (TYPE) I eq to WTB_INSTANCE_COUNT 19991216

Method GET_WTB_INSTANCE_COUNT on class CL_WAPI_WF_TOOLBOX has no exception.

Method HANDLER_DIALOG_CLOSE Signature

Method HANDLER_DIALOG_CLOSE on class CL_WAPI_WF_TOOLBOX has no parameter.
Method HANDLER_DIALOG_CLOSE on class CL_WAPI_WF_TOOLBOX has no exception.

Method HANDLER_PROTOCOL_GRID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing E_COLUMN_ID Call by reference Attribute reference (LIKE) 19990203
2 Importing E_ROW_ID Call by reference Attribute reference (LIKE) 19990203

Method HANDLER_PROTOCOL_GRID on class CL_WAPI_WF_TOOLBOX has no exception.

Method HANDLER_PROTOCOL_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ACTION Call by reference Attribute reference (LIKE) 19990204
2 Importing FRAME Call by reference Attribute reference (LIKE) 19990204
3 Importing GETDATA Call by reference Attribute reference (LIKE) 19990204
4 Importing POSTDATA Call by reference Attribute reference (LIKE) 19990204
5 Importing QUERY_TABLE Call by reference Attribute reference (LIKE) 19990204

Method HANDLER_PROTOCOL_HTML on class CL_WAPI_WF_TOOLBOX has no exception.

Method HANDLER_TOOLBAR_DROPDOWN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FCODE Call by reference Attribute reference (LIKE) 19990130
2 Importing POSX Call by reference Attribute reference (LIKE) 19990130
3 Importing POSY Call by reference Attribute reference (LIKE) 19990130

Method HANDLER_TOOLBAR_DROPDOWN on class CL_WAPI_WF_TOOLBOX has no exception.

Method HANDLER_TOOLBAR_FUNCTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FCODE Call by reference Attribute reference (LIKE) 19990130

Method HANDLER_TOOLBAR_FUNCTION on class CL_WAPI_WF_TOOLBOX has no exception.

Method HANDLER_WORKITEM_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ACTION Call by reference Attribute reference (LIKE) 19990204
2 Importing FRAME Call by reference Attribute reference (LIKE) 19990204
3 Importing GETDATA Call by reference Attribute reference (LIKE) 19990204
4 Importing POSTDATA Call by reference Attribute reference (LIKE) 19990204
5 Importing QUERY_TABLE Call by reference Attribute reference (LIKE) 19990204

Method HANDLER_WORKITEM_HTML on class CL_WAPI_WF_TOOLBOX has no exception.

Method INITIALIZE Signature

Method INITIALIZE on class CL_WAPI_WF_TOOLBOX has no parameter.
# Exception Resumable Description Created on
1 CONTAINER_MISSING implaced mode was chosen, but no container was given! 19990131
2 ERROR_WORKITEM_READ could not read workitem 19990131
3 NO_MODELESS_TB_FOR_WEBGUI webgui cannot handle modeless windows 20000202
4 WRONG_MODE given toolbox mode is not defined 19990131

Method MAINTAIN_DIALOGBOX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_DIALOG Call by reference Object reference (TYPE REF TO) CL_GUI_DIALOGBOX_CONTAINER dialogbox 19990201
2 Importing I_CAPTION Call by reference Type reference (TYPE) C caption 19990201
3 Importing I_HEIGHT Call by reference Type reference (TYPE) I height 19990201
4 Importing I_LEFT Call by reference Type reference (TYPE) I left 19990201
5 Importing I_TOP Call by reference Type reference (TYPE) I top 19990201
6 Importing I_WIDTH Call by reference Type reference (TYPE) I width 19990201

Method MAINTAIN_DIALOGBOX on class CL_WAPI_WF_TOOLBOX has no exception.

Method MAINTAIN_GRID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_GRID Call by reference Object reference (TYPE REF TO) CL_GUI_ALV_GRID grid 19990204
2 Importing I_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER container for grid 19990204
3 Importing I_STEP Call by reference Type reference (TYPE) SWL_PM_CVH step of actions to be displayed 19990204

Method MAINTAIN_GRID on class CL_WAPI_WF_TOOLBOX has no exception.

Method MAINTAIN_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_HTML Call by reference Object reference (TYPE REF TO) CL_GUI_HTML_VIEWER html 19990204
2 Importing I_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER container 19990130
# Exception Resumable Description Created on
1 ERROR_WORKITEM_READ could not read workitem 19990131

Method MAINTAIN_PROTOCOL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER container for protocol 19990131

Method MAINTAIN_PROTOCOL on class CL_WAPI_WF_TOOLBOX has no exception.

Method MAINTAIN_TOOLBAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER container for toolbox 19990130
# Exception Resumable Description Created on
1 ERROR_WORKITEM_READ error 19990130

Method OPEN_CRITICAL_METHOD Signature

Method OPEN_CRITICAL_METHOD on class CL_WAPI_WF_TOOLBOX has no parameter.
Method OPEN_CRITICAL_METHOD on class CL_WAPI_WF_TOOLBOX has no exception.

Method REFRESH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_WI_ID Value transfer Type reference (TYPE) SWW_WIID wi 19990923
# Exception Resumable Description Created on
1 ERROR_WORKITEM_READ could not read workitem 19990131

Method START_DYNP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_CONT Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER Container 20000329

Method START_DYNP on class CL_WAPI_WF_TOOLBOX has no exception.
Event Signatures

Event USER_TOOK_WORKITEM_AWAY Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 RAISED_BECAUSE_OF_WHAT Exporting Value transfer Type reference (TYPE) I function which led to this event 19990326
History
Last changed by/on SAP  20110908 
SAP Release Created in