kvision / pl.treksoft.kvision.core / StyledComponent

StyledComponent

abstract class StyledComponent : Component

Base class for components supporting CSS styling.

Types

RefreshDelegate	`inner class RefreshDelegate<T>`
RefreshDelegateProvider	`inner class RefreshDelegateProvider<T>`

Constructors

<init>

StyledComponent()

Base class for components supporting CSS styling.

Properties

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.
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: CssSize?` Bottom edge 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).
display	`open var display: Display?` CSS display of the current component.
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: CssSize?` 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.
height	`open var height: CssSize?` Height of the current component.
left	`open var left: CssSize?` Left edge of the current component.
letterSpacing	`open var letterSpacing: CssSize?` CSS Text letter spacing of the current component.
lineHeight	`open var lineHeight: CssSize?` CSS Text line height of the current component.
margin	`open var margin: CssSize?` Margin of the current component.
marginBottom	`open var marginBottom: CssSize?` Bottom margin of the current component.
marginLeft	`open var marginLeft: CssSize?` Left margin of the current component.
marginRight	`open var marginRight: CssSize?` Right margin of the current component.
marginTop	`open var marginTop: CssSize?` Top margin of the current component.
maxHeight	`open var maxHeight: CssSize?` Maximal height of the current component.
maxWidth	`open var maxWidth: CssSize?` Maximal width of the current component.
minHeight	`open var minHeight: CssSize?` Minimal height of the current component.
minWidth	`open var minWidth: CssSize?` Minimal width of the current component.
opacity	`open var opacity: Double?` Opacity of the current component.
overflow	`open var overflow: Overflow?` CSS overflow of the current component.
padding	`open var padding: CssSize?` Padding of the current component.
paddingBottom	`open var paddingBottom: CssSize?` Bottom padding of the current component.
paddingLeft	`open var paddingLeft: CssSize?` Left padding of the current component.
paddingRight	`open var paddingRight: CssSize?` Right padding of the current component.
paddingTop	`open var paddingTop: CssSize?` Top padding 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: CssSize?` Right edge of the current component.
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: CssSize?` 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.
top	`open var top: CssSize?` Top edge of 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.
whiteSpace	`open var whiteSpace: WhiteSpace?` CSS Text white space of the current component.
width	`open var width: CssSize?` Width of the current component.
wordSpacing	`open var wordSpacing: CssSize?` CSS Text word spacing of the current component.
zIndex	`open var zIndex: Int?` Z-index of the current component.

Inherited Properties

parent	`abstract var parent: Container?` Parent of the current component.
visible	`abstract var visible: Boolean` Visibility state of the current component.

Functions

getSnStyle	`open fun getSnStyle(): List<StringPair>` Returns the list of String pairs defining CSS style attributes and their values.
refreshOnUpdate	`fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>` `fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>`

Inherited Functions

addCssClass	`abstract fun addCssClass(css: String): Component` Adds given value to the set of CSS classes generated in html code of current component.
addSurroundingCssClass	`abstract fun addSurroundingCssClass(css: String): Component` Adds given value to the set of CSS classes generated in html code of parent component.
getElement	`abstract fun getElement(): Node?` Returns DOM element bound to the current component.
getElementJQuery	`abstract fun getElementJQuery(): JQuery?` Returns JQuery element bound to the current component.
getElementJQueryD	`abstract fun getElementJQueryD(): dynamic` Returns JQuery element bound to the current component as a dynamic type.
removeCssClass	`abstract fun removeCssClass(css: String): Component` Removes given value from the set of CSS classes generated in html code of current component.
removeSurroundingCssClass	`abstract fun removeSurroundingCssClass(css: String): Component` Removes given value from the set of CSS classes generated in html code of parent component.

Inheritors

Widget

open class Widget : StyledComponent

Base widget class. The parent of all component classes.