bgw-gui/tools.aqua.bgw.components.uicomponents/TableView

TableView

open class TableView<T>( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_TABLE_VIEW_WIDTH, height: Number = DEFAULT_TABLE_VIEW_HEIGHT, columns: List<TableColumn<T>> = emptyList(), items: List<T> = emptyList(), visual: Visual = ColorVisual.WHITE, selectionMode: SelectionMode = SelectionMode.SINGLE, selectionBackground: ColorVisual = ColorVisual.BLUE) : StructuredDataView<T>

A TableView may be used to visualize a data table.

The items list is used as the data model. The columns list defines how the data is represented.

Simplified example on how the columns list is used to represent the data:

items: 1, 2, 3

columns: ("first", {x -> x+1}, 10),

    ("second", {x -> "nice string " + x}, 14),

    ("third", {x -> "" + x*x + "!"}, 10)

Representation:

|first |second |third |

|----------|--------------|----------|

|2 |nice string 1 |1! |

|3 |nice string 2 |4! |

|4 |nice string 3 |9! |

Note that the components Font will be ignored. Use the font field for each TableColumn.

Parameters

Generic TableView content.

posX

Horizontal coordinate for this TableView. Default: 0.

posY

Vertical coordinate for this TableView. Default: 0.

width

Width for this TableView. Default: DEFAULT_TABLE_VIEW_WIDTH.

height

Height for this TableView. Default: DEFAULT_TABLE_VIEW_HEIGHT.

columns

Initial columns for this TableView. Default: empty list.

items

Initial list of items for this TableView. Default: empty list.

visual

Background Visual. Default: ColorVisual.WHITE.

selectionMode

Selection mode to be used for this TableView. Default: SelectionMode.SINGLE.

selectionBackground

Background for selected items in this TableView. Default: ColorVisual.BLUE.

Constructors

TableView

fun <T> TableView( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_TABLE_VIEW_WIDTH, height: Number = DEFAULT_TABLE_VIEW_HEIGHT, columns: List<TableColumn<T>> = emptyList(), items: List<T> = emptyList(), visual: Visual = ColorVisual.WHITE, selectionMode: SelectionMode = SelectionMode.SINGLE, selectionBackground: ColorVisual = ColorVisual.BLUE)

Creates a TableView.

Functions

clearSelection

fun clearSelection()

Clears selection of items. Instantly returns if no item is currently selected.

offset

fun offset(offsetX: Number, offsetY: Number)

Adds an offset to this ComponentView's Position.

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.

select

fun select(element: T)

Selects the specified element. Clears current selection.

fun select(index: Int)

Selects the element at the specified index in this UIComponent. Clears current selection.

selectAll

fun selectAll()

Selects all items in this UIComponent.

selectFirst

fun selectFirst()

Selects the first element in this UIComponent. Clears current selection.

selectLast

fun selectLast()

Selects the last element in this UIComponent. Clears current selection.

selectNext

fun selectNext()

Selects the next element in this UIComponent. Clears current selection.

selectPrevious

fun selectPrevious()

Selects the previous element in this UIComponent. Clears current selection.

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.

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.

backgroundStyle

var backgroundStyle: String

Css style that gets applied to this UIComponent's background.

backgroundStyleProperty

val backgroundStyleProperty: StringProperty

Property for the css style that gets applied to this UIComponent's background.

columns

val columns: ObservableList<TableColumn<T>>

An ObservableList that contains TableColumns which specify how the data is represented in that column. The first TableColumn in this ObservableList will be the leftmost column in the rendered TableView.

componentStyle

var componentStyle: String

Css style that gets applied to this UIComponent.

componentStyleProperty

val componentStyleProperty: StringProperty

Property for the css style that gets applied to this UIComponent.

dropAcceptor

var dropAcceptor: (DragEvent) -> Boolean?

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

font

var font: Font

Font of this UIComponent. Usage depends on subclass.

fontProperty

val fontProperty: Property<Font>

Property for the Font of this UIComponent. Usage depends on subclass.

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.

items

val items: ObservableList<T>

An ObservableList that contains the data objects. The first object in this ObservableList will be the topmost row in the rendered UIComponent.

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.

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.

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.

onScroll

var onScroll: (ScrollEvent) -> Unit?

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

opacity

var opacity: Double

Opacity of this ComponentView.

opacityProperty

val opacityProperty: LimitedDoubleProperty

Property for the opacity of this ComponentView.

parent

var parent: ComponentView?

The parent of this ComponentView.

posX

var posX: Double

Horizontal position of this ComponentView.

posXProperty

val posXProperty: DoubleProperty

Property for the horizontal position of this ComponentView.

posY

var posY: Double

Vertical position of this ComponentView.

posYProperty

val posYProperty: DoubleProperty

Property for the vertical position of this ComponentView.

rotation

var rotation: Double

Rotation of this ComponentView in degrees.

rotationProperty

val rotationProperty: DoubleProperty

Property for the rotation of this ComponentView in degrees.

scale

var scale: Double

Scale of this ComponentView.

scaleX

var scaleX: Double

Horizontal scale of this ComponentView.

scaleXProperty

val scaleXProperty: DoubleProperty

Property for the horizontal scale of this ComponentView.

scaleY

var scaleY: Double

Vertical scale of this ComponentView.

scaleYProperty

val scaleYProperty: DoubleProperty

Property for the vertical scale of this ComponentView.

selectedIndices

val selectedIndices: ReadonlyObservableList<Int>

ReadonlyObservableList containing indices of all currently selected items in this UIComponent. Register a listener to listen for selection changes. Item selection is enabled via selectionMode.

selectedItems

val selectedItems: ReadonlyObservableList<T>

ReadonlyObservableList containing all currently selected items in this UIComponent. Register a listener to listen for selection changes. Item selection is enabled via selectionMode.

selectionBackground

var selectionBackground: ColorVisual

Background color for selected items in this UIComponent. Item selection is enabled via selectionMode.

selectionBackgroundProperty