AbstractTimelineSchedulePage : Global

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 6 Minuten Lesedauer

    • Die Skripteinbindung „ AbstractTimelineSchedulePage “ ist eine Hilfsklasse, die das Arbeiten mit den auf Zeitleisten angezeigten Daten erleichtert.

    Die Verarbeitung der in einer Zeitleiste angezeigten Daten beginnt mit der Ausführung der entsprechenden Funktion der angegebenen Skripteinbindung. Wie bei anderen Skripteinbindungen ist die Sprachsyntax JavaScript und folgt den Standard-Sicherheitseinschränkungen dieses Ressourcentyps. Da die verschiedenen Arten von Anzeigeoptionen jedoch komplex sind, wurde eine Hilfsklasse erstellt. Um eine Zeitleiste anzuzeigen, erweitern Sie die Klasse AbstractTimelineSchedulePage, und koppeln Sie sie mit der entsprechenden Zeitplanseite. Beim Erweitern von Klassen sollte mindestens die getItems()-Methode überschrieben werden, da dies der primäre Event Handler für die Rückgabe von Elementen ist, die auf dem Client angezeigt werden sollen.

    Der Client verarbeitet die von AbstractTimelineSchedulePage zurückgegebenen Daten in zwei Phasen. In der ersten Phase werden die tatsächliches Updates an der Zeitleiste vorgenommen. Unmittelbar danach, sofern konfiguriert, wird in der zweiten Phase ein Erfolgsmeldungsfeld, ein Fehlermeldungsfeld oder eine Dialogfeld-Eingabeaufforderung angezeigt. In Phase 1 stehen folgende Optionen zum Bearbeiten von Daten zur Verfügung:

    • Keine Elemente aktualisieren: Dies ist das Standardverhalten. Führen Sie keine der verbleibenden Schritte in Phase 1 aus.
    • Mit bestimmten Elementen aktualisieren: Dies geschieht mit add().
    • Zeitleiste mit der Funktion „getItems()“ rendern : Dies erfolgt mit: setDoReRenderTimeline(true).
    Hinweis:
    Wenn beide TimelineItems zurückgegeben werden und setDoReRenderTimeline auf truefestgelegt ist, ignoriert das System die Eigenschaft setDoReRenderTimeline und zeigt explizit nur die TimelineItems an, die mit der Funktion add() hinzugefügt wurden.

    In Phase 2 stehen die folgenden Optionen zur Verfügung:

    • Keine Nachrichtenfelder anzeigen: Dies ist das Standardverhalten.
    • Erfolgsdialogfeld anzeigen: Dies geschieht mit: setStatusSuccess().
    • Dialogfeld „Fehler anzeigen“: Dies geschieht mit: setStatusError().
    • Dialogfeld zur Bestätigung anzeigen: Dies geschieht mit: setStatusPrompt().
    Hinweis:

    Eine Skripteinbindungsklasse, die AbstractTimelineSchedulePage erweitert, empfängt automatisch alle URI-Parameter von der ursprünglichen URL, deren Präfix mit sysparm_timeline_beginnt. Um auf deren Werte zuzugreifen, verwenden Sie this.getParameter ("sysparm_timeline_VARIABLE"); in Ihrer erweiterten Klasse.

    Dies ist nützlich, wenn Sie eine Zeitplanseite aus einem dynamischen Element anzeigen möchten, z. B. aus einem Kontextmenü in einer Liste. Durch die Übergabe dynamischer Daten über die URL werden diese Parameter von der Zeitplanseite automatisch in die Ajax-Aufrufe aufgenommen und sind daher in der Skripteinbindung „ AbstractTimelineSchedulePage “ zugänglich.

    AbstractTimelineSchedulePage – add(Object ObjTimeline)

    Fügt ein TimelineItem-Objekt hinzu, das an den Client zurückgegeben und entsprechend auf der Zeitleiste angezeigt wird.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    ObjTimeline Objekt Das TimelineItem-Objekt, das der Zeitleiste hinzugefügt werden soll.
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – addSeparator()

    Fügt der Liste der Zeitleistenelemente ein horizontales Frame-Trennzeichen hinzu. Alle zukünftigen Elemente, die über add() hinzugefügt werden, werden dem nachfolgenden Zeitleisten-Frame hinzugefügt.

    Alle mit der Methode „ add() “ hinzugefügten zukünftigen Elemente werden im nachfolgenden Zeitleistenframe hinzugefügt.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    void

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    // Inside of a script include that extends AbstractTimelineSchedulePage
      this.addSeparator();

    AbstractTimelineSchedulePage – elementMoveX(String spanSysId, String newStartDateTimeMs)

    Event Handler zum Verschieben einer Zeitleiste in horizontaler Richtung.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    spanSysId Zeichenfolge Die Sys-ID der aktuellen Zeitspanne, die angepasst wird.
    newStartDateTimeMs Zeichenfolge Die neue Startzeit der Zeitspanne in Millisekunden. Stellen Sie sicher, dass Sie die Zeichenfolge mit parseInt() analysieren, bevor numerische Vergleiche durchgeführt werden.
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – elementMoveXY(String spanSysId, String itemSysId, String itemSysId, String newItemSysId, String newStartDateTimeMs)

    Event Handler zum Verschieben einer Zeitleiste in horizontaler und vertikaler Richtung.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    spanSysId Zeichenfolge Die Sys-ID der aktuellen Zeitspanne, die angepasst wird.
    itemSysId Zeichenfolge Die Sys-ID des Zeitleistenelements, das der aktuellen Zeitspanne zugeordnet ist.
    newItemSysId Zeichenfolge Die Sys-ID des Zeitleistenelements (eine Zeile), in das die aktuelle Zeitspanne gezogen wurde.
    newStartDateTimeMs Zeichenfolge Die neue Startzeit der Zeitspanne in Millisekunden. Stellen Sie sicher, dass Sie die Zeichenfolge mit parseInt() analysieren, bevor numerische Vergleiche durchgeführt werden.
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – elementMoveY(String spanSysId, String itemSysId, String newItemSysId)

    Event Handler zum Verschieben einer Zeitleiste in vertikaler Richtung.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    spanSysId Zeichenfolge Die Sys-ID der aktuellen Zeitspanne, die angepasst wird.
    itemSysId Zeichenfolge Die Sys-ID des Zeitleistenelements, das der aktuellen Zeitspanne zugeordnet ist.
    newItemSysId Zeichenfolge Die Sys-ID des Zeitleistenelements (eine Zeile), in das die aktuelle Zeitspanne gezogen wurde.
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – elementSuccessor(String spanSysId, String newSuccSpanId)

    Event Handler zum Erstellen einer Zeitleistenbeziehung zwischen zwei Zeitspannen.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    spanSysId Zeichenfolge Die Sys-ID der aktuellen Zeitspanne, die ein Vorgänger der neu erstellten Beziehung sein wird.
    newSuccSpanId Zeichenfolge Die Sys-ID der Nachfolger-Zeitspanne in der erstellten Beziehung.
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    void Rückgabewert

    AbstractTimelineSchedulePage – elementTimeAdjustEnd(String spanSysId, String newEndDateTimeMs)

    Event Handler zum Ändern des Enddatums der Zeitspanne einer Zeitleiste.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    spanSysId Zeichenfolge Die Sys-ID der aktuellen Zeitspanne, die angepasst wird.
    newEndDateTimeMs Zeichenfolge Die neue Endzeit der Zeitspanne in Millisekunden. Stellen Sie sicher, dass Sie die Zeichenfolge mit parseInt() analysieren, bevor numerische Vergleiche durchgeführt werden.
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – elementTimeAdjustStart(String spanSysId, String newStartDateTimeMs)

    Event Handler zum Ändern des Startdatums der Zeitspanne einer Zeitleiste.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    spanSysId Zeichenfolge Die Sys-ID der aktuellen Zeitspanne, die angepasst wird.
    newStartDateTimeMs Zeichenfolge Die neue Startzeit der Zeitspanne in Millisekunden. Stellen Sie sicher, dass Sie die Zeichenfolge mit parseInt() analysieren, bevor numerische Vergleiche durchgeführt werden.
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – getItems()

    Event Handler zum Zurückgeben von Zeitplanelementen zur Anzeige auf der Zeitleiste.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – inputBox(String strInputText)

    Event Handler zur Eingabe einer Zeichenfolge in das Eingabefeld im linken Fensterbereich.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    strInputText Zeichenfolge Der Text, der in das Eingabefeld im linken Fensterbereich eingegeben wurde.
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – itemMove(String itemSysId, String newItemSysId)

    Event Handler zum Verschieben und Ziehen eines Zeilenelements der Zeitleiste in ein anderes Zeilenelement.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    itemSysId Zeichenfolge Die Sys-ID des Zeitleistenelements, das der aktuellen Zeitspanne zugeordnet ist.
    newItemSysId Zeichenfolge Die Sys-ID des Zeitleistenelements (eine Zeile), in das die aktuelle Zeitspanne gezogen wurde.
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – setDoReRenderTimeline(Boolean b)

    Gibt an, ob alle Zeitleistenelemente mit der Funktion getItems() erneut gerendert werden sollen.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    b Boolean Wenn true, wird die Zeitleiste erneut gerendert, indem ein neuer Event-Aufruf an den Handler getItems() des Servers gesendet wird.
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – setPageTitle(String strTitle)

    Gibt den Text an, der als Titel der Zeitleiste angezeigt werden soll.

    Der Seitentitel kann von jedem interaktiven Event aus festgelegt (und aktualisiert) werden. Es wird jedoch empfohlen, ihn während des getItems()-Events festzulegen.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    strTitle Zeichenfolge Der im Titel der Zeitleiste anzuzeigende Text.
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – setStatusError(String strTitle, String strMessage)

    Legt die aktuelle Event-Anforderung auf einen Fehlerstatus mit einem angegebenen Titel und einer angegebenen Meldung fest, die in Phase 2 der GlideTimeline-Event-Verarbeitung angezeigt werden soll.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    strTitle Zeichenfolge Der im Dialogfeldtitel anzuzeigende Text.
    strMessage Zeichenfolge Der im Dialogfeld anzuzeigende Text. Der Text kann HTML-Formatierungen enthalten.
    Tabelle : 28. Ergebnisse
    Typ Beschreibung
    void

    AbstractTimelineSchedulePage – setStatusPrompt(String strTitle, String strOkFunction, String strCancelFunction, String strCloseFunction)

    Legt die aktuelle Event-Anforderung auf einen Eingabeaufforderungs-Fehlerstatus mit einem angegebenen Titel und einer angegebenen Meldung fest, die in Phase 2 der GlideTimeline-Event-Verarbeitung in einem Bestätigungsdialogfeld angezeigt werden soll. Im Bestätigungsfeld werden die Schaltflächen OK und Abbrechen angezeigt, die jeweils neue Events generieren, mit denen die von den Parameterargumenten angegebenen Funktionen aufgerufen werden. Die benutzerdefinierten Funktionen für OK, Abbrechen und Schließen erhalten dieselben Parameterargumente wie die für das aktuelle Event.

    Im Bestätigungsfeld werden die Schaltflächen OK und Abbrechen angezeigt, die jeweils neue Events generieren, mit denen die von den Parameterargumenten angegebenen Funktionen aufgerufen werden.
    Hinweis:
    Die benutzerdefinierten Funktionen für OK, Abbrechen und Schließen erhalten dieselben Parameterargumente wie die für das aktuelle Event.
    Tabelle : 29. Parameter
    Name Typ Beschreibung
    strTitle Zeichenfolge Der im Dialogfeld anzuzeigende Text. Der Text kann HTML-Formatierungen enthalten.
    strOkFunction Zeichenfolge Die Funktion, die in der aktuellen Skripteinbindungsklasse aufgerufen werden soll, wenn der Benutzer auf die Schaltfläche OK klickt.
    strCancelFunction Zeichenfolge Die Funktion, die in der aktuellen Skripteinbindungsklasse aufgerufen werden soll, wenn der Benutzer auf die Schaltfläche Abbrechen klickt.
    strCloseFunction Zeichenfolge Die Funktion, die in der aktuellen Skripteinbindungsklasse aufgerufen werden soll, wenn der Benutzer auf die Schaltfläche Schließen klickt.
    Tabelle : 30. Ergebnisse
    Typ Beschreibung
    void 
    var MyTimelineScriptIncludeClass = Class.create();
      MyTimelineScriptIncludeClass.prototype = Object.extendsObject(AbstractTimelineSchedulePage, {
      
      getItems: function() {
      //...
      },
      
      elementTimeAdjustEnd: function(spanSysId, newEndDateTimeMs) {
      // Display a status prompt dialog box
      this.setStatusPrompt('Confirm Action', 'Are you sure you want to do that?',
      'this._myOkHandlerFunction',  
      'this._myCancelHandlerFunction',
      'this._myCloseHandlerFunction');
      },
      
      _myOkHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... },
      
      _myCancelHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... },
      
      _myCloseHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... }
      };

    AbstractTimelineSchedulePage – setStatusSuccess(String strTitle, String strMessage)

    Legt die aktuelle Event-Anforderung auf einen Erfolgsstatus mit einem angegebenen Titel und einer angegebenen Meldung fest, die in Phase 2 der GlideTimeline-Event-Verarbeitung angezeigt werden soll.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    strTitle Zeichenfolge Der im Dialogfeldtitel anzuzeigende Text.
    strMessage Zeichenfolge Der im Dialogfeld anzuzeigende Text. Der Text kann HTML-Formatierungen enthalten.
    Tabelle : 32. Ergebnisse
    Typ Beschreibung
    void