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

LinearLayout

open class LinearLayout<T : GameComponentView>( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_LINEAR_LAYOUT_WIDTH, height: Number = DEFAULT_LINEAR_LAYOUT_HEIGHT, spacing: Number = DEFAULT_LINEAR_LAYOUT_SPACING, visual: Visual = Visual.EMPTY, orientation: Orientation = Orientation.HORIZONTAL, alignment: Alignment = Alignment.TOP_LEFT) : GameComponentContainer<T>

A LinearLayout may be used to visualize a zone containing GameComponentViews.

GameComponentViews inside the container get placed according to the specified Orientation and Alignment. A spacing between components may be specified which may also be negative e.g. components like playing cards should overlap.

Visualization:

The Visual is used to visualize a background.

If all components are still within bounds with the user defined spacing, the user defined spacing gets used to space the components. Otherwise, the biggest possible spacing is used so that all components are still withing bounds of the LinearLayout.

Parameters

Generic GameComponentView.

posX

horizontal coordinate for this LinearLayout. Default: 0.

posY

vertical coordinate for this LinearLayout. Default: 0.

width

width for this LinearLayout. Default: DEFAULT_LINEAR_LAYOUT_WIDTH.

height

height for this LinearLayout. Default: DEFAULT_LINEAR_LAYOUT_HEIGHT.

spacing

spacing between contained GameComponentViews. Default: DEFAULT_LINEAR_LAYOUT_SPACING.

visual

Visual to be used for this LinearLayout.

orientation

orientation for this LinearLayout. Default: Orientation.HORIZONTAL.

alignment

specifies how the contained GameComponentViews should be aligned. Default: Alignment.TOP_LEFT.

Constructors

LinearLayout

fun LinearLayout( posX: Number = 0, posY: Number = 0, width: Number = 0, height: Number = 0, spacing: Number = 0, visual: Visual = Visual.EMPTY, orientation: Orientation = Orientation.HORIZONTAL, verticalAlignment: VerticalAlignment = VerticalAlignment.TOP, horizontalAlignment: HorizontalAlignment = HorizontalAlignment.LEFT)

Secondary constructor taking separate alignment components.

LinearLayout

fun LinearLayout( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_LINEAR_LAYOUT_WIDTH, height: Number = DEFAULT_LINEAR_LAYOUT_HEIGHT, spacing: Number = DEFAULT_LINEAR_LAYOUT_SPACING, visual: Visual = Visual.EMPTY, orientation: Orientation = Orientation.HORIZONTAL, alignment: Alignment = Alignment.TOP_LEFT)

Creates a LinearLayout.

Functions

add

@Synchronized

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

Adds a GameComponentView to this GameComponentContainer.

addAll

fun addAll(vararg components: T)

Adds all GameComponentViews passed as varargs to this GameComponentContainer.

@Synchronized

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.

clear

@Synchronized

fun clear(): List<T>

Removes all GameComponentViews from this GameComponentContainer.

clearComponentsListener

fun clearComponentsListener()

Removes all listeners from the observableComponents list.

forEach

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

isEmpty

fun isEmpty(): Boolean

Returns whether the components list is empty.

isNotEmpty

fun isNotEmpty(): Boolean

Returns whether the components list is not empty.

iterator

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.

offset

fun offset(offsetX: Number, offsetY: Number)

Adds an offset to this ComponentView's Position.

remove

@Synchronized

fun remove(component: T): Boolean

Removes the GameComponentView specified by the parameter from this GameComponentContainer.

removeAll

@Synchronized

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

Removes all GameComponentViews matching the predicate from this GameComponentContainer.

@Synchronized

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.

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.

setZIndex

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

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

spliterator

open fun spliterator(): Spliterator<T>

toBack

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.

toFront

fun toFront()

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

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 for this LinearLayout.

alignmentProperty

val alignmentProperty: Property<Alignment>

Property for the Alignment of GameComponentViews in this LinearLayout.

components

var components: List<T>

GameComponentViews that are contained in this GameComponentContainer.

dropAcceptor

var dropAcceptor: (DragEvent) -> Boolean?

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

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.

isDraggable

var isDraggable: Boolean

Controls whether component is draggable or not.

isDraggableProperty

val isDraggableProperty: BooleanProperty

Property that controls whether component is draggable or not.

isDragged

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.

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.

isVisible

var isVisible: Boolean

Visibility of this ComponentView.

isVisibleProperty

val isVisibleProperty: BooleanProperty

Property for the visibility of this ComponentView.

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.

onAdd

var onAdd: T.() -> Unit?

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

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.

onDragGestureEnded

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

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

onDragGestureEntered

var onDragGestureEntered: (DragEvent) -> Unit?

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

onDragGestureExited

var onDragGestureExited: (DragEvent) -> Unit?

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

onDragGestureMoved

var onDragGestureMoved: (DragEvent) -> Unit?

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

onDragGestureStarted

var onDragGestureStarted: (DragEvent) -> Unit?

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

onKeyPressed

var onKeyPressed: (KeyEvent) -> Unit?

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

onKeyReleased

var onKeyReleased: (KeyEvent) -> Unit?

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

onKeyTyped

var onKeyTyped: (KeyEvent) -> Unit?

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

onMouseClicked

var onMouseClicked: (MouseEvent) -> Unit?

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

onMouseEntered

var onMouseEntered: (MouseEvent) -> Unit?

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

onMouseExited

var onMouseExited: (MouseEvent) -> Unit?

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

onMousePressed

var onMousePressed: (MouseEvent) -> Unit?

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

onMouseReleased

var onMouseReleased: (MouseEvent) -> Unit?

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

onRemove

var onRemove: T.() -> Unit?

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

onScroll