SAP ABAP Class CL_EHSGWB_ALV_TREE (EHS: LWB ALV Tree)

Hierarchy

☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ EHS-SAF (Application Component) Product Safety
     ⤷ CBGLMP_WB (Package) EHS: Labeling Workbench Framework

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_EHSGWB_ALV_ROOT	EHS: LWB ALV Definition	20110914

Properties

Class	CL_EHSGWB_ALV_TREE
Short Description	EHS: LWB ALV Tree
Super Class	CL_EHSGWB_ALV_ROOT	EHS: LWB ALV Definition
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	CBGLMP_WB	EHS: Labeling Workbench Framework
Created	20110914	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)
2	CL_EHSGBC_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_EHSGWB_ALV_TREE has no interface implemented.

Friends

Class CL_EHSGWB_ALV_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_HIERARCHY_HEADER_WIDTH	Constant	Private	☐	Type reference (TYPE)	INT4	30	Natural Number	20111129
2	MO_ALV	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE		ALV Tree Control	20110914
3	MR_EXPANDED_NODES_DATA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Buffer for Data of Expanded Nodes	20110914
4	MR_OUTTAB	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Output Data	20110914
5	MR_SELECTED_ENTRIES	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Buffer for Previously Selected Entries	20110914
6	MS_HIERARCHY_HEADER	Instance attribute	Protected	☐	Type reference (TYPE)	TREEV_HHDR		Tree Control: Attributes of the Hierarchy Header	20110914
7	MT_EXPANDED_NODES	Instance attribute	Protected	☐	Type reference (TYPE)	LVC_T_NKEY		ALV Tree Control: Node Table	20110914
8	MT_SELECTED_ENTRIES	Instance attribute	Protected	☐	Type reference (TYPE)	LVC_T_NKEY		Buffer for Reselection of Entries	20110914
9	MV_HIERARCHY_LEVELS	Instance attribute	Protected	☐	Type reference (TYPE)	CBGLE_WB_ALV_DISP_TYPE		ALV Display Type	20110914

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_LINE	Instance method	Protected	Method	Add a Line to the Output Table	20110914
2	ADD_NODE	Instance method	Protected	Method	Add a Hierarchy Node	20110914
3	AS_COLUMN_NAME	Instance method	Protected	Method	Determine Name of Column by Column Number	20110914
4	AS_INDEX	Instance method	Protected	Method	Translate Node Key into Table Index	20110914
5	COLLECT_EXPANDED_NODES	Instance method	Protected	Method	Collect Keys of Expanded Nodes to Restore Node Expansion	20110914
6	CONSTRUCTOR	Instance method	Public	Constructor	Create an ALV Tree Object	20110914
7	CREATE_HIERARCHY	Instance method	Protected	Method	Set Up Data Hierarchy	20110914
8	FINALIZE	Instance method	Public	Method	Destroy the ALV Tree Object	20110914
9	GET_INSTANCE_CL	Static method	Public	Method	Create an ALV Tree Object	20110914
10	GET_NODES_DATA	Instance method	Protected	Method	Get Data of Selected Nodes	20110914
11	GET_SELECTED_ENTRIES_INC_CHILD	Instance method	Public	Method	Returns the Selected Entries with All Child Nodes	20110914
12	ON_NODE_DOUBLE_CLICK	Instance method	Public	Event handling method	Event Handler: Node Double-Click	20110914
13	SELECTED_ENTRIES_BUFFER	Instance method	Protected	Method	Buffer Actually Buffered Selected Entries	20110914
14	SELECTED_ENTRIES_COLLECT	Instance method	Protected	Method	Collect Keys of Previously Collected Nodes to Restore Select	20110914
15	SELECTED_ENTRIES_RESELECT	Instance method	Protected	Method	Reselect the Previously Selected Entries	20110914
16	SET_HIERARCHY_HEADER	Instance method	Protected	Method	Set Hierarchy Header Entry	20110914

Events

Class CL_EHSGWB_ALV_TREE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_LS_FIELDS	Protected	See coding			20110914	BEGIN OF ty_ls_fields, col TYPE i, name TYPE abap_compname, END OF ty_ls_fields
2	TY_LT_FIELDS	Protected	See coding			20110914	ty_lt_fields TYPE STANDARD TABLE OF ty_ls_fields WITH KEY col

Method Signatures

Method ADD_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	ANY		EHS: LWB ALV generic outtab structure	20110914
2	Importing	IV_NODE_TEXT	Call by reference	☐	Type reference (TYPE)	LVC_VALUE		ALV Control: Cell Content	20110914
3	Importing	IV_PARENT_KEY	Call by reference	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110914
4	Returning	RV_LINE_KEY	Value transfer	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110914

Method ADD_LINE on class CL_EHSGWB_ALV_TREE has no exception.

Method ADD_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	ANY		EHS: LWB ALV generic outtab structure	20110914
2	Importing	IV_NODE_TEXT	Call by reference	☐	Type reference (TYPE)	LVC_VALUE		ALV Control: Cell Content	20110914
3	Importing	IV_PARENT_KEY	Call by reference	☑	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110914
4	Returning	RV_NODE_KEY	Value transfer	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110914

Method ADD_NODE on class CL_EHSGWB_ALV_TREE has no exception.

Method AS_COLUMN_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COL_NO	Call by reference	☐	Type reference (TYPE)	I			20110914
2	Returning	RV_COL_NAME	Value transfer	☐	Type reference (TYPE)	ABAP_COMPNAME			20110914

Method AS_COLUMN_NAME on class CL_EHSGWB_ALV_TREE has no exception.

Method AS_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_INDEX_NODE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Index of Internal Tables	20110914
2	Exporting	EV_INDEX_REAL	Call by reference	☐	Type reference (TYPE)	LVC_S_ROW-INDEX		ALV control: Row number (index of internal table)	20110914
3	Importing	IV_NODE_KEY	Call by reference	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110914

Method AS_INDEX on class CL_EHSGWB_ALV_TREE has no exception.

Method COLLECT_EXPANDED_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20110914
2	Importing	IV_NODE_KEY	Call by reference	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110914

Method COLLECT_EXPANDED_NODES on class CL_EHSGWB_ALV_TREE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container for Custom Controls in the Screen Area	20110914
2	Importing	IS_HIERARCHY_HEADER	Call by reference	☑	Type reference (TYPE)	TREEV_HHDR		Tree Control: Attributes of the Hierarchy Header	20110914
3	Importing	IT_DATA	Call by reference	☑	Type reference (TYPE)	ANY TABLE		Output data	20110914
4	Importing	IV_BP_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_BP_ID		Business Process ID	20110914
5	Importing	IV_HIERARCHY_LEVELS	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_ALV_DISP_TYPE		ALV display type	20110914
6	Importing	IV_OUTTAB_STRUCTURE	Call by reference	☑	Type reference (TYPE)	CBGLE_WB_STRUCTURE_NAME		ABAP Dictionary name of structure	20110914
7	Importing	IV_SCREEN_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_SCREEN_ID		Screen ID	20110914
8	Importing	IV_TAB_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_TAB_ID		Tab ID	20110914

#	Exception	Resumable	Description	Created on
1	CX_EHSGWB_EXCEPTION	☐		20110914

Method CREATE_HIERARCHY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20110914

Method CREATE_HIERARCHY on class CL_EHSGWB_ALV_TREE has no exception.

Method FINALIZE Signature

Method FINALIZE on class CL_EHSGWB_ALV_TREE has no parameter.
Method FINALIZE on class CL_EHSGWB_ALV_TREE has no exception.

Method GET_INSTANCE_CL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container for Custom Controls in the Screen Area	20110914
2	Importing	IS_HIERARCHY_HEADER	Call by reference	☑	Type reference (TYPE)	TREEV_HHDR		Tree Control: Attributes of the Hierarchy Header	20110914
3	Importing	IT_DATA	Call by reference	☑	Type reference (TYPE)	ANY TABLE		Output data	20110914
4	Importing	IV_BP_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_BP_ID		Business Process ID	20110914
5	Importing	IV_HIERARCHY_LEVELS	Call by reference	☑	Type reference (TYPE)	CBGLE_WB_ALV_DISP_TYPE	'1'	ALV display type	20110914
6	Importing	IV_OUTTAB_STRUCTURE	Call by reference	☑	Type reference (TYPE)	CBGLE_WB_STRUCTURE_NAME	'/TDAG/GFWBS_ALV_STRUC_GENERIC'	ABAP Dictionary name of structure	20110914
7	Importing	IV_SCREEN_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_SCREEN_ID		Screen ID	20110914
8	Importing	IV_TAB_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_TAB_ID		Tab ID	20110914
9	Returning	RO_ALV_TREE	Value transfer	☐	Object reference (TYPE REF TO)	CL_EHSGWB_ALV_TREE		EHS: LWB ALV tree	20110914

#	Exception	Resumable	Description	Created on
1	CX_EHSGWB_EXCEPTION	☐		20110914

Method GET_NODES_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20110914
2	Exporting	EV_FLG_NODE_SELECTED	Call by reference	☐	Type reference (TYPE)	AS4FLAG		Flag (X or Blank)	20110914
3	Importing	IV_FLG_INCLUDE_CHILD_NODES	Call by reference	☐	Type reference (TYPE)	AS4FLAG	ABAP_TRUE	Flag (X or Blank)	20110914
4	Importing	IV_NODE_KEY	Call by reference	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110914

Method GET_NODES_DATA on class CL_EHSGWB_ALV_TREE has no exception.

Method GET_SELECTED_ENTRIES_INC_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20110914

Method GET_SELECTED_ENTRIES_INC_CHILD on class CL_EHSGWB_ALV_TREE has no exception.

Method ON_NODE_DOUBLE_CLICK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20110914
2	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20110914

Method ON_NODE_DOUBLE_CLICK on class CL_EHSGWB_ALV_TREE has no exception.

Method SELECTED_ENTRIES_BUFFER Signature

Method SELECTED_ENTRIES_BUFFER on class CL_EHSGWB_ALV_TREE has no parameter.
Method SELECTED_ENTRIES_BUFFER on class CL_EHSGWB_ALV_TREE has no exception.

Method SELECTED_ENTRIES_COLLECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20110914
2	Importing	IV_NODE_KEY	Call by reference	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110914

Method SELECTED_ENTRIES_COLLECT on class CL_EHSGWB_ALV_TREE has no exception.

Method SELECTED_ENTRIES_RESELECT Signature

Method SELECTED_ENTRIES_RESELECT on class CL_EHSGWB_ALV_TREE has no parameter.
Method SELECTED_ENTRIES_RESELECT on class CL_EHSGWB_ALV_TREE has no exception.

Method SET_HIERARCHY_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HIERARCHY_HEADER	Call by reference	☐	Type reference (TYPE)	TREEV_HHDR		Tree Control: Attributes of the Hierarchy Header	20110914

Method SET_HIERARCHY_HEADER on class CL_EHSGWB_ALV_TREE has no exception.

History

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