STREAMWIDE SDK Android 3.12.1/com.streamwide.smartms.lib.core.api_ktx.mybusiness.model.form/TextItem

TextItem

class TextItem : ConditionalDisplayItem

Text Widget ************************* https://trac.smartms.streamwide.com/wiki/22/Backend_Spec_221/Storage_Template_JSON_Structure#text https://trac.smartms.streamwide.com/wiki/22/Backend_Spec_221/Storage_Template_JSON_Structure#textarea

JSON Structure: { "uuid": "1c2470b8-2394-4862-945c-3771db210d56", "type": "text", "label": "First Name", "help": "Type your first name here", "required": false, "maskEmpty": false, "gridLocation": { "rowNumber": 1, "startColumn": 1, "columnSpan": 2 }, "conditionalDisplay": null, "defaultValue": "", "autoCaps": 2, "hasValue": true, "unsupportedTypeValue": "" }, { "uuid": "1c2470b8-2394-4862-945c-3771db210d56", "type": "textarea", "label": "Info", "help": "Type your details here", "required": false, "maskEmpty": false, "gridLocation": { "rowNumber": 1, "startColumn": 1, "columnSpan": 3 }, "conditionalDisplay": null, "defaultValue": "", "lines": 7, "autoCaps": 0, "hasValue": true, "unsupportedTypeValue": "" }

Constructors

fun TextItem( json: JSONObject, displayMode: Int, processUUID: String?)

fun TextItem(parcel: Parcel)

Types

object CREATOR : Parcelable.Creator<TextItem>

Properties

val autoCaps: Int = 0

val currentValue: LiveData<String>

val defaultValue: String

val lines: Int = 1

var value: String

Inherited properties

blacklistedWidgets

val blacklistedWidgets: <ERROR CLASS><String>? = null

var blockRange: Int = 0

bottomWidgetType

val bottomWidgetType: String? = null

val columnSpan: Int = 2

conditionalDisplay

val conditionalDisplay: ConditionalDisplayItem? = null

currentVisibility

val currentVisibility: StateFlow<Boolean>

val displayMode: Int

displayModeLiveData

val displayModeLiveData: LiveData<Int>

displayPositionUUID

val displayPositionUUID: String? = null

val help: String

isConditionalDuplicationEnabled

val isConditionalDuplicationEnabled: Boolean = false

val isRequired: Boolean = false

isUsedInProcessLabel

val isUsedInProcessLabel: Boolean = false

val isVisible: Boolean = false

val label: String

val maskEmpty: Boolean = false

var processUUID: String? = null

val rowNumber: Int = 0

val startColumn: Int = 0

lateinit val type: String

lateinit val uuid: String

validationState

val validationState: LiveData<WidgetResult.ResultStatus>

Functions

open override fun extractData(): String

extract data from all fields of a widget.

extractDataForExternalDB

open override fun extractDataForExternalDB(): String

open override fun getStringValue(context: Context): String

open override fun haveChanges(): Boolean

open override fun isValidValue(mode: Int): Boolean

open override fun parseData(data: String, saveData: Boolean)

open override fun publishValues()

putDataFromExternalDB

open override fun putDataFromExternalDB(data: String?)

open override fun resetValues()

open override fun saveChanges()

updateCurrentValue

fun updateCurrentValue(value: Any)

open override fun writeToParcel(dest: Parcel, flags: Int)

Inherited functions

describeContents

open override fun describeContents(): Int

getConditionalDisplayUUIDs

fun getConditionalDisplayUUIDs(): List<String>?

getSubWidgetItem

open fun getSubWidgetItem(widgetUUID: String?): WidgetItem?

getTypeAndSubType

open fun getTypeAndSubType(): String

haveSubscribers

fun haveSubscribers(): Boolean

fun isRoot(): Boolean

open override fun onDataChanged( widgetUUID: String?, tempValue: String?, data: Any?)

onParentVisibilityChanged

open override fun onParentVisibilityChanged(widgetUUID: String, isVisible: Boolean)

call back when Parent widget Visibility Changed need to set the parent visibility and recalculate the validity of the widget

fun publishData(value: String, data: Any?)

notify all subscribers when data changed on the widget

publishVisibility

open fun publishVisibility(isVisible: Boolean)

update the visibility status and notify all subscribers about the visibility of the widget

setConditionalDisplayType

fun setConditionalDisplayType(uuid: String, type: String)

fun setType(mType: String)

fun setUuid(mUuid: String)

fun subscribe(widgetListener: ConditionalDisplayListener)

called from the activity to add teh callback as subscriber note:subscribers is a Set so we don't need to test if the callback already exist

fun validate(isFullValidation: Boolean): WidgetResult

open override fun writeToParcel(bundle: Bundle): Bundle