GlideModal : client

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 3 minutes de lecture
  • L’API GlideModal fournit des méthodes pour afficher une superposition de contenu.

    Utilisez ces méthodes dans les scripts partout où vous pouvez utiliser JavaScript côté client. Ces méthodes sont le plus souvent appelées à partir d’une action d’interface utilisateur avec la case Client cochée.

    Il s’agit d’un remplacement complet des API GlideWindow et GlideDialogWindow .
    Figure 1. Exemple de superposition
    Exemple de superposition

    GlideModal : GlideModal(ID de chaîne, booléen readOnly, largeur numérique)

    Crée une instance de la classe GlideModalV3.

    Tableau 1. Paramètres
    Nom Type Description
    id Chaîne Page d’interface utilisateur à charger dans le modal.
    readOnly Booléen Marqueur indiquant s’il faut masquer le bouton Fermer dans le modal.
    Valeurs valides :
    • true : n’affiche pas le bouton Fermer dans la fenêtre modale.
    • false : affiche le bouton Fermer dans le modal.

    Valeur par défaut : false

    largeur Numéro Largeur du modal en pixels.

    Par défaut :

    Largeur maximale : 900 pixels

    Remarque :
    Vous pouvez également définir la largeur de la fenêtre modale à l’aide de la GlideModal : setWidth(largeur du nombre) méthode.

    GlideModal : obtenir (ID de chaîne)

    Obtenir un objet GlideModal par ID.

    Tableau 2. Paramètres
    Nom Type Description
    id Chaîne ID d’élément de l’objet GlideModal.
    Tableau 3. Renvoie
    Type Description
    GlideModal L’objet.

    GlideModal : getPreference(nom de la chaîne)

    Renvoie la valeur de la préférence spécifiée (propriété).

    L’invocation d’actions qui créent le modal crée généralement aussi les préférences nécessaires pour le modal à l’aide de la GlideModal : setPreference(nom de chaîne, valeur de chaîne) méthode. Le script client de la page d’interface utilisateur utilise ensuite ces préférences à l’aide de cette méthode.

    Tableau 4. Paramètres
    Nom Type Description
    nom Chaîne Nom de la valeur de préférence à récupérer. Cette valeur doit avoir été définie au préalable sur le modal à l’aide de la GlideModal : setPreference(nom de chaîne, valeur de chaîne) méthode.
    Tableau 5. Renvoie
    Type Description
    Chaîne Valeur de la préférence spécifiée.

    Cet exemple montre un cas simple de définition d’une préférence, puis de récupération de cette préférence à partir d’une fenêtre modale spécifiée.

    var gm = new GlideModal('UI_dialog_name');
    //Sets the dialog title
    gm.setTitle('Show title');
    
    //sets the value of the preference table
    gm.setPreference('table', 'incident');
    
    //gets the value of the preference table
    var title = gm.getPreference('table');

    GlideModal - render()

    Affiche la page d’interface utilisateur dans le modal.

    Tableau 6. Paramètres
    Nom Type Description
    Aucun
    Tableau 7. Renvoie
    Type Description
    nul
    var gm = new GlideModal("UI_dialog_name");
    
    //Sets the dialog title
    gm.setTitle('Show title');		      	
    gm.setWidth(550);
    
    //Opens the dialog
    gm.render();

    GlideModal - renderWithContent(Object html)

    Affichez une fenêtre modale avec le contenu HTML spécifié.

    La méthode renderWithContent() remplace la méthode render() et ne demande pas qu’une page d’interface utilisateur s’affiche.

    Tableau 8. Paramètres
    Nom Type Description
    html Objet Contenu HTML à afficher dans le modal.
    Tableau 9. Renvoie
    Type Description
    nul

    GlideModal - renderWithContent(String html)

    Affichez une fenêtre modale avec le contenu HTML spécifié.

    La méthode renderWithContent() remplace la méthode render() et ne demande pas qu’une page d’interface utilisateur s’affiche.

    Tableau 10. Paramètres
    Nom Type Description
    html Chaîne Contenu HTML à afficher dans le modal.
    Tableau 11. Renvoie
    Type Description
    nul

    GlideModal : setPreference(nom de chaîne, valeur de chaîne)

    Définit le champ spécifié dans le formulaire actuel sur la valeur spécifiée.

    Tableau 12. Paramètres
    Nom Type Description
    nom Chaîne Nom du champ de formulaire à mettre à jour.

    Si ce champ n’existe pas sur le formulaire actuel, la demande est ignorée.

    valide Chaîne Valeur à stocker dans le champ de formulaire spécifié.
    Tableau 13. Renvoie
    Type Description
    nul
    var gm = new GlideModal('UI_dialog_name');
    //Sets the dialog title
    gm.setTitle('Show title'); 
    gm.setPreference('table', 'task'); 			
    gm.setPreference('name', 'value');        	
    
    //Opens the dialog
    gm.render();

    GlideModal : setPreferenceAndReload(Propriétés du tableau)

    Définissez les propriétés et rechargez le modal.

    Tableau 14. Paramètres
    Nom Type Description
    Propriétés de Tableau Un tableau de paires nom-valeur à définir.
    Tableau 15. Renvoie
    Type Description
    nul

    GlideModal : setTitle (titre de la chaîne)

    Définit le titre du modal.

    Tableau 16. Paramètres
    Nom Type Description
    Titre Chaîne Titre à afficher
    Tableau 17. Renvoie
    Type Description
    nul
    var dialog = new GlideModal('UI_dialog_name');
    
    //Sets the dialog title
    dialog.setTitle('Show title');
    dialog.setPreference('name', 'value');
     			      	        
    //Opens the dialogdialog.render(); 
    

    GlideModal : setWidth(largeur du nombre)

    Définit la largeur du modal en pixels.

    Vous pouvez également définir la largeur d’un modal lorsque vous l’instanciez pour la première fois à l’aide de la GlideModal : GlideModal(ID de chaîne, booléen readOnly, largeur numérique) méthode.

    Tableau 18. Paramètres
    Nom Type Description
    largeur Numéro Nombre de pixels à définir comme largeur du modal.

    Maximum : 900 pixels

    Tableau 19. Renvoie
    Type Description
    nul
    var dialog = new GlideModal('UI_dialog_name');
    
    //Sets the dialog title
    dialog.setTitle('Show title'); 
    dialog.setPreference('name', 'value'); 			      	
    dialog.setWidth(550);
    
    //Opens the dialog
    dialog.render();

    GlideModal : switchView(String newView)

    Changez la vue et rechargez la fenêtre modale.

    Tableau 20. Paramètres
    Nom Type Description
    newView Chaîne Vue à utiliser.
    Tableau 21. Renvoie
    Type Description
    nul