com.github.mvysny.karibudsl.v8.TextField.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of karibu-dsl-v8 Show documentation
Karibu-DSL, Kotlin extensions/DSL for Vaadin
The newest version!
package com.github.mvysny.karibudsl.v8

import com.vaadin.annotations.JavaScript
import com.vaadin.server.AbstractJavaScriptExtension
import com.vaadin.shared.JavaScriptExtensionState
import com.vaadin.ui.AbstractTextField
import com.vaadin.ui.HasComponents
import com.vaadin.ui.TextArea
import com.vaadin.ui.TextField

/**
 * Creates a [TextField] and attaches it to this component.
 * @param caption optional caption
 * @param value the optional value
 */
@VaadinDsl
public fun (@VaadinDsl HasComponents).textField(caption: String? = null, value: String = "", block: (@VaadinDsl TextField).() -> Unit = {}): TextField = init(TextField(caption, value), block)

/**
 * Creates a [TextArea] and attaches it to this component.
 * @param caption optional caption
 */
@VaadinDsl
public fun (@VaadinDsl HasComponents).textArea(caption: String? = null, block: (@VaadinDsl TextArea).() -> Unit = {}): TextArea = init(TextArea(caption), block)

/**
 * Simply sets the `type` HTML attribute to the `` element represented by the [TextField] Vaadin component. Instead of
 * using this class directly, you can use [AbstractTextField.type] to change the type easily.
 *
 * See [AbstractTextField.type] for documentation.
 */
@JavaScript("type-extension.js")
public class TypeExtension(textField: AbstractTextField) : AbstractJavaScriptExtension(textField) {

    public var type: String
        get() = getState(false).type
        set(value) {
            state.type = value
        }

    override fun getState(): TypeExtensionState = super.getState() as TypeExtensionState
    override fun getState(markAsDirty: Boolean): TypeExtensionState = super.getState(markAsDirty) as TypeExtensionState

    public class TypeExtensionState : JavaScriptExtensionState() {
        @JvmField
        public var type: String = ""
    }
}

/**
 * Controls the type of the text field. You can use any of the [HTML types allowed](https://www.w3schools.com/tags/att_input_type.asp), however
 * only a couple may actually be usable:
 * * `"email"`
 * * `"number"` - use [textField] and Vaadin binder with appropriate numeric converter, such as [toInt].
 * * `"search"`
 * * `"text"` (default)
 * * `"tel"`
 * * `"url"`
 * * `"range"`
 * You should use other Vaadin fields as necessary:
 * * Use [com.vaadin.ui.DateField] to input `"date"`
 * * Use [colorPicker] instead of `"color"`
 * * Use [button] instead of `"button"` or `"reset"` or `"submit"`
 * * Use [dateTimeField] instead of `"datetime-local"`
 * * Use [upload] instead of `"file"`
 * * Use [com.vaadin.ui.Component.isVisible] instead of `"hidden"`
 * * Use [dateField] and set [com.vaadin.ui.DateField.setResolution] to MONTH for `"month"`
 * * Use [passwordField] instead of `"password"`
 * * Use [radioButtonGroup] instead of `"radio"`
 * * No Vaadin component for `"time"`
 * * No Vaadin component for `"week"`
 */
public var AbstractTextField.type: String? by ExtensionPropertyDelegate(TypeExtension::class.java, TypeExtension::type, { TypeExtension(it) }, "text")

/**
 * Creates a [TextField] with the [type] of `"email"` and attaches it to this component.
 * @param caption optional caption
 * @param value the optional value
 */
@VaadinDsl
public fun (@VaadinDsl HasComponents).emailField(caption: String? = null, value: String = "", block: (@VaadinDsl TextField).() -> Unit = {}): TextField = textField(caption, value) {
    type = "email"
    block()
}