eu.vaadinonkotlin.vaadin.VaadinUtils.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vok-framework Show documentation

VoK: The Framework

There is a newer version: 0.18

package eu.vaadinonkotlin.vaadin

import com.vaadin.flow.component.UI
import com.vaadin.flow.data.binder.BeanPropertySet
import com.vaadin.flow.data.binder.PropertyDefinition
import eu.vaadinonkotlin.I18n
import eu.vaadinonkotlin.getI18nProvider
import java.util.*
import kotlin.reflect.KProperty1

/**
 * Shortcut for VOK Translate. Retrieves the [I18n] for the current UI and the current locale.
 * Fails if there is no UI (the function is not called from Vaadin's UI thread).
 *
 * To configure the current user locale, just call [UI.setLocale] in your [UI.init] method:
 *
 * * As a first step, you can check whether the user has configured his language in his settings. Just get the current
 * user from the session, then do a database lookup for the user settings and retrieve the locale. If it's not null, use it.
 * * If user haven't configured his locale or your app doesn't support this kind of functionality, fall back and simply poll the browser
 * for the [com.vaadin.flow.server.WebBrowser.locale]: `Session.current.browser.locale`
 * * If the browser provided `null` locale, fall back to [java.util.Locale.ENGLISH].
 * * Set the value computed by the steps above to the UI: [UI.setLocale]
 *
 * Example usage:
 * ```
 * label(vt["createUser.caption"])
 * ```
 */
public val vt: I18n
    get() {
    val ui: UI = checkUIThread()
    val locale: Locale? = ui.locale
    check(locale != null) { "UI.getCurrent().locale can't really return null" }
    val provider: (Locale) -> I18n = getI18nProvider(ui.session.configuration.isProductionMode)
    return provider(locale)
}

/**
 * Checks that this thread runs with Vaadin UI set.
 * @return the UI instance, not null.
 * @throws IllegalStateException if not run in the UI thread or [UI.init] is ongoing.
 */
public fun checkUIThread(): UI = UI.getCurrent() ?: throw IllegalStateException("Not in UI thread, or UI.init() is currently ongoing")

/**
 * Returns the Vaadin's [PropertyDefinition] for Kotlin [KProperty1].
 */
@Suppress("UNCHECKED_CAST")
public inline val  KProperty1.definition: PropertyDefinition
    get() =
        BeanPropertySet.get(T::class.java).getProperty(name).get() as PropertyDefinition