kform/tech.ostack.kform/DisplayStatus

DisplayStatus

enum DisplayStatus : Enum<DisplayStatus> (source)

Display status of a value.

This status represents how a value should be displayed in terms of its validity, taking into consideration whether it has been "touched". I.e. the value might be invalid but, because it hasn't yet been touched, its display status would be Valid.

Furthermore, the display status of a value takes descendant values into consideration. This means that a parent value containing a "touched" descendant with errors will have a display status of Error.

Entries

Valid

Display status representing that the value is either "unvalidated", "untouched", or that itself and all of its descendants are valid.

Error

Display status representing that the value is "touched" and that either itself of one of its descendants has an error.

Warning

Display status representing that the value is "touched", that either itself of one of its descendants has a warning, and that neither itself nor any of its descendants has an error.

Properties

entries

val entries: EnumEntries<DisplayStatus>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): DisplayStatus

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<DisplayStatus>

Returns an array containing the constants of this enum type, in the order they're declared.