SAP ABAP Class CL_GUI_TCF_ALV_WRAPPER (CFW for variable column sort - ALV Tree)

Hierarchy

☛ ECC-DIMP (Software Component) DIMP
   ⤷ IS-AD (Application Component) Aerospace & Defence Industry Solution
     ⤷ AD_TCF (Package) A&D: Tree Control Framework

Properties

Class	CL_GUI_TCF_ALV_WRAPPER
Short Description	CFW for variable column sort - ALV Tree
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	AD_TCF	A&D: Tree Control Framework
Created	20010222	SAP
Last change	20050301	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_GUI_TCF_ALV_WRAPPER has no forward declaration.

Interfaces

Class CL_GUI_TCF_ALV_WRAPPER has no interface implemented.

Friends

Class CL_GUI_TCF_ALV_WRAPPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ALV_TREE	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE		ALV Tree Control	20010222
2	G_TOOLBAR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar	20010222
3	INPUT_TABLE_REFERENCE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Global Input Table	20010222
4	M_HIERARCHY_HEADER	Instance attribute	Private	☐	Type reference (TYPE)	TREEV_HHDR		Hierarchy Header	20010222
5	M_INPUT_TABLE_LINE_REF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Input table line reference	20010222
6	M_PROFILE_KEY	Instance attribute	Private	☐	Type reference (TYPE)	ADTCF_MASTER-PROFILE_KEY		Profile Key - System entered	20010222
7	M_PROFILE_OKCODE_PREFIX	Constant	Private	☐	Type reference (TYPE)	SY-UCOMM	'#PROFILE_'	Screens, function code triggered by PAI	20010222
8	M_PROGRAM_NAME	Instance attribute	Private	☐	Type reference (TYPE)	SY-CPROG		Program name	20010222
9	M_USER_ID	Instance attribute	Private	☐	Type reference (TYPE)	SY-UNAME		User Id	20010222
10	TREE_TABLE_REFERENCE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Data Table Reference	20010222

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20010222
2	CREATE_INPUT_TABLE_LINE_REF	Instance method	Private	Method	Create input table line reference	20010222
3	DISPLAY_TREE	Instance method	Public	Method	Display tree	20010222
4	FCAT_NO_OUT	Instance method	Private	Method	Field Catalog - Set the NO OUT fields	20010222
5	FREE	Instance method	Public	Method	Destructor	20010222
6	GENERATE_SUBROUTINE_AND_SORT	Instance method	Private	Method	Generate Subroutine and sort	20010222
7	ON_TOOLBAR_DROPDOWN_CLICKED	Instance method	Private	Event handling method	Toolbar Dropdown menu	20010222
8	ON_TOOLBAR_FUNCTION_SELECTED	Instance method	Private	Event handling method	Function Selected In Toolbar	20010222
9	PREPARE_FIELD_CATALOG	Instance method	Private	Method	Validate the sort criteria - internal	20010222
10	PREPARE_FIELD_CATALOG2	Instance method	Private	Method	Validate the sort criteria - internal	20010222
11	PREPARE_PRESENTATION	Instance method	Private	Method	Prepare Presentation	20010222
12	PREPARE_SORT_CRITERIA	Instance method	Private	Method	Validate the sort criteria - internal	20010222
13	PREPARE_TOOLBAR	Instance method	Private	Method	Prepare toolbar	20010222

Events

#	Event	Type	Visibility	Description	Created on
1	ERROR_DURING_GENERATION	Instance Event (0)	Public (2)	Generation Error Occured	20010222

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	SORT_CRITERIA_INTERNAL	Protected	See coding		Internal Sort Criteria	20010222
2	SORT_FIELD_REC_INTERNAL	Protected	See coding		Sort Criteria Record (Internal)	20010222

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20010222

Method CONSTRUCTOR on class CL_GUI_TCF_ALV_WRAPPER has no exception.

Method CREATE_INPUT_TABLE_LINE_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INPUT_TABLE	Call by reference	☐	Type reference (TYPE)	TABLE		Input table	20010222

Method CREATE_INPUT_TABLE_LINE_REF on class CL_GUI_TCF_ALV_WRAPPER has no exception.

Method DISPLAY_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_INPUT_TABLE	Call by reference	☐	Type reference (TYPE)	TABLE		Input Table	20010222
2	Importing	I_HIERARCHY_HEADER	Call by reference	☑	Type reference (TYPE)	TREEV_HHDR		Hierarchy Header	20010222
3	Importing	I_PROFILE_KEY	Call by reference	☑	Type reference (TYPE)	ADTCF_MASTER-PROFILE_KEY		Profile Key - System entered	20010222
4	Importing	I_PROGRAM_NAME	Call by reference	☐	Type reference (TYPE)	SY-CPROG		Program name	20010222
5	Importing	I_USER_ID	Call by reference	☐	Type reference (TYPE)	SYST-UNAME		User Id	20010222

#	Exception	Resumable	Description	Created on
1	ERROR_DURING_GENERATION	☐	Error during Generation	20010222
2	FAILED	☐	Failed	20010222
3	INVALID_CUSTOMIZING	☐	Invalid Customizing	20010222
4	INVALID_SORT_CRITERIA	☐	Invalid sort criteria	20010222
5	NO_SORT_CRITERIA	☐	No sort criteria	20010222

Method FCAT_NO_OUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	LT_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	TABLE		Field Catalog	20010222
2	Importing	PROFILE_NUMBER	Call by reference	☐	Type reference (TYPE)	I		Profile Number	20010222

Method FCAT_NO_OUT on class CL_GUI_TCF_ALV_WRAPPER has no exception.

Method FREE Signature

Method FREE on class CL_GUI_TCF_ALV_WRAPPER has no parameter.
Method FREE on class CL_GUI_TCF_ALV_WRAPPER has no exception.

Method GENERATE_SUBROUTINE_AND_SORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_INPUT_TABLE	Call by reference	☐	Type reference (TYPE)	TABLE		Input Table	20010222
2	Importing	I_SORT_CRITERIA	Call by reference	☐	Type reference (TYPE)	SORT_CRITERIA_INTERNAL		Sort criteria	20010222

#	Exception	Resumable	Description	Created on
1	ERROR_DURING_GENERATION	☐	Error During Generation	20010222
2	INVALID_CUSTOMISING	☐	invalid customisation data	20010222

Method ON_TOOLBAR_DROPDOWN_CLICKED Signature

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

Method ON_TOOLBAR_DROPDOWN_CLICKED on class CL_GUI_TCF_ALV_WRAPPER has no exception.

Method ON_TOOLBAR_FUNCTION_SELECTED Signature

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

Method ON_TOOLBAR_FUNCTION_SELECTED on class CL_GUI_TCF_ALV_WRAPPER has no exception.

Method PREPARE_FIELD_CATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog	20010222
2	Importing	I_INPUT_TABLE_LINE	Call by reference	☐	Type reference (TYPE)	ANY		Input table line	20010222
3	Importing	I_PROFILE_NUMBER	Call by reference	☑	Type reference (TYPE)	ADTCF_MASTER-PROFILE_KEY		Profile Number	20010222
4	Importing	I_PROG_NAME	Call by reference	☐	Type reference (TYPE)	SY-CPROG		Program Name	20010222
5	Importing	I_USER_ID	Call by reference	☐	Type reference (TYPE)	SYST-UNAME		User Id	20010222

#	Exception	Resumable	Description	Created on
1	INVALID_CUSTOMIZING	☐	Field name or level is empty in a record	20010222

Method PREPARE_FIELD_CATALOG2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog	20010222
2	Importing	I_INPUT_TABLE_LINE	Call by reference	☐	Type reference (TYPE)	ANY		Input table line	20010222
3	Importing	I_PROFILE_NUMBER	Call by reference	☑	Type reference (TYPE)	ADTCF_MASTER-PROFILE_KEY		Profile Number	20010222
4	Importing	I_PROG_NAME	Call by reference	☐	Type reference (TYPE)	SY-CPROG		Program Name	20010222
5	Importing	I_USER_ID	Call by reference	☐	Type reference (TYPE)	SYST-UNAME		User Id	20010222

#	Exception	Resumable	Description	Created on
1	INVALID_CUSTOMIZING	☐	Field name or level is empty in a record	20010222

Method PREPARE_PRESENTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_SORT_CRITERIA	Call by reference	☐	Type reference (TYPE)	SORT_CRITERIA_INTERNAL		Sort Criteria	20010222
2	Importing	I_INPUT_TABLE	Call by reference	☐	Type reference (TYPE)	TABLE		Input Table	20010222
3	Importing	I_LAST_LEVEL	Call by reference	☐	Type reference (TYPE)	SY-TABIX		Last Level	20010222
4	Importing	I_PROFILE_NO	Call by reference	☐	Type reference (TYPE)	ADTCF_DETAIL-PROFILE_KEY		ADTCF : Profile Key	20010226

Method PREPARE_PRESENTATION on class CL_GUI_TCF_ALV_WRAPPER has no exception.

Method PREPARE_SORT_CRITERIA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_HIERARCHY_HEADER	Call by reference	☐	Type reference (TYPE)	TREEV_HHDR		Tree Control: Attributes of the Hierarchy Header	20010222
2	Exporting	E_LAST_LEVEL	Call by reference	☐	Type reference (TYPE)	SY-TABIX		Last Level	20010222
3	Exporting	E_SORT_CRITERIA	Call by reference	☐	Type reference (TYPE)	SORT_CRITERIA_INTERNAL		Output Sort Criteria	20010222
4	Importing	I_INPUT_TABLE	Call by reference	☐	Type reference (TYPE)	TABLE		Given Input table	20010222
5	Importing	I_PROFILE_NUMBER	Call by reference	☑	Type reference (TYPE)	ADTCF_MASTER-PROFILE_KEY		Profile Number	20010222
6	Importing	I_PROG_NAME	Call by reference	☐	Type reference (TYPE)	SY-CPROG		Program Name	20010222
7	Importing	I_USER_ID	Call by reference	☐	Type reference (TYPE)	SYST-UNAME		User Id	20010222

#	Exception	Resumable	Description	Created on
1	FIELD_NAME_OR_LEVEL_EMPTY	☐	Field name or level is empty in a record	20010222
2	FIELD_NOT_PART_OF_TYPE	☐	Field is not part of given table type	20010222
3	INVALID_CUSTOMIZING	☐	Invalid Customizing	20010222
4	NO_SORT_CRITERIA	☐	No Sort Criteria	20010222
5	REPEATING_FIELD_NAMES	☐	Repeating field names	20010222
6	REPEATING_LEVELS	☐	Repeating levels	20010222

Method PREPARE_TOOLBAR Signature

Method PREPARE_TOOLBAR on class CL_GUI_TCF_ALV_WRAPPER has no parameter.
Method PREPARE_TOOLBAR on class CL_GUI_TCF_ALV_WRAPPER has no exception.

Event Signatures

Event ERROR_DURING_GENERATION Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	CODE	Exporting	Value transfer	☐	Type reference (TYPE)	TABLE		Code Table	20010222
2	LINE	Exporting	Value transfer	☐	Type reference (TYPE)	SY-TABIX		Line in which error occured	20010222
3	MESSAGE	Exporting	Value transfer	☐	Type reference (TYPE)	STRING		Error Message	20010222
4	OFFSET	Exporting	Value transfer	☐	Type reference (TYPE)	SY-TABIX		Offset in the line where error occured	20010222
5	WORD	Exporting	Value transfer	☐	Type reference (TYPE)	STRING		Word in which error occured	20010222

History

Last changed by/on	SAP	20050301
SAP Release Created in	46C2