AbstractTimeLineSchedulePage : global

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 8 minutes de lecture

    • L’API AbstractTimeLineSchedulePage est une classe d’aide permettant de faciliter l’utilisation des données affichées sur les chronologies.

    Le traitement des données affichées dans une chronologie commence par l’exécution de la fonction correspondante du script include spécifié. Comme d’autres script includes, la syntaxe du langage est JavaScript et suit les contraintes de sécurité par défaut de ce type de ressource. Cependant, comme les différents types d’options d’affichage sont complexes, une classe d’assistance a été créée. Pour afficher une chronologie, étendez la classe AbstractTimelineSchedulePage et associez-la à la page de planification correspondante. Au minimum, l’extension des classes doit remplacer la méthode getItems(), car il s’agit du gestionnaire d’événements principal pour renvoyer des éléments à afficher sur le client.

    Le client traite les données renvoyées par AbstractTimelineSchedulePage en deux phases. La première phase effectue les mises à jour réelles de la chronologie. Immédiatement après (si elle est configurée), la deuxième phase affiche une zone de message de réussite, une zone de message d’erreur ou une invite de message de dialogue. Au cours de la première phase, les options disponibles pour la manipulation des données sont les suivantes :

    • Ne mettre à jour aucun élément : il s’agit du comportement par défaut. N’effectuez aucune des étapes restantes de la première phase.
    • Mettre à jour avec des éléments spécifiques - Cela se fait à l’aide de : add().
    • Affichez la chronologie à l’aide de la fonction getItems() - Cela se fait à l’aide de : setDoRenderTimeline(true).
    Remarque :
    Si les deux TimelineItems sont renvoyés et setDoReRenderTimeline qu’ils sont définis sur true, le système ignorera la setDoReRenderTimeline propriété et affichera explicitement uniquement les TimelineItems qui ont été ajoutés via la fonction add().

    Les options disponibles pour la deuxième phase sont les suivantes :

    • Ne pas afficher de boîtes de message : il s’agit du comportement par défaut.
    • Afficher une boîte de dialogue de réussite - Pour ce faire, utilisez : setStatusSuccess().
    • Afficher une boîte de dialogue d’erreur - Pour ce faire, utilisez : setStatusError().
    • Afficher une boîte de dialogue de confirmation - Cela se fait à l’aide de : setStatusPrompt().
    Remarque :

    Une classe de script include qui étend AbstractTimelineSchedulePage reçoit automatiquement tous les paramètres Uri de l’URL d’origine dont le préfixe commence par sysparm_timeline_. Pour accéder aux valeurs de celles-ci, utilisez : this.getParameter(« sysparm_timeline_VARIABLE ») ; à l’intérieur de votre classe étendue.

    Ceci est utile si vous devez afficher une page de planification à partir d’un élément dynamique, par exemple à partir d’un menu contextuel d’une liste. En transmettant des données dynamiques via l’URL, la page de planification inclura automatiquement ces paramètres à l’intérieur des appels Ajax et sera donc accessible à l’intérieur des includes de script AbstractTimelineSchedulePage .

    AbstractTimelineSchedulePage - add(Object ObjTimeline)

    Ajoute un objet TimelineItem qui est renvoyé au client et affiché de manière appropriée sur la chronologie.

    Tableau 1. Paramètres
    Nom Type Description
    ObjTimeline (Chronologie d’obj.) Objet Objet TimelineItem à ajouter à la chronologie.
    Tableau 2. Renvoie
    Type Description
    nul

    AbstractTimelineSchedulePage - addSeparator()

    Ajoute un séparateur d’image horizontal à la liste des éléments de chronologie. Tous les futurs éléments ajoutés via add() seront ajoutés dans l’image de chronologie suivante.

    Tous les futurs éléments ajoutés via add() seront ajoutés dans l’image de chronologie suivante.

    Tableau 3. Paramètres
    Nom Type Description
    aucun
    Tableau 4. Renvoie
    Type Description
    nul 
    // Inside of a script include that extends AbstractTimelineSchedulePage
      this.addSeparator();

    AbstractTimelineSchedulePage : elementMoveX(String spanSysId, String newStartDateTimeMs)

    Gestionnaire d’événements pour le déplacement horizontal d’une plage chronologique.

    Tableau 5. Paramètres
    Nom Type Description
    spanSysId (ID spanSys) Chaîne L’ID système du parcours actuel en cours d’ajustement.
    newStartDateTimeMs Chaîne Nouvelle heure de début du parcours, en millisecondes. Assurez-vous d’analyser la chaîne à l’aide de parseInt() avant d’effectuer des comparaisons numériques.
    Tableau 6. Renvoie
    Type Description
    nul

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

    Gestionnaire d’événements pour le déplacement vertical d’une plage de chronologie.

    Tableau 7. Paramètres
    Nom Type Description
    spanSysId (ID spanSys) Chaîne L’ID système du parcours actuel en cours d’ajustement.
    itemSysId Chaîne ID système de l’élément de chronologie associé au parcours actuel.
    nouveauItemSysId Chaîne L’ID système de l’élément de chronologie (une ligne) dans lequel le parcours actuel a été déplacé.
    Tableau 8. Renvoie
    Type Description
    nul

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

    Gestionnaire d’événements pour les déplacements horizontaux et verticaux d’une plage de chronologie.

    Tableau 9. Paramètres
    Nom Type Description
    spanSysId (ID spanSys) Chaîne L’ID système du parcours actuel en cours d’ajustement.
    itemSysId Chaîne ID système de l’élément de chronologie associé au parcours actuel.
    nouveauItemSysId Chaîne L’ID système de l’élément de chronologie (une ligne) dans lequel le parcours actuel a été déplacé.
    newStartDateTimeMs Chaîne Nouvelle heure de début du parcours, en millisecondes. Assurez-vous d’analyser la chaîne à l’aide de parseInt() avant d’effectuer des comparaisons numériques.
    Tableau 10. Renvoie
    Type Description
    nul

    AbstractTimelineSchedulePage : elementSuccessor(String spanSysId, String newSuccSpanId)

    Gestionnaire d’événements pour la création d’une relation de chronologie entre deux parcours.

    Tableau 11. Paramètres
    Nom Type Description
    spanSysId (ID spanSys) Chaîne L’ID système du parcours actuel qui sera un prédécesseur de la relation nouvellement créée.
    nouveauSuccSpanId Chaîne L’ID système du parcours du successeur à partir de la relation créée.
    Tableau 12. Renvoie
    Type Description
    nul Returnvalue

    AbstractTimelineSchedulePage : elementTimeAdjustStart(String spanSysId, String newStartDateTimeMs)

    Gestionnaire d’événements indiquant quand la date de début d’un parcours de chronologie a été modifiée.

    Tableau 13. Paramètres
    Nom Type Description
    spanSysId (ID spanSys) Chaîne ID système du parcours actuel en cours d’ajustement.
    newStartDateTimeMs Chaîne Nouvelle heure de début du parcours, en millisecondes. Assurez-vous d’analyser la chaîne à l’aide de parseInt() avant d’effectuer des comparaisons numériques.
    Tableau 14. Renvoie
    Type Description
    nul

    AbstractTimelineSchedulePage - elementTimeAdjustEnd(String spanSysId, String newEndDateTimeMs)

    Gestionnaire d’événements indiquant quand la date de fin d’un parcours de chronologie a été modifiée.

    Tableau 15. Paramètres
    Nom Type Description
    spanSysId (ID spanSys) Chaîne ID système du parcours actuel en cours d’ajustement.
    newEndDateTimeMs Chaîne La nouvelle heure de fin du parcours, en millisecondes. Assurez-vous d’analyser la chaîne à l’aide de parseInt() avant d’effectuer des comparaisons numériques.
    Tableau 16. Renvoie
    Type Description
    nul

    AbstractTimelineSchedulePage : getItems()

    Gestionnaire d’événements pour le renvoi des éléments de calendrier à afficher sur la chronologie.

    Tableau 17. Paramètres
    Nom Type Description
    aucun
    Tableau 18. Renvoie
    Type Description
    nul

    AbstractTimelineSchedulePage - inputBox(String strInputText)

    Gestionnaire d’événements pour le moment où une chaîne a été saisie dans la zone d’entrée du volet gauche.

    Tableau 19. Paramètres
    Nom Type Description
    strInputText Chaîne Texte qui a été saisi dans la zone de saisie du volet gauche.
    Tableau 20. Renvoie
    Type Description
    nul

    AbstractTimelineSchedulePage : itemMove(String itemSysId, String newItemSysId)

    Gestionnaire d’événements pour le déplacement et le glissement d’un élément de ligne de chronologie vers un autre élément de ligne.

    Tableau 21. Paramètres
    Nom Type Description
    itemSysId Chaîne ID système de l’élément de chronologie associé au parcours actuel.
    nouveauItemSysId Chaîne L’ID système de l’élément de chronologie (une ligne) dans lequel le parcours actuel a été déplacé.
    Tableau 22. Renvoie
    Type Description
    nul

    AbstractTimelineSchedulePage : setDoRenderTimeline(Booléen b)

    Indique s’il faut ou non restituer tous les éléments de chronologie à l’aide de la fonction getItems().

    Tableau 23. Paramètres
    Nom Type Description
    b Booléen Si vrai, restituez la chronologie en effectuant un nouvel appel d’événement au gestionnaire getItems() du serveur.
    Tableau 24. Renvoie
    Type Description
    nul

    AbstractTimelineSchedulePage : setPageTitle(String strTitle)

    Spécifie le texte à afficher comme titre de la chronologie.

    Le titre de la page peut être défini (et mis à jour) à partir de n’importe quel événement interactif ; Toutefois, il est recommandé de le définir pendant l’événement getItems().

    Tableau 25. Paramètres
    Nom Type Description
    strTitle (Titre de la configuration) Chaîne Texte à afficher sur le titre de la chronologie.
    Tableau 26. Renvoie
    Type Description
    nul

    AbstractTimelineSchedulePage : setStatusError(String strTitle, String strMessage)

    Définit la demande d’événement actuelle sur un état d’erreur avec un titre et un message spécifiés à afficher dans la deuxième phase du traitement des événements GlideChronologie .

    Tableau 27. Paramètres
    Nom Type Description
    strTitle (Titre de la configuration) Chaîne Texte à afficher dans le titre de la boîte de dialogue.
    strMessage Chaîne Texte à afficher dans la boîte de dialogue. Le texte peut contenir un formatage HTML.
    Tableau 28. Renvoie
    Type Description
    nul

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

    Définit la demande d’événement actuelle sur un état d’erreur d’invite avec un titre et un message spécifiés à afficher dans une boîte de dialogue de confirmation au cours de la deuxième phase du traitement des événements GlideChronologie . La boîte de confirmation affiche un bouton OK et un bouton Annuler qui génèrent chacun de nouveaux événements qui appelleront les fonctions spécifiées les arguments du paramètre. Les fonctions personnalisées définies pour OK, Annuler et Fermer reçoivent les mêmes arguments de paramètre que celles de l’événement actuel.

    La boîte de confirmation affiche un bouton OK et un bouton Annuler qui génèrent chacun de nouveaux événements qui appelleront les fonctions spécifiées les arguments du paramètre.
    Remarque :
    Les fonctions personnalisées définies pour OK, Annuler et Fermer reçoivent les mêmes arguments de paramètre que celles de l’événement actuel.
    Tableau 29. Paramètres
    Nom Type Description
    strTitle (Titre de la configuration) Chaîne Texte à afficher dans la boîte de dialogue. Le texte peut contenir un formatage HTML.
    strOkFunction Chaîne Fonction à appeler dans la classe de script include actuelle si les utilisateurs cliquent sur le bouton OK .
    strCancelFunction Chaîne Fonction à appeler dans la classe de script include actuelle si l’utilisateur clique sur le bouton Annuler .
    strCloseFunction Chaîne Fonction à appeler dans la classe de script include actuelle si l’utilisateur clique sur le bouton Fermer .
    Tableau 30. Renvoie
    Type Description
    nul 
    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)

    Définit la demande d’événement actuel sur un état de réussite avec un titre et un message spécifiés à afficher dans la deuxième phase du traitement des événements GlideChronologie .

    Tableau 31. Paramètres
    Nom Type Description
    strTitle (Titre de la configuration) Chaîne Texte à afficher dans le titre de la boîte de dialogue.
    strMessage Chaîne Texte à afficher dans la boîte de dialogue. Le texte peut contenir un formatage HTML.
    Tableau 32. Renvoie
    Type Description
    nul