Package dev.fritz2.dom

Types

CommentNode

class CommentNode(content: String, domNode: Comment) : WithDomNode<Comment>

Represents a DOM-CommentNode

DomListener

class DomListener<E : Event, out X : Element>(events: Flow<E>) : Listener<E>

Handles a Flow of Dom Events.

EventContext

interface EventContext<out T : Element> : WithJob, WithEvents<T>

Context for handling events

HtmlTagMarker

@DslMarker()

annotation class HtmlTagMarker

A marker to separate the layers of calls in the type-safe-builder pattern.

Listener

open class Listener<E : Event>(events: Flow<E>)

Handles a Flow of Events

MultipleRootElementsException

class MultipleRootElementsException(message: String) : Exception

Occurs when more then one root Tag is defined in a render context.

Tag

open class Tag<out E : Element>(tagName: String, id: String?, baseClass: String?, job: Job, domNode: E) : WithDomNode<E> , WithComment<E> , EventContext<E> , TagContext

Represents a tag in the resulting HTML.

TextNode

class TextNode(content: String, domNode: Text) : WithDomNode<Text>

Represents a DOM-TextNode

Window

object Window

Represents all Events of the browser window object as WindowListeners

WindowListener

class WindowListener<E : Event>(events: Flow<E>) : Listener<E>

Handles a Flow of Window Events

WithComment

interface WithComment<out T : Node> : WithDomNode<T> , TagContext

Provides functionality to handle comments.

WithDomNode

external interface WithDomNode<out T : Node>

Base-interface for everything that represents a node in the DOM.

WithEvents

interface WithEvents<out T : Element> : WithDomNode<T>

Offers DomListeners for all DOM-events available.

WithText

interface WithText<N : Node> : WithDomNode<N> , TagContext

Interface providing functionality to handle text-content

Functions

enter

fun DomListener<KeyboardEvent, HTMLInputElement>.enter(): Flow<String>

Gives you the new value as String from the targeting Element when enter is pressed.

fun DomListener<KeyboardEvent, HTMLTextAreaElement>.enter(): Flow<String>

Gives you the new value as String from the targeting Element.

enterAsNumber

fun DomListener<KeyboardEvent, HTMLInputElement>.enterAsNumber(): Flow<Double>

Gives you the new value as Double from the targeting Element when enter is pressed.

files

fun DomListener<Event, HTMLInputElement>.files(): Flow<FileList?>

Gives you the FileList from the targeting Element.

key

fun <X : Element> DomListener<KeyboardEvent, X>.key(): Flow<Key>

Gives you the pressed key as Key from a KeyboardEvent.

fun <X : Element> WindowListener<KeyboardEvent>.key(): Flow<Key>

Gives you the pressed key as Key from a KeyboardEvent.

mountDomNode

fun <N : Node> mountDomNode(job: Job, target: N, upstream: Flow<WithDomNode<N>>)

Mounts the values of a Flow of WithDomNodes (mostly Tags) at this point in the DOM.

mountDomNodeList

fun <N : Node> mountDomNodeList(job: Job, target: N, upstream: Flow<List<WithDomNode<N>>>)

Mounts the a List of a Flow of WithDomNodes (mostly Tags) at this point in the DOM.

mountDomNodePatch

fun <N : Node> mountDomNodePatch(job: Job, target: N, upstream: Flow<List<Patch<WithDomNode<N>>>>, cancelJob: (Node) -> Unit)

Mounts Patches of a Flow of WithDomNodes (mostly Tags) at this point in the DOM.

mountDomNodeUnordered

fun <N : Node> mountDomNodeUnordered(job: Job, target: N, upstream: Flow<WithDomNode<N>>)

Mounts the values of a Flow of WithDomNodes (mostly Tags) at this point in the DOM.

selectedIndex

fun DomListener<Event, HTMLSelectElement>.selectedIndex(): Flow<Int>

Gives you the selected index as Int from the targeting Element.

selectedText

fun DomListener<Event, HTMLSelectElement>.selectedText(): Flow<String>

Gives you the selected text as String from the targeting Element.

selectedValue

fun DomListener<Event, HTMLSelectElement>.selectedValue(): Flow<String>

Gives you the selected value as String from the targeting Element.

states

fun DomListener<Event, HTMLInputElement>.states(): Flow<Boolean>

Gives you the checked value as Boolean from the targeting Element.

values

fun DomListener<Event, HTMLInputElement>.values(): Flow<String>

Gives you the new value as String from the targeting Element.

fun DomListener<Event, HTMLSelectElement>.values(): Flow<String>

Gives you the new value as String from the targeting Element.

fun DomListener<Event, HTMLTextAreaElement>.values(): Flow<String>

Gives you the new value as String from the targeting Element.

fun DomListener<InputEvent, HTMLInputElement>.values(): Flow<String>

Gives you the new value as String from the targeting Element.

valuesAsNumber

fun DomListener<Event, HTMLInputElement>.valuesAsNumber(): Flow<Double>

Gives you the new value as Double from the targeting Element.

fun DomListener<InputEvent, HTMLInputElement>.valuesAsNumber(): Flow<Double>

Gives you the new value as Double from the targeting Element.