List

GET_LIST

Mit der Methode GET_LIST bekommt man über die ControlID die Instanz der Liste zurück und hat dann Zugriff auf die Eigenschaften der Liste. Sie wird genutzt, um verschiedene Elemente in einer geordneten oder ungeordneten Listendarstellung anzuzeigen.

Attribute im Designer

List

Attribut	Beschreibung	Standardwert
controlId	Eindeutige Id der Komponente	Wird automatisch generiert
noDataText	Text, der bei fehlenden Items angezeigt werden soll
showNoData	Definiert, ob ein No-Data-Text bei fehlenden Items angezeigt werden soll	True
headerText	Text der Überschrift
items	Liste der möglichen Items, repräsentiert durch einen List Item
mode	Auswahlmodus in der Liste mit möglichen Werten: None, SingleSelect, SingleSelectLeft, SingleSelectMaster, MultiSelect	None
visible	Gibt an, ob die Komponente angezeigt werden soll	true
spanS	Gibt die Breite des Controls im Grid-Layout an. Definiert, wie viele Spalten eingenommen werden sollen	12
spanM	Gibt die Breite des Controls im Grid-Layout an. Definiert, wie viele Spalten eingenommen werden sollen	12
spanL	Gibt die Breite des Controls im Grid-Layout an. Definiert, wie viele Spalten eingenommen werden sollen	12
spanXL	Gibt die Breite des Controls im Grid-Layout an. Definiert, wie viele Spalten eingenommen werden sollen	12

Methode	Beschreibung
ADD_LIST_ITEM	Hinzufügen eines Elements zur Liste
ADD_LIST_ITEMS	Hinzufügen mehrerer Elemente zur Liste
GET_HEADER_TEXT	Setzen des Texts des Headers
GET_ITEM	Lesen eines Elements anhand eines Schlüssels
GET_ITEMS	Lesen aller Items
GET_MODE	Lesen des gesetzten Auswahlmodus‘
GET_NO_DATA_TEXT	Lesen des gesetzten No-Data-Texts
GET_SELECTED_ITEMS	Lesen der ausgewählten Items
GET_SHOW_NO_DATA	Lesen, ob der No-Data-Text angezeigt wird
ITEMS_COUNT	Lesen der Anzahl aller Items
REMOVE_ALL_ITEMS	Entfernen aller Elemente in der Liste
REMOVE_ITEM	Entfernen eines Items anhand einer ID
SET_HEADER_TEXT	Setzen des Texts des Headers
SET_MODE	Setzen des Auswahlmodus‘
SET_NO_DATA_TEXT	Setzen des No-Data-Texts
SET_SHOW_NO_DATA	Setzen, ob der No-Data-Text angezeigt werden soll

Code-Beispiel

List

DATA(ls_list_item_1) = VALUE /mobbuild/cl_list=>ty_list_item(
  key = 'item_1'
  title = 'item_1_title'
  description = 'item_1_description'
  visible = abap_true
).

  lo_list->add_list_item( ls_list_item_1 ).

Geerbte Methoden von

CONTROL

Vererbt an

Keine

Implementiert das Interface

Keines

Methoden

ADD_LIST_ITEM

Hinzufügen eines Elements zur Liste.

Übergabeparameter	Typ	Standardwert	Beschreibung
IS_STANDARD_LIST_ITEM	TY_LIST_ITEM		Hinzuzufügendes Listen-Item

Rückgabeparameter	Typ	Beschreibung
RO_CONTROL	List	Referenz auf this, um Methodenverkettung zu erlauben

ADD_LIST_ITEMS

Hinzufügen mehrerer Elemente zur Liste.

Übergabeparameter	Typ	Standardwert	Beschreibung
IT_LIST_ITEMS	TT_LIST_ITEM		Liste der hinzuzufügenden Items

Rückgabeparameter	Typ	Beschreibung
RO_CONTROL	List	Referenz auf this, um Methodenverkettung zu erlauben

GET_HEADER_TEXT

Lesen des Texts des Headers.

Rückgabeparameter	Typ	Beschreibung
RV_VALUE	String	Auszulesender Header-Text

GET_ITEM

Lesen eines Items anhand eines Keys.

Übergabeparameter	Typ	Standardwert	Beschreibung
IV_KEY	String		Key, anhand dessen ausgelesen werden soll

Rückgabeparameter	Typ	Beschreibung
RS_LIST_ITEM	TY_LIST_ITEM	Auszulesendes Item

GET_ITEMS

Lesen aller Items.

Rückgabeparameter	Typ	Beschreibung
RT_LIST_ITEM	TT_LIST_ITEM	Alle Items in der Liste

GET_MODE

Lesen des Auswahlmodus‘.

Rückgabeparameter	Typ	Beschreibung
RV_LIST_MODE	String	Gesetzter Auswahlmodus mit möglichen Werten None, SingeSelect, SingleSelectLeft, SingleSelectMaster, MultiSelect

GET_NO_DATA_TEXT

Lesen des No-Data-Texts. Dieser kann angezeigt werden, wenn keine Daten in der Liste vorhanden sind. Standard auf „Keine Daten“ gesetzt.

Rückgabeparameter	Typ	Beschreibung
RV_VALUE	String	Gesetzter No-Data-Text

GET_SELECTED_ITEMS

Lesen aller ausgewählten Items.

Rückgabeparameter	Typ	Beschreibung
RT_LIST_ITEM	TT_LIST_ITEM	Alle ausgewählten Items

GET_SHOW_NO_DATA

Lesen, ob der No-Data-Text angezeigt wird. Dies passiert in der Regel, wenn keine Daten zur Liste hinzugefügt wurden.

Rückgabeparameter	Typ	Beschreibung
RV_VALUE	BOOLE_D	True, wenn der No-Data-Text angezeigt wird, andernfalls False

ITEMS_COUNT

Lesen der Anzahl aller hinzugefügten Items.

Rückgabeparameter	Typ	Beschreibung
RV_COUNT	I	Anzahl aller Items

REMOVE_ALL_ITEMS

Entfernen aller Items.

Rückgabeparameter	Typ	Beschreibung
RO_CONTROL	List	Referenz auf this, um Methodenverkettung zu erlauben

REMOVE_ITEM

Entfernen eines Items anhand eines Keys.

Übergabeparameter	Typ	Standardwert	Beschreibung
IV_KEY	String		Key des zu entfernenden Items

Rückgabeparameter	Typ	Beschreibung
RO_CONTROL	List	Referenz auf this, um Methodenverkettung zu erlauben

SET_HEADER_TEXT

Setzen des Texts des Headers.

Übergabeparameter	Typ	Standardwert	Beschreibung
IV_VALUE	String		Zu setzender Header-Text

Rückgabeparameter	Typ	Beschreibung
RO_CONTROL	List	Referenz auf this, um Methodenverkettung zu erlauben

SET_MODE

Setzen des Auswahlmodus‘.

Übergabeparameter	Typ	Standardwert	Beschreibung
IV_LIST_MODE	String		Zu setzender Auswahlmodus mit möglichen Werten None, SingeSelect, SingleSelectLeft, SingleSelectMaster, MultiSelect

Rückgabeparameter	Typ	Beschreibung
RO_CONTROL	List	Referenz auf this, um Methodenverkettung zu erlauben

SET_NO_DATA_TEXT

Setzen des No-Data-Texts. Dieser kann angezeigt werden, wenn keine Daten in der Liste vorhanden sind. Standard auf „Keine Daten“ gesetzt.

Übergabeparameter	Typ	Standardwert	Beschreibung
IV_VALUE	String		Zu setzender No-Data-Text

Rückgabeparameter	Typ	Beschreibung
RO_CONTROL	List	Referenz auf this, um Methodenverkettung zu erlauben

SET_SHOW_NO_DATA

Setzen, ob der No-Data-Text angezeigt werden soll. Dies passiert in der Regel, wenn keine Daten zur Liste hinzugefügt wurden.

Übergabeparameter	Typ	Standardwert	Beschreibung
IV_VALUE	BOOLE_D		True, wenn der No-Data-Text angezeigt werden soll, andernfalls False

Rückgabeparameter	Typ	Beschreibung
RO_CONTROL	List	Referenz auf this, um Methodenverkettung zu erlauben

List Item

Message Box