bgw-gui/tools.aqua.bgw.components.layoutviews/GridPane

GridPane

open class GridPane<T : ComponentView>( posX: Number = 0, posY: Number = 0, columns: Int, rows: Int, spacing: Number = DEFAULT_GRID_SPACING, layoutFromCenter: Boolean = true, visual: Visual = Visual.EMPTY) : LayoutView<T> , Iterable<GridIteratorElement<T>>

Defines a LayoutView that orders components in a grid structure.

Parameters

Generic ComponentView.

posX

Horizontal coordinate for this GridPane. Default: 0.

posY

Vertical coordinate for this GridPane. Default: 0.

columns

Initial column count.

rows

Initial row count.

spacing

Spacing between rows and columns. Default: DEFAULT_GRID_SPACING.

layoutFromCenter

Whether the GridPane should anchor in the center (true) or top-Left (false). Default: true.

visual

Initial visual for this GridPane. Default: Visual.EMPTY.

Constructors

GridPane

fun GridPane( posX: Number = 0, posY: Number = 0, columns: Int, rows: Int, spacing: Number = DEFAULT_GRID_SPACING, layoutFromCenter: Boolean = true, visual: Visual = Visual.EMPTY)

Creates a GridPane with given rows and columns.

Types

Companion

object Companion

Functions

addColumns

fun addColumns(columnIndex: Int, count: Int = 1)

Adds the desired amount of columns between column columnIndex - 1 and columnIndex. New columns get null-initialized.

addRows

fun addRows(rowIndex: Int, count: Int = 1)

Adds the desired amount of rows between row rowIndex and rowIndex + 1. New rows get null-initialized.

forEach

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

get

operator fun get(columnIndex: Int, rowIndex: Int): T?

Returns ComponentView in specified cell. Returns null if there was no component.

getCellCenterMode

fun getCellCenterMode(columnIndex: Int, rowIndex: Int): Alignment

Returns centering mode as an Alignment of the specified cell.

getColumnWidth

fun getColumnWidth(columnIndex: Int): Double

Returns the set column width for the given column.

getRowHeight

fun getRowHeight(rowIndex: Int): Double

Returns the set row height for the given row.

grow

fun grow( left: Int = 0, right: Int = 0, top: Int = 0, bottom: Int = 0): Boolean

Grows grid by specified dimensions, filling new cells with null values.

iterator

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

Returns an Iterator over the grid components.

offset

fun offset(offsetX: Number, offsetY: Number)

Adds an offset to this ComponentView's Position.

removeColumn

fun removeColumn(columnIndex: Int)

Removes the desired column in the grid. Removes all, views in the column. If there is no column left in the grid, it gets trimmed to size 0x0.

removeEmptyColumns

fun removeEmptyColumns()

Removes all empty columns e.g. all rows that have no views in their cells.

removeEmptyRows

fun removeEmptyRows()

Removes all empty rows e.g. all rows that have no views in their cells.

removeFromParent

fun removeFromParent(): ComponentView

Removes this component from its parent.

removeRow

fun removeRow(rowIndex: Int)

Removes the desired row in the grid. Removes all, views in the row.

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.

set

operator fun set( columnIndex: Int, rowIndex: Int, component: T?)

Sets content of desired grid cell. Overrides existing component in this cell. Pass null to remove a component.

setAutoColumnWidth

fun setAutoColumnWidth(columnIndex: Int)

Restores automatic resizing behavior for desired column.

setAutoColumnWidths

fun setAutoColumnWidths()

Restores automatic resizing behavior for all columns.

setAutoRowHeight

fun setAutoRowHeight(rowIndex: Int)

Restores automatic resizing behavior for desired row.

setAutoRowHeights

fun setAutoRowHeights()

Restores automatic resizing behavior for all rows.

setCellCenterMode

fun setCellCenterMode( columnIndex: Int, rowIndex: Int, value: Alignment)

Sets centering mode of desired grid cell with given Alignment. Overrides existing mode in this cell.

setCenterMode

fun setCenterMode(value: Alignment)

Sets centering mode of all cells in the grid with given Alignment. Overrides existing modes of all cells.

setColumnCenterMode

fun setColumnCenterMode(columnIndex: Int, value: Alignment)

Sets centering mode of desired column in grid with given Alignment. Overrides existing mode in the whole column.

setColumnWidth

fun setColumnWidth(columnIndex: Int, columnWidth: Number)

Manually set column width of one column. Overrides automatic resizing based on content from this column.

setColumnWidths

fun setColumnWidths(columnWidths: DoubleArray)

fun setColumnWidths(columnWidth: Number)

Manually set column width of all columns. Overrides automatic resizing based on content from this column.

setRowCenterMode

fun setRowCenterMode(rowIndex: Int, value: Alignment)

Sets centering mode of desired row in grid with given Alignment. Overrides existing mode in the whole row.

setRowHeight

fun setRowHeight(rowIndex: Int, rowHeight: Number)

Manually set row height of one row. Overrides automatic resizing based on content from this row.

setRowHeights

fun setRowHeights(rowHeights: DoubleArray)

fun setRowHeights(rowHeight: Number)

Manually set row height of all rows. Overrides automatic resizing based on content from this row.

spliterator

open fun spliterator(): Spliterator<GridIteratorElement<T>>

toBack

fun toBack()

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

toFront

fun toFront()

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

trim

fun trim(): Boolean

Removes all empty outer rows and columns e.g. all rows and columns counted from left, right, top and bottom that have no views in their cells.

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.

columns

val columns: Int

Current column count.

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.

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.

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.