Class VFXTableHelper.AbstractHelper<T>

java.lang.Object

io.github.palexdev.virtualizedfx.base.VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

io.github.palexdev.virtualizedfx.table.VFXTableHelper.AbstractHelper<T>

Type Parameters:

T -

All Implemented Interfaces:

VFXContainerHelper<T, VFXTable<T>>, VFXTableHelper<T>

Direct Known Subclasses:

VFXTableHelper.FixedTableHelper, VFXTableHelper.VariableTableHelper

Enclosing interface:

VFXTableHelper<T>

public abstract static class VFXTableHelper.AbstractHelper<T>
extends VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>
implements VFXTableHelper<T>

Abstract implementation of VFXTableHelper, contains common members for the two concrete implementations VFXTableHelper.FixedTableHelper and VFXTableHelper.VariableTableHelper, such as:

- the range of columns to display as a IntegerRangeProperty

- the range of rows to display as a IntegerRangeProperty

Nested Class Summary

Nested classes/interfaces inherited from interface VFXContainerHelper

VFXContainerHelper.VFXContainerHelperBase<T,C>

Nested classes/interfaces inherited from interface VFXTableHelper

VFXTableHelper.AbstractHelper<T>, VFXTableHelper.FixedTableHelper<T>, VFXTableHelper.VariableTableHelper<T>

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.range.NumberRange<Integer>>	columnsRange	Specifies the range of columns that should be present in the viewport.
javafx.beans.property.ReadOnlyDoubleProperty	maxHScroll	Specifies the maximum possible horizontal position.
javafx.beans.property.ReadOnlyDoubleProperty	maxVScroll	Specifies the maximum possible vertical position.
javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.range.NumberRange<Integer>>	rowsRange	Specifies the range of rows that should be present in the viewport.
javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.Position>	viewportPosition	Cells are actually contained in a separate pane called 'viewport'.
javafx.beans.property.ReadOnlyDoubleProperty	virtualMaxX	Specifies the total number of pixels on the x-axis.
javafx.beans.property.ReadOnlyDoubleProperty	virtualMaxY	Specifies the total number of pixels on the y-axis.

Field Summary

Fields

Modifier and Type	Field	Description
protected final io.github.palexdev.mfxcore.base.properties.range.IntegerRangeProperty	columnsRange
protected final io.github.palexdev.mfxcore.base.properties.range.IntegerRangeProperty	rowsRange

Fields inherited from class VFXContainerHelper.VFXContainerHelperBase

container, maxHScroll, maxVScroll, viewportPosition, virtualMaxX, virtualMaxY, vmxBinding, vmyBinding

Constructor Summary

Constructors

Constructor	Description
AbstractHelper(VFXTable<T> table)

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.range.NumberRange<Integer>>	columnsRangeProperty()	Specifies the range of columns that should be present in the viewport.
protected javafx.beans.binding.DoubleBinding	createMaxVScrollBinding()	Builds and returns the binding which computes the VFXContainerHelper.VFXContainerHelperBase.maxVScrollProperty()'s value.
int	firstRow()
int	lastColumn()
int	lastRow()
javafx.beans.property.ReadOnlyDoubleProperty	maxHScrollProperty()	Specifies the maximum possible horizontal position.
javafx.beans.property.ReadOnlyDoubleProperty	maxVScrollProperty()	Specifies the maximum possible vertical position.
javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.range.NumberRange<Integer>>	rowsRangeProperty()	Specifies the range of rows that should be present in the viewport.
int	totalRows()
javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.Position>	viewportPositionProperty()	Cells are actually contained in a separate pane called 'viewport'.
javafx.beans.property.ReadOnlyDoubleProperty	virtualMaxXProperty()	Specifies the total number of pixels on the x-axis.
javafx.beans.property.ReadOnlyDoubleProperty	virtualMaxYProperty()	Specifies the total number of pixels on the y-axis.
int	visibleRows()

Methods inherited from class VFXContainerHelper.VFXContainerHelperBase

createBindings, createMaxHScrollBinding, createVirtualMaxXBinding, createVirtualMaxYBinding, dispose, getContainer, invalidateVirtualSizes

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface VFXContainerHelper

dispose, getContainer, getMaxHScroll, getMaxVScroll, getViewportPosition, getVirtualMaxX, getVirtualMaxY, indexToItem, invalidatePos, invalidateVirtualSizes

Methods inherited from interface VFXTableHelper

autosizeColumn, autosizeColumns, columnsRange, firstColumn, getColumnPos, getColumnWidth, getViewportHeight, indexToRow, isInViewport, isLastColumn, itemToRow, layoutCell, layoutColumn, layoutRow, rowsRange, scrollBy, scrollToIndex, scrollToPixel, totalCells, totalColumns, visibleCells, visibleColumns

Property Details

columnsRange

public javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.range.NumberRange<Integer>> columnsRangeProperty

Specified by:

columnsRangeProperty in interface VFXTableHelper<T>

Returns:

the columnsRange property

See Also:

• columnsRangeProperty()

rowsRange

public javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.range.NumberRange<Integer>> rowsRangeProperty

Specified by:

rowsRangeProperty in interface VFXTableHelper<T>

Returns:

the rowsRange property

See Also:

• rowsRangeProperty()

virtualMaxX

public javafx.beans.property.ReadOnlyDoubleProperty virtualMaxXProperty

Specified by:

virtualMaxXProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

virtualMaxXProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the virtualMaxX property

See Also:

• virtualMaxXProperty()

virtualMaxY

public javafx.beans.property.ReadOnlyDoubleProperty virtualMaxYProperty

Specified by:

virtualMaxYProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

virtualMaxYProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the virtualMaxY property

See Also:

• virtualMaxYProperty()

maxVScroll

public javafx.beans.property.ReadOnlyDoubleProperty maxVScrollProperty

Specified by:

maxVScrollProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

maxVScrollProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the maxVScroll property

See Also:

• maxVScrollProperty()

maxHScroll

public javafx.beans.property.ReadOnlyDoubleProperty maxHScrollProperty

Specified by:

maxHScrollProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

maxHScrollProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the maxHScroll property

See Also:

• maxHScrollProperty()

viewportPosition

public javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.Position> viewportPositionProperty

Specified by:

viewportPositionProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

viewportPositionProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the viewportPosition property

See Also:

• viewportPositionProperty()

Field Details

columnsRange

protected final io.github.palexdev.mfxcore.base.properties.range.IntegerRangeProperty columnsRange

rowsRange

protected final io.github.palexdev.mfxcore.base.properties.range.IntegerRangeProperty rowsRange

Constructor Details

AbstractHelper

public AbstractHelper(VFXTable<T> table)

Method Details

createMaxVScrollBinding

protected javafx.beans.binding.DoubleBinding createMaxVScrollBinding()

Description copied from class: VFXContainerHelper.VFXContainerHelperBase

Builds and returns the binding which computes the VFXContainerHelper.VFXContainerHelperBase.maxVScrollProperty()'s value.

For most containers the value is given by: virtualMaxY - containerHeight.

The formula may vary for some containers!

Overrides:

createMaxVScrollBinding in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

lastColumn

public int lastColumn()

Given by columnsRange().getMax()

Specified by:

lastColumn in interface VFXTableHelper<T>

Returns:

the index of the last visible column

columnsRangeProperty

public javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.range.NumberRange<Integer>> columnsRangeProperty()

Description copied from interface: VFXTableHelper

Specifies the range of columns that should be present in the viewport. This also takes into account buffer columns, see VFXTableHelper.visibleColumns() and VFXTableHelper.totalColumns().

Specified by:

columnsRangeProperty in interface VFXTableHelper<T>

Returns:

the columnsRange property

firstRow

public int firstRow()

Given by Math.floor(vPos / rowsHeight), clamped between 0 and VFXContainer.size() - 1.

Specified by:

firstRow in interface VFXTableHelper<T>

Returns:

the index of the first visible row

lastRow

public int lastRow()

Given by rowsRange().getMax()

Specified by:

lastRow in interface VFXTableHelper<T>

Returns:

the index of the last visible row

visibleRows

public int visibleRows()

Given by Math.ceil(viewportHeight / rowsHeight). 0 if the rows height is also 0.

Specified by:

visibleRows in interface VFXTableHelper<T>

Returns:

the number of rows visible in the viewport. Not necessarily the same as VFXTableHelper.totalRows()

totalRows

public int totalRows()

Given by visibleRows + rowsBuffer * 2, can't exceed VFXContainer.size() and it's 0 if the number of visible rows is also 0.

Specified by:

totalRows in interface VFXTableHelper<T>

Returns:

the total number of rows in the viewport which doesn't include only the number of visible rows but also the number of buffer rows

rowsRangeProperty

public javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.range.NumberRange<Integer>> rowsRangeProperty()

Description copied from interface: VFXTableHelper

Specifies the range of rows that should be present in the viewport. This also takes into account buffer rows, see VFXTableHelper.visibleRows() and VFXTableHelper.totalRows().

Specified by:

rowsRangeProperty in interface VFXTableHelper<T>

Returns:

the rowsRange property

virtualMaxXProperty

public javafx.beans.property.ReadOnlyDoubleProperty virtualMaxXProperty()

Description copied from interface: VFXContainerHelper

Specifies the total number of pixels on the x-axis.

Specified by:

virtualMaxXProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

virtualMaxXProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the virtualMaxX property

See Also:

• VFXContainerHelper.getVirtualMaxX()

virtualMaxYProperty

public javafx.beans.property.ReadOnlyDoubleProperty virtualMaxYProperty()

Description copied from interface: VFXContainerHelper

Specifies the total number of pixels on the y-axis.

Specified by:

virtualMaxYProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

virtualMaxYProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the virtualMaxY property

See Also:

• VFXContainerHelper.getVirtualMaxY()

maxVScrollProperty

public javafx.beans.property.ReadOnlyDoubleProperty maxVScrollProperty()

Description copied from interface: VFXContainerHelper

Specifies the maximum possible vertical position.

Specified by:

maxVScrollProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

maxVScrollProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the maxVScroll property

See Also:

• VFXContainerHelper.getMaxVScroll()

maxHScrollProperty

public javafx.beans.property.ReadOnlyDoubleProperty maxHScrollProperty()

Description copied from interface: VFXContainerHelper

Specifies the maximum possible horizontal position.

Specified by:

maxHScrollProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

maxHScrollProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the maxHScroll property

See Also:

• VFXContainerHelper.getMaxHScroll()

viewportPositionProperty

public javafx.beans.property.ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.Position> viewportPositionProperty()

Description copied from interface: VFXContainerHelper

Cells are actually contained in a separate pane called 'viewport'. The scroll is applied on this pane.

This property specifies the translation of the viewport, the value depends on the implementation.

Specified by:

viewportPositionProperty in interface VFXContainerHelper<T, VFXTable<T>>

Overrides:

viewportPositionProperty in class VFXContainerHelper.VFXContainerHelperBase<T, VFXTable<T>>

Returns:

the viewportPosition property

See Also:

• VFXContainerHelper.getViewportPosition()