kvision-material/io.kvision.material.select/MdFilledSelect

MdFilledSelect

open class MdFilledSelect(label: String? = null, quick: Boolean = false, disabled: Boolean = false, required: Boolean = false, errorText: String? = null, supportingText: String? = null, error: Boolean = false, menuPositioning: SelectMenuPositioning = SelectMenuPositioning.Popover, typeaheadDelay: Int = DEFAULT_TYPEAHEAD_DELAY, selectedIndex: Int = -1, name: String? = null, value: String? = null, validationMessage: String? = null, className: String? = null, init: MdFilledSelect.() -> Unit? = null) : MdSelect

Filled select type.

Author

Maanrifa Bacar Ali

Constructors

MdFilledSelect

constructor(label: String? = null, quick: Boolean = false, disabled: Boolean = false, required: Boolean = false, errorText: String? = null, supportingText: String? = null, error: Boolean = false, menuPositioning: SelectMenuPositioning = SelectMenuPositioning.Popover, typeaheadDelay: Int = DEFAULT_TYPEAHEAD_DELAY, selectedIndex: Int = -1, name: String? = null, value: String? = null, validationMessage: String? = null, className: String? = null, init: MdFilledSelect.() -> Unit? = null)

Properties

disabled

var disabled: <Error class: unknown class>

Whether or not the widget is disabled.

error

var error: <Error class: unknown class>

Gets or sets whether or not the select is in a visually invalid state. This error state overrides the error state controlled by reportValidity.

errorText

var errorText: <Error class: unknown class>

The error message that replaces supporting text when error is true. If errorText is an empty string, then the supportingText will continue to show. This error message overrides the error message displayed by reportValidity.

form

val form: <Error class: unknown class>?

The associated form element with which this element's value will submit.

label

var label: <Error class: unknown class>

The floating label for the field.

labels

val labels: <Error class: unknown class>?

The labels this element is associated with.

menuPositioning

var menuPositioning: <Error class: unknown class>

Whether or not the underlying md-menu should be position: fixed to display in a top-level manner, or position: absolute.

name

var name: <Error class: unknown class>

The name to use in form submission.

options

val options: Array<MdSelectOption>

List of available options.

parent

open var parent: <Error class: unknown class>?

quick

var quick: <Error class: unknown class>

Opens the menu synchronously with no animation.

required

var required: <Error class: unknown class>

Indicates that the component must provides a valid value when participating in form submission.

selectedIndex

var selectedIndex: Int

Index of the selected option.

selectedOptions

val selectedOptions: Array<MdSelectOption>

List of selected options.

supportingText

var supportingText: <Error class: unknown class>

Conveys additional information below the select, such as how it should be used.

typeaheadDelay

var typeaheadDelay: <Error class: unknown class>

The max time between the keystrokes of the typeahead select / menu behavior before it clears the typeahead buffer.

validationMessage

val validationMessage: String?

Message to display when the component value is not valid.

validity

val validity: <Error class: unknown class>?

Gets the element's current validity state.

value

var value: <Error class: unknown class>

The value that is submitted to the form.

willValidate

val willValidate: Boolean

Indicates that the element is a candidate for constraint validation.

Functions

add

open override fun add(item: MdSelectOption)

Adds given item to the current widget.

open override fun add(position: Int, item: MdSelectOption)

Adds given item to the current widget at the given position.

addAll

open override fun addAll(items: List<MdSelectOption>)

Adds a list of items to the current widget.

afterCreate

open override fun afterCreate(node: <Error class: unknown class>)

buildAttributeSet

open override fun buildAttributeSet(attributeSetBuilder: <Error class: unknown class>)

checkValidity

fun checkValidity(): Boolean

Indicates the validity of the value of the element. If the value is invalid, this method also fires the invalid event on the element.

dispose

open fun dispose()

disposeAll

open override fun disposeAll()

Removes all items from the current widget and disposes them.

remove

open override fun remove(item: MdSelectOption)

Removes given item from the current widget.

removeAll

open override fun removeAll()

Removes all items from the current widget.

removeAt

open override fun removeAt(position: Int)

Removes the item from the current widget at the given position.

render

open fun render(): <Error class: unknown class>

reportValidity

fun reportValidity(): Boolean

Performs the same validity checking steps as the checkValidity method. If the value is invalid, this method also fires the invalid event on the element, and (if the event isn't canceled) reports the problem to the user.

reset

fun reset()

Reset the select to its default value.

select

fun select(index: Int)

Selects an option given the index of the option.

fun select(value: String)

Selects an option given the value of the option.

selectOption

fun MdSelect.selectOption(value: String? = null, disabled: Boolean = false, selected: Boolean = false, typeaheadText: String? = null, className: String? = null, init: MdSelectOption.() -> Unit? = null): <Error class: unknown class>

setCustomValidity

fun setCustomValidity(message: String)

Sets a custom validity message for the underlying element.