tornadofx / tornadofx / Wizard

Wizard

abstract class Wizard : View

Constructors

<init> Wizard(title: String? = null, heading: String? = null)

Properties

allPagesComplete val allPagesComplete: BooleanExpression
backButtonTextProperty val backButtonTextProperty: SimpleStringProperty
canFinish open val canFinish: BooleanExpression
canGoBack open val canGoBack: BooleanExpression
canGoNext open val canGoNext: BooleanExpression
cancelButtonTextProperty val cancelButtonTextProperty: SimpleStringProperty
complete open val complete: SimpleBooleanProperty
currentPage var currentPage: UIComponent
currentPageComplete val currentPageComplete: BooleanExpression
currentPageProperty val currentPageProperty: SimpleObjectProperty<UIComponent>
enableStepLinks var enableStepLinks: Boolean
enableStepLinksProperty val enableStepLinksProperty: SimpleBooleanProperty
enterProgresses var enterProgresses: Boolean
enterProgressesProperty val enterProgressesProperty: BooleanProperty
finishButtonTextProperty val finishButtonTextProperty: SimpleStringProperty
graphic var graphic: Node
graphicProperty val graphicProperty: SimpleObjectProperty<Node>
hasNext val hasNext: BooleanBinding
hasPrevious val hasPrevious: BooleanBinding
nextButtonTextProperty val nextButtonTextProperty: SimpleStringProperty
numberedSteps var numberedSteps: Boolean
numberedStepsProperty val numberedStepsProperty: SimpleBooleanProperty
pages val pages: ObservableList<UIComponent>
root open val root: <ERROR CLASS>
showHeader var showHeader: Boolean
showHeaderProperty val showHeaderProperty: SimpleBooleanProperty
showSteps var showSteps: Boolean
showStepsHeader var showStepsHeader: Boolean
showStepsHeaderProperty val showStepsHeaderProperty: SimpleBooleanProperty
showStepsProperty val showStepsProperty: SimpleBooleanProperty
stepLinksCommits var stepLinksCommits: Boolean
stepLinksCommitsProperty val stepLinksCommitsProperty: SimpleBooleanProperty
stepsTextProperty val stepsTextProperty: SimpleStringProperty

Functions

back fun back(): Unit
cancel fun cancel(): Unit
getNextPage open fun getNextPage(): Int
getPreviousPage open fun getPreviousPage(): Int
next fun next(): Unit
onCancel open fun onCancel(): Unit
onComplete fun onComplete(resultListener: () -> Unit): Unit
fun onComplete(resultListener: Runnable): Unit
onDock open fun onDock(): Unit

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

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.

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>
splitmenubutton fun EventTarget.splitmenubutton(text: String? = null, graphic: Node? = null, op: SplitMenuButton.() -> 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>
subscene fun EventTarget.subscene(depthBuffer: Boolean = false, antiAlias: SceneAntialiasing = SceneAntialiasing.DISABLED, width: Number? = null, height: Number? = null, op: SubScene.() -> Unit = {}): <ERROR CLASS>

Create a subscene and attach it to the current container as a child. The root node of the SubScene will be whatever is built inside the op builder parameter. If no height or width is given, the size property will be bound to its parent size.

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<out 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 EventTarget.textfield(property: ObservableValue<Int>, 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