SAP ABAP Class CL_ESD_LISTBOX (ESD: Listbox)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-WS-ABA (Application Component) Web Service Tools - ABAP
     ⤷ SESD_ESI_OBJECT_EDITORS_REUSE (Package) Unified Editors Reuse-Parts

Properties

Class	CL_ESD_LISTBOX
Short Description	ESD: Listbox
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SESD_ESI_OBJECT_EDITORS_REUSE	Unified Editors Reuse-Parts
Created	20060214	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_ESD_LISTBOX	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	VRM	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_ESD_LISTBOX has no interface implemented.

Friends

Class CL_ESD_LISTBOX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_LISTBOX_TYPE_ALVGRID	Constant	Public	☐	Type reference (TYPE)	ESD_LISTBOX_TYPE	'AG'	Listbox type ALV grid	20060214
2	C_LISTBOX_TYPE_DYNPRO	Constant	Public	☐	Type reference (TYPE)	ESD_LISTBOX_TYPE	'DY'	Listbox type dynpro	20060214
3	C_OFF	Constant	Public	☐	Type reference (TYPE)	FLAG	SPACE	Off	20060214
4	C_ON	Constant	Public	☐	Type reference (TYPE)	FLAG	'X'	On	20060214
5	T_LISTBOX_OBJECTS	Static Attribute	Protected	☐	Type reference (TYPE)	ESD_LISTBOX_OBJECTS_T		Table with listbox objects	20060214
6	T_VRM_VALUES	Instance attribute	Protected	☐	Type reference (TYPE)	VRM_VALUES			20060214
7	V_HANDLE	Instance attribute	Protected	☐	Type reference (TYPE)	INT4		Handle (for listbox in ALV-Grids)	20060214
8	V_HANDLE_COUNT	Static Attribute	Protected	☐	Type reference (TYPE)	INT4		Handle counter (for Handle-usage in listboxes)	20060214

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_OBJECT_KEY	Static method	Protected	Method	Creates a key string	20060214
2	FILL_LISTBOX_INTERNAL	Instance method	Protected	Method	Fills a list box with key/value pairs	20060214
3	FREE	Instance method	Public	Method	DESTRUCTOR	20060214
4	GENERATE_VRM_VALUES	Instance method	Protected	Method	Generates the data for the list box	20060214
5	GET_DROP_DOWN_VALUES	Instance method	Public	Method	Return List Box Values (e.g. for an ALV Grid)	20060214
6	GET_FIRST_KEY	Instance method	Public	Method	Returns the key of the first entry	20060214
7	GET_HANDLE	Instance method	Public	Method	Returns the handle	20060214
8	GET_VRM_KEY	Instance method	Public	Method	Returns a code for a text	20060214
9	GET_VRM_TEXT	Instance method	Public	Method	Returns a text for a code	20060214
10	GET_VRM_VALUES	Instance method	Public	Method	Returns the list box entries	20060214
11	HAS_KEY	Instance method	Public	Method	Reports if list box contains supplied key	20060214

Events

Class CL_ESD_LISTBOX has no event.

Types

Class CL_ESD_LISTBOX has no local type.

Method Signatures

Method BUILD_OBJECT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLASSNAME	Call by reference	☐	Type reference (TYPE)	STRING		Class name	20060214
2	Importing	I_P1	Call by reference	☐	Type reference (TYPE)	ANY			20060214
3	Importing	I_P10	Call by reference	☐	Type reference (TYPE)	ANY			20060214
4	Importing	I_P11	Call by reference	☐	Type reference (TYPE)	ANY			20060214
5	Importing	I_P12	Call by reference	☐	Type reference (TYPE)	ANY			20060214
6	Importing	I_P13	Call by reference	☐	Type reference (TYPE)	ANY			20060214
7	Importing	I_P14	Call by reference	☐	Type reference (TYPE)	ANY			20060214
8	Importing	I_P15	Call by reference	☐	Type reference (TYPE)	ANY			20060214
9	Importing	I_P16	Call by reference	☐	Type reference (TYPE)	ANY			20060214
10	Importing	I_P17	Call by reference	☐	Type reference (TYPE)	ANY			20060214
11	Importing	I_P18	Call by reference	☐	Type reference (TYPE)	ANY			20060214
12	Importing	I_P19	Call by reference	☐	Type reference (TYPE)	ANY			20060214
13	Importing	I_P2	Call by reference	☐	Type reference (TYPE)	ANY			20060214
14	Importing	I_P20	Call by reference	☐	Type reference (TYPE)	ANY			20060214
15	Importing	I_P3	Call by reference	☐	Type reference (TYPE)	ANY			20060214
16	Importing	I_P4	Call by reference	☐	Type reference (TYPE)	ANY			20060214
17	Importing	I_P5	Call by reference	☐	Type reference (TYPE)	ANY			20060214
18	Importing	I_P6	Call by reference	☐	Type reference (TYPE)	ANY			20060214
19	Importing	I_P7	Call by reference	☐	Type reference (TYPE)	ANY			20060214
20	Importing	I_P8	Call by reference	☐	Type reference (TYPE)	ANY			20060214
21	Importing	I_P9	Call by reference	☐	Type reference (TYPE)	ANY			20060214
22	Returning	RV_OBJECT_KEY	Value transfer	☐	Type reference (TYPE)	STRING		Key of a listbox object	20060214

Method BUILD_OBJECT_KEY on class CL_ESD_LISTBOX has no exception.

Method FILL_LISTBOX_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DROP_DOWN_ALIAS	Call by reference	☐	Type reference (TYPE)	LVC_T_DRAL		Table for Drop Down Handles with Aliases	20060214
2	Exporting	EV_RC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Return Code	20060214
3	Importing	IV_FIELDNAME	Call by reference	☐	Type reference (TYPE)	VRM_ID		Dynpro Feldname	20060214
4	Importing	IV_LISTBOX_TYPE	Call by reference	☐	Type reference (TYPE)	ESD_LISTBOX_TYPE	CL_ESD_LISTBOX=>C_LISTBOX_TYPE_DYNPRO	Type of Listbox	20060214
5	Importing	IV_REFRESH	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	Refresh	20060214

Method FILL_LISTBOX_INTERNAL on class CL_ESD_LISTBOX has no exception.

Method FREE Signature

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

Method GENERATE_VRM_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REFRESH	Call by reference	☐	Type reference (TYPE)	FLAG	''	General Flag	20060214
2	Returning	RV_RC	Value transfer	☐	Type reference (TYPE)	SYSUBRC		Return Code	20060214

Method GENERATE_VRM_VALUES on class CL_ESD_LISTBOX has no exception.

Method GET_DROP_DOWN_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DROP_DOWN_ALIAS	Call by reference	☐	Type reference (TYPE)	LVC_T_DRAL		Table for Drop Down Handles with Aliases	20060214
2	Exporting	EV_HANDLE	Call by reference	☐	Type reference (TYPE)	INT4		Listbox Handle	20060214
3	Exporting	EV_RC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Return Code	20060214

Method GET_DROP_DOWN_VALUES on class CL_ESD_LISTBOX has no exception.

Method GET_FIRST_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_KEY	Value transfer	☐	Type reference (TYPE)	VRM_VALUE-KEY			20060214

Method GET_FIRST_KEY on class CL_ESD_LISTBOX has no exception.

Method GET_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_HANDLE	Value transfer	☐	Type reference (TYPE)	INT4		Handle	20060214

Method GET_HANDLE on class CL_ESD_LISTBOX has no exception.

Method GET_VRM_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VRM_TEXT	Call by reference	☐	Type reference (TYPE)	VRM_VALUE-TEXT			20060214
2	Returning	RV_VRM_KEY	Value transfer	☐	Type reference (TYPE)	VRM_VALUE-KEY			20060214

Method GET_VRM_KEY on class CL_ESD_LISTBOX has no exception.

Method GET_VRM_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VRM_KEY	Call by reference	☐	Type reference (TYPE)	VRM_VALUE-KEY			20060214
2	Returning	RV_VRM_TEXT	Value transfer	☐	Type reference (TYPE)	VRM_VALUE-TEXT			20060214

Method GET_VRM_TEXT on class CL_ESD_LISTBOX has no exception.

Method GET_VRM_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_VRM_VALUES	Value transfer	☐	Type reference (TYPE)	VRM_VALUES		Listbox values	20060214

Method GET_VRM_VALUES on class CL_ESD_LISTBOX has no exception.

Method HAS_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	VRM_VALUE-KEY		Key of a listbox entry	20060214
2	Returning	RV_HAS_KEY	Value transfer	☐	Type reference (TYPE)	FLAG		Key exists	20060214

Method HAS_KEY on class CL_ESD_LISTBOX has no exception.

History

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