glok-core/uk.co.nickthecoder.glok.scene.dsl

Package-level declarations

Types

IconGrid

class IconGrid(val iconSheet: IconSheet, val spacing: Int, var left: Int, var top: Int)

MeaningDSL

class MeaningDSL(val buttonBar: ButtonBar, val meaning: ButtonMeaning)

PropertyRadioChoicesDSL

class PropertyRadioChoicesDSL<V, P : Property<V>>(val property: P)

PropertyToggleChoicesDSL

class PropertyToggleChoicesDSL<V, P : Property<V?>>(val property: P)

RotationDSL

class RotationDSL

SceneDSL

class SceneDSL(val width: Float = 0.0f, val height: Float = 0.0f)

ToggleGroupDSL

class ToggleGroupDSL

Functions

borderPane

fun borderPane(block: BorderPane.() -> Unit? = null): BorderPane

borderSize

fun Region.borderSize(size: Number)

fun Region.borderSize(topBottom: Number, leftRight: Number)

fun Region.borderSize(top: Number, right: Number, bottom: Number, left: Number)

Sets Region.borderSize.

box

fun box(orientation: Orientation, block: Box.() -> Unit? = null): Box

button

fun button(text: String, block: Button.() -> Unit? = null): Button

fun button(text: String, graphic: Node?, block: Button.() -> Unit? = null): Button

buttonBar

fun buttonBar(block: ButtonBar.() -> Unit? = null): ButtonBar

checkBox

fun checkBox(block: CheckBox.() -> Unit? = null): CheckBox

fun checkBox(text: String, block: CheckBox.() -> Unit? = null): CheckBox

choiceBox

fun <V> choiceBox(block: ChoiceBox<V>.() -> Unit? = null): ChoiceBox<V>

colorButton

fun colorButton(block: ColorButton.() -> Unit? = null): ColorButton

fun colorButton(text: String, block: ColorButton.() -> Unit? = null): ColorButton

colorSlider

fun colorSlider(block: ColorSlider.() -> Unit? = null): ColorSlider

container

fun container(block: SingleContainer.() -> Unit? = null): SingleContainer

fun container(contentProperty: ObservableOptionalNode, block: SingleContainer.() -> Unit? = null): SingleContainer

customColorPicker

fun customColorPicker(initialColor: Color = Color.WHITE, block: CustomColorPicker.() -> Unit? = null): CustomColorPicker

fun customColorPicker(initialColor: Color = Color.WHITE, editAlpha: Boolean, block: CustomColorPicker.() -> Unit? = null): CustomColorPicker

customMenuItem

fun customMenuItem(block: CustomMenuItem.() -> Unit? = null): CustomMenuItem

documentTabBar

fun documentTabBar(block: TabBar.() -> Unit? = null): TabBar

documentTabPane

fun documentTabPane(block: TabPane.() -> Unit? = null): TabPane

Creates a TabPane, but using the style "document_tab_pane" instead of the standard "tab_pane". This style is suitable for tabs containing documents

doubleSlider

fun doubleSlider(block: DoubleSlider.() -> Unit? = null): DoubleSlider

doubleSpinner

fun doubleSpinner(block: DoubleSpinner.() -> Unit? = null): DoubleSpinner

fun doubleSpinner(initialValue: Double, block: DoubleSpinner.() -> Unit? = null): DoubleSpinner

fileButton

fun fileButton(title: String, prop: FileProperty): Button

floatSlider

fun floatSlider(block: FloatSlider.() -> Unit? = null): FloatSlider

floatSpinner

fun floatSpinner(block: FloatSpinner.() -> Unit? = null): FloatSpinner

fun floatSpinner(initialValue: Float, block: FloatSpinner.() -> Unit? = null): FloatSpinner

flowPane

fun flowPane(block: FlowPane.() -> Unit? = null): FlowPane

folderButton

fun folderButton(title: String, prop: FileProperty): Button

form

fun form(block: FormGrid.() -> Unit? = null): FormGrid

formGrid

fun formGrid(block: FormGrid.() -> Unit? = null): FormGrid

grid

fun IconSheet.grid(left: Int, top: Int, spacing: Int, block: IconGrid.() -> Unit)

hBox

fun hBox(block: HBox.() -> Unit? = null): HBox

height

fun Node.height(height: Number)

Sets Node.overridePrefHeight

icon

fun IconSheet.icon(name: String, x: Int, y: Int)

imageView

fun imageView(observableImage: ObservableOptionalImage, block: ImageView.() -> Unit? = null): ImageView

fun imageView(image: Image?, block: ImageView.() -> Unit? = null): ImageView

intSlider

fun intSlider(block: IntSlider.() -> Unit? = null): IntSlider

intSpinner

fun intSpinner(block: IntSpinner.() -> Unit? = null): IntSpinner

fun intSpinner(initialValue: Int, block: IntSpinner.() -> Unit? = null): IntSpinner

invoke

operator fun <N : Node> N.invoke(block: N.() -> Unit): N

Removes the need to use .apply { ... } when building scene graphs.

label

fun label(text: String, block: Label.() -> Unit? = null): Label

fun label(text: String, graphic: Node? = null, block: Label.() -> Unit? = null): Label

listView

fun <T> listView(block: ListView<T>.() -> Unit? = null): ListView<T>

meaning

fun ButtonBar.meaning(meaning: ButtonMeaning, block: MeaningDSL.() -> Unit? = null)

fun menu(text: String, block: Menu.() -> Unit? = null): Menu

fun menu(text: String, graphic: Node? = null, block: Menu.() -> Unit? = null): Menu

menuBar

fun menuBar(block: MenuBar.() -> Unit? = null): MenuBar

menuButton

fun menuButton(text: String, block: MenuButton.() -> Unit? = null): MenuButton

fun menuButton(text: String, graphic: Node?, block: MenuButton.() -> Unit? = null): MenuButton

menuItem

fun menuItem(text: String, block: MenuItem.() -> Unit): MenuItem

fun menuItem(text: String, graphic: Node?, block: MenuItem.() -> Unit? = null): MenuItem

mixedTreeView

fun <I : MixedTreeItem<I>> mixedTreeView(block: MixedTreeView<I>.() -> Unit? = null): MixedTreeView<I>

ninePatch

fun NinePatchImages.ninePatch(name: String, x: Number, y: Number, width: Number, height: Number, edges: Edges)

Part of a DSL (Domain specific language) for loading nine patches. See ninePatchImages for details.

ninePatchImages

fun ninePatchImages(resources: Resources, textureName: String, block: NinePatchImages.() -> Unit): NinePatchImages

Part of a DSL (Domain specific language) for loading nine patches. Example (taken from DemoNinePatch) :

noBackground

fun Region.noBackground()

Sets [Region.background to NoBackground

noBorder

fun Region.noBorder()

padding

fun Region.padding(size: Number)

fun Region.padding(topBottom: Number, leftRight: Number)

fun Region.padding(top: Number, right: Number, bottom: Number, left: Number)

Sets Region.padding.

paletteColorPicker

fun paletteColorPicker(initialColor: Color = Color.WHITE, block: PaletteColorPicker.() -> Unit? = null): PaletteColorPicker

pane

fun pane(block: Pane.() -> Unit? = null): Pane

plainBackground

fun Region.plainBackground(color: String)

Sets Region.background to Color[color]

fun Region.plainBackground(color: Color)

Sets Region.background to PlainBackground

plainBorder

fun Region.plainBorder(color: String)

fun Region.plainBorder(color: Color)

popupMenu

fun popupMenu(block: PopupMenu.() -> Unit? = null): PopupMenu

prefDigits

fun TextField.prefDigits(digits: Int)

Sets TextField.expectDigits = true and TextField.prefColumnCount to digits.

propertyRadioButton

fun <V, P : Property<V>> propertyRadioButton(property: P, value: V, text: String, block: PropertyRadioButton<V, P>.() -> Unit? = null): PropertyRadioButton<V, P>

propertyToggleButton

fun <V, P : Property<V?>> propertyToggleButton(property: P, value: V, text: String, block: PropertyToggleButton<V, P>.() -> Unit? = null): PropertyToggleButton<V, P>

pseudoStyle

fun Node.pseudoStyle(name: String)

Adds a style to Node.pseudoStyle

pseudoStyleIf

fun Node.pseudoStyleIf(test: Boolean, pseudoStyle: String)

Adds or removes the pseudoStyle depending on test. See Node.pseudoStyles

fun Node.pseudoStyleIf(test: Boolean, trueStyle: String, falseStyle: String)

When test is true, trueStyle is added, and falseStyle is removed from Node.pseudoStyles.

radioButton

fun radioButton(toggleGroup: ToggleGroup, text: String, block: RadioButton.() -> Unit? = null): RadioButton

fun radioButton(toggleGroup: ToggleGroup, text: String, graphic: Node, block: RadioButton.() -> Unit? = null): RadioButton

radioChoices

fun <V, P : Property<V>> radioChoices(property: P, block: PropertyRadioChoicesDSL<V, P>.() -> Unit? = null): PropertyRadioChoicesDSL<V, P>

readOnly

fun TextField.readOnly()

rotation

fun rotation(angle: Int, block: RotationDSL.() -> Unit? = null): Rotation

roundedBackground

fun Region.roundedBackground(color: String, radius: Number)

fun Region.roundedBackground(color: Color, radius: Number)

roundedBorder

fun Region.roundedBorder(color: String, radius: Number)

fun Region.roundedBorder(color: Color, radius: Number)

row

fun FormGrid.row(block: FormRow.() -> Unit? = null)

Add a FormRow to a FormGrid. e.g.

fun FormGrid.row(label: String, block: FormRow.() -> Unit? = null)

A very common convenience method when left is a label. This is equivalent to :

fun IconGrid.row(prefix: String, vararg names: String)

fun IconSheet.row(left: Int, top: Int, spacing: Int, vararg names: String)

fun IconSheet.row(prefix: String, left: Int, top: Int, spacing: Int, vararg names: String)

fun FormGrid.row(label: String, text: String, block: FormRow.() -> Unit? = null)

A convenience method for when you want a row with just a label on the left, and text on the right.

ruler

fun ruler(side: Side = Side.TOP, block: Ruler.() -> Unit? = null): Ruler

scene

fun scene(block: SceneDSL.() -> Unit? = null): Scene

fun scene(width: Number, height: Number, block: SceneDSL.() -> Unit? = null): Scene

scene

fun Stage.scene(block: SceneDSL.() -> Unit? = null): Scene

fun Stage.scene(width: Number, height: Number, block: SceneDSL.() -> Unit? = null): Scene

scrollableBar

fun scrollableBar(block: ScrollableBar.() -> Unit? = null): ScrollableBar

fun scrollableBar(child: Node, block: ScrollableBar.() -> Unit? = null): ScrollableBar

scrollBar

fun scrollBar(block: ScrollBar.() -> Unit? = null): ScrollBar

fun scrollBar(orientation: Orientation, block: ScrollBar.() -> Unit): ScrollBar

scrollPane

fun scrollPane(block: ScrollPane.() -> Unit? = null): ScrollPane

fun scrollPane(child: Node, block: ScrollPane.() -> Unit? = null): ScrollPane

sheets

fun Icons.sheets(block: Sheets.() -> Unit)

singleContainer

fun singleContainer(block: SingleContainer.() -> Unit? = null): SingleContainer

fun singleContainer(contentProperty: ObservableOptionalNode, block: SingleContainer.() -> Unit? = null): SingleContainer

fun singleContainer(content: Node, block: SingleContainer.() -> Unit? = null): SingleContainer

slider

fun slider(initialValue: Double, block: DoubleSlider.() -> Unit? = null): DoubleSlider

fun slider(initialValue: Float, block: FloatSlider.() -> Unit? = null): FloatSlider

slider2d

fun slider2d(block: Slider2d.() -> Unit? = null): Slider2d

spacer

fun spacer(priority: Number = 0.001f): Pane

The default priority is small, but larger than 0, so that other controls will fill the space in preference to the spacer. The spacer will only take significant space if there are no other control with a non-zero growPriority, or they reach their max size.

spacing

fun BoxBase.spacing(size: Number)

Sets BoxBase.spacing.

spinner

fun spinner(initialValue: Double, block: DoubleSpinner.() -> Unit? = null): DoubleSpinner

fun spinner(initialValue: Float, block: FloatSpinner.() -> Unit? = null): FloatSpinner

fun spinner(initialValue: Int, block: IntSpinner.() -> Unit? = null): IntSpinner

splitMenuButton

fun splitMenuButton(text: String, block: SplitMenuButton.() -> Unit? = null): SplitMenuButton

fun splitMenuButton(text: String, graphic: Node?, block: SplitMenuButton.() -> Unit? = null): SplitMenuButton

splitPane

fun splitPane(block: SplitPane.() -> Unit? = null): SplitPane

fun splitPane(orientation: Orientation, block: SplitPane.() -> Unit? = null): SplitPane

stackPane

fun stackPane(block: StackPane.() -> Unit? = null): StackPane

style

fun Node.style(name: String)

Adds a style to Node.styles

styledTextArea

fun styledTextArea(block: StyledTextArea.() -> Unit? = null): StyledTextArea

fun styledTextArea(text: String, block: StyledTextArea.() -> Unit? = null): StyledTextArea

fun styledTextArea(stringProperty: StringProperty, block: StyledTextArea.() -> Unit? = null): StyledTextArea

fun styledTextArea(textDocument: StyledTextDocument, block: StyledTextArea.() -> Unit? = null): StyledTextArea

styleIf

fun Node.styleIf(test: Boolean, style: String)

Adds or removes the style depending on test. See Node.styles

subMenu

fun subMenu(text: String, block: SubMenu.() -> Unit? = null): SubMenu

fun subMenu(text: String, graphic: Node?, block: SubMenu.() -> Unit? = null): SubMenu

tab

fun tab(text: String, block: Tab.() -> Unit? = null): Tab

fun tab(text: String, graphic: Node?, block: Tab.() -> Unit? = null): Tab

tabBar

fun tabBar(block: TabBar.() -> Unit? = null): TabBar

tabPane

fun tabPane(side: Side = Side.TOP, block: TabPane.() -> Unit? = null): TabPane

text

fun text(text: String, block: Text.() -> Unit? = null): Text

textArea

fun textArea(block: TextArea.() -> Unit? = null): TextArea

fun textArea(text: String, block: TextArea.() -> Unit? = null): TextArea

fun textArea(stringProperty: StringProperty, block: TextArea.() -> Unit? = null): TextArea

fun textArea(textDocument: TextDocument, block: TextArea.() -> Unit? = null): TextArea

textField

fun textField(block: TextField.() -> Unit? = null): TextField

fun textField(text: String, block: TextField.() -> Unit? = null): TextField

texture

fun Icons.texture(textureName: String, size: Int, block: IconSheet.() -> Unit)

threeRow

fun threeRow(block: ThreeRow.() -> Unit): ThreeRow

titledPane

fun titledPane(text: String, block: TitledPane.() -> Unit? = null): TitledPane

toggleButton

fun toggleButton(text: String, graphic: Node? = null, toggleGroup: ToggleGroup? = null, block: ToggleButton.() -> Unit? = null): ToggleButton

toggleChoices

fun <V, P : Property<V?>> toggleChoices(property: P, block: PropertyToggleChoicesDSL<V, P>.() -> Unit? = null): PropertyToggleChoicesDSL<V, P>

toggleGroup

fun toggleGroup(block: ToggleGroupDSL.() -> Unit? = null): ToggleGroupDSL

toggleMenuItem

fun toggleMenuItem(text: String, block: ToggleMenuItem.() -> Unit? = null): ToggleMenuItem

toolBar

fun toolBar(block: ToolBar.() -> Unit? = null): ToolBar

fun toolBar(side: Side, block: ToolBar.() -> Unit? = null): ToolBar

treeView

fun <T> treeView(block: TreeView<T>.() -> Unit? = null): TreeView<T>

vBox

fun vBox(block: VBox.() -> Unit? = null): VBox

width

fun Node.width(width: Number)

Sets Node.overridePrefWidth