ZkBlobField

abstract class ZkBlobField<T : EntityBo<T>, BT : BlobBo<BT, T>>(form: ZkForm<T>, comm: BlobCommInterface<BT, T>, reference: EntityId<T>?, blobCountMax: Int?, disposition: String?, blobClass: KClass<BT>?, hideUpload: () -> Boolean, makeBlobCb: (File) -> BT?) : ZkFieldBase<Unit, ZkBlobField<T, BT>>

Form field to handle blobs.

Ways to create the blob instances (in order of precedence):

override makeBlob
pass makeBlobCb
pass blobClass

When none of the above is used, an IllegalStateException is thrown on blob create attempts.

Parameters

form

The form this field belongs to.

reference

The entity to which these images belong.

blobCountMax

Maximum number of images allowed.

disposition

Disposition of images, saved to the disposition field of the image.

blobClass

The class of blob instances. When no special initialization is needed, the field can create the blobs by itself from this class.

hideUpload

Function to decide if the upload area is hidden or nor. Default returns with "false".

makeBlobCb

Callback function to make a blob instance.

Constructors

ZkBlobField

js

fun <T : EntityBo<T>, BT : BlobBo<BT, T>> ZkBlobField(form: ZkForm<T>, comm: BlobCommInterface<BT, T>, reference: EntityId<T>? = null, blobCountMax: Int? = null, disposition: String? = null, blobClass: KClass<BT>? = null, hideUpload: () -> Boolean = { false }, makeBlobCb: (File) -> BT? = null)

The form this field belongs to.

Functions

addChildSkipDOM

js

open fun addChildSkipDOM(child: ZkElement?)

addInvalid

js

open fun HTMLElement.addInvalid()

allowUpload

js

open fun allowUpload(): Boolean

Checks if the current state of the field allows upload.

blobs

js

open fun blobs(): List<BT>

List blob BOs this field contains.

build

js

open infix fun build(builder: ZkElement.() -> Unit): ZkElement

infix fun HTMLElement.build(build: ZkElement.() -> Unit): HTMLElement

buildFieldLabel

js

open fun buildFieldLabel()

buildFieldValue

js

open fun buildFieldValue()

buildSectionField

js

open fun buildSectionField()

clear

js

open fun clear()

clearChildren

js

open fun clearChildren(): ZkElement

column

js

open fun column(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLElement

css

js

fun css(vararg classNames: String): ZkElement

infix fun css(className: String): ZkElement

infix fun css(rule: ZkCssStyleRule): ZkElement

infix fun Element.css(className: String): Element

infix fun HTMLElement.css(className: String): HTMLElement

infix fun HTMLElement.css(rule: ZkCssStyleRule): HTMLElement

div

js

open fun div(vararg rules: ZkCssStyleRule, build: ZkElement.() -> Unit): HTMLElement

open fun div(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLElement

dock

js

fun dock(iconSource: ZkIconSource, title: String?): ZkDockedElement

find

js

inline fun <T : ZkElement> find(): List<T>

findFirst

js

inline fun <T : ZkElement> findFirst(): T

first

js

inline fun <T : ZkElement> first(): T

firstOrNull

js

inline fun <T : ZkElement> firstOrNull(): T?

focus

js

open override fun focus(): ZkElement

focusEvents

js

open fun focusEvents(element: HTMLElement)

focusValue

js

open fun focusValue()

gap

js

open fun gap(width: String, height: String): HTMLElement

get

js

inline operator fun <T : ZkElement> get(cssClassName: String): T

inline operator fun <T : ZkElement> get(kClass: KClass<T>): T

inline operator fun <T : ZkElement> get(rule: ZkCssStyleRule): T

grid

js

open fun grid(rule: ZkCssStyleRule?, style: String?, build: ZkElement.() -> Unit): HTMLElement

gridColumn

js

infix fun gridColumn(value: Int): ZkElement

infix fun gridColumn(value: String): ZkElement

infix fun HTMLElement.gridColumn(value: Int): HTMLElement

infix fun HTMLElement.gridColumn(value: String): HTMLElement

gridRow

js

infix fun gridRow(value: Int): ZkElement

infix fun gridRow(value: String): ZkElement

infix fun HTMLElement.gridRow(value: Int): HTMLElement

infix fun HTMLElement.gridRow(value: String): HTMLElement

h1

js

open fun h1(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLElement

h2

js

open fun h2(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLElement

h3

js

open fun h3(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLElement

h4

js

open fun h4(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLElement

hasChildOf

js

inline fun <T : ZkElement> hasChildOf(): Boolean

hasRole

js

fun hasRole(roleName: String): Boolean

hide

js

open fun hide(): ZkElement

fun HTMLElement.hide(): HTMLElement

ifAnonymous

js

fun ifAnonymous(builder: ZkElement.() -> Unit)

ifNotAnonymous

js

fun ifNotAnonymous(builder: ZkElement.() -> Unit)

image

js

open fun image(src: String, rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLImageElement

insertAfter

js

open fun insertAfter(child: ZkElement?, after: ZkElement?)

insertBefore

js

open fun insertBefore(child: ZkElement?, before: ZkElement?)

insertFirst

js

open infix fun insertFirst(child: ZkElement?)

isEmpty

js

fun isEmpty(): Boolean

isHidden

js

fun isHidden(): Boolean

isShown

js

fun isShown(): Boolean

launchBuild

js

open infix fun launchBuild(builder: suspend ZkElement.() -> Unit): ZkElement

makeBlob

js

open fun makeBlob(file: File): BT

Creates a blob instance from a file dropped on the drop area.

makeEntry

js

abstract fun makeEntry(blob: BT, state: BlobCreateState? = null): ZkBlobFieldEntry<BT>

Creates ZkBlobFieldEntry to display the blob to the user.

mandatoryMark

js

open fun mandatoryMark()

marginBottom

js

infix fun marginBottom(size: Any): ZkElement

marginLeft

js

infix fun marginLeft(size: Any): ZkElement

marginRight

js

infix fun marginRight(size: Any): ZkElement

minusAssign

js

open operator fun minusAssign(clazz: KClass<*>)

open operator fun minusAssign(child: ZkElement?)

needsMandatoryMark

js

open fun needsMandatoryMark(): Boolean

not

js

operator fun String.not(): HTMLElement

operator fun ZkCssStyleRule.not()

on

js

fun on(type: String, listener: (Event) -> Unit?): ZkElement

fun on(target: EventTarget, type: String, listener: (Event) -> Unit?): ZkElement

onCreate

js

open override fun onCreate()

onCreateSuccess

js

open suspend override fun onCreateSuccess(created: EntityBo<*>)

onDelete

js

open suspend fun onDelete(preview: ZkBlobFieldEntry<BT>): Boolean

onDestroy

js

open fun onDestroy()

onDragOver

js

open fun onDragOver(event: Event)

onDrop

js

open fun onDrop(event: Event)

onPause

js

open fun onPause()

onResume

js

open fun onResume()

onUserChange

js

open fun onUserChange(newValue: Unit)

onValidated

js

open override fun onValidated(report: ValidityReport)

p

js

open fun p(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLElement

plusAssign

js

operator fun plusAssign(children: List<ZkElement>)

open operator fun plusAssign(child: ZkElement?)

removeInvalid

js

open fun HTMLElement.removeInvalid()

row

js

open fun row(rule: ZkCssStyleRule?, grid: Boolean, gap: Boolean, build: ZkElement.() -> Unit): HTMLElement

setValidClass

js

open fun setValidClass()

show

js

open fun show(): ZkElement

fun HTMLElement.show(): HTMLElement

showErrors

js

open fun showErrors()

span

js

open fun span(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLElement

stringMandatoryMark

js

fun stringMandatoryMark(): Boolean

style

js

open fun style(styleBuilder: CSSStyleDeclaration.() -> Unit)

syncChildrenState

js

open fun syncChildrenState(child: ZkElement)

table

js

open fun table(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLTableElement

tbody

js

open fun tbody(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLTableSectionElement

td

js

open fun td(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLTableCellElement

th

js

open fun th(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLTableCellElement

thead

js

open fun thead(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLTableSectionElement

toggle

js

fun toggle(): Boolean

tr

js

open fun tr(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): HTMLTableRowElement

unaryMinus

js

operator fun ZkElement.unaryMinus(): ZkElement

operator fun ZkElement?.unaryMinus(): ZkElement?

operator fun ZkCssStyleRule.unaryMinus()

unaryPlus

js

operator fun String.unaryPlus(): Element

operator fun String?.unaryPlus(): Element?

operator fun HTMLElement.unaryPlus(): HTMLElement

operator fun HTMLElement?.unaryPlus(): HTMLElement?

operator fun ZkElement.unaryPlus(): ZkElement

operator fun ZkElement?.unaryPlus(): ZkElement?

operator fun <T, FT : ZkFieldBase<T, FT>> ZkFieldBase<T, FT>.unaryPlus(): FT

operator fun CssValueConst.unaryPlus()

operator fun ZkCssStyleRule.unaryPlus()

updateDropArea

js

open fun updateDropArea()

withOneOfRoles

js

fun withOneOfRoles(vararg roles: String, builder: ZkElement.() -> Unit)

withOptCss

js

fun withOptCss(className: String): ZkElement

withoutRole

js

fun withoutRole(role: String, builder: ZkElement.() -> Unit)

withRole

js

fun withRole(role: String, builder: ZkElement.() -> Unit)

zke

js

open fun zke(rule: ZkCssStyleRule?, build: ZkElement.() -> Unit): ZkElement

Properties

blobClass

js

open val blobClass: KClass<BT>? = null

The class of blob instances.

blobCountMax

js

open val blobCountMax: Int? = null

Maximum number of images allowed.

buildPoint

js

var buildPoint: HTMLElement

childElements

js

val childElements: MutableList<ZkElement>

classList

js

val classList: DOMTokenList

className

js

var className: String

comm

js

open val comm: BlobCommInterface<BT, T>

context

js

val context: ZkFieldContext

disposition

js

open val disposition: String? = null

Disposition of images, saved to the disposition field of the image.

droparea

js

open lateinit var droparea: ZkElement

element

js

val element: HTMLElement

errors

js

val errors: ZkElement

form

js

val form: ZkForm<T>

The form this field belongs to.

gridAutoColumns

js

var gridAutoColumns: String

gridAutoRows

js

var gridAutoRows: String

gridGap

js

var gridGap: String

gridTemplateColumns

js

var gridTemplateColumns: String

gridTemplateRows

js

var gridTemplateRows: String

height

js

var height: String

hideUpload

js

open val hideUpload: () -> Boolean

Function to decide if the upload area is hidden or nor.

hint

js

lateinit var hint: String

id

js

val id: Long

innerHTML

js

var innerHTML: String

innerText

js

var innerText: String

invalidInput

js

var invalidInput: Boolean

label

js

open var label: String?

labelContainer

js

open val labelContainer: HTMLElement

labelText

js

open var labelText: String?

lifeCycleState

js

var lifeCycleState: ZkElementState

makeBlobCb

js

open val makeBlobCb: (File) -> BT? = null

Callback function to make a blob instance.

onChangeCallback

js

var onChangeCallback: (origin: ChangeOrigin, value: Unit, field: ZkBlobField<T, BT>) -> Unit?

onFocusOut

js

var onFocusOut: (event: FocusEvent, field: ZkBlobField<T, BT>) -> Unit?

propName

js

val propName: String?

readOnly

js

open override var readOnly: Boolean

reference

js

open val reference: EntityId<T>? = null

The entity to which these images belong.

setter

js

var setter: (Unit) -> Unit

style

js

var style: String

touched

js

var touched: Boolean

valid

js

var valid: Boolean

value

js

open var value: Unit

valueOrNull

js

abstract var valueOrNull: Unit?

width

js

var width: String

Inheritors

ZkAttachmentsField

ZkImagesField