SAP ABAP Interface _IF_BGRFC_COLUMN_TREE_MODEL (Interface for Tree Column Tree Model)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-RFC-BG (Application Component) Background RFC (bgRFC)
     ⤷ SBGRFCGUI (Package) bgRFC Reports with GUI Part

Properties

Interface	_IF_BGRFC_COLUMN_TREE_MODEL
Short Description	Interface for Tree Column Tree Model

General Data

Package	SBGRFCGUI	bgRFC Reports with GUI Part
Created	20090127	SAP
Last changed	20130531	SAP
Unicode checks active	☑

Forward declarations

Interface _IF_BGRFC_COLUMN_TREE_MODEL has no forward declaration.

Interfaces

Interface _IF_BGRFC_COLUMN_TREE_MODEL has no interface.

Friends

Interface _IF_BGRFC_COLUMN_TREE_MODEL has no friend.

Attributes

Interface _IF_BGRFC_COLUMN_TREE_MODEL has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_COLUMN	Instance method	Public	Method		20090127
2	ADD_ITEMS	Instance method	Public	Method		20090127
3	ADD_NODE	Instance method	Public	Method		20090127
4	ADD_NODES	Instance method	Public	Method		20090127
5	CREATE_TREE_CONTROL	Instance method	Public	Method		20090127
6	DELETE_ALL_NODES	Instance method	Public	Method		20090127
7	EXPAND_NODE	Instance method	Public	Method		20090127
8	EXPAND_NODES	Instance method	Public	Method		20090127
9	EXPAND_NODE_PREDECESSORS	Instance method	Public	Method		20090127
10	GET_EXPANDED_NODES	Instance method	Public	Method		20090127
11	GET_ROOT_NODES	Instance method	Public	Method		20090127
12	GET_SELECTED_ITEM	Instance method	Public	Method		20090127
13	GET_SELECTED_NODE	Instance method	Public	Method		20090127
14	GET_SELECTED_NODES	Instance method	Public	Method		20090127
15	GET_TREE	Instance method	Public	Method		20090127
16	HIERARCHY_HEADER_SET_TEXT	Instance method	Public	Method		20090127
17	HIERARCHY_HEADER_SET_TOOLTIP	Instance method	Public	Method		20090127
18	HIERARCHY_HEADER_SET_WIDTH	Instance method	Public	Method		20090127
19	NODE_GET_CHILDREN	Instance method	Public	Method		20090127
20	NODE_GET_PROPERTIES	Instance method	Public	Method		20120712
21	NODE_KEY_IN_TREE	Instance method	Public	Method		20090127
22	SET_REGISTERED_EVENTS	Instance method	Public	Method		20090127
23	SET_SELECTED_NODE	Instance method	Public	Method		20090127

Events

#	Event	Type	Visibility	Description	Created on
1	BUTTON_CLICK	Instance Event (0)	Public (2)		20090127
2	EXPAND_NO_CHILDREN	Instance Event (0)	Public (2)		20090127
3	ITEM_CONTEXT_MENU_REQUEST	Instance Event (0)	Public (2)		20090127
4	ITEM_CONTEXT_MENU_SELECT	Instance Event (0)	Public (2)		20090127
5	ITEM_DOUBLE_CLICK	Instance Event (0)	Public (2)		20090127
6	NODE_CONTEXT_MENU_REQUEST	Instance Event (0)	Public (2)		20090127
7	NODE_CONTEXT_MENU_SELECT	Instance Event (0)	Public (2)		20090127
8	NODE_DOUBLE_CLICK	Instance Event (0)	Public (2)		20090127

Types

Interface _IF_BGRFC_COLUMN_TREE_MODEL has no local type.

Method Signatures

Method ADD_COLUMN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALIGNMENT	Value transfer	☑	Type reference (TYPE)	I			20090127
2	Importing	DISABLED	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127
3	Importing	HEADER_IMAGE	Value transfer	☑	Type reference (TYPE)	TV_IMAGE			20090127
4	Importing	HEADER_TEXT	Call by reference	☐	Type reference (TYPE)	TV_HEADING			20090127
5	Importing	HEADER_TOOLTIP	Call by reference	☑	Type reference (TYPE)	TV_HEADING			20090127
6	Importing	HIDDEN	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127
7	Importing	NAME	Call by reference	☐	Type reference (TYPE)	TV_ITMNAME			20090127
8	Importing	WIDTH	Value transfer	☐	Type reference (TYPE)	I			20090127

#	Exception	Resumable	Description	Created on
1	COLUMN_EXISTS	☐		20090127
2	ILLEGAL_ALIGNMENT	☐		20090127
3	ILLEGAL_COLUMN_NAME	☐		20090127
4	TOO_MANY_COLUMNS	☐		20090127

Method ADD_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMCITAC			20090127

#	Exception	Resumable	Description	Created on
1	ERROR_IN_ITEM_TABLE	☐		20090127
2	NODE_NOT_FOUND	☐		20090127

Method ADD_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISABLED	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127
2	Importing	DRAG_DROP_ID	Value transfer	☑	Type reference (TYPE)	I			20090127
3	Importing	EXPANDED_IMAGE	Value transfer	☑	Type reference (TYPE)	TV_IMAGE			20090127
4	Importing	EXPANDER	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127
5	Importing	HIDDEN	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127
6	Importing	IMAGE	Value transfer	☑	Type reference (TYPE)	TV_IMAGE			20090127
7	Importing	ISFOLDER	Value transfer	☐	Type reference (TYPE)	AS4FLAG			20090127
8	Importing	ITEMS_INCOMPLETE	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127
9	Importing	ITEM_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMCITAB			20090127
10	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127
11	Importing	NO_BRANCH	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127
12	Importing	RELATIONSHIP	Value transfer	☑	Type reference (TYPE)	I			20090127
13	Importing	RELATIVE_NODE_KEY	Call by reference	☑	Type reference (TYPE)	TM_NODEKEY			20090127
14	Importing	STYLE	Value transfer	☑	Type reference (TYPE)	INT4			20090127
15	Importing	USER_OBJECT	Value transfer	☑	Object reference (TYPE REF TO)	OBJECT			20090127

#	Exception	Resumable	Description	Created on
1	ERROR_IN_ITEM_TABLE	☐		20090127
2	ILLEGAL_RELATIONSHIP	☐		20090127
3	NODE_KEY_EMPTY	☐		20090127
4	NODE_KEY_EXISTS	☐		20090127
5	RELATIVE_NODE_NOT_FOUND	☐		20090127

Method ADD_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMCNOTA			20090127

#	Exception	Resumable	Description	Created on
1	ERROR_IN_NODE_TABLE	☐		20090127

Method CREATE_TREE_CONTROL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONTROL	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL			20090127
2	Importing	LIFETIME	Value transfer	☑	Type reference (TYPE)	I			20090127
3	Importing	PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER			20090127
4	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I			20090127

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20090127
2	CREATE_ERROR	☐		20090127
3	FAILED	☐		20090127
4	LIFETIME_ERROR	☐		20090127
5	TREE_CONTROL_ALREADY_CREATED	☐		20090127

Method DELETE_ALL_NODES Signature

Method DELETE_ALL_NODES on Interface _IF_BGRFC_COLUMN_TREE_MODEL has no parameter.
Method DELETE_ALL_NODES on Interface _IF_BGRFC_COLUMN_TREE_MODEL has no exception.

Method EXPAND_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPAND_PREDECESSORS	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127
2	Importing	EXPAND_SUBTREE	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127
3	Importing	LEVEL_COUNT	Value transfer	☑	Type reference (TYPE)	I			20090127
4	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐		20090127

Method EXPAND_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMNOTAB			20090127

#	Exception	Resumable	Description	Created on
1	ERROR_IN_NODE_KEY_TABLE	☐		20090127

Method EXPAND_NODE_PREDECESSORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐		20090127

Method GET_EXPANDED_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NODE_KEY_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMNOTAB			20090127
2	Importing	NO_HIDDEN_NODES	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20090127

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20090127
2	CONTROL_DEAD	☐		20090127
3	CONTROL_NOT_EXISTING	☐		20090127
4	FAILED	☐		20090127

Method GET_ROOT_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NODE_KEY_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMNOTAB			20090127

Method GET_ROOT_NODES on Interface _IF_BGRFC_COLUMN_TREE_MODEL has no exception.

Method GET_SELECTED_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ITEM_NAME	Call by reference	☐	Type reference (TYPE)	TV_ITMNAME			20090127
2	Exporting	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20090127
2	CONTROL_DEAD	☐		20090127
3	CONTROL_NOT_EXISTING	☐		20090127
4	FAILED	☐		20090127
5	NO_ITEM_SELECTION	☐		20090127

Method GET_SELECTED_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20090127
2	CONTROL_DEAD	☐		20090127
3	CONTROL_NOT_EXISTING	☐		20090127
4	FAILED	☐		20090127
5	SINGLE_NODE_SELECTION_ONLY	☐		20090127

Method GET_SELECTED_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NODE_KEY_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMNOTAB			20090127

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20090127
2	CONTROL_DEAD	☐		20090127
3	CONTROL_NOT_EXISTING	☐		20090127
4	FAILED	☐		20090127
5	MULTIPLE_NODE_SELECTION_ONLY	☐		20090127

Method GET_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ITEM_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMCITAC			20090127
2	Exporting	NODE_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMCNOTA			20090127
3	Importing	ROOT_NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

#	Exception	Resumable	Description	Created on
1	ROOT_NODE_NOT_FOUND	☐		20090127

Method HIERARCHY_HEADER_SET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TEXT	Call by reference	☐	Type reference (TYPE)	TV_HEADING			20090127

Method HIERARCHY_HEADER_SET_TEXT on Interface _IF_BGRFC_COLUMN_TREE_MODEL has no exception.

Method HIERARCHY_HEADER_SET_TOOLTIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TOOLTIP	Call by reference	☐	Type reference (TYPE)	TV_HEADING			20090127

Method HIERARCHY_HEADER_SET_TOOLTIP on Interface _IF_BGRFC_COLUMN_TREE_MODEL has no exception.

Method HIERARCHY_HEADER_SET_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WIDTH	Value transfer	☐	Type reference (TYPE)	I			20090127

Method HIERARCHY_HEADER_SET_WIDTH on Interface _IF_BGRFC_COLUMN_TREE_MODEL has no exception.

Method NODE_GET_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127
2	Exporting	NODE_KEY_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMNOTAB			20090127

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐		20090127

Method NODE_GET_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20120712
2	Exporting	PROPERTIES	Call by reference	☐	Type reference (TYPE)	TREEMSNOD			20120712

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐		20120712

Method NODE_KEY_IN_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	KEY_IN_TREE	Value transfer	☐	Type reference (TYPE)	AS4FLAG			20090127
2	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

Method NODE_KEY_IN_TREE on Interface _IF_BGRFC_COLUMN_TREE_MODEL has no exception.

Method SET_REGISTERED_EVENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENTS	Call by reference	☐	Type reference (TYPE)	CNTL_SIMPLE_EVENTS			20090127

#	Exception	Resumable	Description	Created on
1	ILLEGAL_EVENT_COMBINATION	☐		20090127
2	UNKNOWN_EVENT	☐		20090127

Method SET_SELECTED_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐		20090127
2	SINGLE_NODE_SELECTION_ONLY	☐		20090127

Event Signatures

Event BUTTON_CLICK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM_NAME	Exporting	Call by reference	☐	Type reference (TYPE)	TV_ITMNAME			20090127
2	NODE_KEY	Exporting	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

Event EXPAND_NO_CHILDREN Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	NODE_KEY	Exporting	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

Event ITEM_CONTEXT_MENU_REQUEST Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM_NAME	Exporting	Call by reference	☐	Type reference (TYPE)	TV_ITMNAME			20090127
2	MENU	Exporting	Call by reference	☐	Object reference (TYPE REF TO)	CL_CTMENU			20090127
3	NODE_KEY	Exporting	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

Event ITEM_CONTEXT_MENU_SELECT Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Call by reference	☐	Type reference (TYPE)	SY-UCOMM			20090127
2	ITEM_NAME	Exporting	Call by reference	☐	Type reference (TYPE)	TV_ITMNAME			20090127
3	NODE_KEY	Exporting	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

Event ITEM_DOUBLE_CLICK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM_NAME	Exporting	Call by reference	☐	Type reference (TYPE)	TV_ITMNAME			20090127
2	NODE_KEY	Exporting	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

Event NODE_CONTEXT_MENU_REQUEST Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	MENU	Exporting	Call by reference	☐	Object reference (TYPE REF TO)	CL_CTMENU			20090127
2	NODE_KEY	Exporting	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

Event NODE_CONTEXT_MENU_SELECT Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Call by reference	☐	Type reference (TYPE)	SY-UCOMM			20090127
2	NODE_KEY	Exporting	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

Event NODE_DOUBLE_CLICK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	NODE_KEY	Exporting	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20090127

History

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