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

ToggleButton

class ToggleButton( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_TOGGLE_BUTTON_WIDTH, height: Number = DEFAULT_TOGGLE_BUTTON_HEIGHT, text: String = "", font: Font = Font(), alignment: Alignment = Alignment.CENTER_LEFT, isWrapText: Boolean = false, isSelected: Boolean = false, toggleGroup: ToggleGroup = ToggleGroup(), visual: Visual = Visual.EMPTY) : BinaryStateButton

A ToggleButton may be used as a Button that is either selected or not selected. An important feature of ToggleButtons is the ToggleGroup.

ToggleGroups can be used to group ToggleButtons.

All ToggleButtons that keep the same instance of a ToggleGroup belong to that ToggleGroup. Only one ToggleButton may be selected in a ToggleGroup. This means whenever a ToggleButton changes its selected state to true, all other ToggleButtons in the same ToggleGroup get deselected.

An exception to this rule is, whenever a new ToggleButton that is currently selected gets added to the ToggleGroup.

Parameters

posX

Horizontal coordinate for this ToggleButton. Default: 0.

posY

Vertical coordinate for this ToggleButton. Default: 0.

width

Width for this ToggleButton. Default: DEFAULT_TOGGLE_BUTTON_WIDTH.

height

Height for this ToggleButton. Default: DEFAULT_TOGGLE_BUTTON_HEIGHT.

text

Text to be displayed for this ToggleButton.

font

Font to be used for this ToggleButton. Default: default Font constructor.

alignment

Alignment to be used for this ToggleButton.

isWrapText

Defines if text should be wrapped, if it exceeds the label's width. Default: false.

isSelected

The initial state for this ToggleButton. Default: false.

toggleGroup

The ToggleGroup of this ToggleButton. Default: empty group.

visual

Background Visual. Default: Visual.EMPTY.

Constructors

ToggleButton

fun ToggleButton( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_TOGGLE_BUTTON_WIDTH, height: Number = DEFAULT_TOGGLE_BUTTON_HEIGHT, text: String = "", font: Font = Font(), alignment: Alignment = Alignment.CENTER_LEFT, isWrapText: Boolean = false, isSelected: Boolean = false, toggleGroup: ToggleGroup = ToggleGroup(), visual: Visual = Visual.EMPTY)

Creates a ToggleButton.

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.

alignment

var alignment: Alignment

Alignment of this LabeledUIComponent.

alignmentProperty

val alignmentProperty: Property<Alignment>

Property for the Alignment of this LabeledUIComponent.

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.

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.

isSelected

var isSelected: Boolean

Selected state for this ToggleButton.

isVisible

var isVisible: Boolean

Visibility of this ComponentView.

isVisibleProperty

val isVisibleProperty: BooleanProperty

Property for the visibility of this ComponentView.

isWrapText

var isWrapText: Boolean

Defines if text should be wrapped, if it exceeds the Label's width.

isWrapTextProperty

val isWrapTextProperty: BooleanProperty

Property for the isWrapText state of this Label.

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.

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.