bgw-gui/tools.aqua.bgw.components.uicomponents/ComboBox

ComboBox

open class ComboBox<T>( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_COMBOBOX_WIDTH, height: Number = DEFAULT_COMBOBOX_HEIGHT, font: Font = Font(), val prompt: String = "", items: List<T> = emptyList(), formatFunction: (T) -> String? = null) : UIComponent

A standard ComboBox that may be populated with items of specified type parameter.

The formatFunction is used to gain a String representation of each item. If no formatFunction is specified the toString function gets used instead.

Whenever the user selects an item, the selectedItemProperty gets updated.

Parameters

Generic ComboBox content.

posX

Horizontal coordinate for this ComboBox. Default: 0.

posY

Vertical coordinate for this ComboBox. Default: 0.

width

Width for this ComboBox. Default: DEFAULT_COMBOBOX_WIDTH.

height

Height for this ComboBox. Default: DEFAULT_COMBOBOX_HEIGHT.

font

Font to be used for the options. Default: default Font constructor.

items

The initial selection of items. Default: empty list.

formatFunction

The formatFunction that is used to represent the items. Default: null.

Constructors

ComboBox

fun <T> ComboBox( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_COMBOBOX_WIDTH, height: Number = DEFAULT_COMBOBOX_HEIGHT, font: Font = Font(), prompt: String = "", items: List<T> = emptyList(), formatFunction: (T) -> String? = null)

Creates a ComboBox.

Functions

offset

fun offset(offsetX: Number, offsetY: Number)

Adds an offset to this ComponentView's Position.

removeFromParent

fun removeFromParent(): ComponentView

Removes this component from its parent.

reposition

fun reposition(posX: Number, posY: Number)

Repositions this ComponentView to the specified coordinates.

resize

fun resize(width: Number, height: Number)

Resizes this ComponentView to the specified width and height.

rotate

fun rotate(degrees: Number)

Rotates this ComponentView by the given number of degrees.

scale

fun scale(scalar: Number)

Scales this ComponentView by the given scalar.

scaleX

fun scaleX(scalar: Number)

Scales this ComponentView's width by the given scalar.

scaleY

fun scaleY(scalar: Number)

Scales this ComponentView's height by the given scalar.

toBack

fun toBack()

Puts the ComponentView to the back inside its parent and Changes its zIndex accordingly.

toFront

fun toFront()

Puts the ComponentView to the front inside its parent and Changes its zIndex accordingly.

Properties

actualHeight

var actualHeight: Double

The actual height for this ComponentView considering scale.

actualPosX

var actualPosX: Double

Horizontal position of this ComponentView considering scale.

actualPosY

var actualPosY: Double

Vertical position of this ComponentView considering scale.

actualWidth

var actualWidth: Double

The actual width for this ComponentView considering scale.

backgroundStyle

var backgroundStyle: String

Css style that gets applied to this UIComponent's background.

backgroundStyleProperty

val backgroundStyleProperty: StringProperty

Property for the css style that gets applied to this UIComponent's background.

componentStyle

var componentStyle: String

Css style that gets applied to this UIComponent.

componentStyleProperty

val componentStyleProperty: StringProperty

Property for the css style that gets applied to this UIComponent.

dropAcceptor

var dropAcceptor: (DragEvent) -> Boolean?

Returns whether this ComponentView is a valid drop target for the dragged component in the given DragEvent or not.

font

var font: Font

Font of this UIComponent. Usage depends on subclass.

fontProperty

val fontProperty: Property<Font>

Property for the Font of this UIComponent. Usage depends on subclass.

formatFunction

var formatFunction: (T) -> String?

The formatFunction that gets used to obtain a String representation for each item.

formatFunctionProperty

var formatFunctionProperty: Property<(T) -> String?>

Property for the formatFunction that gets used to obtain a String representation for each item.

height

var height: Double

The height for this ComponentView.

heightProperty

val heightProperty: DoubleProperty

Property for the height of this ComponentView.

isDisabled

var isDisabled: Boolean

Controls if user input events cause input functions of this ComponentView to get invoked.

isDisabledProperty

val isDisabledProperty: BooleanProperty

Property that controls if user input events cause input functions of this ComponentView to get invoked.

isFocusable

var isFocusable: Boolean

Controls whether this ComponentView is focusable or not.

isFocusableProperty

val isFocusableProperty: BooleanProperty

Property that controls whether this ComponentView is focusable or not.

isVisible

var isVisible: Boolean

Visibility of this ComponentView.

isVisibleProperty

val isVisibleProperty: BooleanProperty

Property for the visibility of this ComponentView.

items

var items: List<T>

Items List for this ComboBox.

layoutBounds

var layoutBounds: CoordinatePlain

Returns a CoordinatePlain containing the component's corner Coordinates and its layout bounds.

name

var name: String

Name field only for debugging purposes. Has no effect on rendering.

observableItemsList

val observableItemsList: ObservableList<T>

Property for the items for this ComboBox.

onDragDropped

var onDragDropped: (DragEvent) -> Unit?

Gets invoked with a DragEvent whenever a drag and drop gesture finishes over this ComponentView and the dropAcceptor returns true for the given DragEvent.