input/com.maxkeppeler.sheets.input.type/InputCheckBox

InputCheckBox

class InputCheckBox(key: String? = null, func: InputCheckBox.() -> Unit) : Input

Input of the type Checkbox.

Constructors

InputCheckBox

fun InputCheckBox(key: String? = null, func: InputCheckBox.() -> Unit)

Functions

changeListener

fun changeListener(listener: CheckBoxInputListener)

Set a listener which returns the new value when it changed.

columns

fun columns(columns: Int)

Set the amount of columns this input will span.

content

fun content(@StringRes contentRes: Int)

fun content(content: String)

Set the content text.

defaultValue

fun defaultValue(defaultValue: Boolean)

Set the default value.

drawable

fun drawable(@DrawableRes drawableRes: Int)

Set a drawable.

invokeResultListener

open override fun invokeResultListener(): Unit?

Invoke the result listener which returns the input value.

label

fun label(@StringRes labelRes: Int)

fun label(label: String)

Set the label text.

putValue

open override fun putValue(bundle: Bundle, index: Int)

Save the input value into the bundle. Takes the index as an key, if there's no unique input key available.

required

fun required(required: Boolean = true)

Require a value before the user can click the positive button.

resultListener

fun resultListener(listener: CheckBoxInputListener)

Set a listener which returns the final value when the user clicks the positive button.

text

fun text(@StringRes textRes: Int)

fun text(text: String)

Set the text of the CheckBox.

valid

open override fun valid(): Boolean

Check if the input value is valid.

visible

fun visible(visible: Boolean = true)

Set the initial visibility of the input.

Properties

value

var value: Boolean = false