SAP ABAP Interface IF_SALV_ITAB_VIEW_GROUPED_DATA (Merged view on results of IF_SALV_ITAB_SERVICES)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-ATS (Application Component) ABAP Table/Tree Services
     ⤷ SALV_ST_PUB (Package) ALV Services for Tables: Public API

Properties

Interface	IF_SALV_ITAB_VIEW_GROUPED_DATA
Short Description	Merged view on results of IF_SALV_ITAB_SERVICES

General Data

Package	SALV_ST_PUB	ALV Services for Tables: Public API
Created	20100906	SAP
Last changed	20141121
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	IF_SALV_SERVICE_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_SALV_STI_GROUPING_SERVICE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no interface.

Friends

Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CS_AGGR_EXCEPTION_CODE	Constant	Public	☐	See coding				20110811
2	CS_ROW_TYPE	Constant	Public	☐	See coding				20100908

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COLLAPSE_ALL_GROUPS	Instance method	Public	Method		20130312
2	COLLAPSE_GROUP	Instance method	Public	Method	Collapses the group with header row at I_ROW_INDEX	20100913
3	EXPAND_ALL_GROUPS	Instance method	Public	Method		20130312
4	EXPAND_GROUP	Instance method	Public	Method	Expands the group with header row at I_ROW_INDEX	20100913
5	FIND_DATA_ROW_BACKWARD	Instance method	Public	Method	Find a data row starting search at given index	20110408
6	FIND_DATA_ROW_FORWARD	Instance method	Public	Method	Find a data row starting search at given index	20110408
7	GET_FORMATTING	Instance method	Public	Method	Get formatting for given range according formatting rule	20140611
8	GET_GRAND_TOTAL	Instance method	Public	Method	Returns grand total line with measures (if any)	20111021
9	GET_INDEX_MAPPER	Instance method	Public	Method	Provides mappings between source and result line indexes	20100906
10	GET_PARENT_NODES	Instance method	Public	Method		20140226
11	GET_SOURCE_LINE_ORDER	Instance method	Public	Method	Order of source lines as they appear in result	20110125
12	GET_TABLE	Instance method	Public	Method	Gets data lines merged with extra lines (grouping, aggr.)	20100906
13	GET_TABLE_SIZE	Instance method	Public	Method	Number of lines available from GET_TABLE	20100906
14	GET_VISIBLE_NODE_INFORMATION	Instance method	Public	Method	Get information on visible nodes for scroll tip provider	20131016
15	IS_GRAND_TOTAL_IN_TABLE	Instance method	Public	Method		20130916
16	NAVIGATE_TO_NEXT_DATA_ROW	Instance method	Public	Method	Determines result index of next data row and expands all nec	20140602
17	SET_GRAND_TOTAL_IN_TABLE	Instance method	Public	Method	Grand total in result table is included or excluded	20111024
18	SET_INSERT_POSITION	Instance method	Public	Method	Sets the insert position for new lines (in result data set)	20101021

Events

Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_AGGREGATION_EXCEPTION	Public	See coding			20110811	begin of ys_aggregation_exception, row_index type if_salv_service_types=>y_row_index, field_path type if_salv_service_types=>y_field_path, exception_code type y_aggr_exception_code, alternative_text type string, end of ys_aggregation_exception
2	YS_HEADER_ROW_INFO	Public	See coding			20140212	begin of ys_header_row_info, r_key_record type ref to data, data_only_res_idx type i, group_level type i, result_idx type i, end of ys_header_row_info
3	YS_RESULT_ROW_INFO	Public	See coding			20110114	begin of ys_result_row_info, row_type type y_row_type, group_level type i, is_expanded type abap_bool, group_label type string, group_path_label type string, data_count type i, end of ys_result_row_info
4	YTS_AGGREGATION_EXCEPTION	Public	See coding			20110811	yts_aggregation_exception type sorted table of ys_aggregation_exception with unique key row_index field_path
5	YT_HEADER_ROW_INFO	Public	See coding			20140212	yt_header_row_info type standard table of ys_header_row_info with default key
6	YT_PARENT_NODE_RESULT_INDEX	Public	See coding			20140225	yt_parent_node_result_index type table of sytabix
7	YT_RESULT_ROW_INFO	Public	See coding			20110114	yt_result_row_info type standard table of ys_result_row_info with default key
8	Y_AGGR_EXCEPTION_CODE	Public	Type reference (TYPE)	CHAR1		20110811
9	Y_ROW_TYPE	Public	Type reference (TYPE)	CHAR1		20100908

Method Signatures

Method COLLAPSE_ALL_GROUPS Signature

Method COLLAPSE_ALL_GROUPS on Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SALV_API_CONTRACT_VIOLATION	☐		20130312

Method COLLAPSE_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		Index of Internal Tables	20100913

#	Exception	Resumable	Description	Created on
1	CX_SALV_NOT_A_GROUP_ROW	☐	The selected row is not a group row	20100913

Method EXPAND_ALL_GROUPS Signature

Method EXPAND_ALL_GROUPS on Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SALV_API_CONTRACT_VIOLATION	☐		20130312

Method EXPAND_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ROW_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		Index of Internal Tables	20100913

#	Exception	Resumable	Description	Created on
1	CX_SALV_NOT_A_GROUP_ROW	☐	The selected row is not a group row	20100913

Method FIND_DATA_ROW_BACKWARD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_START_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		where to start the search	20110408
2	Returning	R_DATA_ROW_INDEX	Value transfer	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		index of first data row at or below start index	20110408

#	Exception	Resumable	Description	Created on
1	CX_SALV_API_CONTRACT_VIOLATION	☐	API contract violated by caller	20110408
2	CX_SALV_INDEX_OUT_OF_BOUNDS	☐	An index value is not inside the valid bounds	20110411

Method FIND_DATA_ROW_FORWARD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_START_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		where to start the search	20110408
2	Returning	R_DATA_ROW_INDEX	Value transfer	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		index of first data row at or below start index	20110408

#	Exception	Resumable	Description	Created on
1	CX_SALV_API_CONTRACT_VIOLATION	☐	API contract violated by caller	20110408
2	CX_SALV_INDEX_OUT_OF_BOUNDS	☐	An index value is not inside the valid bounds	20110411

Method GET_FORMATTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FORMATTING_DATA	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_FORMATTING_INFO		Formatting info for given rows	20140611
2	Importing	I_FROM_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX	1	Index of Internal Tables	20140611
3	Importing	I_TO_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX	IF_SALV_SERVICE_TYPES=>CS_ROW_INDEX-TABLE_SIZE	Index of Internal Tables	20140611

Method GET_FORMATTING on Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no exception.

Method GET_GRAND_TOTAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_AGGREGATION_EXCEPTION	Call by reference	☐	Type reference (TYPE)	YTS_AGGREGATION_EXCEPTION			20111021
2	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20111021

#	Exception	Resumable	Description	Created on
1	CX_SALV_API_CONTRACT_VIOLATION	☐		20111021

Method GET_INDEX_MAPPER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_MAPPER	Value transfer	☐	Object reference (TYPE REF TO)	IF_SALV_INDEX_MAPPER		Index mapping interface for ALV Services	20100906

Method GET_INDEX_MAPPER on Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no exception.

Method GET_PARENT_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARENT_NODE_RESULT_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_ITAB_VIEW_GROUPED_DATA=>YT_PARENT_NODE_RESULT_INDEX			20140226
2	Importing	IV_RESULT_INDEX	Value transfer	☐	Type reference (TYPE)	SYTABIX			20140226

Method GET_PARENT_NODES on Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no exception.

Method GET_SOURCE_LINE_ORDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINE_ORDER	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>YT_LINE_ORDER			20110125
2	Exporting	E_SAME_AS_SOURCE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		if TRUE et_line_order is initial	20110125

#	Exception	Resumable	Description	Created on
1	CX_SALV_API_CONTRACT_VIOLATION	☐	API contract violated by caller	20110125
2	CX_SALV_HIDDEN_LINES_NO_ORDER	☐	There is no defined order for hidden lines	20110125

Method GET_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_AGGREGATION_EXCEPTION	Call by reference	☐	Type reference (TYPE)	YTS_AGGREGATION_EXCEPTION		Aggregation cells requiring special interpretation	20110811
2	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20110114
3	Exporting	ET_ROW_INFO	Call by reference	☐	Type reference (TYPE)	YT_RESULT_ROW_INFO		Description/information for each line in the table ET_DATA	20110114
4	Importing	I_FROM_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX	1	Index of Internal Tables	20100906
5	Importing	I_TO_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX	IF_SALV_SERVICE_TYPES=>CS_ROW_INDEX-TABLE_SIZE	Index of Internal Tables	20100906

#	Exception	Resumable	Description	Created on
1	CX_SALV_API_CONTRACT_VIOLATION	☐	API contract violated by caller	20100906
2	CX_SALV_INDEX_OUT_OF_BOUNDS	☐		20130919

Method GET_TABLE_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		Index of Internal Tables	20100906

#	Exception	Resumable	Description	Created on
1	CX_SALV_API_CONTRACT_VIOLATION	☐	API contract violated by caller	20100906

Method GET_VISIBLE_NODE_INFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_VIS_NODE_INFO	Value transfer	☐	Type reference (TYPE)	IF_SALV_STI_GROUPING_SERVICE=>YT_VIS_NODE_INFO			20131016

Method GET_VISIBLE_NODE_INFORMATION on Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no exception.

Method IS_GRAND_TOTAL_IN_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_IS_INCLUDED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130916

Method IS_GRAND_TOTAL_IN_TABLE on Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no exception.

Method NAVIGATE_TO_NEXT_DATA_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RESULT_RESIZED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20140702
2	Exporting	EV_RES_IDX	Value transfer	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		result index of next/prev data row	20140702
3	Importing	IV_BACKWARD	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20140602
4	Importing	IV_START_RES_IDX	Call by reference	☑	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		start idx 0 ->first/last data row	20140602

Method NAVIGATE_TO_NEXT_DATA_ROW on Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no exception.

Method SET_GRAND_TOTAL_IN_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_IS_INCLUDED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20111026

Method SET_GRAND_TOTAL_IN_TABLE on Interface IF_SALV_ITAB_VIEW_GROUPED_DATA has no exception.

Method SET_INSERT_POSITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INSERT_BEFORE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101108
2	Importing	I_RESULT_INDEX	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_ROW_INDEX		Index of Internal Tables	20101108

#	Exception	Resumable	Description	Created on
1	CX_SALV_API_CONTRACT_VIOLATION	☐	API contract violated by caller	20110512
2	CX_SALV_INDEX_OUT_OF_BOUNDS	☐		20130919

History

Last changed by/on	SAP	20141121
SAP Release Created in	703