Список с поиском для выбора одного значения

Назначение

Список с поиском для выбора одного значения - это составной компонент, который используется длявыбора одного значения из списка доступных с возможностью поиска.Для того чтобы данные, отобранные с помощью этой компоненты, сохранялись в базу данных, её необходимо вложить в компоненту Форма.

Компонента Список с поиском для выбора одного значения находится в разделе Компоненты - Поля - Список с поиском для выбора одного значения.

В структуру компоненты Список с поиском для выбора одного значения входят следующие элементы

Структура

Основные вложенные элементы компоненты Список с поиском для выбора одного значения

Наименование элемента	Описание
Список с поиском для выбора одного значения	контейнер горизонтального выравнивания, в который вложены все дочерние компоненты
Списка с поиском (с возможностью сохранения)	отображает информацию по выбранной записи из списка
Кнопка выбора	используется для открытия (вызова) диалогового окна
Диалог выбора	используется для отображениявсплывающего диалогового окна
Панель фильтров	представляет собой сворачиваемую панель, которая включает в себя Группу фильтров, Кнопку для фильтрации и “Кнопку Очистить”, которые будут отображаться в диалоговом окне
Группа фильтров	позволяет задать фильтры поиска, которые будут применяться к Таблице; в зависимости от типа полей (текст, число и т.д.) по которым будет осуществляться фильтрация, в группу фильтров может быть вложен, например, Фильтр по текстовому полю или Фильтр по числовому полю
Кнопка для фильтрации	используется для осуществления поиска значения в Таблице в соответствии с заданными фильтрами из Группы фильтров
Кнопка Очистить	позволяет очистить введенные значения фильтров из Группы фильтров
Таблица	используется для отображения информации в табличном виде, в данном случае, списка доступных значений из справочника
Кнопка выбора	позволяет перенести значение из списка доступных вариантов в поле список с поиском (с возможностью сохранения)
Кнопка отмены	позволяет закрыть диалог без выполнения действий с данными

Свойства

Компонента имеет набор общих свойств.

Основные параметры Списка с поиском для выбора одного значения

прим.: с полным описанием компоненты и её настройки также можно ознакомиться в разделе - Горизонтальный контейнер

Основные параметры Списка с поиском с возможностью сохранения

прим.: с полным описанием компоненты и её настройки также можно ознакомиться в разделе - Поле ввода с подбором значения (Поиск)

Наименование свойства	Назначение свойства	Принимаемые значения
Подсказка	позволяет создать подсказку, расположенную внутри элемента	пример возможного значения: Начните вводить название департамента
Надпись	позволяет задать наименование поля, которое будет отображаться на странице	пример возможного значения: Департамент
Зависит от	используется в том случае, когда набор доступных для выбора значений в текущем компоненте необходимо ограничить, исходя из выбранного значения в вышестоящем компоненте, от которого зависит текущий
Начать подбор вариантов после ввода	задает минимальное число символов, при наборе которых будет осуществляться запрос на сервер	пример возможного значения: 3 - значение по умолчанию
Прикрепить значение (Scroll Gravity)	позволяет задать расположение уже выбранного значения при отображении в выпадающем списке доступных значений позволяет задать расположение уже выбранного значения при отображении в выпадающем списке доступных значений	По умолчанию (DEFAULT) - выбранное значение отображается в порядке своего следования в списке доступных значений для выбора По центру (CENTER) - выбранное значение отображается по центру в выпадающем списке доступных значений для выбора В верхней части (TOP)- выбранное значение отображается в верхней части выпадающего списка доступных значений для выбора В нижней части (BOTTOM) - выбранное значение отображается в нижней части выпадающего списка доступных значений для выбора
Исключить условия графа	данное свойство позволяет подгружать для отображения значения в поле минуя условия (ограничения), заданные в Графе сущностей компоненты	Не активно - в данном состоянии, при подгрузке значений отсекаются значения не соответствующие условиям, заданным в Графе сущностей компоненты Активно - в данном состоянии, при подгрузке значений допускается отображение значений, не соответствующих условиям, заданным в Графе сущностей компоненты, но без возможности их повторного выбора в выпадающем списке
Помечать невалидным (Mark invalid if not Satisfy)	данное свойство доступно для управления при активации значении свойства Exclude Graph Conditions и позволяет визуально помечать поле как невалидное на странице, в случае если в него было подгружено значение, не соответствующие условиям Графа сущностей элемента	Не активно - в данном значении, поле не помечается на странице как невалидное и отображается стандартным образом Активно - в данном значении, убрав фокус с поля, оно помечается на странице как невалидное
Css class if not Satisfy	данное свойство доступно для управления при активном значении свойства Exclude Graph Conditions и позволяет задать CSS-класс, который будет применяться, в случае если в поле было подгружено значение, не соответствующие условиям Графа сущностей элемента
Tooltip if not Satisfy	позволяет отображать всплывающую подсказку,в случае если в поле было подгружено значение, не соответствующие условиям Графа сущностей элемента. Данное свойство доступно для управления при: активном значении свойства Exclude Graph Conditions и заданному значению в поле Css Class If Not Satisfy	пример возможного значения: not_valid

Свойство компоненты: Поле ввода с подбором значения. Подгрузка данных

позволяет задать источник подгрузки данных с указанием методов и типов сортировки, и с настройкой Графа сущностей. Является обязательным к заполнению и настройке.

Граф сущностей элемента настраивается в соответствии с п. Настройка Графа сущностей. Является обязательным к заполнению и настройке.
Возвращать значение дополнительно из - по умолчанию компонента возвращает идентификатор записи выбранной из справочника значений. Настройка данного параметра позволяет указать компоненте, какое значение необходимо дополнительно считать и вернуть, кроме значения идентификатора выбранной пользователем записи.
Показывать варианты по - позволяет ограничить список отображаемых вариантов в процессе подбора по подстроке.
Тип поиска позволяет задать один из вариантов поиска по вводимой пользователем подстроке:
С начала строки - значение отображается в списке, если с введенной пользователем подстроки начинается значение колонки из базы данных
По всей строке -значение отображается в списке, если введенная пользователем подстрока содержится в значении колонки из базы данных с любого места вхождения
Связаны по - позволяет указать колонку текущей компоненты, по которой осуществляется связь с компонентой, указанной в свойстве “Зависит от”, обеспечивающую связь между родительской и текущей компонентами
Тип колонки - это свойство, позволяющее выбрать тип для отображения значения в поле:
Из одной колонки - значение по умолчанию
Из нескольких колонок - позволяет указать перечень колонок, значения которых будут склеиваться в одну строку при отображении на страницес определяемым разделителем значений (точка, запятая, пробел и другие)
Разделитель - символ или пробел, который будет разделять между собой значения из разных колонок таблиц (ы) приводимых в одну строку (доступно для настройки при Тип колонки - Из нескольких колонок)
Колонка для поиска (Search Columns) - позволяет задать элемент базы данных (колонку) со строковым типом данных, значениекоторого будет отображаться в строке результата поиска, в случае если в отображаемой (по умолчанию) пользователю колонке (Display Column) содержится значение NULL (доступно для настройки при Тип колонки - Из нескольких колонок)
Порядок сортировки (Sort Order) - позволяет задать порядок сортировки отображаемых значений в списке для выбора, принимает значения:
- по возрастанию - значения будут сортироваться от меньшего к большему
- по убыванию - значения будут сортироваться от большего к меньшему
Показывать пользователю - позволяет задатьэлемент базы данных, значение которого будет отображено пользователю в Выпадающем списке (доступно для настройки при Тип колонки - Из одной колонки)
Активировать фильтрацию по - позволяет задать колонку, по которой можно будет динамически активировать фильтр при использовании метода “Задать фильтр” (Set_Filter) в компоненте Обработка Событий в отношении настраиваемой компоненты
*Datasource Jndi Name - *позволяет задать иной источник (базу данных) для выполнения запроса, заданного с помощью элементов базы данных в редакторе Графа сущностей элемента.

Значение данного свойства может быть задано следующим образом: java:/webbpm/AppRepDS, а сам адрес базы данных, логин и пароль для подключения должен быть указан в файлеstandalone.xml(аналогично тому, как указывается, например, подключение к базе данных безопасности) (рис.1)

В случае, если данное свойство не заполнено, запрос выполняется в базе данных, указанной в конфигурации проекта (во вкладке База данных).

Сортировать по - позволяет задать элемент базы данных, по значению которого будет производиться сортировка

с описанием настройки Списка с поиском с возможностью сохраненияможно ознакомиться в разделе: Поле ввода с подбором значения

Свойство компоненты: Поле ввода с подбором значения. Сохранение значения

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

В случае, если значение Поля ввода с подбором значения не требуется сохранять или подгружать из базы данных, то данное свойство удаляется (или отключается). Данный вариант может быть необходим, когда поле используется для отображения значения, которое является константой, определённой в логике приложения.

Свойство компоненты: Заполнить значением из переменнойлюбого типа

позволяет указать переменную процесса, значение которой будет передаваться в поле и отображаться по умолчанию

с описанием настройки свойстваЗаполнить значением из переменной процессаможно ознакомиться в разделе: Заполнить значением из переменной процесса

Свойство компоненты: Поле ввода с подбором значения. Подгрузка данных по умолчанию

позволяет указать значение по умолчанию, которое будет подгружаться в поле с помощью двух типов подгрузки (источников подгрузки значения):

из колонки
из сервиса

с описанием настройки свойства Заполнить значением поумолчаниюи соответствующих ей типов подгрузкиможно ознакомиться в разделе: Заполнить значением по умолчанию

Основные параметры Кнопки выбора (открытия диалога)

прим.: с полным описанием компоненты и её настройки также можно ознакомиться в разделе - Кнопка выбора

Наименование свойства	Назначение свойства	Принимаемые значения
Надпись на кнопке	позволяет задать надпись на кнопке	… - значение по умолчанию
Вызвать диалог	позволяет задать диалог, который будет открываться при нажатии на кнопку	по умолчанию задан Диалог выбора

Основные параметры Диалога выбора

прим.: с полным описанием компоненты и её настройки также можно ознакомиться в разделе - Диалог

Наименование свойства	Назначение свойства	Принимаемые значения
Заголовк	позволяет задать заголовок диалога на странице	пример возможного значения: Выбор записи - значение по умолчанию
Допускается скрытие через системную Х	позволяет задать возможность закрытия диалога по нажатию на системный крестик	возможно закрыть диалог через - значение по умолчанию, невозможно закрыть диалог (системный скрыт)

Основные параметры Панели фильтров

Наименование свойства	Назначение свойства	Принимаемые значения
Заголовок	позволяет задать заголовок сворачиваемой панели на странице	пример возможного значения: Фильтр - значение по умолчанию
Открывать развернутым	позволяет задать вид панели при открытии диалога	не активно - панель свернута - значение по умолчанию, активно - панель развернута

Основные параметры Кнопки для фильтрации

прим.: с полным описанием компоненты и её настройки также можно ознакомиться в разделе - Кнопка для фильтрации

Наименование свойства	Назначение свойства	Принимаемые значения
Надпись на кнопке	позволяет задать надпись на кнопке	Найти - значение по умолчанию
Компонент “Набор фильтров”	позволяет задать Набор фильтров, по значениям которых будет осуществляться поиск	по умолчанию задана Группа фильтров
Текст подтверждения	позволяет задать текст сообщения, который отобразится в диалоговом окне после нажатия на кнопкус возможностью подтвердить действие с помощью кнопок “Да / Нет”

Основные параметры Кнопки “Очистить”

прим.: с полным описанием компоненты и её настройки также можно ознакомиться в разделе-Кнопка очистки фильтра

Наименование свойства	Назначение свойства	Принимаемые значения
Надпись на кнопке	позволяет задать надпись на кнопке	пример возможного значения: Сбросить - значение по умолчанию
Текст подтверждения	позволяет задать текст сообщения, который отобразится в диалоговом окне после нажатия на кнопкус возможностью подтвердить действие с помощью кнопок “Да / Нет”
Для компонента “набор фильтров”	позволяет задать Набор фильтров, поля которого будут очищаться при нажатии	по умолчанию задана Группа фильтров
Сбросить значения фильтров на значения по умолчанию	при нажатии на кнопку возвращает значения заданных фильтров к значениям по умолчанию	Не активно - не сбрасывать значения - значение по умолчанию, активно - сбрасывать значения
Применять фильтры после сброса	позволяет задать возможность возврата фильтруемой Таблицы в первоначальное состояние при нажатии на кнопку	Не активно - не применять значения фильтров - значение по умолчанию, активно - применять значения фильтров

Основные параметры Кнопки выбора

прим.: с полным описанием компоненты и её настройки также можно ознакомиться в разделе - Кнопка выбора

Наименование свойства	Назначение свойства	Принимаемые значения
Надпись на кнопке	позволяет задать надпись на кнопке	пример возможного значения: Выбрать - значение по умолчанию
Текст подтверждения	позволяет задать текст сообщения, который отобразится в диалоговом окне после нажатия на кнопкус возможностью подтвердить действие с помощью кнопок “Да / Нет”
Скрыть диалог	позволяет указать Диалог, который будет закрыт при нажатии на кнопку	по умолчанию задан Диалог выбора

Свойство компоненты: Перенести значение из списка доступных вариантов в поле “выбранное значение”

Наименование свойства	Назначение свойства	Принимаемые значения
Из списка доступных вариантов	позволяет задать Таблицу, из которой будет переносится выбранное значение	по умолчанию задана Таблица
В поле выбранное занчение	позволяет указать поле, куда будет копироваться выбранное значение из Таблицы	по умолчанию задан Список с поиском (с возможностью сохранения)(Поле ввода с подбором значения)

Основные параметры “Кнопки отмены”

прим.: с полным описанием компоненты и её настройки также можно ознакомиться в разделе - Кнопка отмены

Наименование свойства	Назначение свойства	Принимаемые значения
Надпись на кнопке	позволяет задать надпись на кнопке	пример возможного значения: Отмена - значение по умолчанию
Скрыть диалог	позволяет указать Диалог, который будет закрыт при нажатии на кнопку	по умолчанию задан Диалог выбора
Текст подтверждения	позволяет задать текст сообщения, который отобразится в диалоговом окне после нажатия на кнопкус возможностью подтвердить действие с помощью кнопок “Да / Нет”

Основные параметры Таблицы

прим.: с полным описанием компоненты и её настройки также можно ознакомиться в разделе - Таблица

Наименование свойства	Назначение свойства	Принимаемые значения
Зависит от	позволяет указать объект (родителя), по идентификатору которого будут отображаться сведения в текущей Таблице; задаётся в случае необходимости связать Таблицу с другой компонентой, например, Выпадающий список	пример возможного значения: необходимо ограничить по конкретному признаку вложенную Таблицу (справочник районов). В данном случае, ограничивающим признаком будет служить значение из Выпадающего списка (регионы России), например, Республика Татарстан. В Таблице будут отображаться районы только Республики Татарстан, из которых будет производится дальнейший выбор.
Multiselectable	позволяет задать возможность единовременного выбора одной или нескольких записей в Таблице; выбранные строки окрашиваются в отличный от других строк цвет	возможность выбора сразу нескольких или одной строки возможность выбора одной строки - значение по умолчанию
Checkbox Column	позволяет поставить отметку в виде флажка на тех записях, которые выбраны пользователем в рамках работы с компонентой	значение не определено - по умолчанию Активно - отображать колонку флагов Не активно - не отображать колонку флагов
Показывать номер строки	позволяет задать автоматическую нумерацию строк	значение не определено - по умолчанию Активно - отображать нумерацию строк Не активно - не отображать нумерацию строк
Pinned Bottom Row Label	позволяет задать значение для названия итоговой строки таблицы (строки с агрегирующими значениями по колонкам таблицы)	пример возможного значения: Итого
Row click selection type	позволяет задать поведение выбора строк при клике на строку Таблицы	SINGLE_SELECT_CLICK – при клике на строку предыдущие выбранные строки сбрасываются, если не была зажата клавиша Ctrl или Shift- данный метод выбран по умолчанию MULTI_SELECT_CLICK -при каждом клике на строку, предыдущие выбранные строки не сбрасываются, т.е если кликнули на одну строку, а затем на другую, то первая строка останется выбранной. Клик по уже выбранной строке снимает с неё выделение. Использования данного метода допустимо, в случае, если в таблице доступен выбор нескольких строк (при значениисвойстваMultiselectable) SUPPRESS_SELECT_CLICK – исключает возможность выбора (выделения) строки по клику. В данном случае, выбор строки представляется возможным только при использовании чекбоксов.
Save column state	позволяет задать возможность сохранения пользовательских настроек в части состава и ширины колонок в таблице	значение не определено - по умолчанию Активно - изменения пользователя в части отображаемых колонок в таблице (состав и ширина) будут сохраняться в локальном хранилище, т.е. если пользователь исключил для отображения конкретную колонку или изменил ширину столбца в таблице, то при повторном переходе на страницу эти изменения отобразятся Не активно - не сохранять изменения пользователя в части отображаемых колонокв таблице (состав и ширина), т.е. если пользователь исключил для отображения конкретную колонку или изменил ширину столбца в таблице, то при повторном переходе на страницу эти изменения не отобразятся и таблица будет иметь исходный вид по умолчанию
Loading Overlay Type	позволяет выбрать вид прелоадера при подгрузке данных в таблицу	Доступны следующие виды настройки: TEXT_OVERLAY - отображает текст в центре таблицы при подгрузке данных, задаваемый в свойствах: No Rows Overlay Message и Loading Overlay Message PROGRESS_BAR - отображает прогресс-бар при подгрузке данных в таблицу
No rows overlay message	позволяет указать текст для отображения пользователю в таблице в случае, если результат запроса не вернул ни одной строки, например, Данные отсутствуют (доступно для настройки при Loading Overlay Type - TEXT_OVERLAY)	пример возможного значения: Данные отсутствуют
Loading Overlay Message	позволяет указать текст для отображения пользователю в процессе подгрузки данных в таблицу, например,Загрузка данных, пожалуйста, подождите.(доступно для настройки приLoading Overlay Type - TEXT_OVERLAY)	пример возможного значения:Загрузка данных, пожалуйста, подождите.
Allow Context Menu With	позволяет управлять отображением контекстного меню (список доступных для исполнения действий) при нажатии правой кнопкой мыши на ячейку внутри таблицы	значение не определено - по умолчанию Активно - при нажатии правой кнопкой мыши на ячейку внутри таблицы отображается контекстное меню доступных действий, например, копирование значения ячейки Не активно - исключает отображение контекстного меню при нажатии правой кнопкой мыши на ячейку внутри таблицы

Свойство компоненты: Таблица. Подгрузка данных

Наименование свойства	Назначение свойства	Принимаемые значения
Подгрузка данных	позволяет задать граф сущностей для подгрузки данных в Таблицу. Является обязательным к заполнению и настройке.	Граф сущностей элемента настраивается в соответствии с п. Настройка Графа сущностей. Является обязательным к заполнению и настройке. Колонка для режима “Зависит от” - позволяет указать колонку настраиваемой Таблицы, которая обеспечивает связь текущей компоненты с компонентой заданной в параметре “Зависит от”

Свойство компоненты: Таблица. Настроить колонки таблицы

Наименование свойства	Назначение свойства	Принимаемые значения
Настроить колонки таблицы	позволяет настроить отображаемые колонки в Таблице с сортировкой данных по конкретному порядку	с описанием настройки Колонок Таблицы можно ознакомиться в разделе: Настройка колонок Таблицы

Свойство компоненты: Активировать кнопку после выбора строки в таблице

Наименование свойства	Назначение свойства	Принимаемые значения
Активируемая кнопка	устанавливает доступность Кнопки выбора записи после указания необходимой строки в Таблице	по умолчанию задана Кнопка выбора

Свойство компоненты: Таблица. Настроить динамическую подгрузку данных при просмотре страницы

Наименование свойства	Назначение свойства	Принимаемые значения
Количество записей в блоке	количество отображаемых записей в Таблице по умолчанию при каждой новой подгрузке	пример возможного значения: 20 - значение по умолчанию

Основные параметры Группы фильтров

Наименование свойства	Назначение свойства	Принимаемые значения
Фильтровать сразу	позволяет задать возможность фильтровать Таблицу сразу по мере ввода значения фильтра, без нажатия на Кнопку для фильтрации	Активно - не фильтровать сразу - значение по умолчанию Активно - фильтровать сразу, без нажатия Кнопки для фильтрации - значение не определено
Применить к …	позволяет задать Таблицу, по которой будет осуществляться фильтрация записей	по умолчанию задана Таблица
Запомнить значения фильтра	позволяет восстанавливать значения фильтров при возврате на страницу, т.е. запоминать значения фильтров (сохранять в кэше). При этом значение фильтра, заданное пользователем имеет приоритет над значением фильтра по умолчанию	значение не определено - по умолчанию Активно - запоминать значения фильтров Не активно - не запоминать значения фильтров
Skip initial loading	позволяет исключать подгрузку данных в таблицу без указания значений фильтров (пустыми фильтрами)	значение не определено - по умолчанию Активно - исключает возможность подгрузки данных в таблицу без указания значений фильтров, т.е. при пустых значениях фильтров при первоначальном открытии страницы или по кнопке “Найти” запрос в базу данных (по Графу сущностей таблицы) выполняться не будет Не активно - позволяет подгружать данные в таблицу без указания значений фильтров, т.е. при первоначальном открытии страницы или по кнопке “Найти” будет осуществляться запрос в базу данных по пустым значениям фильтров
	позволяет задатьшаблон вывода сообщения (текст сообщения), отображаемого в окне ошибки при валидации значений фильтров. По умолчанию шаблон сообщения выставлен как:“#{label}: #{message}”, где параметры интерпретируются следующим образом: #{label} -наименование компоненты, в которой произошла ошибка. #{message}-текст сообщения об ошибке	Примеры возможной настройки: При пустом значений в поле* Message Validation Template* текст в окне об ошибке, отображаемом, например, при не заполнении значения в обязательном поле, будет отображаться по шаблону `"\#{label}: \#{message}"`, где `\#{label}` - наименование компоненты, в которой произошла ошибка (например, поле ФИО) `\#{message}` - текст сообщения об ошибке (значение по умолчанию Поле обязательно). При указании конкретного текста в поле Message Validation Template,например, “Для выполнения поиска необходимо заполнить обязательные поля!”. Указываемое значение вMessage Validation Template допускает и использование атрибутов#{label} и #{message} по отдельности, например, если задать значение “#{label}: Некорректное значение в обязательном поле”, то окно об ошибке будет иметь следующий вид (рис.3), где#{label} -наименование компоненты, в которой произошла ошибка (например, поле ФИО)

Функции

В ходе настройки свойств компоненты (заданных по умолчанию) может оказаться недостаточно для выполнения поставленной задачи и получения необходимого результата.

Для каждой компоненты предусмотрен перечень функций, расширяющих её базовую функциональность, которые можно добавить нажатием кнопки Добавить скрипт

Вследствие технических особенностей реализации функций (функции, которые выполняются удаленно на сервере приложений, функции, которые выполняются в браузере пользователя), они имеют разные иконки, но это никак не влияет на их функциональность или предпочтительность использования.

TODO

Определить права текущего пользователя

Определить роли текущего пользователя

Методические рекомендации по применению

Пошаговые инструкции по применению компонента в типовых задачах Вы можете найти в разделах:

Как добавить список с поиском для выбора одного значения на страницу?

Часто задаваемые вопросы

Вопрос	Ответ
Как определить какие типы фильтров необходимо включить в Группу Фильтров?	В зависимости от того, к какому типу относится колонка в таблице, по которой будет осуществляться поиск и фильтрация, определяется соответствующий тип фильтра. Например, если мы указываем, что необходимо фильтровать по колонке, в которой хранится текст, то в данном случае, используем Фильтр по текстовому полю, если необходимо предоставить возможность выбора значения из списка значений, то применяем Фильтр по выпадающему списку.
Есть ли ограничения по количеству включаемых фильтров в Группу фильтров?	Нет.Количество фильтров определяется в зависимости от решаемой задачи.
Обязательно ли использование фильтров в диалоговом окне?	Нет, необязательно.Фильтры можно отключить, скрыв видимость Панели фильтров.
В каком случае целесообразно использовать компоненту Список с поиском для выбора одного значения, а в каком Выпадающий список?	Если справочник, из которого необходимо выбрать значение имеет небольшую размерность и пользователь сможет сразу найти значение без использования вспомогательных фильтров, то целесообразно использовать Выпадающий список значений. Если для удобства выбора значения необходимо отобразить дополнительные параметры в виде Таблицы, то в этом случае необходимо использовать Список с поиском для выбора одного значения.