tornadofx / tornadofx / UIComponent

UIComponent

abstract class UIComponent : Component, EventTarget

Constructors

<init> UIComponent(viewTitle: String? = "", icon: Node? = null)

Properties

accelerators val accelerators: HashMap<KeyCombination, () -> Unit>
closeable open val closeable: BooleanExpression
complete open val complete: BooleanExpression
creatable open val creatable: BooleanExpression
currentStage val currentStage: Stage?
currentWindow val currentWindow: Window?
deletable open val deletable: BooleanExpression
fxmlLoader lateinit var fxmlLoader: FXMLLoader
heading var heading: String
headingProperty open val headingProperty: StringProperty
icon var icon: Node
iconProperty val iconProperty: ObjectProperty<Node>
isComplete var isComplete: Boolean
isDocked val isDocked: Boolean
isDockedProperty val isDockedProperty: ReadOnlyBooleanProperty
modalStage var modalStage: Stage?
onDockListeners var onDockListeners: MutableList<(UIComponent) -> Unit>?
onUndockListeners var onUndockListeners: MutableList<(UIComponent) -> Unit>?
owningTab val owningTab: Tab?
refreshable open val refreshable: BooleanExpression
root abstract val root: Parent
savable open val savable: BooleanExpression
title var title: String
titleProperty open val titleProperty: StringProperty

Inherited Properties

app val app: App
clipboard val clipboard: Clipboard
config open val config: ConfigProperties
configCharset open val configCharset: Charset
configPath open val configPath: Path

Path to component specific configuration settings. Defaults to javaClass.properties inside the configured configBasePath of the application (By default conf in the current directory).

hostServices val hostServices: HostServices
log val log: <ERROR CLASS>
messages var messages: ResourceBundle
params val params: Map<String, Any?>
paramsProperty val paramsProperty: SimpleObjectProperty<Map<String, Any?>>
primaryStage val primaryStage: Stage
properties val properties: <ERROR CLASS>
resources val resources: ResourceLookup
scope open val scope: Scope
subscribedEvents val subscribedEvents: HashMap<KClass<out FXEvent>, ArrayList<FXEventRegistration>>
workspace val workspace: Workspace

Functions

accelerator fun Button.accelerator(combo: KeyCombination): Unit
add fun <T : UIComponent> EventTarget.add(type: KClass<T>, params: Map<*, Any?>? = null, op: T.() -> Unit = {}): Unit
fun <T : UIComponent> EventTarget.add(vararg params: Pair<*, Any?>, op: T.() -> Unit = {}): Unit
fun <T : UIComponent> EventTarget.add(uiComponent: Class<T>): Unit
fun EventTarget.add(uiComponent: UIComponent): Unit
fun EventTarget.add(child: Node): Unit
bottom fun <C : UIComponent> BorderPane.bottom(): <ERROR CLASS>
fun <C : UIComponent> BorderPane.bottom(nodeType: KClass<C>): <ERROR CLASS>
buildEventDispatchChain open fun buildEventDispatchChain(tail: EventDispatchChain?): EventDispatchChain
builderFragment fun builderFragment(title: String = "", scope: Scope = this@UIComponent.scope, rootBuilder: UIComponent.() -> Parent): BuilderFragment

Create an fragment by supplying an inline builder expression and optionally open it if the openModality is specified. A fragment can also be assigned to an existing node hierarchy using add() or this += inlineFragment {}, or you can specify the behavior inside it using Platform.runLater {} before you return the root node for the builder fragment.

builderWindow fun builderWindow(title: String = "", modality: Modality = Modality.APPLICATION_MODAL, stageStyle: StageStyle = StageStyle.DECORATED, scope: Scope = this@UIComponent.scope, owner: Window? = currentWindow, rootBuilder: UIComponent.() -> Parent): <ERROR CLASS>
cellCache fun <S, T> TableColumn<S, T>.cellCache(cachedGraphicProvider: (T) -> Node): Unit

Calculate a unique Node per item and set this Node as the graphic of the TableCell.

fun <T> ListView<T>.cellCache(cachedGraphicProvider: (T) -> Node): Unit
cellFormat fun <S, T> TableColumn<S, T>.cellFormat(formatter: TableCell<S, T>.(T) -> Unit): Unit
fun <T> ListView<T>.cellFormat(formatter: ListCell<T>.(T) -> Unit): Unit
fun <T> ComboBox<T>.cellFormat(formatButtonCell: Boolean = true, formatter: ListCell<T>.(T) -> Unit): Unit
cellFragment fun <S, T, F : TableCellFragment<S, T>> TableColumn<S, T>.cellFragment(fragment: KClass<F>): Unit
fun <T, F : TreeCellFragment<T>> TreeView<T>.cellFragment(fragment: KClass<F>): Unit
fun <T, F : ListCellFragment<T>> ListView<T>.cellFragment(fragment: KClass<F>): Unit
center fun <C : UIComponent> BorderPane.center(): <ERROR CLASS>
fun <C : UIComponent> BorderPane.center(nodeType: KClass<C>): <ERROR CLASS>
close fun close(): Unit
closeModal fun closeModal(): Unit
closeableWhen fun closeableWhen(closeable: () -> BooleanExpression): Unit
completeWhen fun completeWhen(complete: () -> BooleanExpression): Unit
connectWorkspaceActions fun TabPane.connectWorkspaceActions(): Unit
fun StackPane.connectWorkspaceActions(): Unit

Forward the Workspace button states and actions to the TabPane, which in turn will forward these states and actions to whatever View is represented by the currently active Tab.

creatableWhen fun creatableWhen(creatable: () -> BooleanExpression): Unit
deletableWhen fun deletableWhen(deletable: () -> BooleanExpression): Unit
dialog fun dialog(title: String = "", modality: Modality = Modality.APPLICATION_MODAL, stageStyle: StageStyle = StageStyle.DECORATED, scope: Scope = this@UIComponent.scope, owner: Window? = currentWindow, labelPosition: Orientation = Orientation.HORIZONTAL, builder: StageAwareFieldset.() -> Unit): Stage?
disableClose fun disableClose(): Unit
disableCreate fun disableCreate(): Unit
disableDelete fun disableDelete(): Unit
disableRefresh fun disableRefresh(): Unit
disableSave fun disableSave(): Unit
forwardWorkspaceActions fun forwardWorkspaceActions(uiComponent: UIComponent): Unit

Forward the Workspace button states and actions to the given UIComponent. This will override the currently active forwarding to the docked UIComponent.

fxid fun <T : Any> fxid(propName: String? = null): ReadOnlyProperty<UIComponent, T>
fxml fun <T : Node> fxml(location: String? = null, hasControllerAttribute: Boolean = false, root: Any? = null): ReadOnlyProperty<UIComponent, T>

Load an FXML file from the specified location, or from a file with the same package and name as this UIComponent if not specified. If the FXML file specifies a controller (handy for content completion in FXML editors) set the hasControllerAttribute parameter to true. This ensures that the fx:controller attribute is ignored by the loader so that this UIComponent can still be the controller for the FXML file.

goto fun goto(target: UIComponent): Unit
fun <T : UIComponent> goto(params: Map<String, Any?>? = null): Unit
fun <T : UIComponent> goto(vararg params: Pair<String, Any?>): Unit
include fun <T : Parent> EventTarget.include(scope: Scope = this@UIComponent.scope, hasControllerAttribute: Boolean = false, location: String): T
init fun init(): Unit
item fun <T : UIComponent> Drawer.item(scope: Scope = this@UIComponent.scope, vararg params: Pair<*, Any?>, expanded: Boolean = false, showHeader: Boolean = false, op: DrawerItem.() -> Unit = {}): DrawerItem
fun <T : UIComponent> Drawer.item(scope: Scope = this@UIComponent.scope, params: Map<*, Any?>? = null, expanded: Boolean = false, showHeader: Boolean = false, op: DrawerItem.() -> Unit = {}): DrawerItem
fun Drawer.item(uiComponent: KClass<out UIComponent>, scope: Scope = this@UIComponent.scope, params: Map<*, Any?>? = null, expanded: Boolean = false, showHeader: Boolean = false, op: DrawerItem.() -> Unit = {}): DrawerItem
fun Drawer.item(uiComponent: KClass<out UIComponent>, scope: Scope = this@UIComponent.scope, vararg params: Pair<*, Any?>, expanded: Boolean = false, showHeader: Boolean = false, op: DrawerItem.() -> Unit = {}): Unit
left fun <C : UIComponent> BorderPane.left(): <ERROR CLASS>
fun <C : UIComponent> BorderPane.left(nodeType: KClass<C>): <ERROR CLASS>
loadFXML fun <T : Node> loadFXML(location: String? = null, hasControllerAttribute: Boolean = false, root: Any? = null): T
onBeforeShow open fun onBeforeShow(): Unit

Called right before the stage for this view is shown. You can access the currentWindow property at this stage. This callback is only available to top level UIComponents

onCreate open fun onCreate(): Unit

Create callback which is triggered when the Creaste button in the Workspace is clicked.

onDelete open fun onDelete(): Unit
onDock open fun onDock(): Unit

Called when a Component becomes the Scene root or when its root node is attached to another Component.

onEdit fun <T> ListView<T>.onEdit(eventListener: ListCell<T>.(EditEventType, T?) -> Unit): Unit
onGoto open fun onGoto(source: UIComponent): Unit
onNavigateBack open fun onNavigateBack(): Boolean

Callback that runs before the Workspace navigates back in the View stack. Return false to veto the navigation.

onNavigateForward open fun onNavigateForward(): Boolean

Callback that runs before the Workspace navigates forward in the View stack. Return false to veto the navigation.

onRefresh open fun onRefresh(): Unit
onSave open fun onSave(): Unit

Save callback which is triggered when the Save button in the Workspace is clicked, or when the Next button in a Wizard is clicked.

onTabSelected open fun onTabSelected(): Unit

Called when this Component is hosted by a Tab and the corresponding tab is selected

onUndock open fun onUndock(): Unit

Called when a Component is detached from the Scene

openInternalBuilderWindow fun openInternalBuilderWindow(title: String, scope: Scope = this@UIComponent.scope, icon: Node? = null, modal: Boolean = true, owner: Node = root, escapeClosesWindow: Boolean = true, closeButton: Boolean = true, overlayPaint: Paint = c("#000", 0.4), rootBuilder: UIComponent.() -> Parent): Unit
openInternalWindow fun <T : UIComponent> openInternalWindow(scope: Scope = this@UIComponent.scope, icon: Node? = null, modal: Boolean = true, owner: Node = root, escapeClosesWindow: Boolean = true, closeButton: Boolean = true, overlayPaint: Paint = c("#000", 0.4), params: Map<*, Any?>? = null): Unit
fun <T : UIComponent> openInternalWindow(scope: Scope = this@UIComponent.scope, icon: Node? = null, modal: Boolean = true, owner: Node = root, escapeClosesWindow: Boolean = true, closeButton: Boolean = true, overlayPaint: Paint = c("#000", 0.4), vararg params: Pair<*, Any?>): Unit
fun openInternalWindow(view: KClass<out UIComponent>, scope: Scope = this@UIComponent.scope, icon: Node? = null, modal: Boolean = true, owner: Node = root, escapeClosesWindow: Boolean = true, closeButton: Boolean = true, overlayPaint: Paint = c("#000", 0.4), params: Map<*, Any?>? = null): Unit
fun openInternalWindow(view: KClass<out UIComponent>, scope: Scope = this@UIComponent.scope, icon: Node? = null, modal: Boolean = true, owner: Node = root, escapeClosesWindow: Boolean = true, closeButton: Boolean = true, overlayPaint: Paint = c("#000", 0.4), vararg params: Pair<*, Any?>): Unit
fun openInternalWindow(view: UIComponent, icon: Node? = null, modal: Boolean = true, owner: Node = root, escapeClosesWindow: Boolean = true, closeButton: Boolean = true, overlayPaint: Paint = c("#000", 0.4)): Unit
openModal fun openModal(stageStyle: StageStyle = StageStyle.DECORATED, modality: Modality = Modality.APPLICATION_MODAL, escapeClosesWindow: Boolean = true, owner: Window? = currentWindow, block: Boolean = false, resizable: Boolean? = null): Stage?
openWindow fun openWindow(stageStyle: StageStyle = StageStyle.DECORATED, modality: Modality = Modality.NONE, escapeClosesWindow: Boolean = true, owner: Window? = currentWindow, block: Boolean = false, resizable: Boolean? = null): Stage?
placeholder fun <T : UIComponent> TableView<*>.placeholder(scope: Scope = this@UIComponent.scope, params: Map<*, Any?>? = null, op: T.() -> Unit = {}): Unit
fun <T : UIComponent> TableView<*>.placeholder(scope: Scope = this@UIComponent.scope, vararg params: Pair<*, Any?>, op: T.() -> Unit = {}): Unit
fun <T : UIComponent> ListView<*>.placeholder(scope: Scope = this@UIComponent.scope, params: Map<*, Any?>? = null, op: T.() -> Unit = {}): Unit
fun <T : UIComponent> ListView<*>.placeholder(scope: Scope = this@UIComponent.scope, vararg params: Pair<*, Any?>, op: T.() -> Unit = {}): Unit
fun <T : UIComponent> TreeTableView<*>.placeholder(scope: Scope = this@UIComponent.scope, params: Map<*, Any?>? = null, op: T.() -> Unit = {}): Unit
fun <T : UIComponent> TreeTableView<*>.placeholder(scope: Scope = this@UIComponent.scope, vararg params: Pair<*, Any?>, op: T.() -> Unit = {}): Unit
plusAssign operator fun <T : UIComponent> EventTarget.plusAssign(type: KClass<T>): Unit
refreshableWhen fun refreshableWhen(refreshable: () -> BooleanExpression): Unit
replaceWith fun <T : UIComponent> replaceWith(transition: ViewTransition? = null, sizeToScene: Boolean = false, centerOnScreen: Boolean = false): Boolean
fun <T : UIComponent> replaceWith(component: KClass<T>, transition: ViewTransition? = null, sizeToScene: Boolean = false, centerOnScreen: Boolean = false): Booleanfun replaceWith(replacement: UIComponent, transition: ViewTransition? = null, sizeToScene: Boolean = false, centerOnScreen: Boolean = false): Boolean

Replace this component with another, optionally using a transition animation.

right fun <C : UIComponent> BorderPane.right(): <ERROR CLASS>
fun <C : UIComponent> BorderPane.right(nodeType: KClass<C>): <ERROR CLASS>
savableWhen fun savableWhen(savable: () -> BooleanExpression): Unit
setWindowMaxSize fun setWindowMaxSize(width: Number, height: Number): <ERROR CLASS>
setWindowMinSize fun setWindowMinSize(width: Number, height: Number): <ERROR CLASS>
shortcut fun Button.shortcut(combo: String): Unit
fun <T> shortcut(combo: KeyCombination, command: Command<T>, param: T? = null): Unitfun Button.shortcut(combo: KeyCombination): Unit

Add the key combination as a shortcut for this Buttons action.

fun shortcut(combo: KeyCombination, action: () -> Unit): Unit
fun shortcut(combo: String, action: () -> Unit): Unit

Configure an action for a key combination.

slideshow fun EventTarget.slideshow(defaultTimeout: Duration? = null, scope: Scope = this@UIComponent.scope, op: Slideshow.() -> Unit): <ERROR CLASS>
tab fun <T : UIComponent> TabPane.tab(scope: Scope = this@UIComponent.scope, op: Tab.() -> Unit = {}): Tab
top fun <C : UIComponent> BorderPane.top(): <ERROR CLASS>
fun <C : UIComponent> BorderPane.top(nodeType: KClass<C>): <ERROR CLASS>
useProgressBar fun <S> TableColumn<S, out Number?>.useProgressBar(afterCommit: (CellEditEvent<S, Number?>) -> Unit = {}): <ERROR CLASS>
whenCreated fun whenCreated(onCreate: () -> Unit): Unit
whenDeleted fun whenDeleted(onDelete: () -> Unit): Unit
whenRefreshed fun whenRefreshed(onRefresh: () -> Unit): Unit
whenSaved fun whenSaved(onSave: () -> Unit): Unit
wrapper fun wrapper(op: () -> Parent): Unit

Inherited Functions

background fun <T> background(func: FXTask<*>.() -> T): Task<T>
di fun <T : Any> di(name: String? = null): ReadOnlyProperty<Component, T>
find fun <T : Component> find(vararg params: Pair<*, Any?>, op: T.() -> Unit = {}): T
fun <T : Component> find(params: Map<*, Any?>? = null, op: T.() -> Unit = {}): T
fun <T : Component> find(type: KClass<T>, params: Map<*, Any?>? = null, op: T.() -> Unit = {}): <ERROR CLASS>
fun <T : Component> find(type: KClass<T>, vararg params: Pair<*, Any?>, op: T.() -> Unit = {}): <ERROR CLASS>
fun <T : Component> find(componentType: Class<T>, params: Map<*, Any?>? = null, scope: Scope = this@Component.scope): T
fire fun <T : FXEvent> fire(event: T): Unit
fragment fun <T : Fragment> fragment(overrideScope: Scope = scope, vararg params: Pair<String, Any?>): ReadOnlyProperty<Component, T>
fun <T : Fragment> fragment(overrideScope: Scope = scope, params: Map<String, Any?>): ReadOnlyProperty<Component, T>
get fun <InjectableType, T> get(prop: KProperty1<InjectableType, T>): T where InjectableType : Component, InjectableType : ScopedInstance

Find the given property inside the given ScopedInstance. Useful for assigning a property from a View or Controller in any Component. Example:

inject fun <T> inject(overrideScope: Scope = scope, vararg params: Pair<String, Any?>): ReadOnlyProperty<Component, T> where T : Component, T : ScopedInstance
fun <T> inject(overrideScope: Scope = scope, params: Map<String, Any?>? = null): ReadOnlyProperty<Component, T> where T : Component, T : ScopedInstance
k fun <T : Any> k(javaClass: Class<T>): KClass<T>
nullableParam fun <T> nullableParam(defaultValue: T? = null): ReadOnlyProperty<Component, T>
param fun <T> param(defaultValue: T? = null): ReadOnlyProperty<Component, T>
preferences fun preferences(nodename: String? = null, op: Preferences.() -> Unit): Unit

Store and retrieve preferences.

runAsync fun <T, R> KClass<T>.runAsync(op: T.() -> R): Task<R> where T : Component, T : ScopedInstance

Perform the given operation on an ScopedInstance of the specified type asynchronousyly.

fun <InjectableType, ReturnType> KFunction1<InjectableType, ReturnType>.runAsync(doOnUi: (ReturnType) -> Unit = {}): Task<ReturnType> where InjectableType : Component, InjectableType : ScopedInstance
fun <InjectableType, P1, ReturnType> KFunction2<InjectableType, P1, ReturnType>.runAsync(p1: P1, doOnUi: (ReturnType) -> Unit = {}): <ERROR CLASS> where InjectableType : Component, InjectableType : ScopedInstance

Perform the given operation on an ScopedInstance class function member asynchronousyly.

fun <InjectableType, P1, P2, ReturnType> KFunction3<InjectableType, P1, P2, ReturnType>.runAsync(p1: P1, p2: P2, doOnUi: (ReturnType) -> Unit = {}): <ERROR CLASS> where InjectableType : Component, InjectableType : ScopedInstance
fun <InjectableType, P1, P2, P3, ReturnType> KFunction4<InjectableType, P1, P2, P3, ReturnType>.runAsync(p1: P1, p2: P2, p3: P3, doOnUi: (ReturnType) -> Unit = {}): <ERROR CLASS> where InjectableType : Component, InjectableType : ScopedInstance
fun <InjectableType, P1, P2, P3, P4, ReturnType> KFunction5<InjectableType, P1, P2, P3, P4, ReturnType>.runAsync(p1: P1, p2: P2, p3: P3, p4: P4, doOnUi: (ReturnType) -> Unit = {}): <ERROR CLASS> where InjectableType : Component, InjectableType : ScopedInstance
fun <T> runAsync(daemon: Boolean = false, status: TaskStatus? = find(scope), func: FXTask<*>.() -> T): Task<T>fun <T> runAsync(status: TaskStatus? = find(scope), func: FXTask<*>.() -> T): Task<T>

Runs task in background. If not set directly, looks for TaskStatus instance in current scope.

set fun <InjectableType, T> set(prop: KMutableProperty1<InjectableType, T>, value: T): Unit where InjectableType : Component, InjectableType : ScopedInstance
setInScope fun <T : ScopedInstance> setInScope(value: T, scope: Scope = this.scope): <ERROR CLASS>
subscribe fun <T : FXEvent> subscribe(times: Number? = null, action: EventContext.(T) -> Unit): FXEventRegistration
ui infix fun <T> Task<T>.ui(func: (T) -> Unit): <ERROR CLASS>
unsubscribe fun <T : FXEvent> unsubscribe(action: EventContext.(T) -> Unit): Unit

Extension Properties

tag var EventTarget.tag: Any?
tagProperty var EventTarget.tagProperty: Property<Any?>

Extension Functions

accordion fun EventTarget.accordion(vararg panes: TitledPane, op: Accordion.() -> Unit = {}): Accordion
add fun EventTarget.add(node: Node): Unit
addChildIfPossible fun EventTarget.addChildIfPossible(node: Node, index: Int? = null): Unit
addViewsWhen fun EventTarget.addViewsWhen(acceptor: (ViewProvider) -> Boolean): Unit

Subscribe to ViewProvider events from other OSGi bundles and add the provided view to this UI element if the acceptor returns true.

anchorpane fun EventTarget.anchorpane(vararg nodes: Node, op: AnchorPane.() -> Unit = {}): AnchorPane
areachart fun <X, Y> EventTarget.areachart(title: String? = null, x: Axis<X>, y: Axis<Y>, op: AreaChart<X, Y>.() -> Unit = {}): <ERROR CLASS>

Create an AreaChart with optional title, axis and add to the parent pane. The optional op will be performed on the new instance.

barchart fun <X, Y> EventTarget.barchart(title: String? = null, x: Axis<X>, y: Axis<Y>, op: BarChart<X, Y>.() -> Unit = {}): <ERROR CLASS>

Create a BarChart with optional title, axis and add to the parent pane. The optional op will be performed on the new instance.

bindChildren fun <T> EventTarget.bindChildren(sourceList: ObservableList<T>, converter: (T) -> Node): ListConversionListener<T, Node>

Bind the children of this Layout node to the given observable list of items by converting them into nodes via the given converter function. Changes to the source list will be reflected in the children list of this layout node.

fun <T> EventTarget.bindChildren(sourceList: ListProperty<T>, converter: (T) -> Node): ListConversionListener<T, Node>

Bind the children of this Layout node to the items of the given ListPropery by converting them into nodes via the given converter function. Changes to the source list and changing the list inside the ListProperty will be reflected in the children list of this layout node.

fun <T> EventTarget.bindChildren(sourceSet: ObservableSet<T>, converter: (T) -> Node): SetConversionListener<T, Node>

Bind the children of this Layout node to the given observable set of items by converting them into nodes via the given converter function. Changes to the source set will be reflected in the children list of this layout node.

fun <K, V> EventTarget.bindChildren(sourceMap: ObservableMap<K, V>, converter: (K, V) -> Node): MapConversionListener<K, V, Node>
bindComponents fun <T> EventTarget.bindComponents(sourceList: ObservableList<T>, converter: (T) -> UIComponent): ListConversionListener<T, Node>

Bind the children of this Layout node to the given observable list of items by converting them into UIComponents via the given converter function. Changes to the source list will be reflected in the children list of this layout node.

borderpane fun EventTarget.borderpane(op: BorderPane.() -> Unit = {}): <ERROR CLASS>
bubblechart fun <X, Y> EventTarget.bubblechart(title: String? = null, x: Axis<X>, y: Axis<Y>, op: BubbleChart<X, Y>.() -> Unit = {}): <ERROR CLASS>

Create a BubbleChart with optional title, axis and add to the parent pane. The optional op will be performed on the new instance.

button fun EventTarget.button(text: String = "", graphic: Node? = null, op: Button.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.button(text: ObservableValue<String>, graphic: Node? = null, op: Button.() -> Unit = {}): <ERROR CLASS>
buttonbar fun EventTarget.buttonbar(buttonOrder: String? = null, forceLabelIndent: Boolean = true, op: ButtonBar.() -> Unit = {}): ButtonBarField

Creates a ButtonBarFiled with the given button order (refer to javafx.scene.control.ButtonBar#buttonOrderProperty for more information about buttonOrder).

fun EventTarget.buttonbar(buttonOrder: String? = null, op: ButtonBar.() -> Unit): <ERROR CLASS>
canvas fun EventTarget.canvas(width: Double = 0.0, height: Double = 0.0, op: Canvas.() -> Unit = {}): <ERROR CLASS>
checkbox fun EventTarget.checkbox(text: String? = null, property: Property<Boolean>? = null, op: CheckBox.() -> Unit = {}): <ERROR CLASS>
choicebox fun <T> EventTarget.choicebox(property: Property<T>? = null, values: List<T>? = null, op: ChoiceBox<T>.() -> Unit = {}): <ERROR CLASS>
colorpicker fun EventTarget.colorpicker(color: Color? = null, mode: ColorPickerMode = ColorPickerMode.Button, op: ColorPicker.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.colorpicker(colorProperty: ObjectProperty<Color>, mode: ColorPickerMode = ColorPickerMode.Button, op: ColorPicker.() -> Unit = {}): <ERROR CLASS>
combobox fun <T> EventTarget.combobox(property: Property<T>? = null, values: List<T>? = null, op: ComboBox<T>.() -> Unit = {}): <ERROR CLASS>
contextmenu fun EventTarget.contextmenu(op: ContextMenu.() -> Unit = {}): ContextMenu
datagrid fun <T> EventTarget.datagrid(items: List<T>? = null, scope: Scope = FX.defaultScope, op: DataGrid<T>.() -> Unit = {}): <ERROR CLASS>
datepicker fun EventTarget.datepicker(op: DatePicker.() -> Unit = {}): DatePicker
fun EventTarget.datepicker(property: Property<LocalDate>, op: DatePicker.() -> Unit = {}): <ERROR CLASS>
drawer fun EventTarget.drawer(side: Side = Side.LEFT, multiselect: Boolean = false, floatingContent: Boolean = false, op: Drawer.() -> Unit): Drawer
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.

field fun EventTarget.field(text: String? = null, orientation: Orientation = HORIZONTAL, forceLabelIndent: Boolean = false, op: Field.() -> Unit = {}): Field

Create a field with the given text and operate on it.

fieldset fun EventTarget.fieldset(text: String? = null, icon: Node? = null, labelPosition: Orientation? = null, wrapWidth: Double? = null, op: Fieldset.() -> Unit = {}): Fieldset
findAll fun <T : UIComponent> UIComponent.findAll(): List<T>

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

flowpane fun EventTarget.flowpane(op: FlowPane.() -> Unit = {}): <ERROR CLASS>
form fun EventTarget.form(op: Form.() -> Unit = {}): <ERROR CLASS>
getChildList fun EventTarget.getChildList(): MutableList<Node>?

Find the list of children from a Parent node. Gleaned code from ControlsFX for this.

getProperty fun <T> Any.getProperty(prop: KMutableProperty1<*, T>): ObjectProperty<T>
getToggleGroup fun EventTarget.getToggleGroup(): ToggleGroup?
gridpane fun EventTarget.gridpane(op: GridPane.() -> Unit = {}): <ERROR CLASS>
group fun EventTarget.group(initialChildren: Iterable<Node>? = null, op: Group.() -> Unit = {}): <ERROR CLASS>
hbox fun EventTarget.hbox(spacing: Number? = null, alignment: Pos? = null, op: HBox.() -> Unit = {}): HBox
htmleditor fun EventTarget.htmleditor(html: String? = null, op: HTMLEditor.() -> Unit = {}): <ERROR CLASS>
hyperlink fun EventTarget.hyperlink(text: String = "", graphic: Node? = null, op: Hyperlink.() -> Unit = {}): Hyperlink
fun EventTarget.hyperlink(observable: ObservableValue<String>, graphic: Node? = null, op: Hyperlink.() -> Unit = {}): <ERROR CLASS>
imageview fun EventTarget.imageview(url: String? = null, lazyload: Boolean = true, op: ImageView.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.imageview(url: ObservableValue<String>, lazyload: Boolean = true, op: ImageView.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.imageview(image: ObservableValue<Image?>, op: ImageView.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.imageview(image: Image, op: ImageView.() -> Unit = {}): ImageView
isInsideRow fun EventTarget.isInsideRow(): Boolean

Did the event occur inside a TableRow, TreeTableRow or ListCell?

keyboard fun EventTarget.keyboard(op: KeyboardLayout.() -> Unit): <ERROR CLASS>
label fun EventTarget.label(text: String = "", graphic: Node? = null, op: Label.() -> Unit = {}): <ERROR CLASS>
fun <T> EventTarget.label(observable: ObservableValue<T>, graphicProperty: ObservableValue<Node>? = null, converter: StringConverter<in T>? = null, op: Label.() -> Unit = {}): <ERROR CLASS>
lazyContextmenu fun EventTarget.lazyContextmenu(op: ContextMenu.() -> Unit = {}): <ERROR CLASS>

Add a context menu to the target which will be created on demand.

linechart fun <X, Y> EventTarget.linechart(title: String? = null, x: Axis<X>, y: Axis<Y>, op: LineChart<X, Y>.() -> Unit = {}): <ERROR CLASS>

Create a LineChart with optional title, axis and add to the parent pane. The optional op will be performed on the new instance.

listmenu fun EventTarget.listmenu(orientation: Orientation = VERTICAL, iconPosition: Side = Side.LEFT, theme: String? = null, tag: Any? = null, op: ListMenu.() -> Unit = {}): <ERROR CLASS>
listview fun <T> EventTarget.listview(values: ObservableList<T>? = null, op: ListView<T>.() -> Unit = {}): <ERROR CLASS>
fun <T> EventTarget.listview(values: ReadOnlyListProperty<T>, op: ListView<T>.() -> Unit = {}): <ERROR CLASS>
fun <T> EventTarget.listview(values: ObservableValue<ObservableList<T>>, op: ListView<T>.() -> 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

menubar fun EventTarget.menubar(op: MenuBar.() -> Unit = {}): MenuBar
menubutton fun EventTarget.menubutton(text: String = "", graphic: Node? = null, op: MenuButton.() -> Unit = {}): <ERROR CLASS>
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.

observable fun <T : Any> Any.observable(propName: String): ObjectProperty<T>
pagination fun EventTarget.pagination(pageCount: Int? = null, pageIndex: Int? = null, op: Pagination.() -> Unit = {}): Pagination
pane fun EventTarget.pane(op: Pane.() -> Unit = {}): <ERROR CLASS>
passwordfield fun EventTarget.passwordfield(value: String? = null, op: PasswordField.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.passwordfield(property: ObservableValue<String>, op: PasswordField.() -> Unit = {}): <ERROR CLASS>
piechart fun EventTarget.piechart(title: String? = null, data: ObservableList<Data>? = null, op: PieChart.() -> Unit = {}): PieChart

Create a PieChart with optional title data and add to the parent pane. The optional op will be performed on the new instance.

plusAssign operator fun EventTarget.plusAssign(node: Node): Unit
operator fun EventTarget.plusAssign(view: UIComponent): Unit
progressbar fun EventTarget.progressbar(initialValue: Double? = null, op: ProgressBar.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.progressbar(property: ObservableValue<Number>, op: ProgressBar.() -> Unit = {}): <ERROR CLASS>
progressindicator fun EventTarget.progressindicator(op: ProgressIndicator.() -> Unit = {}): ProgressIndicator
fun EventTarget.progressindicator(property: Property<Number>, op: ProgressIndicator.() -> Unit = {}): <ERROR CLASS>
radiobutton fun EventTarget.radiobutton(text: String? = null, group: ToggleGroup? = getToggleGroup(), value: Any? = null, op: RadioButton.() -> Unit = {}): <ERROR CLASS>

Create a radiobutton inside the current or given toggle group. The optional value parameter will be matched against the extension property selectedValueProperty() on Toggle Group. If the #ToggleGroup.selectedValueProperty is used, its value will be updated to reflect the value for this radio button when its selected.

region fun EventTarget.region(op: Region.() -> Unit = {}): <ERROR CLASS>
removeFromParent fun EventTarget.removeFromParent(): Unit
replaceChildren fun EventTarget.replaceChildren(vararg node: Node): 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.

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.

scatterchart fun <X, Y> EventTarget.scatterchart(title: String? = null, x: Axis<X>, y: Axis<Y>, op: ScatterChart<X, Y>.() -> Unit = {}): <ERROR CLASS>

Create a ScatterChart with optional title, axis and add to the parent pane. The optional op will be performed on the new instance.

scrollpane fun EventTarget.scrollpane(fitToWidth: Boolean = false, fitToHeight: Boolean = false, op: ScrollPane.() -> Unit = {}): ScrollPane
separator fun EventTarget.separator(orientation: Orientation = Orientation.HORIZONTAL, op: Separator.() -> Unit = {}): <ERROR CLASS>
slider fun EventTarget.slider(min: Number? = null, max: Number? = null, value: Number? = null, orientation: Orientation? = null, op: Slider.() -> Unit = {}): <ERROR CLASS>
fun <T> EventTarget.slider(range: ClosedRange<T>, value: Number? = null, orientation: Orientation? = null, op: Slider.() -> Unit = {}): Slider where T : Comparable<T>, T : Number
spinner fun <T> EventTarget.spinner(editable: Boolean = false, property: Property<T>? = null, enableScroll: Boolean = false, op: Spinner<T>.() -> Unit = {}): <ERROR CLASS>

Create a spinner for an arbitrary type. This spinner requires you to configure a value factory, or it will throw an exception.

fun <T : Number> EventTarget.spinner(min: T? = null, max: T? = null, initialValue: T? = null, amountToStepBy: T? = null, editable: Boolean = false, property: Property<T>? = null, enableScroll: Boolean = false, op: Spinner<T>.() -> Unit = {}): Spinner<T>
fun <T> EventTarget.spinner(items: ObservableList<T>, editable: Boolean = false, property: Property<T>? = null, enableScroll: Boolean = false, op: Spinner<T>.() -> Unit = {}): <ERROR CLASS>
fun <T> EventTarget.spinner(valueFactory: SpinnerValueFactory<T>, editable: Boolean = false, property: Property<T>? = null, enableScroll: Boolean = false, op: Spinner<T>.() -> Unit = {}): <ERROR CLASS>
splitpane fun EventTarget.splitpane(orientation: Orientation = Orientation.HORIZONTAL, vararg nodes: Node, op: SplitPane.() -> Unit = {}): SplitPane
squeezebox fun EventTarget.squeezebox(multiselect: Boolean = true, fillHeight: Boolean = true, op: SqueezeBox.() -> Unit): SqueezeBox
stackedbarchart fun <X, Y> EventTarget.stackedbarchart(title: String? = null, x: Axis<X>, y: Axis<Y>, op: StackedBarChart<X, Y>.() -> Unit = {}): <ERROR CLASS>

Create a BarChart with optional title, axis and add to the parent pane. The optional op will be performed on the new instance.

stackpane fun EventTarget.stackpane(initialChildren: Iterable<Node>? = null, op: StackPane.() -> Unit = {}): <ERROR CLASS>
svgicon fun EventTarget.svgicon(shape: String, size: Number = 16, color: Paint = Color.BLACK, op: SVGIcon.() -> Unit = {}): SVGIcon
tableview fun <T> EventTarget.tableview(items: ObservableList<T>? = null, op: TableView<T>.() -> Unit = {}): <ERROR CLASS>
fun <T> EventTarget.tableview(items: ReadOnlyListProperty<T>, op: TableView<T>.() -> Unit = {}): <ERROR CLASS>
fun <T> EventTarget.tableview(items: ObservableValue<ObservableList<T>>, op: TableView<T>.() -> Unit = {}): <ERROR CLASS>
tabpane fun EventTarget.tabpane(op: TabPane.() -> Unit = {}): TabPane
text fun EventTarget.text(op: Text.() -> Unit = {}): Text
fun EventTarget.text(initialValue: String? = null, op: Text.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.text(property: Property<String>, op: Text.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.text(observable: ObservableValue<String>, op: Text.() -> Unit = {}): <ERROR CLASS>
textarea fun EventTarget.textarea(value: String? = null, op: TextArea.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.textarea(property: ObservableValue<String>, op: TextArea.() -> Unit = {}): <ERROR CLASS>
fun <T> EventTarget.textarea(property: Property<T>, converter: StringConverter<T>, op: TextArea.() -> Unit = {}): <ERROR CLASS>
textfield fun EventTarget.textfield(value: String? = null, op: TextField.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.textfield(property: ObservableValue<String>, op: TextField.() -> Unit = {}): <ERROR CLASS>
fun EventTarget.textfield(property: ObservableValue<Number>, op: TextField.() -> Unit = {}): <ERROR CLASS>
fun <T> EventTarget.textfield(property: Property<T>, converter: StringConverter<T>, op: TextField.() -> Unit = {}): <ERROR CLASS>
textflow fun EventTarget.textflow(op: TextFlow.() -> Unit = {}): TextFlow
tilepane fun EventTarget.tilepane(op: TilePane.() -> Unit = {}): <ERROR CLASS>
titledpane fun EventTarget.titledpane(title: String? = null, node: Node? = null, collapsible: Boolean = true, op: TitledPane.() -> Unit = {}): TitledPane
fun EventTarget.titledpane(title: ObservableValue<String>, node: Node? = null, collapsible: Boolean = true, op: TitledPane.() -> Unit = {}): TitledPane
togglebutton fun EventTarget.togglebutton(text: String? = null, group: ToggleGroup? = getToggleGroup(), selectFirst: Boolean = true, value: Any? = null, op: ToggleButton.() -> Unit = {}): <ERROR CLASS>

Create a togglebutton inside the current or given toggle group. The optional value parameter will be matched against the extension property selectedValueProperty() on Toggle Group. If the #ToggleGroup.selectedValueProperty is used, its value will be updated to reflect the value for this radio button when its selected.

fun EventTarget.togglebutton(text: ObservableValue<String>? = null, group: ToggleGroup? = getToggleGroup(), selectFirst: Boolean = true, value: Any? = null, op: ToggleButton.() -> Unit = {}): <ERROR CLASS>
toolbar fun EventTarget.toolbar(vararg nodes: Node, op: ToolBar.() -> Unit = {}): ToolBar
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.

treetableview fun <T> EventTarget.treetableview(root: TreeItem<T>? = null, op: TreeTableView<T>.() -> Unit = {}): <ERROR CLASS>
treeview fun <T> EventTarget.treeview(root: TreeItem<T>? = null, op: TreeView<T>.() -> Unit = {}): <ERROR CLASS>
vbox fun EventTarget.vbox(spacing: Number? = null, alignment: Pos? = null, op: VBox.() -> Unit = {}): VBox
webview fun EventTarget.webview(op: WebView.() -> Unit = {}): WebView
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

Inheritors

Fragment abstract class Fragment : UIComponent
View abstract class View : UIComponent, ScopedInstance