Компонент SearchPickerField
служит для поиска экземпляров сущностей по вводимой пользователем строке. Пользователю достаточно ввести несколько символов
и нажать клавишу Enter. Если поиск дал несколько совпадений, найденные значения отображаются в виде выпадающего списка. Если же критерию поиска
соответствует только один экземпляр, он сразу становится значением компонента. SearchPickerField
позволяет также выполнять действия нажатием на кнопки справа.
XML-имя компонента: searchPickerField
.
Компонент реализован для блоков Web Client и Desktop Client.
-
Для работы компонента
SearchPickerField
необходимо создать collectionDatasource, и задать в нем запрос, содержащий условия поиска. Условие обязательно должно содержать параметр с именемcustom$searchString
- именно в него компонент передает введенную пользователем подстроку при нажатии Enter. Источник данных с условием поиска должен быть указан в атрибуте optionsDatasource компонента. Например:<dsContext> <datasource id="carDs" class="com.company.sample.entity.Car" view="_local"/> <collectionDatasource id="coloursDs" class="com.company.sample.entity.Colour" view="_local"> <query> select c from sample$Colour c where c.name like :(?i)custom$searchString </query> </collectionDatasource> </dsContext> <layout> <searchPickerField datasource="carDs" property="colour" optionsDatasource="coloursDs"/>
В данном случае компонент будет искать экземпляры сущности
Colour
по вхождению подстроки в ее атрибутname
. Префикс(?i)
служит для регистро-независимого поиска (см. Раздел 4.5.3.2.4, «Поиск подстроки без учета регистра»). Выбранное значение подставится в атрибутcolour
сущностиCar
, находящейся в источнике данныхcarDs
. -
С помощью атрибута
minSearchStringLength
можно задать минимальное количество символов, которое должен ввести пользователь для поиска значения. -
В контроллере экрана для компонента можно реализовать методы, вызываемые в двух случаях:
-
если количество введенных символов меньше значения атрибута
minSearchStringLength
. -
если поиск введенных пользователем символов не дал результатов.
Пример реализации методов для вывода на экран сообщений:
@Inject private SearchPickerField colourField; @Override public void init(Map<String, Object> params) { colourField.setSearchNotifications(new SearchField.SearchNotifications() { @Override public void notFoundSuggestions(String filterString) { showNotification("No colours found for search string: " + filterString, NotificationType.TRAY); } @Override public void needMinSearchStringLength(String filterString, int minSearchStringLength) { showNotification("Minimum length of search string is " + minSearchStringLength, NotificationType.TRAY); } }); }
-
-
SearchPickerField
реализует интерфейсы LookupField и PickerField, поэтому все описанное для этих интерфейсов в части работы с сущностями верно и для него. Исключением является список действий по умолчанию, добавляемых при определении компонента в XML: дляSearchPickerField
это действияlookup
иopen
.
Атрибуты searchPickerField
:
align | caption | captionProperty | datasource | description | editable | enable | filterMode | height | id | inputPrompt | metaClass | minSearchStringLength | nullName | optionsDatasource | property | required | requiredMessage | stylename | visible | width
Элементы searchPickerField
: