SAP ABAP Interface IF_ITEM_TREE_CONTROL (*NO* REUSE - Internal Tree Control)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ SABP_SELFTEST_CONTROLS_GUI (Package) *NO* REUSE - Left Overs which Need to be Adressed by ....

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface composition (i COMPRISING i_ref)	IF_GUI_COLUMN_TREE	*NO* REUSE - Column Tree Control	20071022
2	Interface composition (i COMPRISING i_ref)	IF_GUI_LIST_TREE	*NO* REUSE - List Tree Control	20080311
3	Interface composition (i COMPRISING i_ref)	_IF_GUI_COLUMN_TREE	Strictely Internal: Column Tree Control	20071209
4	Interface composition (i COMPRISING i_ref)	_IF_GUI_ITEM_TREE_CONTROL	Strictely Internal: Item Tree Control	20071209
5	Interface implementation (CLASS c. INTERFACES i_ref)	CL_AST_GUI_COLUMN_TREE_FAKE	- NO REUSE - Humble Object Column Tree for Unit Tests	20071022
6	Interface implementation (CLASS c. INTERFACES i_ref)	CL_AST_GUI_LIST_TREE_FAKE	- NO REUSE - Humble Object for use as DOC	20080311
7	Interface implementation (CLASS c. INTERFACES i_ref)	CL_AST_ITEM_TREE_CONTROL_DLGT	- NO REUSE -Delegate to Item Tree	20071022

Properties

Interface	IF_ITEM_TREE_CONTROL
Short Description	*NO* REUSE - Internal Tree Control

General Data

Package	SABP_SELFTEST_CONTROLS_GUI	*NO* REUSE - Left Overs which Need to be Adressed by ....
Created	20071022	SAP
Last changed	20130531	SAP
Unicode checks active	☑

Forward declarations

Interface IF_ITEM_TREE_CONTROL has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_TREE_CONTROL_BASE	☐	☐	*NO* REUSE - Internal Tree Control	20071022

Friends

Interface IF_ITEM_TREE_CONTROL has no friend.

Attributes

Interface IF_ITEM_TREE_CONTROL has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NODES_AND_ITEMS	Instance method	Public	Method	Insert Nodes and Items	20071022
2	DELETE_ALL_ITEMS_OF_NODES	Instance method	Public	Method	Deletes all Items In a Set of Nodes	20071022
3	DELETE_ITEMS	Instance method	Public	Method	Delete Items	20071022
4	GET_SELECTED_ITEM	Instance method	Public	Method	Returns Node Key and Item Name of Selected Item	20071022
5	ITEM_SET_CHOSEN	Instance method	Public	Method	Sets Checked State for a Checkbox	20071022
6	ITEM_SET_DISABLED	Instance method	Public	Method	Sets Whether an Item Can be Selected	20071022
7	ITEM_SET_EDITABLE	Instance method	Public	Method	Sets Whether an Item Can be Edited	20071022
8	ITEM_SET_FONT	Instance method	Public	Method	Sets the Font of an Item	20071022
9	ITEM_SET_HIDDEN	Instance method	Public	Method	Sets the Visibility of an Item	20071022
10	ITEM_SET_STYLE	Instance method	Public	Method	Sets the Style Property of an Item	20071022
11	ITEM_SET_TEXT	Instance method	Public	Method	Sets the Text for an Item	20071022
12	ITEM_SET_T_IMAGE	Instance method	Public	Method	Sets the Picture for an Item	20071022
13	SELECT_ITEM	Instance method	Public	Method	Selects an Item	20071022
14	SET_MIN_NODE_HEIGHT	Instance method	Public	Method	Sets Minimum Height of Nodes in Tree	20071022
15	UPDATE_NODES_AND_ITEMS	Instance method	Public	Method	Insert Nodes and Items	20071022

Events

#	Event	Type	Visibility	Description	Created on
1	BUTTON_CLICK	Instance Event (0)	Public (2)	Pushbutton Clicked	20071022
2	CHECKBOX_CHANGE	Instance Event (0)	Public (2)	Change State of a Checkbox	20071022
3	HEADER_CLICK	Instance Event (0)	Public (2)	Header Clicked	20071022
4	HEADER_CONTEXT_MENU_REQUEST	Instance Event (0)	Public (2)	Request Context Menu for Header	20071022
5	HEADER_CONTEXT_MENU_SELECT	Instance Event (0)	Public (2)	Context Menu Entry Selected	20071022
6	ITEM_CONTEXT_MENU_REQUEST	Instance Event (0)	Public (2)	Request Context Menu for an Item	20071022
7	ITEM_CONTEXT_MENU_SELECT	Instance Event (0)	Public (2)	Context Menu Entry Selected	20071022
8	ITEM_DOUBLE_CLICK	Instance Event (0)	Public (2)	Double-Click on Item	20071022
9	ITEM_KEYPRESS	Instance Event (0)	Public (2)	Key Pressed, Node Was Selected	20071022
10	LINK_CLICK	Instance Event (0)	Public (2)	Link Clicked	20071022
11	ON_DRAG	Instance Event (0)	Public (2)	Event for Filling Drag and Drop Data Object	20071022
12	ON_DRAG_MULTIPLE	Instance Event (0)	Public (2)	Event for Filling Drag and Drop Data Object	20071022
13	ON_DROP_COMPLETE	Instance Event (0)	Public (2)	Drop Event Processed Successfully	20071022
14	ON_DROP_COMPLETE_MULTIPLE	Instance Event (0)	Public (2)	Drop Event Processed Successfully	20071022

Types

Interface IF_ITEM_TREE_CONTROL has no local type.

Method Signatures

Method ADD_NODES_AND_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)	STANDARD TABLE			20071022
2	Importing	ITEM_TABLE_STRUCTURE_NAME	Value transfer	☐	Type reference (TYPE)	X030L-TABNAME			20071022
3	Importing	NODE_TABLE	Call by reference	☑	Type reference (TYPE)	TREEV_NTAB			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	DP_ERROR	☐		20071022
3	ERROR_IN_TABLES	☐		20071022
4	FAILED	☐		20071022
5	TABLE_STRUCTURE_NAME_NOT_FOUND	☐		20071022

Method DELETE_ALL_ITEMS_OF_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)	TREEV_NKS			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	DP_ERROR	☐		20071022
3	ERROR_IN_NODE_KEY_TABLE	☐		20071022
4	FAILED	☐		20071022

Method DELETE_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_KEY_TABLE	Call by reference	☐	Type reference (TYPE)	TREEV_IKS			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	DP_ERROR	☐		20071022
3	ERROR_IN_ITEM_KEY_TABLE	☐		20071022
4	FAILED	☐		20071022

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			20071022
2	Exporting	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TV_NODEKEY			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	FAILED	☐		20071022
3	NO_ITEM_SELECTION	☐		20071022

Method ITEM_SET_CHOSEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHOSEN	Value transfer	☐	Type reference (TYPE)	AS4FLAG			20071022
2	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME			20071022
3	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY			20071022

#	Exception	Resumable	Description	Created on
1	CHOSEN_NOT_SUPPORTED	☐		20071022
2	CNTL_SYSTEM_ERROR	☐		20071022
3	FAILED	☐		20071022
4	ITEM_NOT_FOUND	☐		20071022
5	NODE_NOT_FOUND	☐		20071022

Method ITEM_SET_DISABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISABLED	Value transfer	☐	Type reference (TYPE)	AS4FLAG			20071022
2	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME			20071022
3	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	FAILED	☐		20071022
3	ITEM_NOT_FOUND	☐		20071022
4	NODE_NOT_FOUND	☐		20071022
5	NO_ITEM_SELECTION	☐		20071022

Method ITEM_SET_EDITABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EDITABLE	Value transfer	☐	Type reference (TYPE)	AS4FLAG			20071022
2	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME			20071022
3	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	EDITABLE_NOT_SUPPORTED	☐		20071022
3	FAILED	☐		20071022
4	ITEM_NOT_FOUND	☐		20071022
5	NODE_NOT_FOUND	☐		20071022
6	NO_ITEM_SELECTION	☐		20071022

Method ITEM_SET_FONT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FONT	Value transfer	☐	Type reference (TYPE)	I			20071022
2	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME			20071022
3	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	FAILED	☐		20071022
3	ITEM_NOT_FOUND	☐		20071022
4	NODE_NOT_FOUND	☐		20071022

Method ITEM_SET_HIDDEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HIDDEN	Value transfer	☐	Type reference (TYPE)	AS4FLAG			20071022
2	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME			20071022
3	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	FAILED	☐		20071022
3	ITEM_NOT_FOUND	☐		20071022
4	NODE_NOT_FOUND	☐		20071022

Method ITEM_SET_STYLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME			20071022
2	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY			20071022
3	Importing	STYLE	Value transfer	☐	Type reference (TYPE)	I			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	FAILED	☐		20071022
3	ITEM_NOT_FOUND	☐		20071022
4	NODE_NOT_FOUND	☐		20071022

Method ITEM_SET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME			20071022
2	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY			20071022
3	Importing	TEXT	Value transfer	☐	Type reference (TYPE)	C			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	FAILED	☐		20071022
3	ITEM_NOT_FOUND	☐		20071022
4	NODE_NOT_FOUND	☐		20071022

Method ITEM_SET_T_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME			20071022
2	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY			20071022
3	Importing	T_IMAGE	Value transfer	☐	Type reference (TYPE)	TV_IMAGE			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	FAILED	☐		20071022
3	ITEM_NOT_FOUND	☐		20071022
4	NODE_NOT_FOUND	☐		20071022

Method SELECT_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME			20071022
2	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	FAILED	☐		20071022
3	KEY_OR_ITEM_NAME_NOT_FOUND	☐		20071022
4	NO_ITEM_SELECTION	☐		20071022

Method SET_MIN_NODE_HEIGHT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INCLUDE_BUTTON	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20071022
2	Importing	INCLUDE_CHECKBOX	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20071022
3	Importing	INCLUDE_IMAGE	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20071022
4	Importing	INCLUDE_LINK	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20071022
5	Importing	INCLUDE_TEXT	Value transfer	☑	Type reference (TYPE)	AS4FLAG			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	FAILED	☐		20071022

Method UPDATE_NODES_AND_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)	STANDARD TABLE			20071022
2	Importing	ITEM_TABLE_STRUCTURE_NAME	Value transfer	☐	Type reference (TYPE)	X030L-TABNAME			20071022
3	Importing	NODE_TABLE	Call by reference	☑	Type reference (TYPE)	TREEV_UPNO			20071022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐		20071022
2	DP_ERROR	☐		20071022
3	ERROR_IN_TABLES	☐		20071022
4	FAILED	☐		20071022
5	TABLE_STRUCTURE_NAME_NOT_FOUND	☐		20071022

Event Signatures

Event BUTTON_CLICK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
2	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Node key	20071022

Event CHECKBOX_CHANGE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	CHECKED	Exporting	Value transfer	☐	Type reference (TYPE)	AS4FLAG		'X': Selected; ' ': Not Selected	20071022
2	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
3	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Node key	20071022

Event HEADER_CLICK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	HEADER_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_HDRNAME		Name Of Header Clicked	20071022

Event HEADER_CONTEXT_MENU_REQUEST Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	HEADER_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_HDRNAME		Name Of Header Clicked	20071022
2	MENU	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_CTMENU		Context Menu Object	20071022

Event HEADER_CONTEXT_MENU_SELECT Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Value transfer	☐	Type reference (TYPE)	SY-UCOMM		Function code chosen in context menu	20071022
2	HEADER_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_HDRNAME		Name Of Header Clicked	20071022

Event ITEM_CONTEXT_MENU_REQUEST Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
2	MENU	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_CTMENU		Context Menu Object	20071022
3	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Node key	20071022

Event ITEM_CONTEXT_MENU_SELECT Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Value transfer	☐	Type reference (TYPE)	SY-UCOMM		Function code chosen in context menu	20071022
2	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
3	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Node key	20071022

Event ITEM_DOUBLE_CLICK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
2	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Node key	20071022

Event ITEM_KEYPRESS Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
2	KEY	Exporting	Value transfer	☐	Type reference (TYPE)	I		Key Pressed	20071022
3	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Node key	20071022

Event LINK_CLICK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
2	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Node key	20071022

Event ON_DRAG Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAG_DROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		Drag&Drop Object	20071022
2	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
3	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Key of Dragged Node	20071022

Event ON_DRAG_MULTIPLE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAG_DROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		Drag&Drop Object	20071022
2	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
3	NODE_KEY_TABLE	Exporting	Value transfer	☐	Type reference (TYPE)	TREEV_NKS		Table With Node Keys	20071022

Event ON_DROP_COMPLETE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAG_DROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		Drag&Drop Object	20071022
2	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
3	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Key of Dragged Node	20071022

Event ON_DROP_COMPLETE_MULTIPLE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAG_DROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		Drag&Drop Object	20071022
2	ITEM_NAME	Exporting	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name of Item	20071022
3	NODE_KEY_TABLE	Exporting	Value transfer	☐	Type reference (TYPE)	TREEV_NKS		Table With Node Keys	20071022

History

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