bgw-gui/tools.aqua.bgw.components.container/GameComponentContainer

GameComponentContainer

sealed class GameComponentContainer<T : DynamicComponentView> : DynamicComponentView, Iterable<T> , LayeredContainer<T>

Baseclass for containers that can contain GameComponentViews or its subclasses.

It provides the list to store GameComponentViews and some useful methods to work on said list.

Parameters

T

Generic GameComponentView.

posX

horizontal coordinate for this GameComponentContainer.

posY

vertical coordinate for this GameComponentContainer.

width

width for this GameComponentContainer.

height

height for this GameComponentContainer.

visual

visual for this GameComponentContainer.

Functions

fun add(component: T, index: Int = observableComponents.size)

Adds a GameComponentView to this GameComponentContainer.

fun addAll(vararg components: T)

Adds all GameComponentViews passed as varargs to this GameComponentContainer.

fun addAll(collection: Collection<T>)

Adds all GameComponentViews contained in collection to this GameComponentContainer.

addComponentsListener

fun addComponentsListener(listener: ValueObserver<List<T>>)

Adds a ValueObserver on the observableComponents list.

fun clear(): List<T>

Removes all GameComponentViews from this GameComponentContainer.

clearComponentsListener

fun clearComponentsListener()

Removes all listeners from the observableComponents list.

open fun forEach(p0: Consumer<in T>)

fun isEmpty(): Boolean

Returns whether the components list is empty.

fun isNotEmpty(): Boolean

Returns whether the components list is not empty.

open operator override fun iterator(): Iterator<T>

Returns an iterator over the elements of this GameComponentContainer.

numberOfComponents

fun numberOfComponents(): Int

Returns the size of the components list.

fun offset(offsetX: Number, offsetY: Number)

Adds an offset to this ComponentView's Position.

fun remove(component: T): Boolean

Removes the GameComponentView specified by the parameter from this GameComponentContainer.

fun removeAll(predicate: (T) -> Boolean): Boolean

Removes all GameComponentViews matching the predicate from this GameComponentContainer.

fun removeAll(collection: Collection<T>): Boolean

Removes all GameComponentViews contained in collection from this GameComponentContainer.

removeComponentsListener

fun removeComponentsListener(listener: ValueObserver<List<T>>)

Removes a listener from the observableComponents list.

removeFromParent

fun removeFromParent(): ComponentView

Removes this component from its parent.

fun reposition(posX: Number, posY: Number)

Repositions this ComponentView to the specified coordinates.

fun resize(width: Number, height: Number)

Resizes this ComponentView to the specified width and height.

fun rotate(degrees: Number)

Rotates this ComponentView by the given number of degrees.

fun scale(scalar: Number)

Scales this ComponentView by the given scalar.

fun scaleX(scalar: Number)

Scales this ComponentView's width by the given scalar.

fun scaleY(scalar: Number)

Scales this ComponentView's height by the given scalar.

open override fun setZIndex(component: T, zIndex: Int)

Puts the component in the appropriate place compared to the other observableComponents by the zIndex.

open fun spliterator(): Spliterator<T>

fun toBack()

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

open override fun toBack(component: T)

Puts the component to the back inside the LayeredContainer and Changes its zIndex accordingly.

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

open override fun toFront(component: T)

Puts the component to the front inside the LayeredContainer and Changes its zIndex accordingly.

Properties

var actualHeight: Double

The actual height for this ComponentView considering scale.

var actualPosX: Double

Horizontal position of this ComponentView considering scale.

var actualPosY: Double

Vertical position of this ComponentView considering scale.

var actualWidth: Double

The actual width for this ComponentView considering scale.

var components: List<T>

GameComponentViews that are contained in this GameComponentContainer.

var dropAcceptor: (DragEvent) -> Boolean? = null

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

var height: Double

The height for this ComponentView.

val heightProperty: DoubleProperty

Property for the height of this ComponentView.

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.

var isDraggable: Boolean

Controls whether component is draggable or not.

isDraggableProperty

val isDraggableProperty: BooleanProperty

Property that controls whether component is draggable or not.

var isDragged: Boolean

Reflects whether component is currently dragged or not.

isDraggedProperty

val isDraggedProperty: ReadonlyBooleanProperty

Property that reflects whether component is currently dragged or not.

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.

var isVisible: Boolean

Visibility of this ComponentView.

isVisibleProperty

val isVisibleProperty: BooleanProperty

Property for the visibility of this ComponentView.

var layoutBounds: CoordinatePlain

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

var name: String

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

var onAdd: T.() -> Unit? = null

onAdd gets invoked anytime after a GameComponentView is added to this GameComponentContainer with the added GameComponentView as its receiver.

var onDragDropped: (DragEvent) -> Unit? = null

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

onDragGestureEnded

var onDragGestureEnded: (DropEvent, Boolean) -> Unit? = null

Gets invoked with a DragEvent whenever a drag gesture has ended on this rendered ComponentView.

onDragGestureEntered

var onDragGestureEntered: (DragEvent) -> Unit? = null

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

onDragGestureExited

var onDragGestureExited: (DragEvent) -> Unit? = null

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

onDragGestureMoved

var onDragGestureMoved: (DragEvent) -> Unit? = null

Gets invoked with a DragEvent whenever a mouse movement occurs during a drag gesture on this ComponentView.

onDragGestureStarted

var onDragGestureStarted: (DragEvent) -> Unit? = null

Gets invoked with a DragEvent whenever a drag gesture is started on this ComponentView.

var onKeyPressed: (KeyEvent) -> Unit? = null

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

var onKeyReleased: (KeyEvent) -> Unit? = null

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

var onKeyTyped: (KeyEvent) -> Unit? = null

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

var onMouseClicked: (MouseEvent) -> Unit? = null

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

var onMouseEntered: (MouseEvent) -> Unit? = null

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

var onMouseExited: (MouseEvent) -> Unit? = null

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

var onMousePressed: (MouseEvent) -> Unit? = null

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

onMouseReleased

var onMouseReleased: (MouseEvent) -> Unit? = null

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

var onRemove: T.() -> Unit? = null

onRemove gets invoked anytime after a GameComponentView is removed from this GameComponentContainer with the removed GameComponentView as its receiver.

var onScroll: (ScrollEvent) -> Unit? = null

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

var opacity: Double

Opacity of this ComponentView.

opacityProperty

val opacityProperty: LimitedDoubleProperty

Property for the opacity of this ComponentView.

var parent: ComponentView? = null

The parent of this ComponentView.

var posX: Double

Horizontal position of this ComponentView.

val posXProperty: DoubleProperty

Property for the horizontal position of this ComponentView.

var posY: Double

Vertical position of this ComponentView.

val posYProperty: DoubleProperty

Property for the vertical position of this ComponentView.

var rotation: Double

Rotation of this ComponentView in degrees.

rotationProperty

val rotationProperty: DoubleProperty

Property for the rotation of this ComponentView in degrees.

var scale: Double

Scale of this ComponentView.

var scaleX: Double

Horizontal scale of this ComponentView.

val scaleXProperty: DoubleProperty

Property for the horizontal scale of this ComponentView.

var scaleY: Double

Vertical scale of this ComponentView.

val scaleYProperty: DoubleProperty

Property for the vertical scale of this ComponentView.

open var visual: Visual

Current Visual.

var width: Double

The width for this ComponentView.

val widthProperty: DoubleProperty

Property for the width of this ComponentView.

var zIndex: Int

for the order of ComponentView inside of parent.#

val zIndexProperty: IntegerProperty

Property for the order of ComponentView inside of parent.#

Inheritors