GlideListProperties - Global

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 13 min. de leitura
  • A API GlideListProperties fornece métodos para criar uma lista e definir propriedades da lista. Por exemplo, você pode definir se uma lista tem um filtro, trilhas e pesquisa.

    Para usar esta classe, você deve primeiro instanciar um objeto GlideListProperties usando o construtor.

    Para obter um exemplo desta classe no sistema de base, configure uma lista e selecione Todos. A lista com guias de opções usa a página de IU personalize_all e a macro de IU personalize_all_list para definir propriedades da lista, como título, menu de contexto e trilhas.

    Esta API inclui métodos que fornecem informações sobre as configurações de GlideList existentes e fornece opções para definir várias propriedades de GlideList. Para obter informações sobre como modificar configurações na IU, consulte GlideList2 (g_list) - Cliente ou GlideList (Now Experience) – Cliente.

    GlideListProperties — GlideListProperties()

    Instancia um objeto GlideListProperties.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum
    var list = new GlideListProperties();
    

    GlideListProperties – getListID()

    Retorna o ID exclusivo de uma lista.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 3. Retorna
    Tipo Descrição
    Cadeia de caracteres ID exclusivo da lista
    var list = new GlideListProperties();
    var getID = list.getListID();
    gs.print(getID);

    Saída: 3519f77ad95f5700964f387107a8a394

    GlideListProperties – getListName()

    Retorna o nome da lista.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 5. Retorna
    Tipo Descrição
    Cadeia de caracteres Nome da lista.
    var list = new GlideListProperties();
    var setName = list.setListName("my custom list");
    var getName = list.getListName();
    gs.print(getName);

    Saída: minha lista personalizada

    GlideListProperties – getTitle()

    Obtenha o título de uma lista.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 7. Retorna
    Tipo Descrição
    Cadeia de caracteres O título da lista.

    Explicação de exemplo opcional

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

    Saída: Meu título

    GlideListProperties – hasActions()

    Retorna se a opção Ações nas linhas selecionadas está habilitada ou não para uma lista.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 9. Retorna
    Tipo Descrição
    Booliano Retorna verdadeiro se a opção de ações estiver habilitada para uma lista.
    var list = new GlideListProperties();
    var actions = list.setHasActions(true);
    var hasActions = list.hasActions();
    gs.print(hasActions);

    Saída: verdadeiro

    GlideListProperties – hasBottomNav()

    Retorna se uma lista tem ou não navegação na parte inferior.

    Tabela 10. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 11. Retorna
    Tipo Descrição
    Booliano Se retornar verdadeiro, a lista terá navegação inferior.
    var lp = new GlideListProperties();
    var Nav = lp.setHasBottomNav(true);
    var hasNav = lp.hasBottomNav();
    gs.print(hasNav);

    Saída: verdadeiro

    GlideListProperties – hasBottomVCR()

    Retorna se os controles de navegação da página aparecem ou não no rodapé de uma lista.

    Tabela 12. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 13. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, os controles de navegação da página serão exibidos no rodapé de uma lista.
    var list = new GlideListProperties();
    var vcr = list.setHasBottomVCR(true);
    var hasVCR = list.hasBottomVCR();
    gs.print(hasVCR);

    Saída: verdadeiro

    GlideListProperties – hasFilter()

    Retorna se uma lista tem ou não um filtro.

    A propriedade de filtro é primária da propriedade de trilhas. Se a propriedade de filtro estiver listada como falsa e a trilha estiver listada como verdadeira, hasFilter() ainda retornará verdadeiro porque a propriedade secundária está marcada como verdadeira.

    Tabela 14. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 15. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, um ícone de filtro aparecerá com a lista ou a propriedade de trilha será listada como verdadeira. Se for falso, a propriedade de filtro e a propriedade de trilhas serão marcadas como falsas.
    var list = new GlideListProperties();
    var filter = list.setHasFilter(true);
    var breadcrumbs = list.setHasBreadcrumbs(true);
    var hasFilter = list.hasFilter();
    gs.print(hasFilter);
    

    Saída: verdadeiro

    GlideListProperties - hasHeader()

    Retorna se uma lista tem ou não um cabeçalho.

    Tabela 16. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 17. Retorna
    Tipo Descrição
    Booliano Retorna verdadeiro se uma lista tiver um cabeçalho.
    var list = new GlideListProperties();
    var header = list.setHasHeader(true);
    var hasHeader = list.hasHeader();
    gs.print(hasHeader);

    Saída: verdadeiro

    GlideListProperties - hasHeaderContextMenu()

    Retorna se um menu de contexto de cabeçalho está habilitado ou não para uma lista.

    Tabela 18. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 19. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, um menu de contexto será exibido ao lado de cada cabeçalho de coluna em uma lista.
    var list = new GlideListProperties();
    var header = list.setHasHeaderContextMenu(true);
    var hasHeader = list.hasHeaderContextMenu();
    gs.print(hasHeader);

    Saída: verdadeiro

    GlideListProperties - hasListMecânico()

    Retorna se a personalização de lista está habilitada para uma lista.

    Tabela 20. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 21. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, a mecânica de lista será habilitada para uma lista e o ícone Personalizar lista aparecerá na página.
    var list = new GlideListProperties();
    var mechanic = list.setHasListMechanic(true);
    var hasMechanic = list.hasListMechanic();
    gs.print(hasMechanic);

    Saída: verdadeiro

    GlideListProperties – hasPopup()

    Retorna se uma lista pode ou não ter janelas pop-up.

    Tabela 22. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 23. Retorna
    Tipo Descrição
    Booliano Retorna verdadeiro se a lista permitir pop-ups.
    var list = new GlideListProperties();
    var popup = list.setHasPopup(true);
    var hasPopup = list.hasPopup();
    gs.print(hasPopup);

    Saída: verdadeiro

    GlideListProperties - hasRowContextMenu()

    Retorna se as linhas em uma lista têm ou não um menu de contexto.

    Tabela 24. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 25. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, uma linha de lista pode ter um menu de contexto.
    var list = new GlideListProperties();
    var contextMenu = list.setHasRowContextMenu(true);
    var hasContextMenu = list.hasRowContextMenu();
    gs.print(hasContextMenu);

    Saída: verdadeiro

    GlideListProperties – hasSearch()

    Retorna se a barra de pesquisa está habilitada ou não para uma lista.

    Tabela 26. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 27. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, a barra de pesquisa aparecerá no cabeçalho de uma lista.
    var list = new GlideListProperties();
    var search = list.setHasSearch(true);
    var hasSearch = list.hasSearch();
    gs.print(hasSearch);

    Saída: verdadeiro

    GlideListProperties – hasTitle()

    Retorna se o título da lista aparece ou não no cabeçalho da lista.

    O menu de contexto do título é uma propriedade secundária de título. Se setHasTitleContextMenu estiver definido como verdadeiro, hasTitle também retornará verdadeiro, mesmo se setHasTitle estiver definido como falso.

    Tabela 28. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 29. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, o título da lista aparecerá no cabeçalho da lista.
    var list = new GlideListProperties();
    var title = list.setHasTitle(true);
    var contextMenu = list.setHasTitleContextMenu(true);
    var hasTitle = list.hasTitle();
    gs.print(hasTitle);
    

    Saída: verdadeiro

    GlideListProperties – hasTitleContextMenu()

    Retorna se um menu de contexto aparece em um cabeçalho de lista.

    O menu de contexto do título é uma propriedade secundária de título. Se setHasTitleContextMenu estiver definido como verdadeiro, hasTitle também retornará verdadeiro, mesmo se setHasTitle estiver definido como falso.

    Tabela 30. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 31. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, o menu de contexto aparecerá no cabeçalho da lista ao lado do título da lista.

    Explicação de exemplo opcional

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

    Saída: verdadeiro

    GlideListProperties – hasTopVCR()

    Retorna se os controles de navegação de página aparecem ou não no cabeçalho de uma lista.

    Tabela 32. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 33. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, os controles de navegação de página serão exibidos no cabeçalho de uma lista.
    var list = new GlideListProperties();
    var vcr = list.setHasTopVCR(true);
    var hasVCR = list.hasTopVCR();
    gs.print(hasVCR);

    Saída: verdadeiro

    GlideListProperties – isOmitFilter()

    Retorna se a opção de omitir filtro foi selecionada ou não.

    Os sinalizadores de omissão de ListControl têm precedência porque, se forem definidos, eles negam a configuração do sinalizador correspondente. Por exemplo, se o sinalizador mostrar filtro tiver sido definido como verdadeiro, mas o filtro de omissão de ListControl for verdadeiro, a verificação de hasFilter retornará falso.

    Tabela 34. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 35. Retorna
    Tipo Descrição
    Booliano Retorna verdadeiro ou falso se o sinalizador de omissão de filtro tiver sido selecionado.
    var lp = new GlideListProperties();
    var omitFilter = lp.isOmitFilter();
    gs.print(omitFilter);

    Saída: falso

    GlideListProperties – isSaveFilterHidden()

    Retorna se o botão Salvar filtro está oculto no Construtor de condições.

    Tabela 36. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 37. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, o botão Salvar filtro ficará oculto no Construtor de condições.
    var list = new GlideListProperties();
    var SaveFilter = list.setSaveFilterHidden(true);
    var hasSaveFilter = list.isSaveFilterHidden();
    gs.print(hasSaveFilter);

    Saída: verdadeiro

    GlideListProperties – isToggleHeader()

    Retorna se a alternância das colunas de cabeçalho está disponível ou não para uma lista.

    Tabela 40. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 41. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, os usuários podem mostrar ou ocultar os cabeçalhos de coluna de uma tabela.
    var list = new GlideListProperties();
    var toggle = list.setToggleHeader(true);
    var hasToggle = list.isToggleHeader();
    gs.print(hasToggle);

    Saída: verdadeiro

    GlideListProperties – setCanChangeView(Booliano onOff)

    Determine se o usuário pode mudar a exibição da lista.

    Tabela 42. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se for falso, os usuários não poderão mudar a exibição de lista. Por padrão, a mudança de exibições está habilitada.
    Tabela 43. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var changeView = list.setCanChangeView(true);

    GlideListProperties – setCanGroup(Boolean onOff)

    Determine se os usuários podem agrupar itens em uma lista.

    Tabela 44. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se for falso, a opção agrupar por não aparecerá no menu de contexto da coluna. Por padrão, a opção agrupar por aparece no menu de contexto da lista.
    Tabela 45. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var canGroup = list.setCanGroup(true);

    GlideListProperties – setCanSort(Booliano onOff)

    Determine se a opção de classificação está disponível em uma lista.

    Tabela 46. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se for falso, a opção de classificação não aparecerá no menu de contexto da lista de colunas e os usuários não poderão clicar no título da coluna para mudar a ordem da lista.
    Tabela 47. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var canSort = list.setCanSort(true);

    GlideListProperties – setContextMenus(Boolean onOff)

    Exibe ou oculta todos os menus de contexto disponíveis para uma lista.

    Tabela 48. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se definido como verdadeiro, exibirá o menu de contexto do título, o menu de contexto do cabeçalho e o menu de contexto da lista para uma lista.
    Tabela 49. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var context = list.setContextMenus(true);

    GlideListProperties – setHasActions(Booliano)

    Determine se as opções Ações em linhas selecionadas são exibidas na parte inferior de uma lista.

    Tabela 50. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, exibe opções de ação para uma lista.
    Tabela 51. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var actions = list.setHasActions(true);

    GlideListProperties – setHasBottomNav(Boolean onOff)

    Determine se as ações de navegação na parte inferior de uma lista estão ocultas ou não.

    Tabela 52. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Quando verdadeiro, adiciona a navegação à parte inferior de uma lista.
    Tabela 53. Retorna
    Tipo Descrição
    vazio
    var lp = new GlideListProperties();
    var bottom = lp.setHasBottomNav(true);

    GlideListProperties – setHasBreadcrumbs(Booliano onOff)

    Determina se as trilhas aparecem ou não na parte superior de uma lista.

    As trilhas são secundárias dos filtros. Para ocultar completamente as trilhas, você também precisa definir o filtro como falso.

    Tabela 54. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se for verdadeiro, as trilhas serão exibidas na parte superior de uma lista.
    Tabela 55. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var breadcrumbs = list.setHasBreadcrumbs(true);

    GlideListProperties – setHasBottomVCR(Boolean onOff)

    Determine se os botões de primeira página, última página, próxima página e página anterior aparecem na parte inferior da lista.

    Tabela 56. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, os botões de primeira página, última página, próxima página e página anterior serão exibidos na parte inferior da lista.
    Tabela 57. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var bottomVCR = list.setHasBottomVCR(true);

    GlideListProperties – setHasFilter(Booliano onOff)

    Determine se o filtro será exibido ou não como parte de uma lista.

    O filtro é um pai de trilhas. Para remover o filtro, você precisa definir o filtro e as trilhas como falsos.

    Tabela 58. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, um ícone de filtro aparecerá na parte superior da lista. Os usuários podem usar o filtro para restringir os resultados da pesquisa.
    Tabela 59. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var filter = list.setHasFilter(true);

    GlideListProperties – setHasHeader(Boolean onOff)

    Determine se uma lista exibirá ou não um cabeçalho.

    Tabela 60. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, a lista exibirá um cabeçalho.
    Tabela 61. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var header = list.setHasHeader(true);

    GlideListProperties – setHasHeaderContextMenu(Booliano onOff)

    Determine se o menu de contexto aparecerá ou não ao lado de cada coluna em uma lista.

    Tabela 62. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, o menu de contexto aparecerá ao lado de cada coluna em uma lista.
    Tabela 63. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var actions = list.setHasHeaderContextMenu(true);

    GlideListProperties – setHasListMechanic(Boolean onOff)

    Determine se uma lista tem ou não a opção de personalização.

    Tabela 64. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, a mecânica de lista será habilitada e o ícone Personalizar lista aparecerá na página.
    Tabela 65. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var mechanic = list.setHasListMechanic(true);

    GlideListProperties – setHasPopup(Booliano onOff)

    Determine se a lista tem uma janela pop-up ou modal.

    Tabela 66. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, a lista pode ter janelas pop-up.
    Tabela 67. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var popup = list.setHasPopup(true);

    GlideListProperties – setHasRowContextMenu(Booliano onOff)

    Determina se as linhas da lista têm ou não um menu de contexto.

    Tabela 68. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Quando verdadeiro, as linhas da lista podem ter um menu de contexto.
    Tabela 69. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var contextMenu = list.setHasRowContextMenu(true);

    GlideListProperties – setHasSearch(Boolean onOff)

    Determine se a pesquisa aparece para uma lista.

    Tabela 70. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, a barra de pesquisa aparecerá no cabeçalho da lista.
    Tabela 71. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var search = list.setHasSearch(true);

    GlideListProperties – setHasTitle(Booliano onOff)

    Determine se o título da lista aparece no cabeçalho.

    Tabela 72. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, o título da lista aparecerá no cabeçalho da lista.
    Tabela 73. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var title = list.setHasTitle(true);
    

    GlideListProperties – setHasTitleContextMenu(Booliano onOff)

    Determine se uma lista tem ou não um menu de contexto no cabeçalho.

    Tabela 74. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, o menu de contexto aparecerá ao lado do título da lista no cabeçalho
    Tabela 75. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var contextMenu = list.setHasTitleContextMenu(true);

    GlideListProperties – setHasTopVCR(Boolean onOff)

    Determine se uma lista tem ou não os controles de navegação de página no cabeçalho da lista.

    Tabela 76. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, os controles de navegação de página serão exibidos no cabeçalho de uma lista.
    Tabela 77. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var vcr = list.setHasTopVCR(true);

    GlideListProperties - setHideRows(Booliano onOff)

    Determine se as linhas estão visíveis em uma lista.

    Tabela 78. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, todas as linhas serão ocultas para uma lista.
    Tabela 79. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var hideRows = list.setHideRows(true);

    GlideListProperties - setListID(ID da cadeia de caracteres)

    Defina o ID exclusivo de uma lista.

    Tabela 80. Parâmetros
    Nome Tipo Descrição
    ID exclusiva Cadeia de caracteres O ID exclusivo da lista.
    Tabela 81. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var setID = list.setListID("a9dd1483d99f5700964f387107a8a3ec");
    var getID = list.getListID();
    gs.print(getID);

    Saída: a9dd1483d99f5700964f387107a8a3ec

    GlideListProperties – setListName(cadeia de caracteres nome)

    Define um nome para a lista.

    Tabela 82. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome da lista.
    Tabela 83. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var name = list.setListName("my custom list");
    

    GlideListProperties - setSaveFilterHidden (Booliano onOff)

    Determine se o botão Salvar filtro aparece no Construtor de condições.

    Tabela 84. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, o botão Salvar filtro ficará oculto.
    Tabela 85. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var saveFilter = list.setSaveFilterHidden(true);

    GlideListProperties - setTitle(cadeia de caracteres título)

    Define o título da lista.

    Tabela 88. Parâmetros
    Nome Tipo Descrição
    título Cadeia de caracteres Título da lista.
    Tabela 89. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var title = list.setTitle("My title");

    GlideListProperties - setToggleHeader(Booliano onOff)

    Determine se os usuários podem mostrar ou ocultar cabeçalhos de coluna para uma tabela.

    Tabela 90. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se verdadeiro, um ícone aparecerá no cabeçalho que permite aos usuários mostrar ou ocultar os cabeçalhos das colunas.
    Tabela 91. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var toggle = list.setToggleHeader(true);
    

    GlideListProperties – setVCR(Boolean onOff)

    Determine se os botões de primeira página, última página, próxima página e página anterior aparecem na parte superior e inferior da lista.

    Tabela 92. Parâmetros
    Nome Tipo Descrição
    onOff Booliano Se for falso, a lista não terá nenhum botão de navegação de página para uma lista.
    Tabela 93. Retorna
    Tipo Descrição
    vazio
    var list = new GlideListProperties();
    var VCR = list.setVCR(true);