SAP ABAP Class CL_SALV_GUI_LAYOUT_IDA (Personalizable Layout for IDA ALV)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-SRV-ALV (Application Component) SAP List Viewer
     ⤷ SALV_IDA_IMPL (Package) ALV: Development for IDA No Translation

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ALV_CML_LAYOUT_EDITOR	Interface for Layout: SortRules,FilterRules,Visibility,...	20130305
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_GUI_GRID_LAYOUT_EDITOR	Interface for Layout: SortRules,FilterRules,Visibility,...	20120904
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_GUI_LAYOUT_PERSISTENCE	IDA API Layout Persistence for ALV	20130307

Properties

Class	CL_SALV_GUI_LAYOUT_IDA
Short Description	Personalizable Layout for IDA ALV
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SALV_IDA_IMPL	ALV: Development for IDA No Translation
Created	20120829	SAP
Last change	20141120
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_SALV_GUI_FIELD_CATALOG_IDA	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_ALV_CML_LAYOUT_HANDLER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_ALV_CUL	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	IF_SALV_GUI_TYPES_IDA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
6	IF_SALV_GUI_TYPES_INT_IDA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
7	IF_SALV_IDA_STRUCTDESCR_PROV	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
8	IF_SALV_SERVICE_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
9	KKBLO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ALV_CML_LAYOUT_EDITOR	☐	☐	Interface for Layout: SortRules,FilterRules,Visibility,...	20130305
2	IF_SALV_GUI_GRID_LAYOUT_EDITOR	☐	☐	Interface for Layout: SortRules,FilterRules,Visibility,...	20120904
3	IF_SALV_GUI_LAYOUT_PERSISTENCE	☐	☐	IDA API Layout Persistence for ALV	20130307

Friends

#	Friend	Modeled only	Created on	Description
1	TC_SALV_GUI_AUNIT_FRIEND_IDA	☐	20131212	Friend for AUnit Tests

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_DEFAULT_LAYOUT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_LAYOUT_IDA		Personalizable Layout for ALV on HDB	20120904
2	MO_F4_VALUE_PROVIDER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_F4_VALUE_PROVIDER			20140214
3	MO_FIELD_CATALOG	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SALV_GUI_FIELD_CATALOG_IDA		Implementation of IDA ALV field catalog	20120904
4	MO_FILTER_RULE_EDITOR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_FILTER_RULE_EDITOR			20140606
5	MO_LAYOUT_CHANGE_LOG	Instance attribute	Private	☐	Object reference (TYPE REF TO)	LCL_LAYOUT_CHANGE_LOG			20130212
6	MO_LAYOUT_HANDLER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_ALV_CML_LAYOUT_HANDLER		IF_ALV_CUL_LAYOUT_HANDLER	20130305
7	MO_LOGGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SALV_LOGGER		ALV Trace Logger	20140328
8	MO_OWN_LAYOUT_OBSERVER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_GRID_LAYOUT_OBSERV		if_salv_gui_model_observer_ida	20121023
9	MO_STANDARD_FUNCTIONS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SALV_GUI_STD_FUNCTIONS_IDA		Availablitity of Standard Functions	20130705
10	MO_USER_ACTION	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_USER_ACTION_READER			20130927
11	MO_USER_ACTION_OBSERVER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_USER_ACTION_OBSERV			20120904
12	MS_SNAPSHOT	Instance attribute	Private	☐	See coding				20120904
13	MS_TEXT_SEARCH	Instance attribute	Private	☐	See coding				20140328
14	MTS_AVAILABLE_FIELDS	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>YTS_FIELD_NAME			20140304
15	MTS_UI_INFO	Instance attribute	Protected	☐	Type reference (TYPE)	YTS_FIELD_UI_INFO			20120904
16	MT_FILTER_RULE	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_FILTER_RULE			20120904
17	MT_GROUPING_RULE	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_GROUPING_RULE			20121022
18	MT_HIDDEN_FIELDS	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>YT_FIELD_NAME			20120904
19	MT_SORT_RULE	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_SORT_RULE			20121022
20	MT_SORT_RULES_IDA	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>YT_SORT_RULE			20121023
21	MT_VISIBLE_FIELDS	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>YT_FIELD_NAME			20120904
22	M_MAX_GROUPING_LEVEL	Instance attribute	Protected	☐	Type reference (TYPE)	SYTABIX		Index of Internal Tables	20120904

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_VIS_2_AVAIL_FIELDS	Instance method	Private	Method		20131031
2	CONSTRUCTOR	Instance method	Public	Constructor		20120904
3	CREATE_MTS_UI_INFO	Instance method	Protected	Method		20120904
4	CREATE_SNAPSHOT	Instance method	Protected	Method		20120904
5	FIELDCATALOG_TO_KKBLO	Instance method	Protected	Method		20130305
6	GET_ATS_RULES	Instance method	Public	Method		20120904
7	GET_DEFAULT_LAYOUT	Instance method	Public	Method		20120904
8	GET_FIELD_FOR_LEVEL	Instance method	Public	Method		20120910
9	GET_MAX_GROUPING_LEVEL	Instance method	Public	Method		20120904
10	GET_T_GROUP_KEY_FOR_LEVEL	Instance method	Public	Method		20121022
11	MERGE	Instance method	Public	Method	Merge of DefaultLayout, persited Layout, UpdateATSRules...	20120904
12	ON_STANDARD_FUNCTION_CHANGED	Instance method	Private	Event handling method		20130930
13	RELEASE	Instance method	Protected	Method		20120904
14	ROLLBACK_FROM_SNAPSHOT	Instance method	Protected	Method		20120904
15	SET_F4_VALUE_PROVIDER	Instance method	Public	Method		20140214
16	SET_FIELDCATALOG_FROM_KKBLO	Instance method	Protected	Method		20130305
17	SET_GROUPING_INFO	Instance method	Protected	Method		20120904

Events

Class CL_SALV_GUI_LAYOUT_IDA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_FIELD_UI_INFO	Public	See coding			20120904	BEGIN OF ys_field_ui_info, field_name TYPE cl_salv_gui_field_catalog_ida=>y_field_name, aggregation_type TYPE char3, "' '=Default, N= No, Y=YES group_level TYPE sytabix, column_width TYPE outputlen, END OF ys_field_ui_info
2	YTS_FIELD_UI_INFO	Protected	See coding			20120904	yts_field_ui_info TYPE SORTED TABLE OF ys_field_ui_info WITH UNIQUE KEY field_name
3	YT_FIELD_UI_INFO	Public	See coding			20120904	yt_field_ui_info TYPE STANDARD TABLE OF ys_field_ui_info WITH DEFAULT KEY

Method Signatures

Method CHECK_VIS_2_AVAIL_FIELDS Signature

Method CHECK_VIS_2_AVAIL_FIELDS on class CL_SALV_GUI_LAYOUT_IDA has no parameter.
Method CHECK_VIS_2_AVAIL_FIELDS on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FIELD_CATALOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_GUI_FIELD_CATALOG_IDA		Implementation of IDA ALV field catalog	20120904
2	Importing	IO_STANDARD_FUNCTIONS	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_GUI_STD_FUNCTIONS_IDA		Availablity of Standard Functions	20130705
3	Importing	IO_USER_ACTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_USER_ACTION_READER			20130927
4	Importing	IS_LAYOUT_ID	Call by reference	☑	Type reference (TYPE)	IF_ALV_CML_LAYOUT_HANDLER=>YS_LTDXID			20130305
5	Importing	IS_VARIANT	Call by reference	☑	Type reference (TYPE)	DISVARIANT		Layout (External Use)	20130305
6	Importing	I_DEFAULT_HANDLING_ALLOWED	Call by reference	☑	Type reference (TYPE)	IF_ALV_CUL=>Y_FLAG			20130305
7	Importing	I_SAVE_TYPE	Call by reference	☑	Type reference (TYPE)	IF_ALV_CUL=>Y_FLAG			20130305

Method CONSTRUCTOR on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method CREATE_MTS_UI_INFO Signature

Method CREATE_MTS_UI_INFO on class CL_SALV_GUI_LAYOUT_IDA has no parameter.
Method CREATE_MTS_UI_INFO on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method CREATE_SNAPSHOT Signature

Method CREATE_SNAPSHOT on class CL_SALV_GUI_LAYOUT_IDA has no parameter.
Method CREATE_SNAPSHOT on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method FIELDCATALOG_TO_KKBLO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FIELDCAT_KKBLO	Call by reference	☐	Type reference (TYPE)	KKBLO_T_FIELDCAT			20130305
2	Exporting	ET_FILTER_KKBLO	Call by reference	☐	Type reference (TYPE)	KKBLO_T_FILTER			20130305
3	Exporting	ET_SORT_KKBLO	Call by reference	☐	Type reference (TYPE)	KKBLO_T_SORTINFO			20130305

Method FIELDCATALOG_TO_KKBLO on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method GET_ATS_RULES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_AGGREGATION_RULES	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_AGGREGATION_RULE			20120904
2	Exporting	ET_FILTER_RULES	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_FILTER_RULE			20120904
3	Exporting	ET_GROUPING_RULES	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_GROUPING_RULE			20120904
4	Exporting	ET_SORT_RULES	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_SORT_RULE			20120904

Method GET_ATS_RULES on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method GET_DEFAULT_LAYOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_DEFAULT_LAYOUT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_LAYOUT_IDA		Personalizable Layout for ALV on HDB	20120904

Method GET_DEFAULT_LAYOUT on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method GET_FIELD_FOR_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	FIELD_NAME	Value transfer	☐	Type reference (TYPE)	CL_SALV_GUI_FIELD_CATALOG_IDA=>Y_FIELD_NAME			20120910
2	Importing	LEVEL	Call by reference	☐	Type reference (TYPE)	I			20120910

Method GET_FIELD_FOR_LEVEL on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method GET_MAX_GROUPING_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INCLUDING_GRAND_TOTAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20120904
2	Returning	MAX_LEVEL	Value transfer	☐	Type reference (TYPE)	I			20120904

Method GET_MAX_GROUPING_LEVEL on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method GET_T_GROUP_KEY_FOR_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_GROUP_KEY	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_GROUP_KEY			20121022
2	Importing	LEVEL	Call by reference	☐	Type reference (TYPE)	I			20121022

Method GET_T_GROUP_KEY_FOR_LEVEL on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method MERGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIRST_TIME	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120904

Method MERGE on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method ON_STANDARD_FUNCTION_CHANGED Signature

Method ON_STANDARD_FUNCTION_CHANGED on class CL_SALV_GUI_LAYOUT_IDA has no parameter.
Method ON_STANDARD_FUNCTION_CHANGED on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method RELEASE Signature

Method RELEASE on class CL_SALV_GUI_LAYOUT_IDA has no parameter.
Method RELEASE on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method ROLLBACK_FROM_SNAPSHOT Signature

Method ROLLBACK_FROM_SNAPSHOT on class CL_SALV_GUI_LAYOUT_IDA has no parameter.
Method ROLLBACK_FROM_SNAPSHOT on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method SET_F4_VALUE_PROVIDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_F4_VALUE_PROVIDER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_F4_VALUE_PROVIDER			20140214

Method SET_F4_VALUE_PROVIDER on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method SET_FIELDCATALOG_FROM_KKBLO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELDCAT_KKBLO	Value transfer	☐	Type reference (TYPE)	KKBLO_T_FIELDCAT			20130305
2	Importing	IT_FILTER_KKBLO	Value transfer	☑	Type reference (TYPE)	KKBLO_T_FILTER			20130305
3	Importing	IT_SORT_KKBLO	Value transfer	☑	Type reference (TYPE)	KKBLO_T_SORTINFO			20130305

Method SET_FIELDCATALOG_FROM_KKBLO on class CL_SALV_GUI_LAYOUT_IDA has no exception.

Method SET_GROUPING_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SORT_RULE	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>YT_SORT_RULE			20120904

Method SET_GROUPING_INFO on class CL_SALV_GUI_LAYOUT_IDA has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	740