Splitter

open class Splitter(classes: Set<String>, init: Splitter.() -> Unit?) : SimplePanel

A splitter component.

Parameters

classes

a set of CSS class names

init

an initializer extension function

Constructors

Splitter

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

Creates a splitter component.

Functions

add

open override fun add(child: Component): SimplePanel

Adds given component to the current container.

open override fun add(position: Int, child: Component): SimplePanel

Adds given component to the current container at the given position.

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): <ERROR CLASS>

The supplied function is called after the widget is removed from the DOM.

addAfterInsertHook

open override fun addAfterInsertHook(hook: (<ERROR CLASS>) -> Unit): <ERROR CLASS>

The supplied function is called after the widget is inserted into the DOM.

addAll

open override fun addAll(children: List<Component>): SimplePanel

Adds a list of components to the current container.

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): <ERROR CLASS>

The supplied function is called before the widget is disposed.

addCssClass

open override fun addCssClass(css: String): Widget

Adds given value to the set of CSS classes generated in html code of current component.

addCssStyle

open override fun addCssStyle(css: Style): Widget

Adds given style object to the set of CSS classes generated in html code of current component.

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String): Widget

Adds given value to the set of CSS classes generated in html code of parent component.

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style): Widget

Adds given style object to the set of CSS classes generated in html code of parent component.

animate

open fun animate(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null, styles: StyledComponent.() -> Unit)

Animate the widget changing CSS properties.

blur

open fun blur()

Makes the element blur.

clearDragDropData

open fun clearDragDropData()

Clears D&D data for the current widget.

disablePopover

open fun disablePopover(): Widget

Disables popover for the current widget.

disableTooltip

open fun disableTooltip(): Widget

Disables tooltip for the current widget.

disposeAll

open override fun disposeAll(): Container

Removes all children from the current container and disposes them.

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.

fadeIn

open fun fadeIn(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Shows current widget with fade in effect.

fadeOut

open fun fadeOut(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Hides current widget with fade out effect.

focus

open fun focus()

Makes the element focused.

getAttribute

open override fun getAttribute(name: String): String?

Returns the value of an additional attribute.

getChildren

open override fun getChildren(): List<Component>

Returns a list of children of the current container.

getElement

open override fun getElement(): <ERROR CLASS>?

Returns DOM element bound to the current component.

getElementJQuery

open override fun getElementJQuery(): <ERROR CLASS>?

Returns JQuery element bound to the current component.

getElementJQueryD

open override fun getElementJQueryD(): dynamic

Returns JQuery element bound to the current component as a dynamic type.

getSnStyle

open fun getSnStyle(): List<<ERROR CLASS><String, String>>

Returns the list of String pairs defining CSS style attributes and their values.

getStyle

fun getStyle(name: String): String?

Returns the value of a custom CSS style.

hasCssClass

open override fun hasCssClass(css: String): Boolean

Checks whether the given value is present in the set of CSS classes.

hide

open fun hide(): Widget

Makes current widget invisible.

hideAnim

open fun hideAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Hides current widget with animation effect.

hidePopover

open fun hidePopover(): Widget

Hides popover for the current widget.

hideTooltip

open fun hideTooltip(): Widget

Hides tooltip for the current widget.

invoke

open operator fun invoke(vararg children: Component): Container

Operator function for adding children in a DSL style.

onDeviceBackButton

open fun onDeviceBackButton(callback: (event: BackButtonEvent) -> Unit)

Sets device back button event listener.

onDeviceBackButtonClear

open fun onDeviceBackButtonClear()

Clears device back button event listener.

remove

open override fun remove(child: Component): SimplePanel

Removes given component from the current container.

removeAll

open override fun removeAll(): SimplePanel

Removes all children from the current container.

removeAt

open override fun removeAt(position: Int): SimplePanel

Removes child component from the current container at the given position.

removeAttribute

open override fun removeAttribute(name: String): Widget

Removes the value of additional attribute.

removeCssClass

open override fun removeCssClass(css: String): Widget

Removes given value from the set of CSS classes generated in html code of current component.

removeCssStyle

open override fun removeCssStyle(css: Style): Widget

Removes given style object from the set of CSS classes generated in html code of current component.

removeEventListener

open fun removeEventListener(id: Int): Widget

Removes event listener from current widget.

removeEventListeners

open fun removeEventListeners(): Widget

Removes all event listeners from current widget.

removeStyle

fun removeStyle(name: String): StyledComponent

Removes the value of a custom CSS style.

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String): Widget

Removes given value from the set of CSS classes generated in html code of parent component.

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style): Widget

Removes given style object from the set of CSS classes generated in html code of parent component.

setAttribute

open override fun setAttribute(name: String, value: String): Widget

Sets the value of additional attribute.

setDragDropData

open fun setDragDropData(format: String, data: String)

Sets D&D data for the current widget.

setDropTarget

open fun setDropTarget(format: String, callback: (<ERROR CLASS>) -> Unit)

Sets the current widget as a D&D drop target.

open fun setDropTarget(formats: Set<String>? = null, callback: (<ERROR CLASS>) -> Unit)

Sets the current widget as a D&D drop target.

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> 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): Int

Sets an event listener for current widget, keeping the actual type of component.

setStyle

fun setStyle(name: String, value: String): StyledComponent

Sets the value of a custom CSS style.

show

open fun show(): Widget

Makes current widget visible.

showAnim

open fun showAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Shows current widget with animation effect.

showPopover

open fun showPopover(): Widget

Shows popover for the current widget.

showTooltip

open fun showTooltip(): Widget

Shows tooltip for the current widget.

singleRender

open override fun <T> singleRender(block: () -> T): T

Executes given function within a single rendering process.

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

Executes given function within a single rendering process asynchronously.

slideDown

open fun slideDown(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Shows current widget with slide down effect.

slideUp

open fun slideUp(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Hides current widget with slide up effect.

toggleVisible

open fun toggleVisible(): Widget

Toggles visibility of current widget.

unaryPlus

open operator fun String.unaryPlus()

An operator to add a text node to the container.

Properties

alignContent

open var alignContent: AlignContent?

CSS flexbox/grid content alignment.

alignItems

open var alignItems: AlignItems?

CSS flexbox/grid items alignment.

alignSelf

open var alignSelf: AlignItems?

CSS flexbox items self-alignment.

background

open var background: Background?

Background of the current component.

border

open var border: Border?

Border of the current component.

borderBottom

open var borderBottom: Border?

Bottom border of the current component.

borderLeft

open var borderLeft: Border?

Left border of the current component.

borderRadius

open var borderRadius: <ERROR CLASS><Number, UNIT>?

CSS border radius.

borderRadiusList

open var borderRadiusList: List<<ERROR CLASS><Number, UNIT>>?

List of CSS border radius values.

borderRight

open var borderRight: Border?

Right border of the current component.

borderTop

open var borderTop: Border?

Top border of the current component.

bottom

open var bottom: <ERROR CLASS><Number, UNIT>?

Bottom edge of the current component.

boxShadow

open var boxShadow: BoxShadow?

Box shadow of the current component.

boxShadowList

open var boxShadowList: List<BoxShadow>?

List of box shadows of the current component.

clear

open var clear: Clear?

CSS clear float of the current component.

color

open var color: Color?

Text color for the current component.

colorHex

open var colorHex: Int?

Text color for the current component given in hex format (write only).

colorName

open var colorName: Col?

Text color for the current component given with named constant (write only).

content

val content: <ERROR CLASS>?

A dynamic property returning current content element.

cursor

open var cursor: Cursor?

CSS cursor shape over the current component.

display

open var display: Display?

CSS display of the current component.

draggable

var draggable: Boolean?

Determines if the current widget is draggable.

eventTarget

var eventTarget: Widget? = null

flexBasis

open var flexBasis: <ERROR CLASS><Number, UNIT>?

CSS flexbox item basis.

flexDirection

open var flexDirection: FlexDirection?

CSS flexbox direction.

flexGrow

open var flexGrow: Int?

CSS flexbox item grow.

flexShrink

open var flexShrink: Int?

CSS flexbox item shrink.

flexWrap

open var flexWrap: FlexWrap?

CSS flexbox wrap mode.

float

open var float: PosFloat?

CSS position float of the current component.

fontFamily

open var fontFamily: String?

CSS font family of the current component.

fontSize

open var fontSize: <ERROR CLASS><Number, UNIT>?

CSS font size of the current component.

fontStyle

open var fontStyle: FontStyle?

CSS font style of the current component.

fontVariant

open var fontVariant: FontVariant?

CSS font variant of the current component.

fontWeight

open var fontWeight: FontWeight?

CSS font weight of the current component.

gridArea

open var gridArea: String?

CSS grid area.

gridAutoColumns

open var gridAutoColumns: String?

CSS grid auto columns.

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

CSS grid auto flow.

gridAutoRows

open var gridAutoRows: String?

CSS grid auto rows.

gridColumnEnd

open var gridColumnEnd: String?

CSS grid column end.

gridColumnGap

open var gridColumnGap: Int?

CSS grid column gap.

gridColumnStart

open var gridColumnStart: Int?

CSS grid column start.

gridRowEnd

open var gridRowEnd: String?

CSS grid row end.

gridRowGap

open var gridRowGap: Int?

CSS grid row gap.

gridRowStart

open var gridRowStart: Int?

CSS grid row start.

gridTemplateAreas

open var gridTemplateAreas: List<String>?

CSS grid areas template.

gridTemplateColumns

open var gridTemplateColumns: String?

CSS grid columns template.

gridTemplateRows

open var gridTemplateRows: String?

CSS grid rows template.

height

open var height: <ERROR CLASS><Number, UNIT>?

Height of the current component.

var id: String?

An ID attribute of generated HTML element.

justifyContent

open var justifyContent: JustifyContent?

CSS flexbox/grid content justification.

justifyItems

open var justifyItems: JustifyItems?

CSS grid items justification.

justifySelf

open var justifySelf: JustifyItems?

CSS grid items self-justification.

left

open var left: <ERROR CLASS><Number, UNIT>?

Left edge of the current component.

leftSide

val leftSide: <ERROR CLASS>?

A dynamic property returning current left side element.

letterSpacing

open var letterSpacing: <ERROR CLASS><Number, UNIT>?

CSS Text letter spacing of the current component.

lineBreak

open var lineBreak: LineBreak?

CSS line break of the current component.

lineHeight

open var lineHeight: <ERROR CLASS><Number, UNIT>?

CSS Text line height of the current component.

margin

open var margin: <ERROR CLASS><Number, UNIT>?

Margin of the current component.

marginBottom

open var marginBottom: <ERROR CLASS><Number, UNIT>?

Bottom margin of the current component.

marginLeft

open var marginLeft: <ERROR CLASS><Number, UNIT>?

Left margin of the current component.

marginRight

open var marginRight: <ERROR CLASS><Number, UNIT>?

Right margin of the current component.

marginTop

open var marginTop: <ERROR CLASS><Number, UNIT>?

Top margin of the current component.

maxHeight

open var maxHeight: <ERROR CLASS><Number, UNIT>?

Maximal height of the current component.

maxWidth

open var maxWidth: <ERROR CLASS><Number, UNIT>?

Maximal width of the current component.

minHeight

open var minHeight: <ERROR CLASS><Number, UNIT>?

Minimal height of the current component.

minWidth

open var minWidth: <ERROR CLASS><Number, UNIT>?

Minimal width of the current component.

opacity

open var opacity: Double?

Opacity of the current component.

order

open var order: Int?

CSS flexbox item order.

outline

open var outline: Outline?

Outline of the current component.

overflow

open var overflow: Overflow?

CSS overflow of the current component.

overflowWrap

open var overflowWrap: OverflowWrap?

CSS overflow-wrap of the current component.

padding

open var padding: <ERROR CLASS><Number, UNIT>?

Padding of the current component.

paddingBottom

open var paddingBottom: <ERROR CLASS><Number, UNIT>?

Bottom padding of the current component.

paddingLeft

open var paddingLeft: <ERROR CLASS><Number, UNIT>?

Left padding of the current component.

paddingRight

open var paddingRight: <ERROR CLASS><Number, UNIT>?

Right padding of the current component.

paddingTop

open var paddingTop: <ERROR CLASS><Number, UNIT>?

Top padding of the current component.

parent

open override var parent: Container? = null

Parent of the current component.

position

open var position: Position?

CSS position of the current component.

resize

open var resize: Resize?

CSS resize of the current component.

right

open var right: <ERROR CLASS><Number, UNIT>?

Right edge of the current component.

rightSide

val rightSide: <ERROR CLASS>?

A dynamic property returning current right side element.

role

var role: String?

A role attribute of generated HTML element.

side

val side: <ERROR CLASS>?

A dynamic property returning current first side element.

tabindex

var tabindex: Int?

A tabindex attribute of generated HTML element.

textAlign

open var textAlign: TextAlign?

CSS Text align of the current component.

textDecoration

open var textDecoration: TextDecoration?

CSS Text decoration of the current component.

textDirection

open var textDirection: Direction?

CSS Text direction of the current component.

textIndent

open var textIndent: <ERROR CLASS><Number, UNIT>?

CSS Text indent of the current component.

textOverflow

open var textOverflow: TextOverflow?

CSS Text overflow of the current component.

textShadow

open var textShadow: TextShadow?

CSS Text shadow of the current component.

textTransform

open var textTransform: TextTransform?

CSS Text transform of the current component.

title

var title: String?

A title attribute of generated HTML element.

top

open var top: <ERROR CLASS><Number, UNIT>?

Top edge of the current component.

transition

open var transition: Transition?

CSS transition effect for the current component.

transitionList

open var transitionList: List<Transition>?

List of CSS transition effects for the current component.

unicodeBidi

open var unicodeBidi: UnicodeBidi?

CSS Text unicode-bidi of the current component.

verticalAlign

open var verticalAlign: VerticalAlign?

CSS Text vertical align of the current component.

visible

open override var visible: Boolean = true

Visibility state of the current component.

whiteSpace

open var whiteSpace: WhiteSpace?

CSS Text white space of the current component.

width

open var width: <ERROR CLASS><Number, UNIT>?

Width of the current component.

wordBreak

open var wordBreak: WordBreak?

CSS word break of the current component.

wordSpacing

open var wordSpacing: <ERROR CLASS><Number, UNIT>?

CSS Text word spacing of the current component.

zIndex

open var zIndex: Int?

Z-index of the current component.

Extensions

splitterContent

fun Splitter.splitterContent(classes: Set<String>? = null, className: String? = null, init: SplitterContent.() -> Unit? = null): SplitterContent

DSL builder extension function.

splitterSide

fun Splitter.splitterSide(animation: SideAnimation? = null, swipeable: Boolean? = null, collapse: Collapse? = null, side: Side? = null, classes: Set<String>? = null, className: String? = null, init: SplitterSide.() -> Unit? = null): SplitterSide

DSL builder extension function.