glok-core/uk.co.nickthecoder.glok.control/MenuButton

MenuButton

class MenuButton(text: String, graphic: Node? = null) : ButtonBase, WithItems

A button, which displays items in a PopupMenu when clicked. On the right hand side there is an arrow (though it could be styled differently), to differentiate it from a regular Button.

NOTE, this is very similar to Menu, but Menus only live within MenuBars, and do not look like a Button, and have no arrow.

Theme DSL

"menu_button" {
    child( ".arrow" ) { // An ImageView

        image( image : Image )
        image( images : NamedImages, imageName : String )

        tint( tint : Color )
    }
}

MenuButton inherits all the features of ButtonBase.

Constructors

MenuButton

constructor(text: String, graphic: Node? = null)

Properties

items

open override val items: MutableObservableList<Node>

onShowing

var onShowing: ActionEventHandler?

onShowingProperty

val onShowingProperty: OptionalActionEventHandlerProperty

An event handler which is performed after the button is clicked, but before the popup menu is built.

showing

var showing: Boolean

showingProperty

val showingProperty: ReadOnlyBooleanProperty

Set to true, after the button is clicked, and before the PopupMenu is displayed. It is reset to false when the PopupMenu is closed.

Functions

nodePrefHeight

open override fun nodePrefHeight(): Float

Each subclass of node can determine its preferred height. As most nodes are composed of smaller nodes, this is typically calculated using evalPrefWidth of the child nodes, with extra added for spacing, padding and borders.

nodePrefWidth

open override fun nodePrefWidth(): Float

Each subclass of node can determine its preferred width. As most nodes are composed of smaller nodes, this is typically calculated using evalPrefWidth of the child nodes, with extra added for spacing, padding and borders.

onShowing

fun onShowing(handlerCombination: HandlerCombination = HandlerCombination.AFTER, block: (event: ActionEvent) -> Unit)

Add an event handler which is performed after the button is clicked, but before the popup menu is built.