kvision / pl.treksoft.kvision.html / Iframe

Iframe

open class Iframe : Widget

Iframe component.

Constructors

Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf())

Properties

iframeHeight	`var iframeHeight: Int?` The height of the iframe.
iframeWidth	`var iframeWidth: Int?` The width of the iframe.
location	`var location: String?` A current location URL of the iframe.
name	`var name: String?` The name of the iframe.
sandbox	`var sandbox: Set<Sandbox>?` A set of Sandbox options.
src	`var src: String?` The iframe document address.
srcdoc	`var srcdoc: String?` The HTML content of the iframe.

Inherited Properties

draggable	`var draggable: Boolean?` Determines if the current widget is draggable.
eventTarget	`var eventTarget: Widget?`
id	`var id: String?` An ID attribute of generated HTML element.
lastLanguage	`var lastLanguage: String?`
parent	`open var parent: Container?` Parent of the current component.
popoverOptions	`var popoverOptions: PopoverOptions?`
role	`var role: String?` A role attribute of generated HTML element.
surroundingSpan	`var surroundingSpan: Boolean`
tabindex	`var tabindex: Int?` A tabindex attribute of generated HTML element.
title	`var title: String?` A title attribute of generated HTML element.
tooltipOptions	`var tooltipOptions: TooltipOptions?`
visible	`open var visible: Boolean` Visibility state of the current component.
vnode	`var vnode: VNode?`

Functions

getIframeWindow	`open fun getIframeWindow(): Window` Returns content window object of the iframe.
getSnAttrs	`open fun getSnAttrs(): List<StringPair>` Returns list of element attributes in the form of a List.
render	`open fun render(): VNode` Renders current component as a Snabbdom vnode.

Inherited Functions

addCssClass	`open fun addCssClass(css: String): Widget` Adds given value to the set of CSS classes generated in html code of current component.
addCssStyle	`open fun addCssStyle(css: Style): Widget` Adds given style object to the set of CSS classes generated in html code of current component.
addSurroundingCssClass	`open fun addSurroundingCssClass(css: String): Widget` Adds given value to the set of CSS classes generated in html code of parent component.
addSurroundingCssStyle	`open fun addSurroundingCssStyle(css: Style): Widget` Adds given style object to the set of CSS classes generated in html code of parent component.
afterCreate	`open fun afterCreate(node: VNode): Unit` Method called after creating Snabbdom vnode.
afterDestroy	`open fun afterDestroy(): Unit` Method called after destroying Snabbdom vnode.
afterInsert	`open fun afterInsert(node: VNode): Unit` Method called after inserting Snabbdom vnode into the DOM.
clearDragDropData	`open fun clearDragDropData(): Unit` Clears D&D data for the current widget. It also makes it not draggable.
disablePopover	`open fun disablePopover(): Widget` Disables popover for the current widget.
disableTooltip	`open fun disableTooltip(): Widget` Disables tooltip for the current widget.
dispatchEvent	`open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?`
enablePopover	`open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget` Enables popover for the current widget.
enableTooltip	`open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget` Enables tooltip for the current widget.
getAttribute	`open fun getAttribute(name: String): String?` Returns the value of an additional attribute.
getElement	`open fun getElement(): Node?` Returns DOM element bound to the current component.
getElementJQuery	`open fun getElementJQuery(): JQuery?` Returns JQuery element bound to the current component.
getElementJQueryD	`open fun getElementJQueryD(): dynamic` Returns JQuery element bound to the current component as a dynamic type.
getSnClass	`open fun getSnClass(): List<StringBoolPair>` Returns list of CSS class names for current widget in the form of a List.
getSnHooks	`open fun getSnHooks(): Hooks?` Returns list of hooks in the form of a Snabbdom Hooks object.
getSnOn	`open fun getSnOn(): On?` Returns list of event handlers in the form of a Snabbdom On object.
hide	`open fun hide(): Widget` Makes current widget invisible.
hidePopover	`open fun hidePopover(): Widget` Hides popover for the current widget.
hideTooltip	`open fun hideTooltip(): Widget` Hides tooltip for the current widget.
refreshOnUpdate	`fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>` `fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>`
removeAttribute	`open fun removeAttribute(name: String): Widget` Removes the value of additional attribute.
removeCssClass	`open fun removeCssClass(css: String): Widget` Removes given value from the set of CSS classes generated in html code of current component.
removeCssStyle	`open fun removeCssStyle(css: Style): Widget` Removes given style object from the set of CSS classes generated in html code of current component.
removeEventListeners	`open fun removeEventListeners(): Widget` Removes all event listeners from current widget.
removeSurroundingCssClass	`open fun removeSurroundingCssClass(css: String): Widget` Removes given value from the set of CSS classes generated in html code of parent component.
removeSurroundingCssStyle	`open fun removeSurroundingCssStyle(css: Style): Widget` Removes given style object from the set of CSS classes generated in html code of parent component.
render	`open fun render(elementName: String): VNode` `open fun render(elementName: String, children: Array<dynamic>): VNode` Renders current component as a Snabbdom vnode.
setAttribute	`open fun setAttribute(name: String, value: String): Widget` Sets the value of additional attribute.
setDragDropData	`open fun setDragDropData(format: String, data: String): Unit` Sets D&D data for the current widget. It also makes it draggable.
setDropTarget	`open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit` `open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit` Sets the current widget as a D&D drop target.
setDropTargetData	`open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit` Sets the current widget as a D&D drop target with helper callback accepting String data.
setEventListener	`open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget` Sets an event listener for current widget, keeping the actual type of component. `open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget` Sets an event listener for current widget.
show	`open fun show(): Widget` Makes current widget visible.
showPopover	`open fun showPopover(): Widget` Shows popover for the current widget.
showTooltip	`open fun showTooltip(): Widget` Shows tooltip for the current widget.
singleRender	`fun <T> singleRender(block: () -> T): T`
toggleVisible	`open fun toggleVisible(): Widget` Toggles visibility of current widget.
translate	`fun translate(text: String?): String?`

Extension Functions

addBsBgColor	`fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit`
addBsBorder	`fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit`
addBsClearfix	`fun Component.addBsClearfix(): Unit`
addBsColor	`fun Component.addBsColor(bsColor: BsColor): Unit`
addBsRounded	`fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit`
contextMenu	`fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu` DSL builder extension function.
createInstance	`fun <T> Any?.createInstance(vararg args: dynamic): T` Helper function for creating JavaScript objects from dynamic constructors.
onEvent	`fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Widget`
removeBsBgColor	`fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit`
removeBsBorder	`fun Component.removeBsBorder(vararg bsBorder: BsBorder): Unit`
removeBsClearfix	`fun Component.removeBsClearfix(): Unit`
removeBsColor	`fun Component.removeBsColor(bsColor: BsColor): Unit`
removeBsRounded	`fun Component.removeBsRounded(vararg bsRounded: BsRounded): Unit`
setContextMenu	`fun Widget.setContextMenu(contextMenu: ContextMenu): Widget` Sets context menu for the current widget.
style	`fun Widget.style(className: String? = null, init: (Style.() -> Unit)? = null): Style` DSL builder extension function.