tornadofx / tornadofx

Package tornadofx


AbstractField abstract class AbstractField : Pane
AnchorPaneConstraint class AnchorPaneConstraint
App open class App : Application, Configurable
AuthContext interface AuthContext
AutoCompleteComboBoxSkin open class AutoCompleteComboBoxSkin<T> : ComboBoxPopupControl<T>, FilterHandler

Auto Complete support for combobox Accept a call back to make custom filter Default filter use the string produced by the converter of combobox and search with contains ignore case the occurrence of typed text Created by anouira on 15/02/2017.

BindingAware interface BindingAware
BindingAwareProperty interface BindingAwareProperty<T> : BindingAware, Property<T>

A property wrapper that will report its ViewModel relation to a central location to make it possible for validators to retrieve the correct ValidationContext from the ViewModel this property is bound to.

BindingAwareSimpleBooleanProperty class BindingAwareSimpleBooleanProperty : SimpleBooleanProperty, BindingAwareProperty<Boolean>
BindingAwareSimpleDoubleProperty class BindingAwareSimpleDoubleProperty : SimpleDoubleProperty, BindingAwareProperty<Number>
BindingAwareSimpleFloatProperty class BindingAwareSimpleFloatProperty : SimpleFloatProperty, BindingAwareProperty<Number>
BindingAwareSimpleIntegerProperty class BindingAwareSimpleIntegerProperty : SimpleIntegerProperty, BindingAwareProperty<Number>
BindingAwareSimpleListProperty class BindingAwareSimpleListProperty<T> : SimpleListProperty<T>
BindingAwareSimpleLongProperty class BindingAwareSimpleLongProperty : SimpleLongProperty, BindingAwareProperty<Number>
BindingAwareSimpleMapProperty class BindingAwareSimpleMapProperty<S, T> : SimpleMapProperty<S, T>
BindingAwareSimpleObjectProperty class BindingAwareSimpleObjectProperty<T> : SimpleObjectProperty<T>, BindingAwareProperty<T>
BindingAwareSimpleSetProperty class BindingAwareSimpleSetProperty<T> : SimpleSetProperty<T>
BindingAwareSimpleStringProperty class BindingAwareSimpleStringProperty : SimpleStringProperty, BindingAwareProperty<String>
BorderImageSlice class BorderImageSlice
BorderPaneConstraint class BorderPaneConstraint : MarginableConstraints
BorderPaneContainer enum class BorderPaneContainer
BuilderFragment class BuilderFragment : Fragment
ButtonBarField class ButtonBarField : AbstractField
ChildInterceptor interface ChildInterceptor

An interceptor that can veto or provide another mechanism for adding children to their parent.

ColorPickerMode enum class ColorPickerMode
Command open class Command<in T>
CommandWithParameter class CommandWithParameter : Command<Any?>
Commit class Commit
Component abstract class Component : Configurable
ConfigProperties class ConfigProperties : Properties, Closeable
Configurable interface Configurable
Controller abstract class Controller : Component, ScopedInstance
CssBox data class CssBox<out T>
CssClassDelegate class CssClassDelegate : ReadOnlyProperty<Any, CssRule>
CssElementDelegate class CssElementDelegate : ReadOnlyProperty<Any, CssRule>
CssIdDelegate class CssIdDelegate : ReadOnlyProperty<Any, CssRule>
CssPropertyDelegate class CssPropertyDelegate<T : Any> : ReadOnlyProperty<Any, CssProperty<T>>
CssPseudoClassDelegate class CssPseudoClassDelegate : ReadOnlyProperty<Any, CssRule>
CssRule class CssRule : Selectable, Scoped, Rendered
CssRuleSet class CssRuleSet : Selectable, Scoped, Rendered
CssSelection class CssSelection : Rendered
CssSelectionBlock class CssSelectionBlock : PropertyHolder, SelectionHolder
CssSelector class CssSelector : Selectable
CssSubRule class CssSubRule : Rendered
CustomTextFilter class CustomTextFilter : UnaryOperator<Change>

Custom text filter used to supress input values, for example to only allow numbers in a textfield. Used via the filterInput {} builder

DIContainer interface DIContainer
DataGrid class DataGrid<T> : Control
DataGridCell open class DataGridCell<T> : IndexedCell<T>
DataGridCellBehavior class DataGridCellBehavior<T> : CellBehaviorBase<DataGridCell<T>>
DataGridCellFragment abstract class DataGridCellFragment<T> : ItemFragment<T>
DataGridCellSkin class DataGridCellSkin<T> : CellSkinBase<DataGridCell<T>, DataGridCellBehavior<T>>
DataGridFocusModel class DataGridFocusModel<T> : FocusModel<T>
DataGridPaginator class DataGridPaginator<T> : HBox
DataGridRow open class DataGridRow<T> : IndexedCell<T>
DataGridRowSkin class DataGridRowSkin<T> : CellSkinBase<DataGridRow<T>, BehaviorBase<DataGridRow<T>>>
DataGridSelectionModel class DataGridSelectionModel<T> : MultipleSelectionModel<T>
DataGridSkin class DataGridSkin<T> : VirtualContainerBase<DataGrid<T>, BehaviorBase<DataGrid<T>>, DataGridRow<T>>
Decorator interface Decorator
DefaultErrorHandler class DefaultErrorHandler : UncaughtExceptionHandler
DeregisteringWeakReference class DeregisteringWeakReference<T> : WeakReference<T>
DigestAuthContext class DigestAuthContext : AuthContext
Dimension open class Dimension<T : Enum<T>>
DirtyDecoratingTableRowSkin class DirtyDecoratingTableRowSkin<S> : TableRowSkin<S>
Drawer class Drawer : BorderPane
DrawerItem class DrawerItem : VBox
DrawerStyles class DrawerStyles : Stylesheet
EditEventType enum class EditEventType
EventBus class EventBus
EventContext class EventContext
EventLogView class EventLogView
EventRegistration interface EventRegistration
ExpandableTableRowSkin class ExpandableTableRowSkin<S> : TableRowSkin<S>
ExpandedDrawerContentArea class ExpandedDrawerContentArea : VBox
ExpanderColumn class ExpanderColumn<S> : TableColumn<S, Boolean>
FX class FX
FXEvent open class FXEvent
FXEventRegistration class FXEventRegistration : EventRegistration
FXPropertyResourceBundle class FXPropertyResourceBundle : PropertyResourceBundle
FXResourceBundleControl object FXResourceBundleControl : Control
FXTabAnimation enum class FXTabAnimation
FXTask class FXTask<T> : Task<T>
FXTimerTask class FXTimerTask : TimerTask
FXVisibility enum class FXVisibility
Field class Field : AbstractField
Fieldset open class Fieldset : VBox
FileChooserMode enum class FileChooserMode
FilterHandler interface FilterHandler
FilterInputTextHandler class FilterInputTextHandler : EventHandler<KeyEvent>, Resettable
FilterTooltipHandler class FilterTooltipHandler : EventHandler<KeyEvent>, Resettable
Form open class Form : VBox
Fragment abstract class Fragment : UIComponent
GridPaneConstraint class GridPaneConstraint : MarginableConstraints
HBoxConstraint class HBoxConstraint : MarginableConstraints
HeadingContainer class HeadingContainer : HBox
HttpClientEngine open class HttpClientEngine : Engine
HttpClientRequest class HttpClientRequest : Request
HttpClientResponse class HttpClientResponse : Response
HttpURLBasicAuthContext class HttpURLBasicAuthContext : AuthContext
HttpURLEngine open class HttpURLEngine : Engine
HttpURLRequest class HttpURLRequest : Request
HttpURLResponse class HttpURLResponse : Response
Injectable interface Injectable : ScopedInstance
InlineCss class InlineCss : PropertyHolder, Rendered
InternalWindow class InternalWindow : StackPane
InvalidatableEventRegistration data class InvalidatableEventRegistration : EventRegistration
ItemFragment abstract class ItemFragment<T> : Fragment
ItemViewModel open class ItemViewModel<T> : ViewModel
JavaDocTrap open class JavaDocTrap

This class is here to make maven generate Javadocs. Dokka generated documentation available in the GitHub repo:

JsonBuilder class JsonBuilder
JsonConfig object JsonConfig
JsonModel interface JsonModel
JsonModelAuto interface JsonModelAuto : JsonModel

Requires kotlin-reflect on classpath

KeyFrameBuilder class KeyFrameBuilder
KeyboardKey open class KeyboardKey : Button
KeyboardLayout class KeyboardLayout : Control
KeyboardRow class KeyboardRow
KeyboardSkin class KeyboardSkin : SkinBase<KeyboardLayout>
KeyboardStyles class KeyboardStyles : Stylesheet
Latch class Latch : CountDownLatch

Adds some superpowers to good old CountDownLatch, like exposed lockedProperty or ability to release latch immediately.

LayoutDebugger class LayoutDebugger : Fragment
LazyTreeItem class LazyTreeItem<T : Any> : TreeItem<T>
ListCellCache class ListCellCache<T>
ListCellFragment abstract class ListCellFragment<T> : ItemFragment<T>
ListConversionListener class ListConversionListener<SourceType, TargetType> : ListChangeListener<SourceType>, WeakListener

Listens to changes on a list of SourceType and keeps the target list in sync by converting each object into the TargetType via the supplied converter.

ListMenu class ListMenu : Control
ListMenuItem class ListMenuItem : Control
ListMenuItemSkin class ListMenuItemSkin : SkinBase<ListMenuItem>
ListMenuSkin class ListMenuSkin : SkinBase<ListMenu>
MapConversionListener class MapConversionListener<SourceTypeKey, SourceTypeValue, TargetType> : MapChangeListener<SourceTypeKey, SourceTypeValue>, WeakListener

Listens to changes on a Map of SourceTypeKey to SourceTypeValue and keeps the target list in sync by converting each object into the TargetType via the supplied converter.

MarginableConstraints abstract class MarginableConstraints
MaskPane class MaskPane : BorderPane

A basic mask pane, intended for blocking gui underneath. Styling example:

MessageEvent class MessageEvent : FXEvent
MultiSeries class MultiSeries<X, Y>

Helper class for the multiseries support

MultiValue class MultiValue<T>
NoPrimaryViewSpecified class NoPrimaryViewSpecified : View

This is the default primary view parameter. It is used to signal that there is no primary view configured for the application and so the App start process should not show the primary stage upon startup, unless the --view-class parameter was passed on the command line.

ObservableStyleClass class ObservableStyleClass
PojoProperty open class PojoProperty<T> : SimpleObjectProperty<T>
PropertyDelegate class PropertyDelegate<T> : ReadWriteProperty<Any, T>
PropertyHolder open class PropertyHolder
Rendered interface Rendered
Resettable interface Resettable
ResizeType sealed class ResizeType
ResourceLookup class ResourceLookup
Rest open class Rest : Controller
RestProgressBar class RestProgressBar : Fragment
RowExpanderPane class RowExpanderPane : StackPane
RowItemFragment abstract class RowItemFragment<S, T> : ItemFragment<T>
SVGIcon class SVGIcon : Pane
Scope open class Scope
Scoped interface Scoped
ScopedInstance interface ScopedInstance
Selectable interface Selectable
SelectionHolder interface SelectionHolder
SetConversionListener class SetConversionListener<SourceType, TargetType> : SetChangeListener<SourceType>, WeakListener

Listens to changes on a set of SourceType and keeps the target list in sync by converting each object into the TargetType via the supplied converter.

SimpleMessageDecorator class SimpleMessageDecorator : Decorator
SingleAssign interface SingleAssign<T>
SingleAssignThreadSafetyMode enum class SingleAssignThreadSafetyMode
Slideshow class Slideshow : BorderPane
SmartListCell open class SmartListCell<T> : ListCell<T>
SmartResize class SmartResize
SmartTableCell open class SmartTableCell<S, T> : TableCell<S, T>
SmartTreeCell open class SmartTreeCell<T> : TreeCell<T>
SortedFilteredList class SortedFilteredList<T> : ObservableList<T>

A wrapper for an observable list of items that can be bound to a list control like TableView, ListView etc.

SpacerKeyboardKey class SpacerKeyboardKey : KeyboardKey
SplitPaneConstraint class SplitPaneConstraint
SqueezeBox class SqueezeBox : Control
SqueezeBoxBehavior class SqueezeBoxBehavior : BehaviorBase<SqueezeBox>
SqueezeBoxSkin class SqueezeBoxSkin : BehaviorSkinBase<SqueezeBox, SqueezeBoxBehavior>
SqueezeBoxStyles class SqueezeBoxStyles : Stylesheet
StackpaneConstraint class StackpaneConstraint : MarginableConstraints
StageAwareFieldset class StageAwareFieldset : Fieldset
Stylesheet open class Stylesheet : SelectionHolder, Rendered
TableCellFragment abstract class TableCellFragment<S, T> : RowItemFragment<S, T>
TableColumnCellCache class TableColumnCellCache<T>
TableColumnDirtyState class TableColumnDirtyState<S> : Observable
TableViewEditModel class TableViewEditModel<S>
TaskStatus open class TaskStatus : ItemViewModel<FXTask<*>>
TreeCellCache class TreeCellCache<T>
TreeCellFragment abstract class TreeCellFragment<T> : ItemFragment<T>

Base class for all TreeCellFragments.

TreeTableSmartResize class TreeTableSmartResize
UIComponent abstract class UIComponent : Component, EventTarget
VBoxConstraint class VBoxConstraint : MarginableConstraints
ValidationContext class ValidationContext
ValidationMessage class ValidationMessage
ValidationSeverity enum class ValidationSeverity
ValidationTrigger sealed class ValidationTrigger
View abstract class View : UIComponent, ScopedInstance
ViewModel open class ViewModel : Component, ScopedInstance
ViewTransition abstract class ViewTransition

A class that, when used with replaceWith or UIComponent.replaceWith, allows you to replace Views, Fragments, or Nodes using a transition effect.

WeakDelegate class WeakDelegate<T> : ReadOnlyProperty<Any, DeregisteringWeakReference<T>>
Wizard abstract class Wizard : View
WizardStyles class WizardStyles : Stylesheet
Workspace open class Workspace : View
WorkspaceApp open class WorkspaceApp : App
WorkspaceArea class WorkspaceArea : BorderPane


RestException class RestException : RuntimeException

Extensions for External Classes


DefaultScope var DefaultScope: Scope
digestParams val Response.digestParams: Map<String, String>?
fiveDigits val fiveDigits: DecimalFormat
infinity val infinity: Dimension<LinearUnits>
isSmartResizing var TornadoFXTable<*, *>.isSmartResizing: Boolean
viewModelBundle val viewModelBundle: ResourceBundle


ChangeListener fun <T> ChangeListener(listener: (ObservableValue<out T>?, T, T) -> Unit): ChangeListener<T>
Point2D fun Point2D(value: Double): Point2D
Point3D fun Point3D(value: Double): Point3D
fun Point3D(point: Point2D, z: Double): Point3D
fun Point3D(x: Double, point: Point2D): Point3D
Vector2D fun Vector2D(value: Double): <ERROR CLASS>
Vector3D fun Vector3D(value: Double): <ERROR CLASS>
fun Vector3D(point: Point2D, z: Double): <ERROR CLASS>
fun Vector3D(x: Double, point: Point2D): <ERROR CLASS>
addClass fun <T : Styleable> T.addClass(vararg className: String): <ERROR CLASS>fun <T : Styleable> T.addClass(vararg cssClass: CssRule): <ERROR CLASS>

Add one or more type safe css classes to this Styleable. Pseudo classes are also supported.

addPseudoClass fun <T : Styleable> T.addPseudoClass(className: String): <ERROR CLASS>
addStageIcon fun addStageIcon(icon: Image, scope: Scope = FX.defaultScope): Unit
alert fun alert(type: AlertType, header: String, content: String? = null, vararg buttons: ButtonType, owner: Window? = null, title: String? = null, actionFn: Alert.(ButtonType) -> Unit = {}): Alert

Show an alert dialog of the given type with the given header and content. You can override the default buttons for the alert type and supply an optional function that will run when a button is clicked. The function runs in the scope of the alert dialog and is passed the button that was clicked.

anchorpaneConstraints fun <T : Node> T.anchorpaneConstraints(op: AnchorPaneConstraint.() -> Unit): T
asyncItems fun <T> DataGrid<T>.asyncItems(func: () -> Collection<T>): <ERROR CLASS>
fun <T> SortedFilteredList<T>.asyncItems(func: FXTask<*>.() -> Collection<T>): <ERROR CLASS>
attachTo fun <T : Node> T.attachTo(parent: EventTarget, op: T.() -> Unit = {}): T

Attaches the node to the pane and invokes the node operation.

fun <T : Node> T.attachTo(parent: EventTarget, after: T.() -> Unit, before: (T) -> Unit): <ERROR CLASS>

Attaches the node to the pane and invokes the node operation. Because the framework sometimes needs to setup the node, another lambda can be provided

beforeShutdown fun beforeShutdown(task: () -> Unit): Unit
bindClass fun <T : Styleable> T.bindClass(value: ObservableValue<CssRule>): ObservableStyleClass

Bind this observable type safe css rule to this Node. Pseudo classes are also supported.

bindSelected fun <T> DataGrid<T>.bindSelected(property: Property<T>): Unit
fun <T> DataGrid<T>.bindSelected(model: ItemViewModel<T>): Unit
bindStringProperty fun <S : T, T : Any> bindStringProperty(stringProperty: StringProperty, converter: StringConverter<T>?, format: Format?, property: ObservableValue<S>, readonly: Boolean): Unit
bindTo fun <V : ItemViewModel<T>, T> V.bindTo(itemFragment: ItemFragment<T>): <ERROR CLASS>

Rebind the itemProperty of the ViewModel when the itemProperty in the ListCellFragment changes.

bindToItem fun <V : ItemViewModel<T>, S, T> V.bindToItem(cellFragment: TableCellFragment<S, T>): <ERROR CLASS>

Rebind the itemProperty of the ViewModel when the itemProperty in the TableCellFragment changes. TODO: Do we need this, or can we just use the one above?

bindToRowItem fun <V : ItemViewModel<S>, S, T> V.bindToRowItem(cellFragment: TableCellFragment<S, T>): <ERROR CLASS>

Rebind the rowItemProperty of the ViewModel when the itemProperty in the TableCellFragment changes.

booleanBinding fun <T : Any> booleanBinding(receiver: T, vararg dependencies: Observable, op: T.() -> Boolean): BooleanBinding
booleanListBinding fun <T : Any> booleanListBinding(list: ObservableList<T>, defaultValue: Boolean = false, itemToBooleanExpr: T.() -> BooleanExpression): BooleanExpression

A Boolean binding that tracks all items in an observable list and create an observable boolean value by anding together an observable boolean representing each element in the observable list. Whenever the list changes, the binding is updated as well

booleanProperty fun booleanProperty(value: Boolean = false): BooleanProperty

Convenience SimpleXXXProperty function builders

borderpaneConstraints fun <T : Node> T.borderpaneConstraints(op: BorderPaneConstraint.() -> Unit): T

Access BorderPane constraints to manipulate and apply on this control

box fun <T> box(all: T): CssBox<T>
fun <T> box(vertical: T, horizontal: T): CssBox<T>
fun <T> box(top: T, right: T, bottom: T, left: T): CssBox<T>
c fun c(colorString: String, opacity: Double = 1.0): Color
fun c(red: Double, green: Double, blue: Double, opacity: Double = 1.0): Color
fun c(red: Int, green: Int, blue: Int, opacity: Double = 1.0): Color
children fun children(addTo: MutableList<Node>, op: Pane.() -> Unit): Unit
chooseDirectory fun chooseDirectory(title: String? = null, initialDirectory: File? = null, owner: Window? = null, op: DirectoryChooser.() -> Unit = {}): File?
chooseFile fun chooseFile(title: String? = null, filters: Array<out ExtensionFilter>, mode: FileChooserMode = Single, owner: Window? = null, op: FileChooser.() -> Unit = {}): List<File>

Ask the user to select one or more files from a file chooser dialog. The mode will dictate how the dialog works, by allowing single selection, multi selection or save functionality. The file dialog will only allow files that match one of the given ExtensionFilters.

command fun <T> command(action: (T) -> Unit, enabled: BooleanExpression = SimpleBooleanProperty(true), async: Boolean = false, ui: Boolean = false): Command<T>

Create a command with a non null parameter where the is a function reference.

fun <T> command(action: (T?) -> Unit, enabled: BooleanExpression = SimpleBooleanProperty(true), async: Boolean = false, ui: Boolean = false, nullable: Boolean = true): Command<T?>

Create a command with a nullable parameter where the is either a lambda or a function reference.

fun <T> command(enabled: BooleanExpression = SimpleBooleanProperty(true), async: Boolean = false, ui: Boolean = false, nullable: Boolean = true, action: (T?) -> Unit): Command<T?>

Create a command with a nullable parameter where the is a lambda.

fun command(action: () -> Unit, enabled: BooleanExpression = SimpleBooleanProperty(true), async: Boolean = false, ui: Boolean = false): Command<Any>

Create a parameterless command where the action is a function reference.

fun command(enabled: BooleanExpression = SimpleBooleanProperty(true), async: Boolean = false, ui: Boolean = false, action: () -> Unit): Command<Any>

Create a parameterless command where the action is a lambda. This overload allows the command to be defined as the last parameter

confirm fun confirm(header: String, content: String = "", confirmButton: ButtonType = ButtonType.OK, cancelButton: ButtonType = ButtonType.CANCEL, owner: Window? = null, title: String? = null, actionFn: () -> Unit): Unit

Show a confirmation dialog and execute the given action if confirmButton is clicked. The button types of the confirmButton and cancelButton are configurable.

confirmation fun confirmation(header: String, content: String? = null, vararg buttons: ButtonType, owner: Window? = null, title: String? = null, actionFn: Alert.(ButtonType) -> Unit = {}): Alert
contains fun JsonModel?.contains(text: String?, ignoreCase: Boolean = true): Boolean
contentWidth fun <S> TornadoFXColumn<S>.contentWidth(padding: Double = 0.0, useAsMin: Boolean = false, useAsMax: Boolean = false): <ERROR CLASS>

Make the column fit the content plus an optional padding width. Optionally constrain the min or max width to be this width.

cssclass fun cssclass(value: String? = null, snakeCase: Boolean = value == null): CssClassDelegate
csselement fun csselement(value: String? = null, snakeCase: Boolean = value == null): CssElementDelegate
cssid fun cssid(value: String? = null, snakeCase: Boolean = value == null): CssIdDelegate
cssproperty fun <T : Any> cssproperty(value: String? = null, renderer: (T) -> String = null): CssPropertyDelegate<T>
csspseudoclass fun csspseudoclass(value: String? = null, snakeCase: Boolean = value == null): CssPseudoClassDelegate
dirtyStateFor fun <V : ViewModel, T : ObservableValue<X>, X> V.dirtyStateFor(modelField: KProperty1<V, T>): BooleanBinding
disableWhen fun <T : Node> T.disableWhen(expr: () -> ObservableValue<Boolean>): T

This extension function will automatically bind to the disableProperty of the given node and will disable it, if the given expr returning an observable boolean value equals true.

fun <T : Node> T.disableWhen(predicate: ObservableValue<Boolean>): <ERROR CLASS>

This extension function will automatically bind to the disableProperty of the given node and will disable it, if the given predicate observable boolean value equals true.

doubleBinding fun <T : Any> doubleBinding(receiver: T, vararg dependencies: Observable, op: T.() -> Double): DoubleBinding
doubleProperty fun doubleProperty(value: Double = 0.0): DoubleProperty
dumpStylesheets fun dumpStylesheets(): Unit
dynamicContent fun <S : EventTarget, T> S.dynamicContent(property: ObservableValue<T>, onChangeBuilder: S.(T?) -> Unit): Unit

Listen for changes to an observable value and replace all content in this Node with the new content created by the onChangeBuilder. The builder operates on the node and receives the new value of the observable as its only parameter.

enableWhen fun <T : Node> T.enableWhen(expr: () -> ObservableValue<Boolean>): T

This extension function will make sure that the given node is enabled when ever, the given expr returning an observable boolean value equals true.

fun <T : Node> T.enableWhen(predicate: ObservableValue<Boolean>): <ERROR CLASS>

This extension function will make sure that the given node is enabled when ever, the given predicate observable boolean value equals true.

error fun error(header: String, content: String? = null, vararg buttons: ButtonType, owner: Window? = null, title: String? = null, actionFn: Alert.(ButtonType) -> Unit = {}): Alert
fade fun UIComponent.fade(time: Duration, opacity: Number, easing: Interpolator = Interpolator.EASE_BOTH, reversed: Boolean = false, play: Boolean = true, op: FadeTransition.() -> Unit = {}): FadeTransition

A convenience function for creating a FadeTransition on a UIComponent.

find fun <T : Component> find(scope: Scope = FX.defaultScope, params: Map<*, Any?>? = null): T
fun <T : Component> find(scope: Scope = FX.defaultScope, vararg params: Pair<*, Any?>): T
fun <T : Component> find(type: KClass<T>, scope: Scope = FX.defaultScope, vararg params: Pair<*, Any?>): T
fun <T : Component> find(type: KClass<T>, scope: Scope = FX.defaultScope, params: Map<*, Any?>? = null): T
findAll fun <T : UIComponent> UIComponent.findAll(): List<T>

Find all UIComponents of the specified type that owns any of this UIComponents root nodes children

fixedWidth fun <S> TornadoFXColumn<S>.fixedWidth(width: Number): <ERROR CLASS>
floatBinding fun <T : Any> floatBinding(receiver: T, vararg dependencies: Observable, op: T.() -> Float): FloatBinding
floatProperty fun floatProperty(value: Float = 0F): FloatProperty
fold fun SqueezeBox.fold(title: String? = null, expanded: Boolean = false, icon: Node? = null, closeable: Boolean = false, op: TitledPane.() -> Unit): TitledPane
getDefaultConverter fun <T : Any> getDefaultConverter(): StringConverter<T>?
getInstance fun <T : Any> DIContainer.getInstance(): T
fun <T : Any> DIContainer.getInstance(name: String): T
gridpaneConstraints fun <T : Node> T.gridpaneConstraints(op: GridPaneConstraint.() -> Unit): T

Access GridPane constraints to manipulate and apply on this control

hasClass fun <T : Styleable> T.hasClass(className: String): Booleanfun <T : Styleable> T.hasClass(cssClass: CssRule): Boolean

Check if this Node has the given type safe css class. Pseudo classes are also supported.

hasPseudoClass fun <T : Styleable> T.hasPseudoClass(className: String): Boolean
hboxConstraints fun <T : Node> T.hboxConstraints(op: HBoxConstraint.() -> Unit): T
hiddenWhen fun <T : Node> T.hiddenWhen(expr: () -> ObservableValue<Boolean>): T

This extension function will make sure to hide the given node, if the given expr returning an observable boolean value equals true.

fun <T : Node> T.hiddenWhen(predicate: ObservableValue<Boolean>): <ERROR CLASS>

This extension function will make sure to hide the given node, if the given predicate an observable boolean value equals true.

importStylesheet fun importStylesheet(stylesheet: Path): Unit
fun importStylesheet(stylesheet: String): Unit
fun <T : Stylesheet> importStylesheet(): Unit
fun <T : Stylesheet> importStylesheet(stylesheetType: KClass<T>): Unit
information fun information(header: String, content: String? = null, vararg buttons: ButtonType, owner: Window? = null, title: String? = null, actionFn: Alert.(ButtonType) -> Unit = {}): Alert
insets fun insets(all: Number): Insets
fun insets(horizontal: Number? = null, vertical: Number? = null): Insets
fun insets(top: Number? = null, right: Number? = null, bottom: Number? = null, left: Number? = null): Insets
intProperty fun intProperty(value: Int = 0): IntegerProperty
integerBinding fun <T : Any> integerBinding(receiver: T, vararg dependencies: Observable, op: T.() -> Int): IntegerBinding
invoke operator fun Command<*>.invoke(parameter: Any?): CommandWithParameter
launch fun <T : Application> launch(vararg args: String): <ERROR CLASS>
fun <T : Application> launch(args: Array<String>): <ERROR CLASS>
listProperty fun <V> listProperty(value: ObservableList<V>? = null): ListProperty<V>
fun <V> listProperty(vararg values: V): ListProperty<V>
loadFont fun loadFont(path: String, size: Number): Font?
loadJsonArray fun loadJsonArray(url: URL): <ERROR CLASS>

Load a JsonArray from the given URL

fun loadJsonArray(source: String): <ERROR CLASS>

Load a JsonArray from the given string source

fun loadJsonArray(input: InputStream): <ERROR CLASS>

Load a JsonArray from the given InputStream

fun loadJsonArray(path: Path, vararg options: OpenOption = arrayOf(READ)): <ERROR CLASS>

Load a JsonArray from the given path with the optional OpenOptions

loadJsonModel fun <T : JsonModel> loadJsonModel(url: URL): <ERROR CLASS>

Load a JsonModel of the given type from the given URL

fun <T : JsonModel> loadJsonModel(input: InputStream): <ERROR CLASS>

Load a JsonModel of the given type from the given InputStream

fun <T : JsonModel> loadJsonModel(path: Path, vararg options: OpenOption = arrayOf(READ)): <ERROR CLASS>

Load a JsonModel of the given type from the given path with the optional OpenOptions

fun <T : JsonModel> loadJsonModel(source: String): <ERROR CLASS>

Load a JsonModel from the given String source

loadJsonObject fun loadJsonObject(url: URL): <ERROR CLASS>

Load a JsonObject from the given URL

fun loadJsonObject(input: InputStream): <ERROR CLASS>

Load a JsonObject from the given InputStream

fun loadJsonObject(path: Path, vararg options: OpenOption = arrayOf(READ)): <ERROR CLASS>

Load a JsonObject from the given path with the optional OpenOptions

fun loadJsonObject(source: String): <ERROR CLASS>

Load a JsonObject from the string source.

longBinding fun <T : Any> longBinding(receiver: T, vararg dependencies: Observable, op: T.() -> Long): LongBinding
longProperty fun longProperty(value: Long): LongProperty
longpress fun <T : Node> T.longpress(threshold: Duration = 700.millis, consume: Boolean = false, action: (MouseEvent) -> Unit): <ERROR CLASS>
lookup fun <T : UIComponent> UIComponent.lookup(op: T.() -> Unit = {}): T?

Find the first UIComponent of the specified type that owns any of this UIComponents root nodes children

managedWhen fun <T : Node> T.managedWhen(expr: () -> ObservableValue<Boolean>): T

This extension function will automatically bind to the managedProperty of the given node and will make sure that it is managed, if the given expr returning an observable boolean value equals true.

fun <T : Node> T.managedWhen(predicate: ObservableValue<Boolean>): <ERROR CLASS>

This extension function will automatically bind to the managedProperty of the given node and will make sure that it is managed, if the given predicate an observable boolean value equals true.

mapProperty fun <K, V> mapProperty(value: ObservableMap<K, V>? = null): MapProperty<K, V>
maxWidth fun <S> TornadoFXColumn<S>.maxWidth(width: Number): <ERROR CLASS>
minWidth fun <S> TornadoFXColumn<S>.minWidth(width: Number): <ERROR CLASS>
mixin fun mixin(op: CssSelectionBlock.() -> Unit): CssSelectionBlock
move fun UIComponent.move(time: Duration, destination: Point2D, easing: Interpolator = Interpolator.EASE_BOTH, reversed: Boolean = false, play: Boolean = true, op: TranslateTransition.() -> Unit = {}): TranslateTransition

A convenience function for creating a TranslateTransition on a UIComponent.

multi fun <T> multi(vararg elements: T): MultiValue<T>
multiseries fun <X, Y, ChartType : XYChart<X, Y>> ChartType.multiseries(vararg names: String, op: MultiSeries<X, Y>.() -> Unit = {}): MultiSeries<X, Y>

Add multiple series XYChart.Series with data in one go. Specify a list of names for the series and then add values in the op. Example:

nonNullObjectBinding fun <T : Any, R> nonNullObjectBinding(receiver: T, vararg dependencies: Observable, op: T.() -> R): ObjectBinding<R>
objectBinding fun <T : Any, R> objectBinding(receiver: T, vararg dependencies: Observable, op: T.() -> R?): ObjectBinding<R?>
objectProperty fun <T> objectProperty(value: T? = null): ObjectProperty<T>
observable fun <S, T> S.observable(prop: KMutableProperty1<S, T>): ObjectProperty<T>
fun <S, T> observable(owner: S, prop: KMutableProperty1<S, T>): ObjectProperty<T>

Convert an owner instance and a corresponding property reference into an observable

fun <S, T> observable(owner: S, prop: KProperty1<S, T>): ReadOnlyObjectProperty<T>

Convert an owner instance and a corresponding property reference into a readonly observable

fun <S : Any, T> observable(bean: S, getter: KFunction<T>, setter: KFunction2<S, T, Unit>): PojoProperty<T>

Convert an bean instance and a corresponding getter/setter reference into a writable observable.

fun <S : Any, T : Any> S.observable(getter: KFunction<T>? = null, setter: KFunction2<S, T, Unit>? = null, propertyName: String? = null, propertyType: KClass<T>? = null): ObjectProperty<T>

Convert a pojo bean instance into a writable observable.

observableFloatArrayOf fun observableFloatArrayOf(): ObservableFloatArray

Returns an empty new ObservableFloatArray.

fun observableFloatArrayOf(vararg elements: Float): ObservableFloatArray

Returns a new ObservableFloatArray with the given elements.

observableIntArrayOf fun observableIntArrayOf(): ObservableIntegerArray

Returns an empty new ObservableIntegerArray.

fun observableIntArrayOf(vararg elements: Int): ObservableIntegerArray

Returns a new ObservableIntegerArray with the given elements.

observableList fun <T> observableList(vararg entries: T): ObservableList<T>
observableListOf fun <T> observableListOf(): ObservableList<T>

Returns an empty new ObservableList.

fun <T> observableListOf(vararg elements: T): ObservableList<T>

Returns a new ObservableList with the given elements.

fun <T> observableListOf(collection: Collection<T>): ObservableList<T>

Returns a new ObservableList containing all elements from the given collection.

fun <T> observableListOf(extractor: (T) -> Array<Observable>): ObservableList<T>

Returns an empty new ObservableList with the given extractor. This list reports element updates.

observableMapOf fun <K, V> observableMapOf(): ObservableMap<K, V>

Returns an empty new ObservableMap

fun <K, V> observableMapOf(vararg pairs: Pair<K, V>): ObservableMap<K, V>

Returns a new ObservableMap with the specified contents, given as a list of pairs where the first component is the key and the second is the value.

observableSetOf fun <T> observableSetOf(): ObservableSet<T>

Returns an empty new ObservableSet

fun <T> observableSetOf(vararg elements: T): ObservableSet<T>

Returns a new ObservableSet with the given elements.

onHover fun <T : Node> T.onHover(onHover: (Boolean) -> Unit): <ERROR CLASS>

This extension function will make sure that the given onHover function will always be calles when ever the hoverProperty of the given node changes.

opcr fun <T : Node> opcr(parent: EventTarget, node: T, op: T.() -> Unit = {}): <ERROR CLASS>

Add the given node to the pane, invoke the node operation and return the node. The opcr name is an acronym for "op connect & return".

parallelTransition fun parallelTransition(play: Boolean = true, op: ParallelTransition.() -> Unit): <ERROR CLASS>
pause fun pause(time: Duration, play: Boolean = true, op: PauseTransition.() -> Unit = {}): <ERROR CLASS>
pctWidth fun <S> TornadoFXColumn<S>.pctWidth(pct: Number): <ERROR CLASS>
point fun point(x: Number, y: Number): Point2D
fun point(x: Number, y: Number, z: Number): Point3D
populateTree fun <T> populateTree(item: TreeItem<T>, itemFactory: (T) -> TreeItem<T>, childFactory: (TreeItem<T>) -> Iterable<T>?): Unit

Add children to the given item by invoking the supplied childFactory function, which converts a TreeItem&lt;T> to a List&lt;T>?.

prefWidth fun <S> TornadoFXColumn<S>.prefWidth(width: Number): <ERROR CLASS>
property fun <T> T? = null): PropertyDelegate<T>
fun <T> property(value: T? = null): PropertyDelegate<T>
fun <T> property(block: () -> Property<T>): PropertyDelegate<T>
proxyprop fun <R, T> proxyprop(receiver: Property<R>, getter: Property<R>.() -> T, setter: Property<R>.(T) -> R): ObjectProperty<T>

Create a proxy property backed by calculated data based on a specific property. The setter must return the new value for the backed property. The scope of the getter and setter will be the receiver property

proxypropDouble fun <R> proxypropDouble(receiver: Property<R>, getter: Property<R>.() -> Double, setter: Property<R>.(Double) -> R): DoubleProperty

Create a proxy double property backed by calculated data based on a specific property. The setter must return the new value for the backed property. The scope of the getter and setter will be the receiver property

rebind fun <T : ViewModel> T.rebind(op: T.() -> Unit): Unit
rebindOnChange fun <V : ViewModel, T> V.rebindOnChange(observable: ObservableValue<T>, op: V.(T?) -> Unit = {}): Unit

Listen to changes in the given observable and call the op with the new value on change. After each change the viewmodel is rolled back to reflect the values in the new source object or objects.

fun <V : ViewModel, T> V.rebindOnChange(tableview: TableView<T>, op: V.(T?) -> Unit): Unit
fun <V : ViewModel, T> V.rebindOnChange(listview: ListView<T>, op: V.(T?) -> Unit): Unit
fun <V : ViewModel, T> V.rebindOnChange(treeview: TreeView<T>, op: V.(T?) -> Unit): Unit
fun <V : ViewModel, T> V.rebindOnChange(treetableview: TreeTableView<T>, op: V.(T?) -> Unit): Unit
rebindOnTreeItemChange fun <V : ViewModel, T> V.rebindOnTreeItemChange(observable: ObservableValue<TreeItem<T>>, op: V.(T?) -> Unit): Unit
reloadStylesheetsOnFocus fun reloadStylesheetsOnFocus(): Unit
reloadViewsOnFocus fun reloadViewsOnFocus(): Unit
remainingWidth fun <S> TornadoFXColumn<S>.remainingWidth(): <ERROR CLASS>
removeClass fun <T : Styleable> T.removeClass(className: String, removeAll: Boolean = true): <ERROR CLASS>fun <T : Styleable> T.removeClass(vararg cssClass: CssRule): <ERROR CLASS>

Remove the given given type safe css class(es) from this Node. Pseudo classes are also supported.

removePseudoClass fun <T : Styleable> T.removePseudoClass(className: String): <ERROR CLASS>
removeStylesheet fun <T : Stylesheet> removeStylesheet(): Unit
fun <T : Stylesheet> removeStylesheet(stylesheetType: KClass<T>): Unit
removeWhen fun <T : Node> T.removeWhen(expr: () -> ObservableValue<Boolean>): T

This extension function will make sure that the given node will only be visible in the scene graph, if the given expr returning an observable boolean value equals true.

fun <T : Node> T.removeWhen(predicate: ObservableValue<Boolean>): <ERROR CLASS>

This extension function will make sure that the given node will only be visible in the scene graph, if the given predicate observable boolean value equals true.

replaceChildren fun <T : EventTarget> T.replaceChildren(op: T.() -> Unit): Unit
resizeCall fun <TABLE : Any> resizeCall(param: TornadoFXResizeFeatures<*, TABLE>, installIfNeeded: (TABLE) -> Unit): Boolean
resizeColumnsToFitContent fun <S, T : Any> TornadoFXTable<S, T>.resizeColumnsToFitContent(resizeColumns: List<TornadoFXColumn<S>> = contentColumns, maxRows: Int = 50, afterResize: () -> Unit = {}): Unit
rotate fun UIComponent.rotate(time: Duration, angle: Number, easing: Interpolator = Interpolator.EASE_BOTH, reversed: Boolean = false, play: Boolean = true, op: RotateTransition.() -> Unit = {}): RotateTransition

A convenience function for creating a RotateTransition on a UIComponent.

runAsync fun <T> runAsync(status: TaskStatus? = null, func: FXTask<*>.() -> T): Task<T>
fun <T> runAsync(daemon: Boolean = false, status: TaskStatus? = null, func: FXTask<*>.() -> T): Task<T>
runLater fun runLater(op: () -> Unit): Unit

Run the specified Runnable on the JavaFX Application Thread at some unspecified time in the future.

fun runLater(delay: Duration, op: () -> Unit): FXTimerTask

Run the specified Runnable on the JavaFX Application Thread after a specified delay.

save fun OutputStream): <ERROR CLASS>

Save this JsonModel to the given output stream and close it.

fun Path, vararg options: OpenOption = arrayOf(CREATE, TRUNCATE_EXISTING)): <ERROR CLASS>

Save this JsonModel to the given output path.

scale fun UIComponent.scale(time: Duration, scale: Point2D, easing: Interpolator = Interpolator.EASE_BOTH, reversed: Boolean = false, play: Boolean = true, op: ScaleTransition.() -> Unit = {}): ScaleTransition

A convenience function for creating a ScaleTransition on a UIComponent.

sequentialTransition fun sequentialTransition(play: Boolean = true, op: SequentialTransition.() -> Unit): <ERROR CLASS>
series fun <X, Y, ChartType : XYChart<X, Y>> ChartType.series(name: String, elements: ObservableList<Data<X, Y>>? = null, op: Series<X, Y>.() -> Unit = {}): <ERROR CLASS>

Add a new XYChart.Series with the given name to the given Chart. Optionally specify a list data for the new series or add data with the optional op that will be performed on the created series object.

set fun <T : ScopedInstance> Scope.set(vararg value: T): <ERROR CLASS>
setId fun <T : Node> T.setId(cssId: CssRule): <ERROR CLASS>
setInScope fun <T : ScopedInstance> setInScope(value: T, scope: Scope = FX.defaultScope, kclass: KClass<T> = value.javaClass.kotlin): <ERROR CLASS>
setProperty fun <V> setProperty(value: ObservableSet<V>? = null): SetProperty<V>
setStageIcon fun setStageIcon(icon: Image, scope: Scope = FX.defaultScope): Unit
shortpress fun <T : Node> T.shortpress(consume: Boolean = false, action: (InputEvent) -> Unit): <ERROR CLASS>
singleAssign fun <T> singleAssign(threadSafetyMode: SingleAssignThreadSafetyMode = SingleAssignThreadSafetyMode.SYNCHRONIZED): SingleAssign<T>
splitpaneConstraints fun <T : Node> T.splitpaneConstraints(op: SplitPaneConstraint.() -> Unit): T
stackpaneConstraints fun <T : Node> T.stackpaneConstraints(op: StackpaneConstraint.() -> Unit): T
stringBinding fun <T : Any> stringBinding(receiver: T, vararg dependencies: Observable, op: T.() -> String?): StringBinding
stringProperty fun stringProperty(value: String? = null): StringProperty
task fun <T> task(taskStatus: TaskStatus? = null, func: FXTask<*>.() -> T): Task<T>
fun <T> task(daemon: Boolean = false, taskStatus: TaskStatus? = null, func: FXTask<*>.() -> T): Task<T>
terminateAsyncExecutors fun terminateAsyncExecutors(timeoutMillis: Long): Unit
timeline fun timeline(play: Boolean = true, op: Timeline.() -> Unit): <ERROR CLASS>
toProperty fun <T : Any> T?.toProperty(): SimpleObjectProperty<T>
toggleClass fun <T : Styleable> T.toggleClass(className: String, predicate: Boolean): <ERROR CLASS>fun <T : Styleable> T.toggleClass(cssClass: CssRule, predicate: Boolean): <ERROR CLASS>

Toggle the given type safe css class based on the given predicate. Pseudo classes are also supported.

fun <T : Styleable> T.toggleClass(cssClass: CssRule, observablePredicate: ObservableValue<Boolean>): Unit

Toggle the given type safe css class based on the given predicate observable value. Whenever the observable value changes, the class is added or removed. Pseudo classes are also supported.

togglePseudoClass fun <T : Styleable> T.togglePseudoClass(className: String, predicate: Boolean): <ERROR CLASS>
transform fun UIComponent.transform(time: Duration, destination: Point2D, angle: Number, scale: Point2D, opacity: Number, easing: Interpolator = Interpolator.EASE_BOTH, reversed: Boolean = false, play: Boolean = true, op: ParallelTransition.() -> Unit = {}): <ERROR CLASS>

A convenience function for creating a TranslateTransition, RotateTransition, ScaleTransition, FadeTransition on a UIComponent that all run simultaneously.

validator fun <T> validator(control: Control, property: Property<T>, trigger: ValidationTrigger, model: ViewModel? = null, validator: ValidationContext.(T?) -> ValidationMessage?): <ERROR CLASS>

Add a validator to the given Control for the given model property.

fun <T> validator(control: Control, property: Property<T>, trigger: ValidationTrigger, validator: ValidationContext.(T?) -> ValidationMessage?): <ERROR CLASS>
varargParamsToMap fun varargParamsToMap(params: Array<out Pair<String, Any?>>): <ERROR CLASS>
vboxConstraints fun <T : Node> T.vboxConstraints(op: VBoxConstraint.() -> Unit): T
visibleWhen fun <T : Node> T.visibleWhen(predicate: ObservableValue<Boolean>): <ERROR CLASS>

This extension function will automatically bind to the visibleProperty of the given node and will make sure that it is visible, if the given predicate an observable boolean value equals true.

fun <T : Node> T.visibleWhen(expr: () -> ObservableValue<Boolean>): T

This extension function will automatically bind to the visibleProperty of the given node and will make sure that it is visible, if the given expr returning an observable boolean value equals true.

warning fun warning(header: String, content: String? = null, vararg buttons: ButtonType, owner: Window? = null, title: String? = null, actionFn: Alert.(ButtonType) -> Unit = {}): Alert
weak fun <T> weak(referent: T, deinit: () -> Unit = {}): WeakDelegate<T>
weightedWidth fun <S> TornadoFXColumn<S>.weightedWidth(weight: Number, padding: Double = 0.0, minContentWidth: Boolean = false): <ERROR CLASS>
whenDocked fun <U : UIComponent> U.whenDocked(listener: (U) -> Unit): Unit
whenDockedOnce fun <U : UIComponent> U.whenDockedOnce(listener: (U) -> Unit): Unit
whenUndocked fun <U : UIComponent> U.whenUndocked(listener: (U) -> Unit): Unit
whenUndockedOnce fun <U : UIComponent> U.whenUndockedOnce(listener: (U) -> Unit): Unit
with infix fun Command<*>.with(parameter: Any?): CommandWithParameter