GlideListProperties : global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 13 minutes de lecture

    • L’API GlideListProperties fournit des méthodes pour créer une liste et définir des propriétés de liste. Par exemple, vous pouvez définir si une liste dispose d’un filtre, de fils d’Ariane et d’une recherche.

    Pour utiliser cette classe, vous devez d’abord instancier un objet GlideListProperties à l’aide du constructeur.

    Pour obtenir un exemple de cette classe dans le système de base, configurez une liste et sélectionnez Tout. La liste à onglets des options utilise la page d’interface utilisateur personalize_all et personalize_all_list macro d’interface utilisateur pour définir les propriétés de la liste telles que le titre, le menu contextuel et les fils d’Ariane.

    Cette API inclut des méthodes qui fournissent des informations sur les paramètres GlideList existants et fournit des options pour définir diverses propriétés GlideList. Pour en savoir plus sur la modification des paramètres de l’interface utilisateur, reportez-vous à la section GlideList2 (g_list) : client ou GlideList (Now Experience) : client.

    GlideListProperties : GlideListProperties()

    Instancie un objet GlideListProperties.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun 
    var list = new GlideListProperties();

    GlideListProperties : getListID()

    Renvoie l’ID unique d’une liste.

    Tableau 2. Paramètres
    Nom Type Description
    Aucun
    Tableau 3. Renvoie
    Type Description
    Chaîne ID unique pour la liste 
    var list = new GlideListProperties();
var getID = list.getListID();
gs.print(getID);

    Sortie : 3519f77ad95f5700964f387107a8a394

    GlideListProperties : getListName()

    Renvoie le nom de la liste.

    Tableau 4. Paramètres
    Nom Type Description
    Aucun
    Tableau 5. Renvoie
    Type Description
    Chaîne Nom de la liste. 
    var list = new GlideListProperties();
var setName = list.setListName("my custom list");
var getName = list.getListName();
gs.print(getName);

    Sortie : Ma liste personnalisée

    GlideListProperties : getTitle()

    Obtenir le titre d’une liste.

    Tableau 6. Paramètres
    Nom Type Description
    Aucun
    Tableau 7. Renvoie
    Type Description
    Chaîne Titre de la liste.

    Exemple d’explication facultatif

    var list = new GlideListProperties();
var title = list.setTitle("My title");
var getTitle = list.getTitle();
gs.print(getTitle);

    Sortie : Mon titre

    GlideListProperties : hasActions()

    Indique si l’option Actions sur les lignes sélectionnées est activée ou non pour une liste.

    Tableau 8. Paramètres
    Nom Type Description
    Aucun
    Tableau 9. Renvoie
    Type Description
    Booléen Renvoie la valeur true si l’option actions est activée pour une liste. 
    var list = new GlideListProperties();
var actions = list.setHasActions(true);
var hasActions = list.hasActions();
gs.print(hasActions);

    Sortie : vrai

    GlideListProperties : hasBottomNav()

    Indique si une liste a une navigation en bas ou non.

    Tableau 10. Paramètres
    Nom Type Description
    Aucun
    Tableau 11. Renvoie
    Type Description
    Booléen Si la valeur est vraie , la liste comporte une navigation inférieure. 
    var lp = new GlideListProperties();
var Nav = lp.setHasBottomNav(true);
var hasNav = lp.hasBottomNav();
gs.print(hasNav);

    Sortie : vrai

    GlideListProperties : hasBottomVCR()

    Indique si les contrôles de navigation de page apparaissent ou non dans le pied de page d’une liste.

    Tableau 12. Paramètres
    Nom Type Description
    Aucun
    Tableau 13. Renvoie
    Type Description
    Booléen Si vrai , les contrôles de navigation de page apparaissent dans le pied de page d’une liste. 
    var list = new GlideListProperties();
var vcr = list.setHasBottomVCR(true);
var hasVCR = list.hasBottomVCR();
gs.print(hasVCR);

    Sortie : vrai

    GlideListProperties : hasFilter()

    Indique si une liste a un filtre ou non.

    La propriété filter est un parent de la propriété de fils d’Ariane. Si la propriété filter est répertoriée comme false et que le fil d’Ariane est listé comme true, hasFilter() renvoie toujours true, car la propriété enfant est marquée comme true.

    Tableau 14. Paramètres
    Nom Type Description
    Aucun
    Tableau 15. Renvoie
    Type Description
    Booléen Si vrai , une icône de filtre apparaît avec la liste, ou la propriété de fil d’Ariane est répertoriée comme vrai. Si cette propriété est définie sur false, la propriété filter et la propriété de fil d’Ariane sont marquées comme false. 
    var list = new GlideListProperties();
var filter = list.setHasFilter(true);
var breadcrumbs = list.setHasBreadcrumbs(true);
var hasFilter = list.hasFilter();
gs.print(hasFilter);

    Sortie : vrai

    GlideListProperties : hasHeader()

    Renvoie si une liste a un en-tête ou non.

    Tableau 16. Paramètres
    Nom Type Description
    Aucun
    Tableau 17. Renvoie
    Type Description
    Booléen Renvoie la valeur true si une liste possède un en-tête. 
    var list = new GlideListProperties();
var header = list.setHasHeader(true);
var hasHeader = list.hasHeader();
gs.print(hasHeader);

    Sortie : vrai

    GlideListProperties : hasHeaderContextMenu()

    Indique si un menu contextuel d’en-tête est activé ou non pour une liste.

    Tableau 18. Paramètres
    Nom Type Description
    Aucun
    Tableau 19. Renvoie
    Type Description
    Booléen Si cette propriété est définie sur vrai , un menu contextuel s’affiche en regard de chaque en-tête de colonne d’une liste. 
    var list = new GlideListProperties();
var header = list.setHasHeaderContextMenu(true);
var hasHeader = list.hasHeaderContextMenu();
gs.print(hasHeader);

    Sortie : vrai

    GlideListProperties : hasListMechanic()

    Indique si la personnalisation de la liste est activée pour une liste.

    Tableau 20. Paramètres
    Nom Type Description
    Aucun
    Tableau 21. Renvoie
    Type Description
    Booléen Si vrai , la mécanique de liste est activée pour une liste et l’icône Personnaliser la liste apparaît sur la page. 
    var list = new GlideListProperties();
var mechanic = list.setHasListMechanic(true);
var hasMechanic = list.hasListMechanic();
gs.print(hasMechanic);

    Sortie : vrai

    GlideListProperties : hasPopup()

    Indique si une liste peut avoir des fenêtres contextuelles ou non.

    Tableau 22. Paramètres
    Nom Type Description
    Aucun
    Tableau 23. Renvoie
    Type Description
    Booléen Renvoie la valeur true si la liste autorise les fenêtres contextuelles. 
    var list = new GlideListProperties();
var popup = list.setHasPopup(true);
var hasPopup = list.hasPopup();
gs.print(hasPopup);

    Sortie : vrai

    GlideListProperties : hasRowContextMenu()

    Indique si les lignes d’une liste ont un menu contextuel ou non.

    Tableau 24. Paramètres
    Nom Type Description
    Aucun
    Tableau 25. Renvoie
    Type Description
    Booléen Si cette propriété est définie sur vrai , une ligne de liste peut avoir un menu contextuel. 
    var list = new GlideListProperties();
var contextMenu = list.setHasRowContextMenu(true);
var hasContextMenu = list.hasRowContextMenu();
gs.print(hasContextMenu);

    Sortie : vrai

    GlideListProperties : hasSearch()

    Indique si la barre de recherche est activée ou non pour une liste.

    Tableau 26. Paramètres
    Nom Type Description
    Aucun
    Tableau 27. Renvoie
    Type Description
    Booléen Si vrai , la barre de recherche apparaît dans l’en-tête d’une liste. 
    var list = new GlideListProperties();
var search = list.setHasSearch(true);
var hasSearch = list.hasSearch();
gs.print(hasSearch);

    Sortie : vrai

    GlideListProperties : hasTitle()

    Indique si le titre de liste apparaît ou non dans l’en-tête de liste.

    Le menu contextuel du titre est une propriété enfant du titre. Si setHasTitleContextMenu est défini sur true, hasTitle renvoie également true, même si setHasTitle est défini sur false.

    Tableau 28. Paramètres
    Nom Type Description
    Aucun
    Tableau 29. Renvoie
    Type Description
    Booléen Si vrai , le titre de liste apparaît dans l’en-tête de liste. 
    var list = new GlideListProperties();
var title = list.setHasTitle(true);
var contextMenu = list.setHasTitleContextMenu(true);
var hasTitle = list.hasTitle();
gs.print(hasTitle);

    Sortie : vrai

    GlideListProperties : hasTitleContextMenu()

    Indique si un menu contextuel apparaît dans un en-tête de liste.

    Le menu contextuel du titre est une propriété enfant du titre. Si setHasTitleContextMenu est défini sur true, hasTitle renvoie également true, même si setHasTitle est défini sur false.

    Tableau 30. Paramètres
    Nom Type Description
    Aucun
    Tableau 31. Renvoie
    Type Description
    Booléen Si vrai , le menu contextuel apparaît dans l’en-tête de liste en regard du titre de liste.

    Exemple d’explication facultatif

    var list = new GlideListProperties();
var contextMenu = list.setHasTitleContextMenu(true);
var hasContextMenu = list.hasTitleContextMenu();
gs.print(hasContextMenu);

    Sortie : vrai

    GlideListProperties : hasTopVCR()

    Indique si les contrôles de navigation de page apparaissent ou non dans l’en-tête d’une liste.

    Tableau 32. Paramètres
    Nom Type Description
    Aucun
    Tableau 33. Renvoie
    Type Description
    Booléen Si vrai , les contrôles de navigation de page apparaissent dans l’en-tête d’une liste. 
    var list = new GlideListProperties();
var vcr = list.setHasTopVCR(true);
var hasVCR = list.hasTopVCR();
gs.print(hasVCR);

    Sortie : vrai

    GlideListProperties : isOmitFilter()

    Indique si l’option Omettre le filtre a été sélectionnée ou non.

    Les indicateurs d’omission ListControl sont prioritaires dans la mesure où s’ils sont définis, ils annulent la définition de leur indicateur correspondant. Par exemple, si le marqueur Afficher le filtre a été défini sur vrai, mais que le filtre d’omition ListControl est vrai, la vérification de hasFilter renvoie la valeur faux.

    Tableau 34. Paramètres
    Nom Type Description
    Aucun
    Tableau 35. Renvoie
    Type Description
    Booléen Renvoie vrai ou faux si le marqueur Omettre le filtre a été sélectionné. 
    var lp = new GlideListProperties();
var omitFilter = lp.isOmitFilter();
gs.print(omitFilter);

    Sortie : false

    GlideListProperties : isSaveFilterHidden()

    Indique si le bouton Enregistrer le filtre est masqué dans le générateur de conditions.

    Tableau 36. Paramètres
    Nom Type Description
    Aucun
    Tableau 37. Renvoie
    Type Description
    Booléen Si vrai, le bouton Enregistrer le filtre est masqué dans le générateur de conditions. 
    var list = new GlideListProperties();
var SaveFilter = list.setSaveFilterHidden(true);
var hasSaveFilter = list.isSaveFilterHidden();
gs.print(hasSaveFilter);

    Sortie : vrai

    GlideListProperties : isToggleHeader()

    Indique si l’activation/la désactivation des colonnes d’en-tête est disponible ou non pour une liste.

    Tableau 40. Paramètres
    Nom Type Description
    Aucun
    Tableau 41. Renvoie
    Type Description
    Booléen Si vrai , les utilisateurs peuvent afficher ou masquer les en-têtes de colonne d’une table. 
    var list = new GlideListProperties();
var toggle = list.setToggleHeader(true);
var hasToggle = list.isToggleHeader();
gs.print(hasToggle);

    Sortie : vrai

    GlideListProperties : setCanChangeView(Boolean onOff)

    Déterminez si l’utilisateur peut modifier la vue de la liste.

    Tableau 42. Paramètres
    Nom Type Description
    onOff Booléen Si la valeur est définie sur Faux , les utilisateurs ne peuvent pas modifier la vue de liste. Par défaut, le changement de vues est activé.
    Tableau 43. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var changeView = list.setCanChangeView(true);

    GlideListProperties : setCanGroup(Boolean onOff)

    Déterminez si les utilisateurs peuvent regrouper des éléments dans une liste.

    Tableau 44. Paramètres
    Nom Type Description
    onOff Booléen Si la valeur est définie sur false, l’option Grouper par n’apparaît pas dans le menu contextuel de colonne. Par défaut, l’option Grouper par apparaît dans le menu contextuel de la liste.
    Tableau 45. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var canGroup = list.setCanGroup(true);

    GlideListProperties : setCanSort(Boolean onOff)

    Déterminez si l’option de tri est disponible dans une liste.

    Tableau 46. Paramètres
    Nom Type Description
    onOff Booléen Si la valeur est définie sur faux, l’option de tri n’apparaît pas dans le menu contextuel de la liste de colonnes et les utilisateurs ne peuvent pas cliquer sur le titre de la colonne pour modifier l’ordre de la liste.
    Tableau 47. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var canSort = list.setCanSort(true);

    GlideListProperties : setContextMenus(Boolean onOff)

    Affiche ou masque tous les menus contextuels disponibles pour une liste.

    Tableau 48. Paramètres
    Nom Type Description
    onOff Booléen Si la valeur est définie sur vrai , affiche le menu contextuel du titre, le menu contextuel de l’en-tête et le menu contextuel de la liste d’une liste.
    Tableau 49. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var context = list.setContextMenus(true);

    GlideListProperties : setHasActions(Boolean)

    Déterminez si les options Actions sur les lignes sélectionnées s’affichent au bas d’une liste.

    Tableau 50. Paramètres
    Nom Type Description
    onOff Booléen Si la valeur est définie sur vrai, les options d’action d’une liste s’affichent.
    Tableau 51. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var actions = list.setHasActions(true);

    GlideListProperties : setHasBottomNav(Boolean onOff)

    Déterminez si les actions de navigation en bas d’une liste sont masquées ou non.

    Tableau 52. Paramètres
    Nom Type Description
    onOff Booléen Si la valeur est vrai, ajoute la navigation au bas d’une liste.
    Tableau 53. Renvoie
    Type Description
    nul 
    var lp = new GlideListProperties();
var bottom = lp.setHasBottomNav(true);

    GlideListProperties : setHasBreadcrumbs(Boolean onOff)

    Déterminez si les fils d’Ariane apparaissent ou non en haut d’une liste.

    Les fils d’Ariane sont un enfant des filtres. Pour masquer complètement le fil d’Ariane, vous devez également définir le filtre sur faux.

    Tableau 54. Paramètres
    Nom Type Description
    onOff Booléen Si vrai , les fils d’Ariane apparaissent en haut d’une liste.
    Tableau 55. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var breadcrumbs = list.setHasBreadcrumbs(true);

    GlideListProperties : setHasBottomVCR(Boolean onOff)

    Déterminez si les boutons première page, dernière page, page suivante et page précédente apparaissent en bas de la liste.

    Tableau 56. Paramètres
    Nom Type Description
    onOff Booléen Si vrai, les boutons première page, dernière page, page suivante et page précédente apparaissent en bas de la liste.
    Tableau 57. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var bottomVCR = list.setHasBottomVCR(true);

    GlideListProperties : setHasFilter(Boolean onOff)

    Déterminez si le filtre s’affiche ou non dans le cadre d’une liste.

    Le filtre est un parent de fils d’Ariane. Pour supprimer le filtre, vous devez définir à la fois le filtre et les fils d’Ariane sur faux.

    Tableau 58. Paramètres
    Nom Type Description
    onOff Booléen Si vrai , une icône de filtre apparaît en haut de la liste. Les utilisateurs peuvent utiliser le filtre pour affiner les résultats de la recherche.
    Tableau 59. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var filter = list.setHasFilter(true);

    GlideListProperties : setHasHeader(Boolean onOff)

    Déterminez si une liste affiche un en-tête ou non.

    Tableau 60. Paramètres
    Nom Type Description
    onOff Booléen Si vrai , la liste affiche un en-tête.
    Tableau 61. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var header = list.setHasHeader(true);

    GlideListProperties : setHasHeaderContextMenu(Boolean onOff)

    Déterminez si le menu contextuel s’affiche ou non à côté de chaque colonne d’une liste.

    Tableau 62. Paramètres
    Nom Type Description
    onOff Booléen Si cette propriété est définie sur vrai , le menu contextuel apparaît en regard de chaque colonne d’une liste.
    Tableau 63. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var actions = list.setHasHeaderContextMenu(true);

    GlideListProperties : setHasListMechanic(Boolean onOff)

    Déterminez si une liste dispose ou non d’une option de personnalisation.

    Tableau 64. Paramètres
    Nom Type Description
    onOff Booléen Si vrai , la mécanique de liste est activée et l’icône Personnaliser la liste apparaît sur la page.
    Tableau 65. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var mechanic = list.setHasListMechanic(true);

    GlideListProperties : setHasPopup(Boolean onOff)

    Déterminez si la liste dispose d’une fenêtre contextuelle ou modale.

    Tableau 66. Paramètres
    Nom Type Description
    onOff Booléen Si vrai, la liste peut avoir des fenêtres contextuelles.
    Tableau 67. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var popup = list.setHasPopup(true);

    GlideListProperties : setHasRowContextMenu(Boolean onOff)

    Détermine si les lignes de liste ont un menu contextuel ou non.

    Tableau 68. Paramètres
    Nom Type Description
    onOff Booléen Si la valeur est vraie , les lignes de liste peuvent avoir un menu contextuel.
    Tableau 69. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var contextMenu = list.setHasRowContextMenu(true);

    GlideListProperties : setHasSearch(Boolean onOff)

    Déterminez si une recherche apparaît pour une liste.

    Tableau 70. Paramètres
    Nom Type Description
    onOff Booléen Si vrai , la barre de recherche apparaît dans l’en-tête de liste.
    Tableau 71. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var search = list.setHasSearch(true);

    GlideListProperties : setHasTitle(Boolean onOff)

    Déterminez si le titre de liste apparaît dans l’en-tête.

    Tableau 72. Paramètres
    Nom Type Description
    onOff Booléen Si vrai , le titre de la liste apparaît dans l’en-tête de liste.
    Tableau 73. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var title = list.setHasTitle(true);

    GlideListProperties : setHasTitleContextMenu(Boolean onOff)

    Déterminez si une liste possède ou non un menu contextuel dans l’en-tête.

    Tableau 74. Paramètres
    Nom Type Description
    onOff Booléen Si vrai , le menu contextuel apparaît à côté du titre de liste dans l’en-tête
    Tableau 75. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var contextMenu = list.setHasTitleContextMenu(true);

    GlideListProperties : setHasTopVCR(Boolean onOff)

    Déterminez si une liste possède ou non des contrôles de navigation de page dans l’en-tête de liste.

    Tableau 76. Paramètres
    Nom Type Description
    onOff Booléen Si vrai , les contrôles de navigation de page apparaissent dans l’en-tête d’une liste.
    Tableau 77. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var vcr = list.setHasTopVCR(true);

    GlideListProperties : setHideRows(Boolean onOff)

    Déterminez si les lignes sont visibles dans une liste.

    Tableau 78. Paramètres
    Nom Type Description
    onOff Booléen Si vrai, toutes les lignes d’une liste sont masquées.
    Tableau 79. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var hideRows = list.setHideRows(true);

    GlideListProperties : setListID(ID de chaîne)

    Définissez l’ID unique d’une liste.

    Tableau 80. Paramètres
    Nom Type Description
    ID unique Chaîne L’ID unique pour la liste.
    Tableau 81. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var setID = list.setListID("a9dd1483d99f5700964f387107a8a3ec");
var getID = list.getListID();
gs.print(getID);

    Sortie : a9dd1483d99f5700964f387107a8a3ec

    GlideListProperties : setListName(nom de chaîne)

    Définit un nom pour la liste.

    Tableau 82. Paramètres
    Nom Type Description
    nom Chaîne Nom de la liste.
    Tableau 83. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var name = list.setListName("my custom list");

    GlideListProperties : setSaveFilterHidden(Boolean onOff)

    Déterminez si le bouton Enregistrer le filtre apparaît dans le générateur de conditions.

    Tableau 84. Paramètres
    Nom Type Description
    onOff Booléen Si vrai, le bouton Enregistrer le filtre est masqué.
    Tableau 85. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var saveFilter = list.setSaveFilterHidden(true);

    GlideListProperties : setTitle(titre de la chaîne)

    Définit le titre de la liste.

    Tableau 88. Paramètres
    Nom Type Description
    Titre Chaîne Titre de la liste.
    Tableau 89. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var title = list.setTitle("My title");

    GlideListProperties : setToggleHeader(Boolean onOff)

    Déterminez si les utilisateurs peuvent afficher ou masquer les en-têtes de colonnes d’une table.

    Tableau 90. Paramètres
    Nom Type Description
    onOff Booléen Si vrai , une icône apparaît dans l’en-tête qui permet aux utilisateurs d’afficher ou de masquer les en-têtes de colonne.
    Tableau 91. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var toggle = list.setToggleHeader(true);

    GlideListProperties : setVCR(Boolean onOff)

    Déterminez si les boutons première page, dernière page, page suivante et page précédente apparaissent en haut et en bas de la liste.

    Tableau 92. Paramètres
    Nom Type Description
    onOff Booléen Si la valeur est définie sur faux, la liste ne comporte aucun des boutons de navigation de page d’une liste.
    Tableau 93. Renvoie
    Type Description
    nul 
    var list = new GlideListProperties();
var VCR = list.setVCR(true);