SAP ABAP Interface IF_SALV_GUI_FIELD_CATALOG_IDA (IDA API Field Catalog Manipulation Object)

Hierarchy

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

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SALV_GUI_FIELD_CATALOG_IDA	Implementation of IDA ALV field catalog	20120904

Properties

Interface	IF_SALV_GUI_FIELD_CATALOG_IDA
Short Description	IDA API Field Catalog Manipulation Object

General Data

Package	SALV_IDA_PUB	ALV: Development for IDA Translation DevTools
Created	20120808	SAP
Last changed	20141121
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_SALV_GUI_TYPES_IDA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Interface IF_SALV_GUI_FIELD_CATALOG_IDA has no interface.

Friends

Interface IF_SALV_GUI_FIELD_CATALOG_IDA has no friend.

Attributes

Interface IF_SALV_GUI_FIELD_CATALOG_IDA has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DISABLE_AGGREGATION	Instance method	Public	Method	Disable aggregation function for a field	20130911
2	DISABLE_FILTER	Instance method	Public	Method	Disable filter function for a field	20130912
3	DISABLE_SORT	Instance method	Public	Method	Disable sorting/grouping function for a field	20130911
4	DISPLAY_OPTIONS	Instance method	Public	Method	Get an instance for manipulating display options (interface)	20130916
5	ENABLE_TEXT_SEARCH	Instance method	Public	Method	EnableText search for a field	20140530
6	GET_ALL_FIELDS	Instance method	Public	Method	Fetch all fields of the table/view	20120808
7	GET_AVAILABLE_FIELDS	Instance method	Public	Method	Fetch fields that are available for list display	20120808
8	GET_UNIQUE_ROW_KEY	Instance method	Public	Method	Get the unique row key of the list	20121128
9	SET_AVAILABLE_FIELDS	Instance method	Public	Method	Set fields that are available for list display	20120808
10	SET_CURRENCY_REFERENCE_FIELD	Instance method	Public	Method	Set the currency reference field for a field	20121122
11	SET_DATA_ELEMENT	Instance method	Public	Method	Set data description of a field by a data element	20121220
12	SET_FIELD_HEADER_TEXTS	Instance method	Public	Method	Set the header text for a field	20121122
13	SET_FIXED_CURRENCY	Instance method	Public	Method	Set a fixed currency for an amount field	20130601
14	SET_FIXED_UNIT	Instance method	Public	Method	Set a fixed unit for a quantity field	20130704
15	SET_SORT_STRATEGY	Instance method	Public	Method	Redefine ALV default sort parameters	20131121
16	SET_UNIQUE_ROW_KEY	Instance method	Public	Method	Set the unique row key of the list	20121128
17	SET_UNIT_REFERENCE_FIELD	Instance method	Public	Method	Set the unit reference field for a field	20121122

Events

Interface IF_SALV_GUI_FIELD_CATALOG_IDA has no event.

Types

Interface IF_SALV_GUI_FIELD_CATALOG_IDA has no local type.

Method Signatures

Method DISABLE_AGGREGATION Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_UNKNOWN_NAME	☐		20130911

Method DISABLE_FILTER Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_UNKNOWN_NAME	☐		20130912

Method DISABLE_SORT Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_UNKNOWN_NAME	☐		20130911

Method DISPLAY_OPTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_DISPLAY_OPTIONS	Value transfer	☐	Object reference (TYPE REF TO)	IF_SALV_GUI_FIELD_DISPLAY_OPT			20130916

Method DISPLAY_OPTIONS on Interface IF_SALV_GUI_FIELD_CATALOG_IDA has no exception.

Method ENABLE_TEXT_SEARCH Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140530
2	CX_SALV_IDA_UNKNOWN_NAME	☐		20140530

Method GET_ALL_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_FIELD_NAMES	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>YTS_FIELD_NAME			20121207

Method GET_ALL_FIELDS on Interface IF_SALV_GUI_FIELD_CATALOG_IDA has no exception.

Method GET_AVAILABLE_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_FIELD_NAMES	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>YTS_FIELD_NAME			20121207

Method GET_AVAILABLE_FIELDS on Interface IF_SALV_GUI_FIELD_CATALOG_IDA has no exception.

Method GET_UNIQUE_ROW_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_FIELD_NAMES	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>YTS_FIELD_NAME			20121220

Method GET_UNIQUE_ROW_KEY on Interface IF_SALV_GUI_FIELD_CATALOG_IDA has no exception.

Method SET_AVAILABLE_FIELDS Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_UNKNOWN_NAME	☐		20121207

Method SET_CURRENCY_REFERENCE_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AMOUNT_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20121220
2	Importing	IV_CURRENCY_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20121220

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_CONTRACT_VIOLATION	☐	IDA API contract violated by caller	20130604

Method SET_DATA_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATA_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_DATA_ELEMENT_NAME			20121220
2	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20121220

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_TYPE_MISMATCH	☐	Type mismatch	20130605
3	CX_SALV_IDA_UNKNOWN_NAME	☐	IDA API contract violated by caller	20130604

Method SET_FIELD_HEADER_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20121220
2	Importing	IV_HEADER_TEXT	Call by reference	☑	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_HEADER_TEXT			20121220
3	Importing	IV_TOOLTIP_TEXT	Call by reference	☑	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_TOOLTIP_TEXT			20121220

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_UNKNOWN_NAME	☐	IDA API contract violated by caller	20130604

Method SET_FIXED_CURRENCY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AMOUNT_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20130601
2	Importing	IV_FIXED_CURRENCY	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_CURRENCY		Currency Key	20130601

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_CONTRACT_VIOLATION	☐	IDA API contract violated by caller	20130601

Method SET_FIXED_UNIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIXED_UNIT	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_UNIT		Unit of Measurement	20130704
2	Importing	IV_QUANTITY_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20130704

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_CONTRACT_VIOLATION	☐	IDA API contract violated by caller	20130704

Method SET_SORT_STRATEGY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20131121
2	Importing	IV_SORT_AS_TEXT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	IF_SALV_IDA_TYPES=>CS_SORT_AS_TEXT-DEFAULT		20131121
3	Importing	IV_SORT_BY	Call by reference	☐	Type reference (TYPE)	IF_SALV_SERVICE_TYPES=>Y_PROPERTY_VALUE	IF_SALV_IDA_TYPES=>CS_SORT_BY-DEFAULT		20131127

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_UNKNOWN_NAME	☐		20131125

Method SET_UNIQUE_ROW_KEY Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_UNKNOWN_NAME	☐		20121128

Method SET_UNIT_REFERENCE_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_QUANTITY_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20121220
2	Importing	IV_UNIT_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20121220

#	Exception	Resumable	Description	Created on
1	CX_SALV_CALL_AFTER_1ST_DISPLAY	☐		20140304
2	CX_SALV_IDA_CONTRACT_VIOLATION	☐	IDA API contract violated by caller	20130604

History

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