-
- All Implemented Interfaces:
public class UIComponent extends StaticComponentView<UIComponent>
Baseclass for all UI components.
-
-
Field Summary
-
Method Summary
Modifier and Type Method Description final Property<Font>
getFontProperty()
Property for the Font of this UIComponent. 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
getPosXProperty()
Property for the horizontal position of this ComponentView. final Double
getPosX()
final Unit
setPosX(Double posX)
final Double
getActualPosX()
final Unit
setActualPosX(Double actualPosX)
final DoubleProperty
getPosYProperty()
Property for the vertical position of this ComponentView. final Double
getPosY()
final Unit
setPosY(Double posY)
final Double
getActualPosY()
final Unit
setActualPosY(Double actualPosY)
final DoubleProperty
getWidthProperty()
Property for the width of this ComponentView. final Double
getWidth()
final Unit
setWidth(Double width)
final Double
getActualWidth()
final Unit
setActualWidth(Double actualWidth)
final DoubleProperty
getHeightProperty()
Property for the height of this ComponentView. final Double
getHeight()
final Unit
setHeight(Double height)
final Double
getActualHeight()
final Unit
setActualHeight(Double actualHeight)
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 CoordinatePlain
getLayoutBounds()
final Unit
setLayoutBounds(CoordinatePlain layoutBounds)
final DoubleProperty
getRotationProperty()
Property for the rotation of this ComponentView in degrees. final Double
getRotation()
final Unit
setRotation(Double rotation)
Visual
getVisual()
Unit
setVisual(Visual visual)
Sets a copy of the given Visual to this field and refreshes GUI. final LimitedDoubleProperty
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 a MouseEvent whenever the mouse enters this ComponentView. final Unit
setOnMouseEntered(Function1<MouseEvent, Unit> onMouseEntered)
Gets invoked with a MouseEvent whenever the mouse enters this ComponentView. final Function1<MouseEvent, Unit>
getOnMouseExited()
Gets invoked with a MouseEvent whenever the mouse leaves this ComponentView. final Unit
setOnMouseExited(Function1<MouseEvent, Unit> onMouseExited)
Gets invoked with a MouseEvent 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.-
-
Method Detail
-
getFontProperty
final Property<Font> getFontProperty()
Property for the Font of this UIComponent. Usage depends on subclass.
-
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)
-
setName
final Unit setName(String name)
Name field only for debugging purposes. Has no effect on rendering.
-
getPosXProperty
final DoubleProperty getPosXProperty()
Property for the horizontal position of this ComponentView.
-
getActualPosX
final Double getActualPosX()
-
setActualPosX
final Unit setActualPosX(Double actualPosX)
-
getPosYProperty
final DoubleProperty getPosYProperty()
Property for the vertical position of this ComponentView.
-
getActualPosY
final Double getActualPosY()
-
setActualPosY
final Unit setActualPosY(Double actualPosY)
-
getWidthProperty
final DoubleProperty getWidthProperty()
Property for the width of this ComponentView.
-
getActualWidth
final Double getActualWidth()
-
setActualWidth
final Unit setActualWidth(Double actualWidth)
-
getHeightProperty
final DoubleProperty getHeightProperty()
Property for the height of this ComponentView.
-
getActualHeight
final Double getActualHeight()
-
setActualHeight
final Unit setActualHeight(Double actualHeight)
-
getScaleXProperty
final DoubleProperty getScaleXProperty()
Property for the horizontal scale of this ComponentView.
-
getScaleYProperty
final DoubleProperty getScaleYProperty()
Property for the vertical scale of this ComponentView.
-
getLayoutBounds
final CoordinatePlain getLayoutBounds()
-
setLayoutBounds
final Unit setLayoutBounds(CoordinatePlain layoutBounds)
-
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)
-
setVisual
Unit setVisual(Visual visual)
Sets a copy of the given Visual to this field and refreshes GUI.
-
getOpacityProperty
final LimitedDoubleProperty getOpacityProperty()
Property for the opacity of this ComponentView.
Must 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, wherefalse
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 a MouseEvent whenever the mouse enters this ComponentView.
-
setOnMouseEntered
final Unit setOnMouseEntered(Function1<MouseEvent, Unit> onMouseEntered)
Gets invoked with a MouseEvent whenever the mouse enters this ComponentView.
-
getOnMouseExited
final Function1<MouseEvent, Unit> getOnMouseExited()
Gets invoked with a MouseEvent whenever the mouse leaves this ComponentView.
-
setOnMouseExited
final Unit setOnMouseExited(Function1<MouseEvent, Unit> onMouseExited)
Gets invoked with a MouseEvent 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 orfalse
if a drop is not valid. The DropEvent.draggedComponent will snap back if all available drop targets returnfalse
.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 orfalse
if a drop is not valid. The DropEvent.draggedComponent will snap back if all available drop targets returnfalse
.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.
-
-
-
-