glok-core/uk.co.nickthecoder.glok.action/Commands

Commands

open class Commands(val icons: NamedImages?)

A group of many Commands.

Some applications have a single instance of Commands, but more complex application may have many (one for each part of the application).

For shortcuts to work, you must attachTo a node. The shortcuts will only work when the input focus is one of that node's descendants (or itself). Therefore, Scene.root is often a good choice to attach to.

NOTE, button, toggleButton etc. all create Buttons with text as well as a graphic. However, if the Button is placed within a ToolBar, Glok's default theme sets ContentDisplay.GRAPHIC_ONLY, which means that the text will NOT be displayed (assuming the icon exists). If you place the button elsewhere, then the text (and graphic) will be displayed.

(If the graphic is not found, then the button's text is displayed, despite ContentDisplay.GRAPHIC_ONLY).

IMHO, these are the correct defaults, which differ from JavaFX's defaults.

If you prefer JavaFX's defaults, either extend (or replace) Glok's default theme, or set ContentDisplay.LEFT on each toolbar button.

Constructors

constructor(icons: NamedImages?)

Properties

val icons: NamedImages?

var iconSize: Int

iconSizeProperty

var iconSizeProperty: IntProperty

NOTE, This is a var, which is very unusual! The idea is to let different parts of the GUI use different icon sizes, and yet let them still be adjusted via properties.

Functions

fun action(action: Action, lambda: (ActionEvent) -> Unit): Command

fun attachTo(node: Node)

Adds an onKeyPressed event handler to node, which checks the KeyEvent against each action's Action.keyCombination and Action.additionalKeyCombinations.

fun button(action: Action): Button

fun button(action: Action, block: Button.() -> Unit): Button

fun checkMenuItem(action: Action): ToggleMenuItem

fun checkMenuItem(action: Action, block: ToggleMenuItem.() -> Unit): ToggleMenuItem

fun <V, P : Property<V>> PropertyRadioChoicesDSL<V, P>.choice(action: Action, value: V): PropertyRadioCommand<V, P>

fun <V, P : Property<V?>> PropertyToggleChoicesDSL<V, P>.choice(action: Action, value: V): PropertyToggleCommand<V, P>

fun detachFrom(node: Node)

Removes the key handler added by attachTo.

fun findCommand(action: Action): Command?

fun fire(action: Action)

Looks for the command matching action, checks that it isn't disabled, and then calls the Command.lambda.

operator fun Action.invoke(lambda: (ActionEvent) -> Unit): Command

operator fun Action.invoke(consume: Boolean, lambda: (ActionEvent) -> Unit): Command

Syntactic sugar, which adds an action.

fun menu(action: Action): Menu

fun menu(action: Action, block: Menu.() -> Unit): Menu

fun menuButton(action: Action): MenuButton

fun menuButton(action: Action, block: MenuButton.() -> Unit): MenuButton

fun menuItem(action: Action): MenuItem

fun menuItem(action: Action, block: MenuItem.() -> Unit): MenuItem

propertyRadioButton

fun propertyRadioButton(action: Action): PropertyRadioButton<*, *>

fun propertyRadioButton(action: Action, block: PropertyRadioButton<*, *>.() -> Unit): PropertyRadioButton<*, *>

propertyRadioMenuItem

fun propertyRadioMenuItem(action: Action): PropertyRadioMenuItem<*, *>

fun propertyRadioMenuItem(action: Action, block: PropertyRadioMenuItem<*, *>.() -> Unit): PropertyRadioMenuItem<*, *>

propertyToggleButton

fun propertyToggleButton(action: Action): PropertyToggleButton<*, *>

fun propertyToggleButton(action: Action, block: PropertyToggleButton<*, *>.() -> Unit): PropertyToggleButton<*, *>

propertyToggleMenuItem

fun propertyToggleMenuItem(action: Action): PropertyToggleMenuItem<*, *>

fun propertyToggleMenuItem(action: Action, block: PropertyToggleMenuItem<*, *>.() -> Unit): PropertyToggleMenuItem<*, *>

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

fun removeAction(action: Action)

splitMenuButton

fun splitMenuButton(action: Action): SplitMenuButton

fun splitMenuButton(action: Action, block: SplitMenuButton.() -> Unit): SplitMenuButton

fun subMenu(action: Action): SubMenu

fun subMenu(action: Action, block: SubMenu.() -> Unit): SubMenu

fun toggle(action: Action, selected: BooleanProperty): ToggleCommand

fun toggle(action: Action, selected: BooleanProperty, lambda: (ActionEvent) -> Unit): ToggleCommand

fun toggleButton(action: Action): ToggleButton

fun toggleButton(action: Action, block: ToggleButton.() -> Unit): ToggleButton

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