MetaElement

open class MetaElement(parent: Element) : Element

Functions

activate

fun activate(): Element

addClasses

fun addClasses(vararg classes: String, onlyIf: Boolean = true): Element

A convenience function to append a class to an existing class attribute.

addEventListener

open override fun addEventListener(eventName: String, returnEventFields: Set<String>, retrieveJs: String?, preventDefault: Boolean, callback: (JsonElement) -> Unit): Element

addImmediateEventCode

open override fun addImmediateEventCode(eventName: String, jsCode: String)

addText

fun addText(value: String): Element

assertPluginLoaded

fun assertPluginLoaded(vararg plugins: KClass<out KwebPlugin>)

Requires that a specific plugin or plugins be loaded by listing them in the plugins parameter of the Kweb constructor.

bind

fun bind(accessor: (elementId: String) -> String, updateOnEvent: String, initialValue: JsonElement = JsonPrimitive("")): KVar<JsonElement>

Return a KVar that is tied to a property related to an element, which will update when an specified event fires on this element.

fun bind(reader: (elementId: String) -> String, writer: (elementId: String, value: String) -> String, updateOnEvent: String, initialValue: JsonElement = JsonPrimitive("")): KVar<JsonElement>

Return a KVar that is tied to a property related to an element, which will update when an specified event fires on this element.

blur

fun blur(): Element

callJsFunction

fun callJsFunction(js: String, vararg args: JsonElement)

Execute some JavaScript in the browser.

callJsFunctionWithResult

suspend fun <O> callJsFunctionWithResult(js: String, outputMapper: (JsonElement) -> O, vararg args: JsonElement): O?

Evaluate some JavaScript in the browser and return the result via a Future.

classes

fun classes(vararg value: String): Element

A convenience function to set the class attribute, this is a wrapper around setAttribute.

fun classes(value: KVal<String>): Element

A convenience function to set the class attribute, this is a wrapper around setAttribute.

deactivate

fun deactivate(): Element

delete

fun delete()

Remove this element by calling removeChild on its parent element.

deleteIfExists

fun deleteIfExists()

Remove this element by calling removeChild on its parent element if it exists.

disable

fun disable(): Element

enable

fun enable(): Element

focus

fun focus(): Element

innerHTML

fun innerHTML(html: String): Element

Sets the innerHTML property of a DOM element.

fun innerHTML(html: KVal<String>): Element

Sets the innerHTML property of a DOM element.

on

fun on(retrieveJs: String? = null, preventDefault: Boolean = false): OnReceiver<Element>

See here.

plugin

fun <P : KwebPlugin> plugin(plugin: KClass<P>): P

Obtain the instance of a plugin by its KClass.

removeAttribute

fun removeAttribute(name: String): Element

removeChildAt

fun removeChildAt(position: Int): Element

removeChildren

fun removeChildren(): Element

removeChildrenBetweenSpans

fun removeChildrenBetweenSpans(startSpanId: String, endSpanId: String): Element

removeClasses

fun removeClasses(vararg classes: String, onlyIf: Boolean = true): Element

A convenience function to remove one or more classes from an existing class attribute.

setAttribute

fun setAttribute(name: String, value: Boolean): Element

fun setAttribute(name: String, value: Number): Element

fun setAttribute(name: String, value: String): Element

fun setAttribute(name: String, oValue: KVal<out JsonPrimitive>): Element

Set an attribute to the value in a KVal, if the value changes the attribute value will be updated automatically.

fun setAttribute(name: String, value: JsonPrimitive, namespace: String? = null): Element

Set an attribute of this element.

setAttributeRaw

fun setAttributeRaw(name: String, value: Boolean): Element

fun setAttributeRaw(name: String, value: Number): Element

fun setAttributeRaw(name: String, value: String): Element

fun setAttributeRaw(name: String, value: JsonPrimitive): Element

setAttributes

fun setAttributes(vararg pair: Pair<String, JsonPrimitive>): Element

A utility function to set multiple attributes in a single call, in the style of mapOf.

setClasses

fun setClasses(vararg value: String): Element

A convenience function to set the class attribute, this is a wrapper around setAttribute.

spellcheck

fun spellcheck(spellcheck: Boolean = true): Element

Determines whether this element will be spellchecked.

text

fun text(value: String): Element

Set the text of this element to value.

fun text(text: KVal<String>): Element

Set the text of this element to an KVal value.

Properties

browser

open override val browser: WebBrowser

creator

val creator: ElementCreator<*>?

flags

val flags: ConcurrentSkipListSet<String>

id

on

val on: OnReceiver<Element>

See here.

onImmediate

val onImmediate: OnImmediateReceiver<Element>

See here.

read

open val read: ElementReader

Obtain an ElementReader that can be used to read various properties of this element.

style

val style: StyleReceiver

Some convenience functions for modifying an element's style attribute.

tag

val tag: String? = null

text

var text: KVar<String>