com.github.mvysny.kaributesting.v10.groovy.ComboBoxUtils.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of karibu-testing-v10-groovy Show documentation

Karibu Testing, support for browserless Vaadin testing in Kotlin

There is a newer version: 2.2.0

Show newest version

package com.github.mvysny.kaributesting.v10.groovy

import com.github.mvysny.kaributesting.v10.ComboBoxKt
import com.vaadin.flow.component.combobox.ComboBox
import com.vaadin.flow.component.select.Select
import groovy.transform.CompileStatic
import org.jetbrains.annotations.NotNull
import org.jetbrains.annotations.Nullable

/**
 * A set of basic extension methods for {@link ComboBox}.
 * @author mavi
 */
@CompileStatic
class ComboBoxUtils {
    /**
     * Emulates an user inputting something into the combo box, filtering items.  You can use [getSuggestionItems]
     * to retrieve those items and to verify that the filter on your data provider works properly.
     */
    static void setUserInput(@NotNull ComboBox self, @Nullable String userInput) {
        ComboBoxKt.setUserInput(self, userInput)
    }

    /**
     * Simulates the user creating a custom item. Only works if the field is editable by the user
     * and allows custom values ([ComboBox.isAllowCustomValue] is true).
     */
    static void _fireCustomValueSet(@NotNull ComboBox self, @NotNull String userInput) {
        ComboBoxKt._fireCustomValueSet(self, userInput)
    }

    /**
     * Fetches items currently displayed in the suggestion box.
     */
    @NotNull
    static  List getSuggestionItems(@NotNull ComboBox self) {
        ComboBoxKt.getSuggestionItems(self)
    }

    /**
     * Fetches captions of items currently displayed in the suggestion box.
     */
    @NotNull
    static List getSuggestions(@NotNull ComboBox self) {
        ComboBoxKt.getSuggestions(self)
    }

    /**
     * Fetches items currently displayed in the suggestion box.
     */
    @NotNull
    static  List getSuggestionItems(@NotNull Select self) {
        ComboBoxKt.getSuggestionItems(self)
    }

    /**
     * Fetches captions of items currently displayed in the suggestion box.
     */
    @NotNull
    static List getSuggestions(@NotNull Select self) {
        ComboBoxKt.getSuggestions(self)
    }
}