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.

See also

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

Link copied to clipboard
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

Link copied to clipboard
fun offset(offsetX: Number, offsetY: Number)

Adds an offset to this ComponentView's Position.

Link copied to clipboard
fun removeFromParent(): ComponentView

Removes this component from its parent.

Link copied to clipboard
fun reposition(posX: Number, posY: Number)

Repositions this ComponentView to the specified coordinates.

Link copied to clipboard
fun resize(width: Number, height: Number)

Resizes this ComponentView to the specified width and height.

Link copied to clipboard
fun rotate(degrees: Number)

Rotates this ComponentView by the given number of degrees.

Link copied to clipboard
fun scale(scalar: Number)

Scales this ComponentView by the given scalar.

Link copied to clipboard
fun scaleX(scalar: Number)

Scales this ComponentView's width by the given scalar.

Link copied to clipboard
fun scaleY(scalar: Number)

Scales this ComponentView's height by the given scalar.

Link copied to clipboard
fun toBack()

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

Link copied to clipboard
fun toFront()

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

Properties

Link copied to clipboard
var actualHeight: Double

The actual height for this ComponentView considering scale.

Link copied to clipboard
var actualPosX: Double

Horizontal position of this ComponentView considering scale.

Link copied to clipboard
var actualPosY: Double

Vertical position of this ComponentView considering scale.

Link copied to clipboard
var actualWidth: Double

The actual width for this ComponentView considering scale.

Link copied to clipboard
var alignment: Alignment
Link copied to clipboard
val alignmentProperty: Property<Alignment>
Link copied to clipboard
var backgroundStyle: String

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

Link copied to clipboard
val backgroundStyleProperty: StringProperty

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

Link copied to clipboard
var componentStyle: String

Css style that gets applied to this UIComponent.

Link copied to clipboard
val componentStyleProperty: StringProperty

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

Link copied to clipboard
var dropAcceptor: (DragEvent) -> Boolean?

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

Link copied to clipboard
var font: Font

Font of this UIComponent. Usage depends on subclass.

Link copied to clipboard
val fontProperty: Property<Font>

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

Link copied to clipboard
var height: Double

The height for this ComponentView.

Link copied to clipboard
val heightProperty: DoubleProperty

Property for the height of this ComponentView.

Link copied to clipboard
var isDisabled: Boolean

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

Link copied to clipboard
val isDisabledProperty: BooleanProperty

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

Link copied to clipboard
var isFocusable: Boolean

Controls whether this ComponentView is focusable or not.

Link copied to clipboard
val isFocusableProperty: BooleanProperty

Property that controls whether this ComponentView is focusable or not.

Link copied to clipboard
var isSelected: Boolean

Selected state for this ToggleButton.

Link copied to clipboard
var isVisible: Boolean

Visibility of this ComponentView.

Link copied to clipboard
val isVisibleProperty: BooleanProperty

Property for the visibility of this ComponentView.

Link copied to clipboard
var isWrapText: Boolean

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

Link copied to clipboard
val isWrapTextProperty: BooleanProperty

Property for the isWrapText state of this Label.

Link copied to clipboard
var layoutBounds: CoordinatePlain

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

Link copied to clipboard
var name: String

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

Link copied to clipboard
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.

Link copied to clipboard
var onDragGestureEntered: (DragEvent) -> Unit?

Gets invoked with a DragEvent whenever the mouse enters this ComponentView while performing a drag gesture.

Link copied to clipboard
var onDragGestureExited: (DragEvent) -> Unit?

Gets invoked with a DragEvent whenever the mouse leaves this ComponentView while performing a drag gesture.

Link copied to clipboard
var onKeyPressed: (KeyEvent) -> Unit?

Gets invoked with a KeyEvent whenever a key is pressed while this ComponentView has focus.

Link copied to clipboard
var onKeyReleased: (KeyEvent) -> Unit?

Gets invoked with a KeyEvent whenever a key is released while this ComponentView has focus.

Link copied to clipboard
var onKeyTyped: (KeyEvent) -> Unit?

Gets invoked with a KeyEvent whenever a Character is typed while this ComponentView has focus. Gets invoked after onKeyPressed.

Link copied to clipboard
var onMouseClicked: (MouseEvent) -> Unit?

Gets invoked with a MouseEvent whenever the mouse is clicked inside this ComponentView. Gets invoked after onMousePressed and onMouseReleased.

Link copied to clipboard
var onMouseEntered: (MouseEvent) -> Unit?

Gets invoked with a MouseEvent whenever the mouse enters this ComponentView.

Link copied to clipboard
var onMouseExited: (MouseEvent) -> Unit?

Gets invoked with a MouseEvent whenever the mouse leaves this ComponentView.

Link copied to clipboard
var onMousePressed: (MouseEvent) -> Unit?

Gets invoked with a MouseEvent whenever the mouse is pressed inside this ComponentView.

Link copied to clipboard
var onMouseReleased: (MouseEvent) -> Unit?

Gets invoked with a MouseEvent whenever the mouse is released inside this ComponentView.

Link copied to clipboard
var onScroll: (ScrollEvent) -> Unit?

Gets invoked with a ScrollEvent whenever the mouse wheel is turned while the mouse is inside this ComponentView.

Link copied to clipboard
var opacity: Double

Opacity of this ComponentView.

Link copied to clipboard
val opacityProperty: LimitedDoubleProperty

Property for the opacity of this ComponentView.

Link copied to clipboard
var parent: ComponentView?

The parent of this ComponentView.

Link copied to clipboard
var posX: Double

Horizontal position of this ComponentView.

Link copied to clipboard
val posXProperty: DoubleProperty

Property for the horizontal position of this ComponentView.

Link copied to clipboard
var posY: Double

Vertical position of this ComponentView.

Link copied to clipboard
val posYProperty: DoubleProperty

Property for the vertical position of this ComponentView.

Link copied to clipboard
var rotation: Double

Rotation of this ComponentView in degrees.

Link copied to clipboard
val rotationProperty: DoubleProperty

Property for the rotation of this ComponentView in degrees.

Link copied to clipboard
var scale: Double

Scale of this ComponentView.

Link copied to clipboard
var scaleX: Double

Horizontal scale of this ComponentView.

Link copied to clipboard
val scaleXProperty: DoubleProperty

Property for the horizontal scale of this ComponentView.

Link copied to clipboard
var scaleY: Double

Vertical scale of this ComponentView.

Link copied to clipboard
val scaleYProperty: DoubleProperty

Property for the vertical scale of this ComponentView.

Link copied to clipboard
val selectedProperty: BooleanProperty

Property for the selected state of this ToggleButton.

Link copied to clipboard
var text: String

Label of this LabeledUIComponent.

Link copied to clipboard
val textProperty: StringProperty

Property for the label of this LabeledUIComponent.

Link copied to clipboard
var toggleGroup: ToggleGroup

The ToggleGroup of this ToggleButton.

Link copied to clipboard
open var visual: Visual

Current Visual.

Link copied to clipboard
var width: Double

The width for this ComponentView.

Link copied to clipboard
val widthProperty: DoubleProperty

Property for the width of this ComponentView.

Link copied to clipboard
var zIndex: Int

for the order of ComponentView inside of parent.#

Link copied to clipboard
val zIndexProperty: IntegerProperty

Property for the order of ComponentView inside of parent.#