FloppaClient/floppaclient.module.settings.impl/StringSelectorSetting

StringSelectorSetting

class ~~StringSelectorSetting~~(name: String, defaultSelected: String, var options: ArrayList<String>, visibility: Visibility = Visibility.VISIBLE, description: String? = null) : Setting<Int>

Deprecated

Outdated use the enum selector setting instead.

Constructors

StringSelectorSetting

fun StringSelectorSetting(name: String, defaultSelected: String, options: ArrayList<String>, visibility: Visibility = Visibility.VISIBLE, description: String? = null)

Functions

open operator override fun getValue(thisRef: Module, property: KProperty<*>): Int

This method acts as the getter for the property delegated to this class.

fun isSelected(string: String): Boolean

provideDelegate

open operator override fun provideDelegate(thisRef: Module, property: KProperty<*>): ReadWriteProperty<Module, Int>

This operator provides the Delegate to the Setting.

open fun reset()

Sets value to default.

open operator override fun setValue(thisRef: Module, property: KProperty<*>, value: Int)

This method acts as the setter for the property delegated to this class.

Properties

open override val default: Int

The default for value.

var description: String?

val name: String

var options: ArrayList<String>

var processInput: (Int) -> Int

Can be set to add a setting specific restraint / extra action when setting the new value.

var selected: String

shouldBeVisible

val shouldBeVisible: Boolean

Returns whether this setting should be visible based on visibilityDependency. Is true by default. Use withDependency to change this behavior.

open override var value: Int

This is the main field used to store the state of the setting. There can be additional properties for managing the state in the implementations.

val visibility: Visibility