SAP ABAP Class /IWBEP/CL_SBUI_DYNPRO_HANDLER (SB: UI dynpro handler (state of a screen))

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-BSE-SB (Application Component) Gateway Service Builder
     ⤷ /IWBEP/SB_UI_BASE (Package) Gateway Service Builder UI - API and SPI

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_COMPONENT	SB: UI component	20120116
2	Interface implementation (CLASS c. INTERFACES i_ref)	/IWBEP/IF_SBUI_COMMAND_HANDLER	SB: UI command handler behavior	20120215
3	Interface implementation (CLASS c. INTERFACES i_ref)	/IWBEP/IF_SBUI_DYNPRO_BASED	SB: UI dynpro based behavior	20120613
4	Interface implementation (CLASS c. INTERFACES i_ref)	/IWBEP/IF_SBUI_INTERACTIVE	SB: UI interactive behavior	20120116

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_CR_CMN_HANDLER	Test Handler for Common Aspects	20120607
2	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_LAYOUT_HANDLER	SB: UI layout handler (state of a screen with layout)	20120216
3	Inheritance (c INHERITING FROM c_ref)	/IWBEP/CL_SBUI_WIZARD_HANDLER	SB: UI wizard handler	20120507

Properties

Class	/IWBEP/CL_SBUI_DYNPRO_HANDLER
Short Description	SB: UI dynpro handler (state of a screen)
Super Class	/IWBEP/CL_SBUI_COMPONENT	SB: UI component
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class	/IWBEP/SBUI
Program status	P	SAP Standard Production Program
Category	0
Package	/IWBEP/SB_UI_BASE	Gateway Service Builder UI - API and SPI
Created	20120116	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/IWBEP/CL_SBUI_DYNPRO	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	/IWBEP/IF_SBUI_CONTROLLER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	/IWBEP/IF_SBUI_CONTROL_BASED	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	/IWBEP/IF_SBUI_INTERACTIVE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	/IWBEP/IF_SBUI_SETUP_SERVICE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
6	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/IWBEP/IF_SBUI_COMMAND_HANDLER	☐	☑	SB: UI command handler behavior	20120215
2	/IWBEP/IF_SBUI_DYNPRO_BASED	☐	☑	SB: UI dynpro based behavior	20120613
3	/IWBEP/IF_SBUI_INTERACTIVE	☐	☑	SB: UI interactive behavior	20120116

Friends

#	Friend	Modeled only	Created on	Description
1	/IWBEP/CL_SBUI_CONTROLLER	☐	20130419	SB: UI main controller
2	/IWBEP/CL_SBUI_DYNPRO	☐	20120116	SB: UI dynpro (dynpro accessor, abstract)
3	/IWBEP/CL_SBUI_TABSTRIP	☐	20120325	SB: UI tabstrip (handles one control in host dynpro)

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_SPLIT_COLS	Constant	Protected	☐	Type reference (TYPE)	I	/IWBEP/IF_SBUI_SETUP_SERVICE=>GC_SPLIT_MODE_COLS	split mode: cols	20130510
2	GC_SPLIT_ROWS	Constant	Protected	☐	Type reference (TYPE)	I	/IWBEP/IF_SBUI_SETUP_SERVICE=>GC_SPLIT_MODE_ROWS	split mode: rows	20130510
3	MO_DYNPRO	Instance attribute	Public	☐	Object reference (TYPE REF TO)	/IWBEP/CL_SBUI_DYNPRO		dynpro	20120116
4	MS_DYNAMIC_STATE	Instance attribute	Protected	☐	Type reference (TYPE)	/IWBEP/CL_SBUI_DYNPRO=>TY_S_DYNAMIC_STATE		dynamic state delta	20120320
5	MS_NAVIGATION_STATE	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_S_NAVIGATION_STATE		navigation state before last output	20120524
6	MT_FCODE_EXCLUDE	Instance attribute	Protected	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_T_COMMAND_FCODE		excluded functions	20120116
7	MT_PARAMETER	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_T_PARAMETER_MAP		parameter class member binding	20120426
8	MT_START_NODE	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/T_SBDM_NODES		start nodes provided when calling the screen	20130419
9	MV_RCODE_INPUT	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code from input validation	20120714
10	MV_RCODE_OUTPUT	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code from update before output	20120714
11	MV_RETRIEVING_SELECTION	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		check recursive selection retrieval	20120715
12	MV_SCREEN_STATUS	Instance attribute	Protected	☐	Type reference (TYPE)	SYPFKEY		screen status	20120116
13	MV_SETUP_DONE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		setup controls was called	20120117
14	MV_TITLE_BAR	Instance attribute	Protected	☐	Type reference (TYPE)	TY_TITLE_BAR		screen titlebar definition	20120116
15	MV_TITLE_PARAM_1	Instance attribute	Protected	☐	Type reference (TYPE)	SYTITLE		screen title parameter 1	20120116
16	MV_TITLE_PARAM_2	Instance attribute	Protected	☐	Type reference (TYPE)	SYTITLE		screen title parameter 2	20120116
17	MV_TITLE_PARAM_3	Instance attribute	Protected	☐	Type reference (TYPE)	SYTITLE		screen title parameter 3	20120116
18	MV_TITLE_PARAM_4	Instance attribute	Protected	☐	Type reference (TYPE)	SYTITLE		screen title parameter 4	20120116

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20120119
2	CREATE_COMPONENT_SPLITTER	Instance method	Protected	Method	utility: create component splitter	20130510
3	CREATE_COMPONENT_SWITCH	Instance method	Protected	Method	utility: create component switch	20130510
4	CREATE_COMPONENT_VIEW	Instance method	Protected	Method	utility: create component view (control-based view)	20130510
5	DO_BEFORE_ROLLBACK_CHANGES	Instance method	Protected	Method	template method (optional): prepare rollback of all changes	20120524
6	DO_CANCEL_ERROR_HANDLING	Instance method	Protected	Method	template method (optional): cancel input error handling	20120213
7	DO_CHECK_AFTER_INPUT	Instance method	Protected	Method	template method (optional): check data after input	20120116
8	DO_DYN_HELP_REQUEST	Instance method	Protected	Method	template method (optional): run dynamic online help	20120116
9	DO_DYN_VALUE_REQUEST	Instance method	Protected	Method	template method (optional): run dynamic value help	20120116
10	DO_EXECUTE_COMMAND	Instance method	Protected	Method	template method (optional): execute screen specific command	20120116
11	DO_FINALIZE_CHANGES	Instance method	Protected	Method	template method (optional): finalize accepted data changes	20120201
12	DO_HANDLE_CHANGED_PARAMETER	Instance method	Protected	Method	template method (optional): handle changed parameter value	20130202
13	DO_RETURN_SELECTED_NODES	Instance method	Protected	Method	template method (optional): return selected nodes	20120715
14	DO_RETURN_SELECTION_HANDLER	Instance method	Protected	Method	template method (optional): return handler of selected nodes	20120715
15	DO_SETUP_CONTROLS	Instance method	Protected	Method	template method (optional): setup (controls) within 1st pbo	20120126
16	DO_SETUP_INSTANCE	Instance method	Protected	Method	template method (optional): setup before 1st controller call	20120116
17	DO_UPDATE_BEFORE_OUTPUT	Instance method	Protected	Method	template method (optional): update screen before output	20120116
18	DO_UPDATE_INTERNAL_STATE	Instance method	Protected	Method	template method (optional): update state (before children)	20120524
19	EXECUTE_COMMAND	Instance method	Public	Method		20120410
20	GET_ANCESTOR_INTERACTIVE	Instance method	Public	Method		20120410
21	GET_INPUT_RCODE	Instance method	Public	Method		20120410
22	GET_PARAMETER_VALUE	Instance method	Public	Method		20130201
23	GET_START_NODES	Instance method	Public	Method		20130419
24	SET_PARAMETER_VALUE	Instance method	Public	Method		20130201

Events

Class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_CONTAINER	Protected	See coding		bound main container	20120117	BEGIN OF ty_s_container , container TYPE REF TO cl_gui_container , visible TYPE abap_bool , END OF ty_s_container
2	TY_TITLE_BAR	Protected	See coding		title bar definition	20120116	ty_title_bar TYPE c LENGTH 20
3	TY_T_CONTAINER	Protected	See coding		bound main container table	20120117	ty_t_container TYPE SORTED TABLE OF ty_s_container WITH UNIQUE KEY container

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_CONTROLLER		controller	20120119
2	Importing	IO_DYNPRO	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/CL_SBUI_DYNPRO		dynpro	20120119
3	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_COMPONENT		name	20120119
4	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		plugin	20120119

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120119

Method CREATE_COMPONENT_SPLITTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MODE	Call by reference	☑	Type reference (TYPE)	I	GC_SPLIT_COLS	rows or columns (see constants)	20130510
2	Importing	IV_SIZING	Call by reference	☑	Type reference (TYPE)	STRING	'50:50'	relative size for each cell in percent	20130510
3	Returning	RO_SPLITTER	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_FRAMESET		frameset	20130510

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130510

Method CREATE_COMPONENT_SWITCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SWITCH	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_FRAMESET		composite (contains other components)	20130510

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130510

Method CREATE_COMPONENT_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_COMPONENT		name (from setup)	20130510
2	Importing	IV_PLUGIN	Call by reference	☐	Type reference (TYPE)	/IWBEP/SBUI_PLUGIN		plugin (from setup)	20130510
3	Returning	RO_VIEW	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_VIEW		view (control-based)	20130510

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130510

Method DO_BEFORE_ROLLBACK_CHANGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120524

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120524

Method DO_CANCEL_ERROR_HANDLING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120214

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120227

Method DO_CHECK_AFTER_INPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STEP	Call by reference	☑	Type reference (TYPE)	I		single step in dynpro input check logic	20120116
2	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120215

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120119

Method DO_DYN_HELP_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD	Call by reference	☐	Type reference (TYPE)	SCREEN-NAME		selected field name	20120116

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120119

Method DO_DYN_VALUE_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD	Call by reference	☐	Type reference (TYPE)	SCREEN-NAME		selected field name	20120116

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120119

Method DO_EXECUTE_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_COMMAND	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_S_COMMAND_REQUEST		command request	20120116
2	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120129

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120116

Method DO_FINALIZE_CHANGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120214

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120201

Method DO_HANDLE_CHANGED_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		parameter name as defined while setup instance	20130202

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20130202

Method DO_RETURN_SELECTED_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SELECTED	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_T_NAVIGATION_TARGET		collection of selected nodes	20120715
2	Exporting	EV_RCODE	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120715

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120715

Method DO_RETURN_SELECTION_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	/IWBEP/IF_SBUI_INTERACTIVE		selection handler (either me or a child component)	20120715

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120715

Method DO_SETUP_CONTROLS Signature

Method DO_SETUP_CONTROLS on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no parameter.

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120126

Method DO_SETUP_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARAMETER	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_T_PARAMETER_MAP		mapping of parameter names to class member references	20120427

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120119

Method DO_UPDATE_BEFORE_OUTPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_NAVIGATION_STATE	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_S_NAVIGATION_STATE		navigation state	20120320
2	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120714

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120119

Method DO_UPDATE_INTERNAL_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CURRENT	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_S_UPDATE_STATE		state information provided on update before output	20120524
2	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	/IWBEP/IF_SBUI_CONTROLLER=>TY_RETURN_CODE		return code	20120524

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_SBCM_EXCEPTION	☐	SB: exception	20120524

Method EXECUTE_COMMAND Signature

Method EXECUTE_COMMAND on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no parameter.
Method EXECUTE_COMMAND on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no exception.

Method GET_ANCESTOR_INTERACTIVE Signature

Method GET_ANCESTOR_INTERACTIVE on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no parameter.
Method GET_ANCESTOR_INTERACTIVE on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no exception.

Method GET_INPUT_RCODE Signature

Method GET_INPUT_RCODE on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no parameter.
Method GET_INPUT_RCODE on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no exception.

Method GET_PARAMETER_VALUE Signature

Method GET_PARAMETER_VALUE on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no parameter.
Method GET_PARAMETER_VALUE on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no exception.

Method GET_START_NODES Signature

Method GET_START_NODES on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no parameter.
Method GET_START_NODES on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no exception.

Method SET_PARAMETER_VALUE Signature

Method SET_PARAMETER_VALUE on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no parameter.
Method SET_PARAMETER_VALUE on class /IWBEP/CL_SBUI_DYNPRO_HANDLER has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	200