SAP ABAP Class /BOBF/CL_TUI_CTRL_BO_TREE (Control: BO Instance and Model Tree)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ AP-RC-BOF-TST (Application Component) Business Object Processing Framework Tests
     ⤷ /BOBF/TEST_UI (Package) Business Object Processing Framework Test UI

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/BOBF/IF_TUI_EVENTS	Interface containing all Events of the Controls	20090528

Properties

Class	/BOBF/CL_TUI_CTRL_BO_TREE
Short Description	Control: BO Instance and Model Tree
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/BOBF/TEST_UI	Business Object Processing Framework Test UI
Created	20090528	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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/BOBF/IF_TUI_EVENTS	☐	☐	Interface containing all Events of the Controls	20090528

Friends

Class /BOBF/CL_TUI_CTRL_BO_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GO_TREE_CONTROL	Static Attribute	Private	☐	Object reference (TYPE REF TO)	/BOBF/CL_TUI_CTRL_BO_TREE		Proxy Class for Control in GUI	20090528
2	MO_ALV_TREE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE		Simple ALV Tree	20090528
3	MT_ALV_TREE_DATA	Instance attribute	Private	☐	Type reference (TYPE)	TT_BO_TREE			20090528
4	MT_DISPLAY_ASSOC_CAT	Instance attribute	Private	☐	Type reference (TYPE)	TT_ASSOC_CAT			20090528
5	MT_DISPLAY_ASSOC_TARGET_NODE	Instance attribute	Private	☐	Type reference (TYPE)	TT_NODE_TYPE			20090528
6	MT_DISPLAY_NODE_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	TT_NODE_TYPE			20090528
7	MT_SELECTED_FIELD	Instance attribute	Private	☐	Type reference (TYPE)	TT_SELECTED_FIELD		Selected field for 'Show' in Tree	20120504
8	MV_OBEY_PROPERTIES	Instance attribute	Private	☐	Type reference (TYPE)	BOOLE_D	ABAP_TRUE	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20090601
9	MV_SELECTED_FIELD	Instance attribute	Private	☐	Type reference (TYPE)	/BOBF/OBM_NAME	'KEY'	Name	20120418

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_BO_INSTANCE_DATA	Instance method	Private	Method		20120504
2	ADD_BO_META_DATA	Instance method	Private	Method	Adss bo meta data to the alv tree	20090528
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090528
4	GET_INSTANCE	Static method	Public	Method	Returns the one and only tree control instance	20090528
5	ON_ALV_DOUBLE_CLICKED	Instance method	Public	Event handling method	Reacts as soon as the user clicks on a node in the alv tree	20090528
6	ON_ALV_TOOLBAR_CLICKED	Instance method	Public	Event handling method	Reacts as soon as the user has clicked on the alv toolbar	20090528
7	ON_CONFIGURATION	Instance method	Public	Event handling method		20090601
8	ON_CONTEXT_MENUE_REQUEST	Instance method	Private	Event handling method		20100301
9	ON_CONTEXT_MENUE_REQUEST_ITEM	Instance method	Private	Event handling method		20100315
10	ON_CONTEXT_MENUE_SELECTED	Instance method	Private	Event handling method		20100301
11	ON_CONTEXT_MENUE_SELECTED_ITEM	Instance method	Private	Event handling method		20100315
12	ON_DOUBLE_CLICKED	Instance method	Private	Method		20090528
13	ON_INSTANCES_CHANGED	Instance method	Public	Event handling method		20090528
14	ON_INSTANCES_CREATED	Instance method	Public	Event handling method	Reacts as sonn as the user creates a new node instance	20090528
15	ON_INSTANCES_DELETED	Instance method	Public	Event handling method		20090528
16	ON_INSTANCES_LOADED	Instance method	Public	Event handling method	Reacts as soon as the user has loaded node instances	20090528
17	ON_ITEM_DOUBLE_CLICKED	Instance method	Public	Event handling method		20090528
18	ON_SELECTION_CHANGED	Instance method	Public	Event handling method		20090528
19	ON_TRANSACTION_CLEANEDUP	Instance method	Public	Event handling method		20090528
20	ON_TRANSACTION_SAVED	Instance method	Public	Event handling method		20090528

Events

Class /BOBF/CL_TUI_CTRL_BO_TREE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_ASSOC_CAT	Private	See coding			20090528	tt_assoc_cat TYPE STANDARD TABLE OF /bobf/obm_assoc_cat
2	TT_BO_TREE	Private	See coding			20090528	tt_bo_tree TYPE STANDARD TABLE OF ty_tui_bo_tree WITH KEY bo_key node_key key
3	TT_NODE_TYPE	Private	See coding			20090528	tt_node_type TYPE STANDARD TABLE OF /bobf/obm_node_type
4	TT_SELECTED_FIELD	Private	See coding			20120504	tt_selected_field TYPE STANDARD TABLE OF ty_selected_field WITH KEY bo_key sel_node_key
5	TY_SELECTED_FIELD	Private	See coding			20120504	BEGIN OF ty_selected_field, bo_key TYPE /bobf/obm_bo_key, sel_node_key TYPE /bobf/obm_node_key, sel_attr_name TYPE /bobf/obm_name, END OF ty_selected_field
6	TY_TUI_BO_TREE	Private	See coding			20090528	BEGIN OF ty_tui_bo_tree, bo_key TYPE /bobf/obm_bo_key, node_key TYPE /bobf/obm_node_key, key TYPE /bobf/conf_key, content_key TYPE /bobf/conf_key, content_category TYPE string, caption TYPE /bobf/obm_name, source_key TYPE /bobf/conf_key, source_node_key TYPE /bobf/obm_node_key, source_bo_key TYPE /bobf/obm_bo_key, association TYPE /bobf/obm_assoc_key, nkey TYPE lvc_nkey, pkey TYPE lvc_nkey, END OF ty_tui_bo_tree

Method Signatures

Method ADD_BO_INSTANCE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ASSOC_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/OBM_ASSOC_KEY			20120504
2	Importing	IV_BO_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/OBM_BO_KEY			20120504
3	Importing	IV_CAPTION	Call by reference	☑	Type reference (TYPE)	STRING			20120504
4	Importing	IV_CONTENT_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING			20120504
5	Importing	IV_CONTENT_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/CONF_KEY			20120504
6	Importing	IV_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/CONF_KEY			20120504
7	Importing	IV_NODE_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/OBM_NODE_KEY			20120504
8	Importing	IV_PARENT_TREE_ID	Call by reference	☑	Type reference (TYPE)	LVC_NKEY			20120504
9	Importing	IV_SOURCE_BO_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/OBM_BO_KEY			20120504
10	Importing	IV_SOURCE_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/OBM_NODE_KEY			20120504
11	Importing	IV_SOURCE_NODE_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/OBM_NODE_KEY			20120504

Method ADD_BO_INSTANCE_DATA on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ADD_BO_META_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BO_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/OBM_BO_KEY		Key of the Business Object	20090528
2	Importing	IV_CAPTION	Call by reference	☑	Type reference (TYPE)	/BOBF/OBM_NAME		Recursion only: Caption	20090528
3	Importing	IV_CONTENT_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING		Recursion only: Content Category	20090528
4	Importing	IV_CONTENT_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/CONF_KEY		Recursion only: Content Key	20090528
5	Importing	IV_NODE_KEY	Call by reference	☑	Type reference (TYPE)	/BOBF/OBM_NODE_KEY		Recursion only: Node	20090528
6	Importing	IV_PARENT_TREE_ID	Call by reference	☑	Type reference (TYPE)	LVC_NKEY		Recursion only: Tree ID of the parent node of the entity	20090528

Method ADD_BO_META_DATA on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_TREE_CONTROL	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE		Proxy Class for Control in GUI	20090528

Method CONSTRUCTOR on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EO_BO_TREE	Value transfer	☐	Object reference (TYPE REF TO)	/BOBF/CL_TUI_CTRL_BO_TREE		Tree Control	20090528
2	Importing	IO_TREE_CONTROL	Call by reference	☑	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE		Simple Tree Control with Data Management at the Backend	20090528

Method GET_INSTANCE on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_ALV_DOUBLE_CLICKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528

Method ON_ALV_DOUBLE_CLICKED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_ALV_TOOLBAR_CLICKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Value transfer	☐	Attribute reference (LIKE)				20090528

Method ON_ALV_TOOLBAR_CLICKED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_CONFIGURATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBEY_PROPERTIES	Call by reference	☐	Attribute reference (LIKE)				20090601
2	Importing	IV_SHOW_CHANGES	Call by reference	☐	Attribute reference (LIKE)				20120420
3	Importing	IV_SHOW_KEYS	Call by reference	☐	Attribute reference (LIKE)				20090601

Method ON_CONFIGURATION on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_CONTEXT_MENUE_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MENU	Value transfer	☐	Attribute reference (LIKE)				20100301
2	Importing	NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20100301

Method ON_CONTEXT_MENUE_REQUEST on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_CONTEXT_MENUE_REQUEST_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELDNAME	Value transfer	☐	Attribute reference (LIKE)				20100315
2	Importing	MENU	Value transfer	☐	Attribute reference (LIKE)				20100315
3	Importing	NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20100315

Method ON_CONTEXT_MENUE_REQUEST_ITEM on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_CONTEXT_MENUE_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Value transfer	☐	Attribute reference (LIKE)				20100301
2	Importing	NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20100301

Method ON_CONTEXT_MENUE_SELECTED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_CONTEXT_MENUE_SELECTED_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Value transfer	☐	Attribute reference (LIKE)				20100315
2	Importing	FIELDNAME	Value transfer	☐	Attribute reference (LIKE)				20100315
3	Importing	NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20100315

Method ON_CONTEXT_MENUE_SELECTED_ITEM on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_DOUBLE_CLICKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	LVC_NKEY		Node Key	20090528

Method ON_DOUBLE_CLICKED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_INSTANCES_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
2	Importing	IV_BO_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
3	Importing	IV_NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528

Method ON_INSTANCES_CHANGED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_INSTANCES_CREATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ASSOCIATION	Value transfer	☐	Attribute reference (LIKE)				20090528
2	Importing	IV_BO_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
3	Importing	IV_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
4	Importing	IV_NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
5	Importing	IV_SOURCE_BO_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
6	Importing	IV_SOURCE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
7	Importing	IV_SOURCE_NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528

Method ON_INSTANCES_CREATED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_INSTANCES_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
2	Importing	IV_BO_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
3	Importing	IV_NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528

Method ON_INSTANCES_DELETED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_INSTANCES_LOADED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
2	Importing	IV_BO_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
3	Importing	IV_NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528

Method ON_INSTANCES_LOADED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_ITEM_DOUBLE_CLICKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELDNAME	Value transfer	☐	Attribute reference (LIKE)				20090528
2	Importing	NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528

Method ON_ITEM_DOUBLE_CLICKED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_SELECTION_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
2	Importing	IT_SOURCE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
3	Importing	IV_ASSOCIATION	Value transfer	☐	Attribute reference (LIKE)				20090528
4	Importing	IV_BO_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
5	Importing	IV_NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
6	Importing	IV_SOURCE_BO_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528
7	Importing	IV_SOURCE_NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20090528

Method ON_SELECTION_CHANGED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_TRANSACTION_CLEANEDUP Signature

Method ON_TRANSACTION_CLEANEDUP on class /BOBF/CL_TUI_CTRL_BO_TREE has no parameter.
Method ON_TRANSACTION_CLEANEDUP on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

Method ON_TRANSACTION_SAVED Signature

Method ON_TRANSACTION_SAVED on class /BOBF/CL_TUI_CTRL_BO_TREE has no parameter.
Method ON_TRANSACTION_SAVED on class /BOBF/CL_TUI_CTRL_BO_TREE has no exception.

History

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