gridColumnVisibility

gridColumnVisibility позволяет пользователям показывать или скрывать столбцы в dataGrid.

XML-элемент

gridColumnVisibility

Java-класс

JmixGridColumnVisibility

Основы

gridColumnVisibility состоит из кнопки и выпадающего меню со списком столбцов.

Ниже приведён пример использования gridColumnVisibility на экране списка:

<hbox id="buttonsPanel" classNames="buttons-panel">
    <!-- ... -->
    <gridColumnVisibility dataGrid="stepsTable"
                          icon="COG"
                          themeNames="icon"
                          exclude="duration">
        <menuItem refColumn="name" text="msg://menuItem.text"/>
    </gridColumnVisibility>
</hbox>
<dataGrid id="stepsTable"
          width="100%"
          minHeight="20em"
          dataContainer="stepsDc">
    <columns>
        <column property="name"/>
        <column property="duration"/>
        <column property="sortValue"/>
    </columns>
</dataGrid>

Настройка выпадающего меню

По умолчанию текст пункта копируется из заголовка столбца. Изменить его можно с помощью элемента menuItem.

По умолчанию текст элемента меню копируется из заголовка столбца. Вы можете изменить это, используя элемент menuItem.

Например, в предыдущем примере элемент menuItem используется для установки другого локализованного сообщения для столбца name, отличного от того, которое указано в заголовке dataGrid.

include

Атрибут include используется для указания того, какие столбцы следует включить в выпадающее меню gridColumnVisibility.

exclude

Атрибут exclude используется для указания того, какие столбцы следует исключить из выпадающего меню gridColumnVisibility.

Например, в предыдущем примере мы исключили столбец duration из выпадающего меню gridColumnVisibility.

hideAllEnabled

Атрибут hideAllEnabled определяет видимость пункта Скрыть все в выпадающем меню gridColumnVisibility.

showAllEnabled

Атрибут showAllEnabled определяет видимость пункта Показать все в выпадающем меню gridColumnVisibility.

Варианты темы

Используйте атрибут themeNames, чтобы применить один или несколько вариантов темы.

Вариант Описание Поддерживается в

primary

Применяет основной стиль кнопки.

Aura, Lumo

tertiary

Применяет стиль кнопки с меньшим визуальным акцентом.

Aura, Lumo

tertiary-inline

Применяет встроенный стиль кнопки для использования внутри текстового содержимого.

Lumo

icon

Уменьшает отступы вокруг значка.

Lumo

small

Уменьшает размер кнопки.

Aura, Lumo

large

Увеличивает размер кнопки.

Aura, Lumo

success

Применяет стиль успеха.

Aura, Lumo

error

Применяет стиль ошибки.

Aura, Lumo

contrast

Применяет контрастный стиль.

Lumo

Атрибуты

gridColumnVisibility имеет следующие уникальные атрибуты:

Имя Описание По умолчанию

dataGrid

Устанавливает сетку, столбцы которой будут управляться этим компонентом.

—

exclude

Указывает столбцы, которые необходимо исключить из меню видимости. См. exclude.

—

hideAllEnabled

Определяет, содержит ли меню видимости элемент Скрыть все. См. hideAllEnabled.

—

icon

Задаёт значок.

—

include

Указывает столбцы для включения в меню видимости. См. include.

—

showAllEnabled

Определяет, содержит ли меню видимости элемент Показать все. См. showAllEnabled.

—

gridColumnVisibility имеет следующие общие атрибуты:

id - alignSelf - classNames - colspan - css - enabled - focusShortcut - height - maxHeight - maxWidth - minHeight - minWidth - tabIndex - text - themeNames - visible - whiteSpace - width

Элементы

Компонент gridColumnVisibility может содержать следующие вложенные элементы: menuItem.