Hilfsmethoden

Erstellte Klassen für Hilfsmethoden

Die erstellte Klasse erweitert die Oberklasse /mobbuild/cl_request_base und erbt deren Methoden. Dabei werden die Methoden on_pbo und on_pai in der neuen Klasse redefiniert, um benutzerdefinierte Logik zu implementieren.

Redefinierte Methoden

on_pai

Process After Input ermöglicht die Integration benutzerdefinierter Logik nach der Benutzereingabe.

on_pbo

Process Before Output wird verwendet, um die benutzerdefinierte Logik vor der Anzeige der UI5-Applikation auszuführen.

Geerbte Methoden

Die von der Oberklasse /mobbuild/cl_request_base geerbten Methoden stehen als Hilfsmethoden zur Verfügung. Sie können genutzt werden, um auf die UI5-Applikation Einfluss zu nehmen und Standardoperationen zu vereinfachen.

Hilfsmethoden

CONSTRUCTOR

Erzeugt das Control. Grundsätzlich verwenden alle Komponentenklassen diese Signatur des Constructors, es sei denn, dieser ist erneut bei einer Klasse aufgeführt.

Control Factory

CREATE_MESSAGE_BOX

Diese Methode erzeugt eine neue MessageBox.

Beispiel:

    data(lv_text) = |This is my MessageBox|.
    data(lv_msg_box_type) = |alert|.

    data(lo_message_box) = me->create_message_box( iv_text = lv_text
                                                   iv_msg_box_type = lv_msg_box_type ).

    lo_message_box->add_action( iv_action = /mobbuild/cl_msg_box_action=>co_yes
                                iv_submit = abap_true ).

    lo_message_box->add_action( iv_action = /mobbuild/cl_msg_box_action=>co_no
                                iv_submit = abap_true ).

    lo_message_box->set_emphasized_action( iv_action = /mobbuild/cl_msg_box_action=>co_yes ).

    me->set_message_box( lo_message_box ).

CREATE_MESSAGE_TOAST

Diese Methode erzeugt ein MessageToast.

Beispiel:

    data(lv_text) = |This is my MessageToast|.
    data(lo_message_toast) = me->create_message_toast( lv_text ).
    me->set_message_toast( lo_message_toast ).

GET_CLASS_NAME

Diese Methode gibt den Klassennamen eines übergebenen Control-Types zurück.

GET_CONTROL

Diese Methode liest eine Control in einer Applikation anhand der übergebenen ID aus und gibt diese anschließend zurück.

GET_CONTROLS

Diese Methode gibt alle Controls aus einer Applikation zurück.

GET_CONTROLS_BY_TYPE

Diese Methode liest alle Controls eines Types in einer Applikation aus und gibt diese zurück.

GET_CONTROL_BY_CONTROL_ID

Diese Methode liest eine Control in einer Applikation anhand der übergebenen ID aus und gibt diese anschließend zurück.

INIT_CONTROLS

Diese Methode initialisiert alle Controls, die zur App hinzugefügt wurden. Sie besitzt weder Über- noch Rückgabeparameter. Diese Methode sollte bei Klassen aufgerufen werden, die Kinder haben und bei einer PBO initialisiert werden müssen.

Request_Base

ADD_GLOBAL_DATA

Fügt globale Daten hinzu, die von jeder Klasse ausgelesen werden können.

CLEAR_MESSAGE_BOX

Diese Methode löscht die MessageBox vollständig. Es gibt weder Über- noch Rückgabeparameter.

CLEAR_MESSAGE_TOAST

Diese Methode löscht das MessageToast vollständig. Es gibt weder Über- noch Rückgabeparameter.

GET_APPLICATION_ID

Diese Methode gibt die ID der gesetzten Applikation zurück.

GET_CLIENT_ID

Diese Methode gibt die ID des Clients zurück.

GET_DEVICE

Gibt das Gerät zurück, das der Benutzer zum Anzeigen ausgewählt hat.

GET_DEVICE_ORIENTATION

Gibt die Ausrichtung des Geräts zurück, die der Benutzer zum Anzeigen ausgewählt hat. Sie kann vertikal oder horizontal sein.

GET_DEVICE_TYPE

Gibt den Typ des Geräts zurück, das der Benutzer zum Anzeigen ausgewählt hat. Dieser gibt beispielsweise an, ob es sich um einen Desktop oder ein mobiles Gerät handelt.

GET_EVENT

Gibt ein ausgelöstes Event zurück. Erzeugt standardmäßig ein Request-Data-Event, falls keines vorhanden ist.

GET_GLOBAL_DATA

Liest ein Datenpaar der globalen Daten aus anhand eines Keys.

GET_I18N

Diese Methode gibt das passende i18n-Model zur App und zum gewünschten Sprachcode zurück. Eine Liste aller Sprachcodes kann hier gefunden werden: https://www.npmjs.com/package/i18n-iso-countries

GET_I18N_TEXT

Diese Methode gibt einen übersetzten Text nach einem Übersetzungsschlüssel (Translate Key) zurück.

GET_PAGE_ZOOM

Gibt den Zoom der aktuellen View zurück.

GET_RESPONSE_DATA

Auslesen der Response-Daten zu Request-Daten.

GET_SCREEN_HEIGHT

Gibt die Höhe des Bildschirms zurück. Abhängig vom Gerät, das der Benutzer ausgewählt hat.

GET_SCREEN_WIDTH

Gibt die Breite des Bildschirms zurück. Abhängig vom Gerät, das der Benutzer ausgewählt hat.

GET_TEXT

Diese Methode gibt einen übersetzten Text nach einem Schlüssel zurück.

GET_TYPE

Gibt ein ausgelöstes Event zurück. Erzeugt standardmäßig ein Request-Data-Event, falls keines vorhanden ist.

GET_VIEW

Gibt die aktuelle View zurück. Erzeugt eine neue View, falls keine vorhanden ist.

ON_REQUEST

Diese Methode prüft ob das PAI- oder PBO-Skript ausgeführt werden soll und ruft das entsprechende auf. Keine Über- oder Rückgabeparameter.

REMOVE_GLOBAL_DATA

Entfernt ein Datenpaar der globalen Daten anhand eines Keys.

SET_FOCUS

Diese Methode setzt den Fokus auf eine Control anhand der Control-ID.

SET_MESSAGE_BOX

Diese Methode zeigt eine bereits erstellte MessageBox auf dem Bildschirm des Benutzers an.

SET_MESSAGE_TOAST

Diese Methode zeigt ein bereits erstelltes MessageToast auf dem Bildschirm des Benutzers an.

SET_NAV_TO

Diese Methode navigiert zu einer anderen View, die über die jeweilige ID festgelegt werden muss.

SET_PAGE_ZOOM

Diese Methode setzt den Zoom der aktuellen View.

SET_REQUEST_DATA

SET_REQUEST_DATA_RAW

Setzen der Daten, die angefragt werden.