SAP ABAP Class CL_GUI_LISTBOX (Listbox Control)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-FES-CTL (Application Component) SAP GUI for Windows Controls
     ⤷ SAPTOOLBAR (Package) SAP Toolbar Control

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_GUI_CONTROL	Proxy Class for Control in GUI	20121205

Properties

Class	CL_GUI_LISTBOX
Short Description	Listbox Control
Super Class	CL_GUI_CONTROL	Proxy Class for Control in GUI
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SAPTOOLBAR	SAP Toolbar Control
Created	20121205	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_GUI_LISTBOX has no forward declaration.

Interfaces

Class CL_GUI_LISTBOX has no interface implemented.

Friends

Class CL_GUI_LISTBOX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MY_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	I			20121205
2	MY_SELECTION	Instance attribute	Private	☐	See coding				20121205
3	MY_TEXT	Instance attribute	Private	☐	Type reference (TYPE)	STRING		The string set in Listbox.	20121210
4	M_ID_CHANGE	Constant	Public	☐	Type reference (TYPE)	I	1	ID FOR CHANGE EVENT	20121206
5	M_ID_CLICK	Constant	Public	☐	Type reference (TYPE)	I	-600	ID FOR CLICK EVENT	20121206
6	M_ID_ON_ENTER	Constant	Public	☐	Type reference (TYPE)	I	2		20121210
7	M_LISTBOX_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	I	0	0 - COMBOBOX, 1 - INPUTBOX	20121221

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ITEM	Instance method	Public	Method	Add a new entry	20121205
2	ADD_ITEMS	Instance method	Public	Method	Add a table of entries	20121205
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor for Listbox	20121205
4	GET_TEXT	Instance method	Public	Method	Get the listbox text.	20121210
5	SET_DEFAULT_INDEX	Instance method	Public	Method	Set the default selected index	20121213
6	SET_LABEL_TEXT	Instance method	Private	Method	ADD A LABEL TO THE LISTBOX	20121207
7	SET_LABEL_WIDTH_CHARBASED	Instance method	Public	Method	Set the width of Label/combobox (Unit - No. of chars)	20130114
8	SET_LISTBOX_TYPE	Instance method	Private	Method	0 - COMBOBOX ( Default ), 1 - INPUTBOX , 2 - SIMPLEINPUTBOX	20121221
9	SET_SEARCH_BUTTON_ICON	Instance method	Private	Method	Set search icon (@id@ / @idQtooltiop@)	20130109

Events

#	Event	Type	Visibility	Description	Created on
1	CHANGE	Instance Event (0)	Public (2)	Change event	20121205
2	CLICK	Instance Event (0)	Public (2)	Click event	20121205
3	ON_ENTER	Instance Event (0)	Public (2)	On press Enter	20121210

Types

Class CL_GUI_LISTBOX has no local type.

Method Signatures

Method ADD_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM	Call by reference	☐	Type reference (TYPE)	TEXT70		Item value	20121205

#	Exception	Resumable	Description	Created on
1	OPERATION_NOT_ALLOWED	☐	Operation cannot with performed with current listbox type.	20130227

Method ADD_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_TAB	Call by reference	☐	Type reference (TYPE)	STRINGTAB		Table of items	20121205

#	Exception	Resumable	Description	Created on
1	OPERATION_NOT_ALLOWED	☐	Operation cannot with performed with current listbox type.	20130227

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ICON_INDEX	Call by reference	☑	Type reference (TYPE)	STRING		Icon Index (@xxQTooltip@ / Icon Name)	20130109
2	Importing	ITEM_TAB	Call by reference	☑	Type reference (TYPE)	STRINGTAB		List of items	20130109
3	Importing	LABEL_TEXT	Call by reference	☑	Type reference (TYPE)	STRING		Set Label Text	20130108
4	Importing	LABEL_WIDTH_CHARBASED	Call by reference	☑	Type reference (TYPE)	I		Width of Label in no. of chars	20130109
5	Importing	LIFETIME	Call by reference	☐	Type reference (TYPE)	I	0	Lifetime	20121205
6	Importing	LISTBOX_TYPE	Call by reference	☐	Type reference (TYPE)	I	0	0 - COMBOBOX, 1 - INPUTBOX, 2 - SIMPLEINPUTBOX	20121224
7	Importing	PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Name of the container	20121205
8	Importing	SHELLSTYLE	Call by reference	☐	Type reference (TYPE)	I	0	Shell Style	20121205

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Error in CFW call	20121205

Method GET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20121210

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	General Control Error.	20130222

Method SET_DEFAULT_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDEX	Call by reference	☐	Type reference (TYPE)	I	0	Index	20121213

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	General control error.	20130222
2	OPERATION_NOT_ALLOWED	☐	Operation cannot with performed with current listbox type.	20130227

Method SET_LABEL_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LABEL_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		SET LABEL TEXT	20121207

Method SET_LABEL_TEXT on class CL_GUI_LISTBOX has no exception.

Method SET_LABEL_WIDTH_CHARBASED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LABEL_WIDTH	Call by reference	☐	Type reference (TYPE)	I		Width ( Unit no. of chars)	20130114

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	General Cntrol Error	20130222

Method SET_LISTBOX_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LISTBOX_TYPE	Call by reference	☐	Type reference (TYPE)	I	0	0 - COMBOBOX, 1 - INPUTBOX	20121221

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	General Control Error	20130222

Method SET_SEARCH_BUTTON_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ICON_INDEX	Call by reference	☐	Type reference (TYPE)	STRING		Icon Index(@xxqTooltip@ / Icon Name)	20130109

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	General Control Error	20130222

Event Signatures

Event CHANGE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	INDEX	Exporting	Value transfer	☐	Type reference (TYPE)	I			20121205
2	ITEM	Exporting	Value transfer	☐	Type reference (TYPE)	C			20121205

Event CLICK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	INDEX	Exporting	Value transfer	☐	Type reference (TYPE)	I			20121205
2	ITEM	Exporting	Value transfer	☐	Type reference (TYPE)	C			20121205

Event ON_ENTER Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	INDEX	Exporting	Value transfer	☐	Type reference (TYPE)	I			20121210
2	ITEM	Exporting	Value transfer	☐	Type reference (TYPE)	C			20121210
3	TEXT	Exporting	Value transfer	☐	Type reference (TYPE)	STRING		Text typed/selected in listbox	20121210

History

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