
public class Button
extends LabeledUIComponent

A simple Button with a label.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Button.Companion`	Defines some static constants that can be used as suggested properties of a Button.

Field Summary

Fields
Modifier and Type	Field	Description
`private final StringProperty`	`labelProperty`
`private String`	`label`
`private final Property<Font>`	`fontProperty`
`private Font`	`font`
`private final StringProperty`	`backgroundStyleProperty`
`private String`	`backgroundStyle`
`private final StringProperty`	`componentStyleProperty`
`private String`	`componentStyle`
`private ComponentView`	`parent`
`private String`	`name`
`private final DoubleProperty`	`heightProperty`
`private Double`	`height`
`private final DoubleProperty`	`widthProperty`
`private Double`	`width`
`private final DoubleProperty`	`posXProperty`
`private Double`	`posX`
`private final DoubleProperty`	`posYProperty`
`private Double`	`posY`
`private final DoubleProperty`	`scaleXProperty`
`private Double`	`scaleX`
`private final DoubleProperty`	`scaleYProperty`
`private Double`	`scaleY`
`private Double`	`scale`
`private final DoubleProperty`	`rotationProperty`
`private Double`	`rotation`
`private Visual`	`visual`
`private final DoubleProperty`	`opacityProperty`
`private Double`	`opacity`
`private final BooleanProperty`	`isVisibleProperty`
`private Boolean`	`isVisible`
`private final BooleanProperty`	`isDisabledProperty`
`private Boolean`	`isDisabled`
`private final BooleanProperty`	`isFocusableProperty`
`private Boolean`	`isFocusable`
`private Function1<MouseEvent, Unit>`	`onMouseEntered`
`private Function1<MouseEvent, Unit>`	`onMouseExited`
`private Function1<MouseEvent, Unit>`	`onMousePressed`
`private Function1<MouseEvent, Unit>`	`onMouseReleased`
`private Function1<MouseEvent, Unit>`	`onMouseClicked`
`private Function1<KeyEvent, Unit>`	`onKeyPressed`
`private Function1<KeyEvent, Unit>`	`onKeyReleased`
`private Function1<KeyEvent, Unit>`	`onKeyTyped`
`private Function1<DragEvent, Boolean>`	`dropAcceptor`
`private Function1<DragEvent, Unit>`	`onDragGestureEntered`
`private Function1<DragEvent, Unit>`	`onDragGestureExited`
`private Function1<DragEvent, Unit>`	`onDragDropped`

Constructor Summary

Constructors
Constructor	Description
`Button(Number height, Number width, Number posX, Number posY, String label, Font font)`

Method Summary

Modifier and Type	Method	Description
`final StringProperty`	`getLabelProperty()`	Property for the label of this LabeledUIComponent.
`final String`	`getLabel()`
`final Unit`	`setLabel(String label)`
`final Property<Font>`	`getFontProperty()`	Property for the Font of this LabeledUIComponent.
`final Font`	`getFont()`
`final Unit`	`setFont(Font font)`
`final StringProperty`	`getBackgroundStyleProperty()`	Property for the css style that gets applied to this UIComponent's background.
`final String`	`getBackgroundStyle()`
`final Unit`	`setBackgroundStyle(String backgroundStyle)`
`final StringProperty`	`getComponentStyleProperty()`	Property for the css style that gets applied to this UIComponent.
`final String`	`getComponentStyle()`
`final Unit`	`setComponentStyle(String componentStyle)`
`final ComponentView`	`getParent()`	The parent of this ComponentView.
`final Unit`	`setParent(ComponentView parent)`
`final String`	`getName()`	Name field only for debugging purposes.
`final Unit`	`setName(String name)`	Name field only for debugging purposes.
`final DoubleProperty`	`getHeightProperty()`	Property for the height of this ComponentView.
`final Double`	`getHeight()`
`final Unit`	`setHeight(Double height)`
`final DoubleProperty`	`getWidthProperty()`	Property for the width of this ComponentView.
`final Double`	`getWidth()`
`final Unit`	`setWidth(Double width)`
`final DoubleProperty`	`getPosXProperty()`	Property for the horizontal position of this ComponentView.
`final Double`	`getPosX()`
`final Unit`	`setPosX(Double posX)`
`final DoubleProperty`	`getPosYProperty()`	Property for the vertical position of this ComponentView.
`final Double`	`getPosY()`
`final Unit`	`setPosY(Double posY)`
`final DoubleProperty`	`getScaleXProperty()`	Property for the horizontal scale of this ComponentView.
`final Double`	`getScaleX()`
`final Unit`	`setScaleX(Double scaleX)`
`final DoubleProperty`	`getScaleYProperty()`	Property for the vertical scale of this ComponentView.
`final Double`	`getScaleY()`
`final Unit`	`setScaleY(Double scaleY)`
`final Double`	`getScale()`
`final Unit`	`setScale(Double scale)`
`final DoubleProperty`	`getRotationProperty()`	Property for the rotation of this ComponentView in degrees.
`final Double`	`getRotation()`
`final Unit`	`setRotation(Double rotation)`
`final Visual`	`getVisual()`
`final Unit`	`setVisual(Visual visual)`	Sets a copy of the given Visual to this field and refreshes GUI.
`final DoubleProperty`	`getOpacityProperty()`	Property for the opacity of this ComponentView.
`final Double`	`getOpacity()`
`final Unit`	`setOpacity(Double opacity)`
`final BooleanProperty`	`getIsVisibleProperty()`	Property for the visibility of this ComponentView.
`final Boolean`	`getIsVisible()`
`final Unit`	`setIsVisible(Boolean isVisible)`
`final BooleanProperty`	`getIsDisabledProperty()`	Property that controls if user input events cause input functions of this ComponentView to get invoked.
`final Boolean`	`getIsDisabled()`
`final Unit`	`setIsDisabled(Boolean isDisabled)`
`final BooleanProperty`	`getIsFocusableProperty()`	Property that controls whether this ComponentView is focusable or not.
`final Boolean`	`getIsFocusable()`
`final Unit`	`setIsFocusable(Boolean isFocusable)`
`final Function1<MouseEvent, Unit>`	`getOnMouseEntered()`	Gets invoked with an event whenever the mouse enters this ComponentView.
`final Unit`	`setOnMouseEntered(Function1<MouseEvent, Unit> onMouseEntered)`	Gets invoked with an event whenever the mouse enters this ComponentView.
`final Function1<MouseEvent, Unit>`	`getOnMouseExited()`	Gets invoked with an event whenever the mouse leaves this ComponentView.
`final Unit`	`setOnMouseExited(Function1<MouseEvent, Unit> onMouseExited)`	Gets invoked with an event whenever the mouse leaves this ComponentView.
`final Function1<MouseEvent, Unit>`	`getOnMousePressed()`	Gets invoked with a MouseEvent whenever the mouse is pressed inside this ComponentView.
`final Unit`	`setOnMousePressed(Function1<MouseEvent, Unit> onMousePressed)`	Gets invoked with a MouseEvent whenever the mouse is pressed inside this ComponentView.
`final Function1<MouseEvent, Unit>`	`getOnMouseReleased()`	Gets invoked with a MouseEvent whenever the mouse is released inside this ComponentView.
`final Unit`	`setOnMouseReleased(Function1<MouseEvent, Unit> onMouseReleased)`	Gets invoked with a MouseEvent whenever the mouse is released inside this ComponentView.
`final Function1<MouseEvent, Unit>`	`getOnMouseClicked()`	Gets invoked with a MouseEvent whenever the mouse is clicked inside this ComponentView.
`final Unit`	`setOnMouseClicked(Function1<MouseEvent, Unit> onMouseClicked)`	Gets invoked with a MouseEvent whenever the mouse is clicked inside this ComponentView.
`final Function1<KeyEvent, Unit>`	`getOnKeyPressed()`	Gets invoked with a KeyEvent whenever a key is pressed while this ComponentView has focus.
`final Unit`	`setOnKeyPressed(Function1<KeyEvent, Unit> onKeyPressed)`	Gets invoked with a KeyEvent whenever a key is pressed while this ComponentView has focus.
`final Function1<KeyEvent, Unit>`	`getOnKeyReleased()`	Gets invoked with a KeyEvent whenever a key is released while this ComponentView has focus.
`final Unit`	`setOnKeyReleased(Function1<KeyEvent, Unit> onKeyReleased)`	Gets invoked with a KeyEvent whenever a key is released while this ComponentView has focus.
`final Function1<KeyEvent, Unit>`	`getOnKeyTyped()`	Gets invoked with a KeyEvent whenever a key is typed while this ComponentView has focus.
`final Unit`	`setOnKeyTyped(Function1<KeyEvent, Unit> onKeyTyped)`	Gets invoked with a KeyEvent whenever a key is typed while this ComponentView has focus.
`final Function1<DragEvent, Boolean>`	`getDropAcceptor()`	Returns whether this ComponentView is a valid drop target for the dragged component in the given DragEvent or not.
`final Unit`	`setDropAcceptor(Function1<DragEvent, Boolean> dropAcceptor)`	Returns whether this ComponentView is a valid drop target for the dragged component in the given DragEvent or not.
`final Function1<DragEvent, Unit>`	`getOnDragGestureEntered()`	Gets invoked with a DragEvent whenever the mouse enters this ComponentView while performing a drag gesture.
`final Unit`	`setOnDragGestureEntered(Function1<DragEvent, Unit> onDragGestureEntered)`	Gets invoked with a DragEvent whenever the mouse enters this ComponentView while performing a drag gesture.
`final Function1<DragEvent, Unit>`	`getOnDragGestureExited()`	Gets invoked with a DragEvent whenever the mouse leaves this ComponentView while performing a drag gesture.
`final Unit`	`setOnDragGestureExited(Function1<DragEvent, Unit> onDragGestureExited)`	Gets invoked with a DragEvent whenever the mouse leaves this ComponentView while performing a drag gesture.
`final Function1<DragEvent, Unit>`	`getOnDragDropped()`	Gets invoked with a DragEvent whenever a drag and drop gesture finishes over this ComponentView and the dropAcceptor returns `true` for the given DragEvent.
`final Unit`	`setOnDragDropped(Function1<DragEvent, Unit> onDragDropped)`	Gets invoked with a DragEvent whenever a drag and drop gesture finishes over this ComponentView and the dropAcceptor returns `true` for the given DragEvent.

Methods inherited from class tools.aqua.bgw.components.StaticComponentView
removeFromParent
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Button
```
Button(Number height, Number width, Number posX, Number posY, String label, Font font)
```
    Parameters:
    
    height - height for this Button.
    
    width - width for this Button.
    
    posX - horizontal coordinate for this Button.
    
    posY - vertical coordinate for this Button.
    
    label - label for this Button.
    
    font - font to be used for the label.
- Method Detail
  - getLabelProperty
```
 final StringProperty getLabelProperty()
```
    Property for the label of this LabeledUIComponent.
  - getLabel
```
 final String getLabel()
```
  - setLabel
```
 final Unit setLabel(String label)
```
  - getFontProperty
```
 final Property<Font> getFontProperty()
```
    Property for the Font of this LabeledUIComponent.
  - getFont
```
 final Font getFont()
```
  - setFont
```
 final Unit setFont(Font font)
```
  - getBackgroundStyleProperty
```
 final StringProperty getBackgroundStyleProperty()
```
    Property for the css style that gets applied to this UIComponent's background. This gets applied last, so it may override any changes made via other fields and functions of this UIComponent. Critical failures, bugs or other undefined behaviour could occur when using this feature.
  - getBackgroundStyle
```
 final String getBackgroundStyle()
```
  - setBackgroundStyle
```
 final Unit setBackgroundStyle(String backgroundStyle)
```
  - getComponentStyleProperty
```
 final StringProperty getComponentStyleProperty()
```
    Property for the css style that gets applied to this UIComponent. This gets applied last, so it may override any changes made via other fields and functions of this UIComponent. Critical failures, bugs or other undefined behaviour could occur when using this feature.
  - getComponentStyle
```
 final String getComponentStyle()
```
  - setComponentStyle
```
 final Unit setComponentStyle(String componentStyle)
```
  - getParent
```
 final ComponentView getParent()
```
    The parent of this ComponentView. null if this ComponentView is not contained in a GameComponentContainer, LayoutView, or a Scene. If the component has been added directly to a Scene, parent is equal to the scene's RootComponent. If the component is contained within a container, parent is equal to that container.
  - setParent
```
 final Unit setParent(ComponentView parent)
```
  - getName
```
 final String getName()
```
    Name field only for debugging purposes. Has no effect on rendering.
  - setName
```
 final Unit setName(String name)
```
    Name field only for debugging purposes. Has no effect on rendering.
  - getHeightProperty
```
 final DoubleProperty getHeightProperty()
```
    Property for the height of this ComponentView.
  - getHeight
```
 final Double getHeight()
```
  - setHeight
```
 final Unit setHeight(Double height)
```
  - getWidthProperty
```
 final DoubleProperty getWidthProperty()
```
    Property for the width of this ComponentView.
  - getWidth
```
 final Double getWidth()
```
  - setWidth
```
 final Unit setWidth(Double width)
```
  - getPosXProperty
```
 final DoubleProperty getPosXProperty()
```
    Property for the horizontal position of this ComponentView.
  - getPosX
```
 final Double getPosX()
```
  - setPosX
```
 final Unit setPosX(Double posX)
```
  - getPosYProperty
```
 final DoubleProperty getPosYProperty()
```
    Property for the vertical position of this ComponentView.
  - getPosY
```
 final Double getPosY()
```
  - setPosY
```
 final Unit setPosY(Double posY)
```
  - getScaleXProperty
```
 final DoubleProperty getScaleXProperty()
```
    Property for the horizontal scale of this ComponentView.
  - getScaleX
```
 final Double getScaleX()
```
  - setScaleX
```
 final Unit setScaleX(Double scaleX)
```
  - getScaleYProperty
```
 final DoubleProperty getScaleYProperty()
```
    Property for the vertical scale of this ComponentView.
  - getScaleY
```
 final Double getScaleY()
```
  - setScaleY
```
 final Unit setScaleY(Double scaleY)
```
  - getScale
```
 final Double getScale()
```
  - setScale
```
 final Unit setScale(Double scale)
```
  - getRotationProperty
```
 final DoubleProperty getRotationProperty()
```
    Property for the rotation of this ComponentView in degrees. Values not in [0,360) get mapped to values in [0,360) by modulo operation with 360.
    example conversions: -10 -> 350 -370 -> 350 370 -> 10 730 -> 10
  - getRotation
```
 final Double getRotation()
```
  - setRotation
```
 final Unit setRotation(Double rotation)
```
  - getVisual
```
 final Visual getVisual()
```
  - setVisual
```
 final Unit setVisual(Visual visual)
```
    Sets a copy of the given Visual to this field and refreshes GUI.
  - getOpacityProperty
```
 final DoubleProperty getOpacityProperty()
```
    Property for the opacity of this ComponentView. Should be in range 0.0 to 1.0. 0.0 corresponds to 0% opacity, where 1.0 corresponds to 100% opacity. Note that invisible objects (opacity == 0.0) still remain interactive.
  - getOpacity
```
 final Double getOpacity()
```
  - setOpacity
```
 final Unit setOpacity(Double opacity)
```
  - getIsVisibleProperty
```
 final BooleanProperty getIsVisibleProperty()
```
    Property for the visibility of this ComponentView. Invisible ComponentViews are disabled. An object marked as visible may still be opaque due to opacity
  - getIsVisible
```
 final Boolean getIsVisible()
```
  - setIsVisible
```
 final Unit setIsVisible(Boolean isVisible)
```
  - getIsDisabledProperty
```
 final BooleanProperty getIsDisabledProperty()
```
    Property that controls if user input events cause input functions of this ComponentView to get invoked. true means no invocation, where false means invocation.
    For a list of affected functions refer to the See Also section.
  - getIsDisabled
```
 final Boolean getIsDisabled()
```
  - setIsDisabled
```
 final Unit setIsDisabled(Boolean isDisabled)
```
  - getIsFocusableProperty
```
 final BooleanProperty getIsFocusableProperty()
```
    Property that controls whether this ComponentView is focusable or not.
  - getIsFocusable
```
 final Boolean getIsFocusable()
```
  - setIsFocusable
```
 final Unit setIsFocusable(Boolean isFocusable)
```
  - getOnMouseEntered
```
 final Function1<MouseEvent, Unit> getOnMouseEntered()
```
    Gets invoked with an event whenever the mouse enters this ComponentView.
  - setOnMouseEntered
```
 final Unit setOnMouseEntered(Function1<MouseEvent, Unit> onMouseEntered)
```
    Gets invoked with an event whenever the mouse enters this ComponentView.
  - getOnMouseExited
```
 final Function1<MouseEvent, Unit> getOnMouseExited()
```
    Gets invoked with an event whenever the mouse leaves this ComponentView.
  - setOnMouseExited
```
 final Unit setOnMouseExited(Function1<MouseEvent, Unit> onMouseExited)
```
    Gets invoked with an event whenever the mouse leaves this ComponentView.
  - getOnMousePressed
```
 final Function1<MouseEvent, Unit> getOnMousePressed()
```
    Gets invoked with a MouseEvent whenever the mouse is pressed inside this ComponentView.
  - setOnMousePressed
```
 final Unit setOnMousePressed(Function1<MouseEvent, Unit> onMousePressed)
```
    Gets invoked with a MouseEvent whenever the mouse is pressed inside this ComponentView.
  - getOnMouseReleased
```
 final Function1<MouseEvent, Unit> getOnMouseReleased()
```
    Gets invoked with a MouseEvent whenever the mouse is released inside this ComponentView.
  - setOnMouseReleased
```
 final Unit setOnMouseReleased(Function1<MouseEvent, Unit> onMouseReleased)
```
    Gets invoked with a MouseEvent whenever the mouse is released inside this ComponentView.
  - getOnMouseClicked
```
 final Function1<MouseEvent, Unit> getOnMouseClicked()
```
    Gets invoked with a MouseEvent whenever the mouse is clicked inside this ComponentView. Gets invoked after onMousePressed and onMouseReleased.
  - setOnMouseClicked
```
 final Unit setOnMouseClicked(Function1<MouseEvent, Unit> onMouseClicked)
```
    Gets invoked with a MouseEvent whenever the mouse is clicked inside this ComponentView. Gets invoked after onMousePressed and onMouseReleased.
  - getOnKeyPressed
```
 final Function1<KeyEvent, Unit> getOnKeyPressed()
```
    Gets invoked with a KeyEvent whenever a key is pressed while this ComponentView has focus.
  - setOnKeyPressed
```
 final Unit setOnKeyPressed(Function1<KeyEvent, Unit> onKeyPressed)
```
    Gets invoked with a KeyEvent whenever a key is pressed while this ComponentView has focus.
  - getOnKeyReleased
```
 final Function1<KeyEvent, Unit> getOnKeyReleased()
```
    Gets invoked with a KeyEvent whenever a key is released while this ComponentView has focus.
  - setOnKeyReleased
```
 final Unit setOnKeyReleased(Function1<KeyEvent, Unit> onKeyReleased)
```
    Gets invoked with a KeyEvent whenever a key is released while this ComponentView has focus.
  - getOnKeyTyped
```
 final Function1<KeyEvent, Unit> getOnKeyTyped()
```
    Gets invoked with a KeyEvent whenever a key is typed while this ComponentView has focus. Gets invoked after onKeyPressed
  - setOnKeyTyped
```
 final Unit setOnKeyTyped(Function1<KeyEvent, Unit> onKeyTyped)
```
    Gets invoked with a KeyEvent whenever a key is typed while this ComponentView has focus. Gets invoked after onKeyPressed
  - getDropAcceptor
```
 final Function1<DragEvent, Boolean> getDropAcceptor()
```
    Returns whether this ComponentView is a valid drop target for the dragged component in the given DragEvent or not.
    Implement this function in such a way that it returns true if this ComponentView accepts the drop of the given DropEvent.draggedComponent or false if a drop is not valid. The DropEvent.draggedComponent will snap back if all available drop targets return false.
    It is advised not to modify the Scene or its children in this function. A better suited function to modify the Scene or its children after a drag and drop gesture is onDragDropped.
    Note: onDragDropped only gets invoked if the dropAcceptor returns true for the given DropEvent.
  - setDropAcceptor
```
 final Unit setDropAcceptor(Function1<DragEvent, Boolean> dropAcceptor)
```
    Returns whether this ComponentView is a valid drop target for the dragged component in the given DragEvent or not.
    Implement this function in such a way that it returns true if this ComponentView accepts the drop of the given DropEvent.draggedComponent or false if a drop is not valid. The DropEvent.draggedComponent will snap back if all available drop targets return false.
    It is advised not to modify the Scene or its children in this function. A better suited function to modify the Scene or its children after a drag and drop gesture is onDragDropped.
    Note: onDragDropped only gets invoked if the dropAcceptor returns true for the given DropEvent.
  - getOnDragGestureEntered
```
 final Function1<DragEvent, Unit> getOnDragGestureEntered()
```
    Gets invoked with a DragEvent whenever the mouse enters this ComponentView while performing a drag gesture.
  - setOnDragGestureEntered
```
 final Unit setOnDragGestureEntered(Function1<DragEvent, Unit> onDragGestureEntered)
```
    Gets invoked with a DragEvent whenever the mouse enters this ComponentView while performing a drag gesture.
  - getOnDragGestureExited
```
 final Function1<DragEvent, Unit> getOnDragGestureExited()
```
    Gets invoked with a DragEvent whenever the mouse leaves this ComponentView while performing a drag gesture.
  - setOnDragGestureExited
```
 final Unit setOnDragGestureExited(Function1<DragEvent, Unit> onDragGestureExited)
```
    Gets invoked with a DragEvent whenever the mouse leaves this ComponentView while performing a drag gesture.
  - getOnDragDropped
```
 final Function1<DragEvent, Unit> getOnDragDropped()
```
    Gets invoked with a DragEvent whenever a drag and drop gesture finishes over this ComponentView and the dropAcceptor returns true for the given DragEvent.
  - setOnDragDropped
```
 final Unit setOnDragDropped(Function1<DragEvent, Unit> onDragDropped)
```
    Gets invoked with a DragEvent whenever a drag and drop gesture finishes over this ComponentView and the dropAcceptor returns true for the given DragEvent.

Class Button

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class tools.aqua.bgw.components.StaticComponentView

Methods inherited from class java.lang.Object

Constructor Detail

Button

Method Detail

getLabelProperty

getLabel

setLabel

getFontProperty

getFont

setFont

getBackgroundStyleProperty

getBackgroundStyle

setBackgroundStyle

getComponentStyleProperty

getComponentStyle

setComponentStyle

getParent

setParent

getName

setName

getHeightProperty

getHeight

setHeight

getWidthProperty

getWidth

setWidth

getPosXProperty

getPosX

setPosX

getPosYProperty

getPosY

setPosY

getScaleXProperty

getScaleX

setScaleX

getScaleYProperty

getScaleY

setScaleY

getScale

setScale

getRotationProperty

getRotation

setRotation

getVisual

setVisual

getOpacityProperty

getOpacity

setOpacity

getIsVisibleProperty

getIsVisible

setIsVisible

getIsDisabledProperty

getIsDisabled

setIsDisabled

getIsFocusableProperty

getIsFocusable

setIsFocusable

getOnMouseEntered

setOnMouseEntered

getOnMouseExited

setOnMouseExited

getOnMousePressed

setOnMousePressed

getOnMouseReleased

setOnMouseReleased

getOnMouseClicked

setOnMouseClicked

getOnKeyPressed

setOnKeyPressed

getOnKeyReleased

setOnKeyReleased

getOnKeyTyped

setOnKeyTyped

getDropAcceptor