SAP ABAP Class IF_ALV_TREE_BASE (*NO* Reuse - Basic ALV Tree Control)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface composition (i COMPRISING i_ref)	IF_GUI_ALV_TREE	*NO* Reuse - ALV Tree Control	20071023
2	Interface composition (i COMPRISING i_ref)	_IF_GUI_ALV_TREE	Strictely Internal: Tree Control	20071209
3	Interface composition (i COMPRISING i_ref)	_IF_GUI_ALV_TREE_BASE	Strictely Internal: Basic Tree Control	20071209
4	Interface implementation (CLASS c. INTERFACES i_ref)	CL_AST_ALV_TREE_BASE_DLGT	- NO REUSE - Delegate to Basic ALV Tree	20071023
5	Interface implementation (CLASS c. INTERFACES i_ref)	CL_AST_GUI_ALV_TREE_FAKE	- NO REUSE - Humble Object for ALV Tree Interface	20071023
6	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SAT_UI_TREE_CTRL_FAKE	*NO* Reuse: Humble Object for ALV tree Interface	20071109

Properties

Class	IF_ALV_TREE_BASE
Short Description	*NO* Reuse - Basic ALV Tree Control
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package
Created	20071022	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SDYDO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	SLIS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class IF_ALV_TREE_BASE has no interface implemented.

Friends

Class IF_ALV_TREE_BASE has no friend class.

Attributes

Class IF_ALV_TREE_BASE has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_KEY_STROKE	Instance method	Public	Method	Define Key That Triggers KEYPRESS Event	20071022
2	COLLAPSE_ALL_NODES	Instance method	Public	Method	Collapses all Branches of Tree	20071022
3	COLUMN_OPTIMIZE	Instance method	Public	Method	Optimizes Column Width	20071022
4	CREATE_REPORT_HEADER	Instance method	Public	Method	Creates HTML Header	20071022
5	DELETE_ALL_NODES	Instance method	Public	Method	Deletes all Nodes in Tree	20071022
6	FRONTEND_UPDATE	Instance method	Public	Method	Sends Changed/Inserted Nodes to Control	20071022
7	GET_FRONTEND_FIELDCATALOG	Instance method	Public	Method	Returns Current Field Catalog	20071022
8	GET_HIERARCHY_HEADER_WIDTH	Instance method	Public	Method	Returns the Column Width of the Hierarchy Header	20071022
9	GET_HTML_HEADER_OBJECT	Instance method	Public	Method	Returns Object of HTML Header	20071022
10	GET_SELECTED_COLUMNS	Instance method	Public	Method	Returns Selected Columns	20071022
11	GET_TOOLBAR_OBJECT	Instance method	Public	Method	Returns Object of Toolbar Header	20071022
12	GET_VARIANT_KEY	Instance method	Public	Method	Returns the Variant Key	20071022
13	SET_ALV_TREE_FOCUS	Instance method	Public	Method	Sets Focus in Tree Control	20071022
14	SET_CALCULATION_STYLE	Instance method	Public	Method	Sets the Style for Calculated Numbers	20071022
15	SET_CTX_MENU_SELECT_EVENT_APPL	Instance method	Public	Method	Sets the Context Menu Selection Events	20071022
16	SET_DEFAULT_DROP	Instance method	Public	Method	Standard Drop for Free Area in Control	20071022
17	SET_FRONTEND_FIELDCATALOG	Instance method	Public	Method	Sets the Current Field Catalog	20071022
18	SET_HAS_3D_FRAME	Instance method	Public	Method	' ': Display Control Without 3D Frame	20071022
19	SET_HIERARCHY_HELP_FIELDS	Instance method	Public	Method	Sets Reference Fields for F1 Help on Hierarchy	20071022
20	SET_MIN_NODE_HEIGHT	Instance method	Public	Method	Sets Minimum Height of Nodes in Tree	20071022
21	SET_SCREEN_UPDATE	Instance method	Public	Method	Controls When Control is Redrawn	20071022
22	SET_SELECTED_COLUMNS	Instance method	Public	Method	Sets the Columns Selected	20071022
23	SET_SPLITTER_ROW_HEIGHT	Instance method	Public	Method	Sets the Row Height of Splitter	20071022
24	SET_USER_COMMAND	Instance method	Public	Method	Change User Command	20071022
25	SET_VARIANT_KEY	Instance method	Public	Method	Change Variant Key	20071022
26	UNSELECT_ALL	Instance method	Public	Method	Deselects Everything	20071022
27	UPDATE_CALCULATIONS	Instance method	Public	Method	Recalculate Columns	20071022

Events

#	Event	Type	Visibility	Description	Created on
1	AFTER_USER_COMMAND	Instance Event (0)	Public (2)	After User-Command	20071022
2	BEFORE_USER_COMMAND	Instance Event (0)	Public (2)	Before User-Command	20071022
3	DEFAULT_CONTEXT_MENU_REQUEST	Instance Event (0)	Public (2)	Context Menu Request for Control Background	20071022
4	DEFAULT_CONTEXT_MENU_SELECT	Instance Event (0)	Public (2)	Context Menu Entry Selected	20071022
5	HEADER_CONTEXT_MENU_REQUEST	Instance Event (0)	Public (2)	Request Context Menu for Header	20071022
6	HEADER_CONTEXT_MENU_SELECT	Instance Event (0)	Public (2)	Context Menu Entry Selected	20071022
7	TOP_OF_LIST	Instance Event (0)	Public (2)	Top-of-List	20071022
8	TOP_OF_PAGE	Instance Event (0)	Public (2)	Top-of-Page	20071022

Types

Class IF_ALV_TREE_BASE has no local type.

Method Signatures

Method ADD_KEY_STROKE Signature

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

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

Method COLLAPSE_ALL_NODES Signature

Method COLLAPSE_ALL_NODES on class IF_ALV_TREE_BASE has no parameter.

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

Method COLUMN_OPTIMIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_END_COLUMN	Call by reference	☑	Type reference (TYPE)	LVC_FNAME		Last Column to Optimize	20071022
2	Importing	I_INCLUDE_HEADING	Call by reference	☐	Type reference (TYPE)	AS4FLAG	'X'	Include Heading	20071022
3	Importing	I_START_COLUMN	Call by reference	☑	Type reference (TYPE)	LVC_FNAME		First Column to Optimize	20071022

#	Exception	Resumable	Description	Created on
1	END_COLUMN_NOT_FOUND	☐		20071022
2	START_COLUMN_NOT_FOUND	☐		20071022

Method CREATE_REPORT_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LIST_COMMENTARY	Call by reference	☐	Type reference (TYPE)	SLIS_T_LISTHEADER		Header Information	20071022
2	Importing	I_BACKGROUND_ID	Call by reference	☑	Type reference (TYPE)	SDYDO_KEY		HTML Background	20071022
3	Importing	I_LOGO	Call by reference	☑	Type reference (TYPE)	SDYDO_VALUE		Logo	20071022
4	Importing	I_MODEL_MODE	Call by reference	☑	Type reference (TYPE)	SAP_BOOL		Boolean Variable (X=True, Space=False)	20071022
5	Importing	I_SET_SPLITTER_HEIGHT	Call by reference	☑	Type reference (TYPE)	AS4FLAG		Sets Optimal Splitter Height	20071022

Method CREATE_REPORT_HEADER on class IF_ALV_TREE_BASE has no exception.

Method DELETE_ALL_NODES Signature

Method DELETE_ALL_NODES on class IF_ALV_TREE_BASE has no parameter.

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

Method FRONTEND_UPDATE Signature

Method FRONTEND_UPDATE on class IF_ALV_TREE_BASE has no parameter.
Method FRONTEND_UPDATE on class IF_ALV_TREE_BASE has no exception.

Method GET_FRONTEND_FIELDCATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FIELDCATALOG	Value transfer	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog	20071022

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

Method GET_HIERARCHY_HEADER_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_WIDTH	Call by reference	☐	Type reference (TYPE)	I		Width of Hierarchy Column	20071022

Method GET_HIERARCHY_HEADER_WIDTH on class IF_ALV_TREE_BASE has no exception.

Method GET_HTML_HEADER_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ER_HTML_HEADER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_HTML_VIEWER		html_header	20071022

Method GET_HTML_HEADER_OBJECT on class IF_ALV_TREE_BASE has no exception.

Method GET_SELECTED_COLUMNS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEL_COLUMNS	Call by reference	☐	Type reference (TYPE)	LVC_T_FNAM		Table of Column Names	20071022

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

Method GET_TOOLBAR_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_TOOLBAR	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar Object	20071022

Method GET_TOOLBAR_OBJECT on class IF_ALV_TREE_BASE has no exception.

Method GET_VARIANT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_VARIANT	Call by reference	☐	Type reference (TYPE)	DISVARIANT		Variant Key	20071022

Method GET_VARIANT_KEY on class IF_ALV_TREE_BASE has no exception.

Method SET_ALV_TREE_FOCUS Signature

Method SET_ALV_TREE_FOCUS on class IF_ALV_TREE_BASE has no parameter.

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

Method SET_CALCULATION_STYLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CALCULATION_STYLE	Call by reference	☐	Type reference (TYPE)	I		Style for Calculated Numbers	20071022

Method SET_CALCULATION_STYLE on class IF_ALV_TREE_BASE has no exception.

Method SET_CTX_MENU_SELECT_EVENT_APPL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPL_EVENT	Call by reference	☐	Type reference (TYPE)	AS4FLAG		'X': Event with PAI; ' ': Event Without PAI	20071022

Method SET_CTX_MENU_SELECT_EVENT_APPL on class IF_ALV_TREE_BASE has no exception.

Method SET_DEFAULT_DROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DRAG_DROP	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROP		Behavior for Drag and Drop	20071022

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

Method SET_FRONTEND_FIELDCATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELDCATALOG	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog at Frontend	20071022

Method SET_FRONTEND_FIELDCATALOG on class IF_ALV_TREE_BASE has no exception.

Method SET_HAS_3D_FRAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_HAS_3D_FRAME	Call by reference	☐	Type reference (TYPE)	AS4FLAG		' ': Draw Control Without 3D Effect	20071022

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

Method SET_HIERARCHY_HELP_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOKTITLE	Call by reference	☑	Type reference (TYPE)	SCRTEXT_S		Text	20071022
2	Importing	I_REF_FIELD	Call by reference	☑	Type reference (TYPE)	LVC_FNAME		Reference Field	20071022
3	Importing	I_REF_TABLE	Call by reference	☑	Type reference (TYPE)	LVC_RTNAME		Reference Table	20071022
4	Importing	I_ROLLNAME	Call by reference	☑	Type reference (TYPE)	LVC_ROLL		Data Element	20071022

Method SET_HIERARCHY_HELP_FIELDS on class IF_ALV_TREE_BASE has no exception.

Method SET_MIN_NODE_HEIGHT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INCLUDE_BUTTON	Value transfer	☑	Type reference (TYPE)	AS4FLAG		Include Buttons with Minimum Height	20071022
2	Importing	I_INCLUDE_CHECKBOX	Value transfer	☑	Type reference (TYPE)	AS4FLAG		Include Checkbox With Minimum Height	20071022
3	Importing	I_INCLUDE_IMAGE	Value transfer	☑	Type reference (TYPE)	AS4FLAG		Include Pictures With Minimum Height	20071022
4	Importing	I_INCLUDE_LINK	Value transfer	☑	Type reference (TYPE)	AS4FLAG		Include Links With Minimum Height	20071022
5	Importing	I_INCLUDE_TEXT	Value transfer	☑	Type reference (TYPE)	AS4FLAG		Include Text With Minimum Height	20071022

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

Method SET_SCREEN_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_UPDATE	Call by reference	☐	Type reference (TYPE)	AS4FLAG		' ': Switch Off Screen Update	20071022

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

Method SET_SELECTED_COLUMNS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEL_COLUMNS	Call by reference	☐	Type reference (TYPE)	LVC_T_FNAM		Table of Selected Columns	20071022

#	Exception	Resumable	Description	Created on
1	DP_ERROR	☐		20071022
2	FAILED	☐		20071022
3	FIELDNAME_NOT_FOUND	☐		20071022

Method SET_SPLITTER_ROW_HEIGHT Signature

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

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

Method SET_USER_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FCODE	Call by reference	☐	Type reference (TYPE)	SY-UCOMM		Function Code	20071022

Method SET_USER_COMMAND on class IF_ALV_TREE_BASE has no exception.

Method SET_VARIANT_KEY Signature

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

Method SET_VARIANT_KEY on class IF_ALV_TREE_BASE has no exception.

Method UNSELECT_ALL Signature

Method UNSELECT_ALL on class IF_ALV_TREE_BASE has no parameter.

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

Method UPDATE_CALCULATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NO_FRONTEND_UPDATE	Call by reference	☑	Type reference (TYPE)	C			20071022

Method UPDATE_CALCULATIONS on class IF_ALV_TREE_BASE has no exception.

Event Signatures

Event AFTER_USER_COMMAND Signature

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

Event BEFORE_USER_COMMAND Signature

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

Event DEFAULT_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			20071022

Event DEFAULT_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			20071022

Event HEADER_CONTEXT_MENU_REQUEST Signature

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

Event HEADER_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			20071022
2	FIELDNAME	Exporting	Call by reference	☐	Type reference (TYPE)	LVC_FNAME			20071022

Event TOP_OF_LIST Signature
Event TOP_OF_LIST on class IF_ALV_TREE_BASE has no parameter.
Event TOP_OF_PAGE Signature
Event TOP_OF_PAGE on class IF_ALV_TREE_BASE has no parameter.

History

Last changed by/on	SAP	20130531
SAP Release Created in