Class VFXContainerHelper.VFXContainerHelperBase<T, C extends Region & VFXContainer<T>>

java.lang.Object

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

All Implemented Interfaces:

VFXContainerHelper<T,C>

Direct Known Subclasses:

VFXGridHelper.DefaultHelper, VFXListHelper.AbstractHelper, VFXTableHelper.AbstractHelper

Enclosing interface:

VFXContainerHelper<T, C extends Region & VFXContainer<T>>

public abstract static class VFXContainerHelper.VFXContainerHelperBase<T, C extends Region & VFXContainer<T>>
extends Object
implements VFXContainerHelper<T,C>

Abstract implementation of VFXContainerHelper.

This is the recommended class onto which base concrete helpers.

Stores the virtualized container's instance, defines common properties and thus implementing some of the APIs from VFXContainerHelper, and in addition defines some other APIs that should be hidden and known only to its implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.palexdev.virtualizedfx.base.VFXContainerHelper

VFXContainerHelper.VFXContainerHelperBase<T, C extends Region & VFXContainer<T>>

Property Summary

Properties

Type	Property	Description
ReadOnlyDoubleProperty	maxHScroll	Specifies the maximum possible horizontal position.
ReadOnlyDoubleProperty	maxVScroll	Specifies the maximum possible vertical position.
ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.Position>	viewportPosition	Cells are actually contained in a separate pane called 'viewport'.
ReadOnlyDoubleProperty	virtualMaxX	Specifies the total number of pixels on the x-axis.
ReadOnlyDoubleProperty	virtualMaxY	Specifies the total number of pixels on the y-axis.

Field Summary

Fields

Modifier and Type	Field	Description
protected C	container
protected final ReadOnlyDoubleWrapper	maxHScroll
protected final ReadOnlyDoubleWrapper	maxVScroll
protected final io.github.palexdev.mfxcore.base.properties.PositionProperty	viewportPosition
protected final ReadOnlyDoubleWrapper	virtualMaxX
protected final ReadOnlyDoubleWrapper	virtualMaxY
protected DoubleBinding	vmxBinding
protected DoubleBinding	vmyBinding

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VFXContainerHelperBase(C container)

Method Summary

Modifier and Type	Method	Description
protected void	createBindings()
protected DoubleBinding	createMaxHScrollBinding()	Builds and returns the binding which computes the maxHScrollProperty()'s value.
protected DoubleBinding	createMaxVScrollBinding()	Builds and returns the binding which computes the maxVScrollProperty()'s value.
protected abstract DoubleBinding	createVirtualMaxXBinding()	Implementations should use this build and return the DoubleBinding with the appropriate dependencies responsible for the virtualMaxXProperty()'s value.
protected abstract DoubleBinding	createVirtualMaxYBinding()	Implementations should use this build and return the DoubleBinding with the appropriate dependencies responsible for the virtualMaxXProperty()'s value.
void	dispose()	If the helper uses listeners/bindings that may lead to memory leaks, this is the right place to remove them.
C	getContainer()
void	invalidateVirtualSizes()	Implementations should define the logic to manually invalidate the virtual sizes (VFXContainerHelper.virtualMaxXProperty() and VFXContainerHelper.virtualMaxYProperty()) of the container when needed.
ReadOnlyDoubleProperty	maxHScrollProperty()	Specifies the maximum possible horizontal position.
ReadOnlyDoubleProperty	maxVScrollProperty()	Specifies the maximum possible vertical position.
ReadOnlyObjectProperty<io.github.palexdev.mfxcore.base.beans.Position>	viewportPositionProperty()	Cells are actually contained in a separate pane called 'viewport'.
ReadOnlyDoubleProperty	virtualMaxXProperty()	Specifies the total number of pixels on the x-axis.
ReadOnlyDoubleProperty	virtualMaxYProperty()	Specifies the total number of pixels on the y-axis.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.palexdev.virtualizedfx.base.VFXContainerHelper

getMaxHScroll, getMaxVScroll, getViewportPosition, getVirtualMaxX, getVirtualMaxY, indexToItem, invalidatePos

Property Details

virtualMaxX

public ReadOnlyDoubleProperty virtualMaxXProperty

Specified by:

virtualMaxXProperty in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the virtualMaxX property

See Also:

• virtualMaxXProperty()

virtualMaxY

public ReadOnlyDoubleProperty virtualMaxYProperty

Specified by:

virtualMaxYProperty in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the virtualMaxY property

See Also:

• virtualMaxYProperty()

maxVScroll

public ReadOnlyDoubleProperty maxVScrollProperty

Specified by:

maxVScrollProperty in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the maxVScroll property

See Also:

• maxVScrollProperty()

maxHScroll

public ReadOnlyDoubleProperty maxHScrollProperty

Specified by:

maxHScrollProperty in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the maxHScroll property

See Also:

• maxHScrollProperty()

viewportPosition

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

Specified by:

viewportPositionProperty in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the viewportPosition property

See Also:

• viewportPositionProperty()

Field Details

container

protected C extends Region & VFXContainer<T> container

virtualMaxX

protected final ReadOnlyDoubleWrapper virtualMaxX

vmxBinding

protected DoubleBinding vmxBinding

virtualMaxY

protected final ReadOnlyDoubleWrapper virtualMaxY

vmyBinding

protected DoubleBinding vmyBinding

maxVScroll

protected final ReadOnlyDoubleWrapper maxVScroll

maxHScroll

protected final ReadOnlyDoubleWrapper maxHScroll

viewportPosition

protected final io.github.palexdev.mfxcore.base.properties.PositionProperty viewportPosition

Constructor Details

VFXContainerHelperBase

protected VFXContainerHelperBase(C container)

Method Details

createBindings

protected void createBindings()

createVirtualMaxXBinding

protected abstract DoubleBinding createVirtualMaxXBinding()

Implementations should use this build and return the DoubleBinding with the appropriate dependencies responsible for the virtualMaxXProperty()'s value.

createVirtualMaxYBinding

protected abstract DoubleBinding createVirtualMaxYBinding()

Implementations should use this build and return the DoubleBinding with the appropriate dependencies responsible for the virtualMaxXProperty()'s value.

createMaxVScrollBinding

protected DoubleBinding createMaxVScrollBinding()

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

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

The formula may vary for some containers!

createMaxHScrollBinding

protected DoubleBinding createMaxHScrollBinding()

Builds and returns the binding which computes the maxHScrollProperty()'s value.

For most containers the value is given by: virtualMaxX - containerWidth.

The formula may vary for some containers!

virtualMaxXProperty

public ReadOnlyDoubleProperty virtualMaxXProperty()

Description copied from interface: VFXContainerHelper

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

Specified by:

virtualMaxXProperty in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the virtualMaxX property

See Also:

• VFXContainerHelper.getVirtualMaxX()

virtualMaxYProperty

public ReadOnlyDoubleProperty virtualMaxYProperty()

Description copied from interface: VFXContainerHelper

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

Specified by:

virtualMaxYProperty in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the virtualMaxY property

See Also:

• VFXContainerHelper.getVirtualMaxY()

maxVScrollProperty

public ReadOnlyDoubleProperty maxVScrollProperty()

Description copied from interface: VFXContainerHelper

Specifies the maximum possible vertical position.

Specified by:

maxVScrollProperty in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the maxVScroll property

See Also:

• VFXContainerHelper.getMaxVScroll()

maxHScrollProperty

public ReadOnlyDoubleProperty maxHScrollProperty()

Description copied from interface: VFXContainerHelper

Specifies the maximum possible horizontal position.

Specified by:

maxHScrollProperty in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the maxHScroll property

See Also:

• VFXContainerHelper.getMaxHScroll()

viewportPositionProperty

public 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, C extends Region & VFXContainer<T>>

Returns:

the viewportPosition property

See Also:

• VFXContainerHelper.getViewportPosition()

getContainer

public C getContainer()

Specified by:

getContainer in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

Returns:

the VFXContainer implementation instance associated to this helper

invalidateVirtualSizes

public void invalidateVirtualSizes()

Description copied from interface: VFXContainerHelper

Implementations should define the logic to manually invalidate the virtual sizes (VFXContainerHelper.virtualMaxXProperty() and VFXContainerHelper.virtualMaxYProperty()) of the container when needed.

There are exceptional cases where we can't rely on automatic invalidation because it could lead to incorrect states, the easiest and most stable solution for those is manual invalidation.

Specified by:

invalidateVirtualSizes in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>

dispose

public void dispose()

Description copied from interface: VFXContainerHelper

If the helper uses listeners/bindings that may lead to memory leaks, this is the right place to remove them.

Specified by:

dispose in interface VFXContainerHelper<T, C extends Region & VFXContainer<T>>