kvision / pl.treksoft.kvision.panel / SimplePanel

SimplePanel

open class SimplePanel : Widget, Container

Basic container class, rendered as a DIV element with all children directly within.

Constructors

SimplePanel(classes: Set<String> = setOf(), init: SimplePanel.() -> Unit = null)

Inherited Properties

draggable	`var draggable: Boolean?` Determines if the current widget is draggable.
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.
role	`var role: String?` A role attribute of generated HTML element.
title	`var title: String?` A title attribute of generated HTML element.
visible	`open var visible: Boolean` Visibility state of the current component.

Functions

add	`open fun add(child: Component): SimplePanel` Adds given component to the current container.
addAll	`open fun addAll(children: List<Component>): SimplePanel` Adds a list of components to the current container.
addInternal	`fun addInternal(child: Component): SimplePanel` Protected and final method to add given component to the current container.
childrenVNodes	`open fun childrenVNodes(): Array<VNode>` Returns the array of the children Snabbdom vnodes.
getChildren	`open fun getChildren(): List<Component>` Returns a list of children of the current container.
remove	`open fun remove(child: Component): SimplePanel` Removes given component from the current container.
removeAll	`open fun removeAll(): SimplePanel` Removes all children from the current container.
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.
addSurroundingCssClass	`open fun addSurroundingCssClass(css: String): Widget` Adds given value 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.
afterPostpatch	`open fun afterPostpatch(node: VNode): Unit` Method called after updating Snabbdom vnode.
clearDragDropData	`open fun clearDragDropData(): Unit` Clears D&D data for the current widget. It also makes it not draggable.
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.
getSnAttrs	`open fun getSnAttrs(): List<StringPair>` Returns list of element attributes in the form of a List.
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.
invoke	`open operator fun invoke(vararg children: Component): Container` Operator function for adding children in a DSL style.
removeCssClass	`open fun removeCssClass(css: String): Widget` Removes given value 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.
render	`open fun render(elementName: String): VNode` `open fun render(elementName: String, children: Array<dynamic>): VNode` Renders current component as a Snabbdom vnode.
setContextMenu	`open fun setContextMenu(contextMenu: ContextMenu): Widget` Sets context menu for the current widget.
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.
toggleVisible	`open fun toggleVisible(): Widget` Toggles visibility of current widget.
translate	`fun translate(text: String?): String?`

Companion Object Functions

simplePanel

fun Container.simplePanel(classes: Set<String> = setOf(), init: SimplePanel.() -> Unit = null): SimplePanel

DSL builder extension function.

Inheritors

AbstractText	`abstract class AbstractText : SimplePanel, StringFormControl` Base class for form field text components.
ButtonGroup	`open class ButtonGroup : SimplePanel` The Bootstrap button group.
CheckBox	`open class CheckBox : SimplePanel, BoolFormControl` The form field component rendered as HTML input type="checkbox".
DateTime	`open class DateTime : SimplePanel, KDateFormControl` Form field date/time chooser component.
DockPanel	`open class DockPanel : SimplePanel` The container with dock layout (up, down, left, right and center positions).
DropDown	`open class DropDown : SimplePanel` Bootstrap dropdown component.
FlexPanel	`open class FlexPanel : SimplePanel` The container with CSS flexbox layout support.
FormPanel	`open class FormPanel<K : Any> : SimplePanel` Bootstrap form component.
GridPanel	`open class GridPanel : SimplePanel` The container with CSS grid layout support.
Link	`open class Link : SimplePanel` Link component.
ListTag	`open class ListTag : SimplePanel` HTML list component.
Modal	`open class Modal : SimplePanel` Configurable modal window based on Bootstrap modal.
Navbar	`open class Navbar : SimplePanel` The Bootstrap Navbar container.
ProgressBar	`open class ProgressBar : SimplePanel` The Bootstrap progress bar.
Radio	`open class Radio : SimplePanel, BoolFormControl` The form field component rendered as HTML input type="radio".
RadioGroup	`open class RadioGroup : SimplePanel, StringFormControl` The form field component rendered as a group of HTML input type="radio" elements with the same name attribute.
ResponsiveGridPanel	`open class ResponsiveGridPanel : SimplePanel` The container with support for Bootstrap responsive grid layout.
Root	`class Root : SimplePanel` Root container.
Select	`open class Select : SimplePanel, StringFormControl` The form field component for Select control.
SelectInput	`open class SelectInput : SimplePanel, FormInput` The basic component for Select control.
SelectOptGroup	`open class SelectOptGroup : SimplePanel` The helper container for adding option groups to Select.
Spinner	`open class Spinner : SimplePanel, NumberFormControl` The form field component for spinner control.
SplitPanel	`open class SplitPanel : SimplePanel` The container with draggable splitter.
StackPanel	`open class StackPanel : SimplePanel` The container with only one active (visible) child at any moment.
TabPanel	`open class TabPanel : SimplePanel` The container rendering it's children as tabs.
Table	`open class Table : SimplePanel` HTML table component.
Tag	`open class Tag : SimplePanel, Template` HTML tag component.
Toolbar	`open class Toolbar : SimplePanel` The Bootstrap toolbar.
Upload	`open class Upload : SimplePanel, KFilesFormControl` The form field file upload component.
WidgetWrapper	`open class WidgetWrapper : SimplePanel` This class allows to wrap a component into separately styled DIV element.
Window	`open class Window : SimplePanel` Floating window container.