Module VirtualizedFX

Package io.github.palexdev.virtualizedfx.flow.paginated

Class PaginatedHelper.PaginatedVerticalHelper

java.lang.Object

io.github.palexdev.virtualizedfx.flow.OrientationHelper.AbstractOrientationHelper

io.github.palexdev.virtualizedfx.flow.OrientationHelper.VerticalHelper

io.github.palexdev.virtualizedfx.flow.paginated.PaginatedHelper.PaginatedVerticalHelper

All Implemented Interfaces:

OrientationHelper, PaginatedHelper

Enclosing interface:

PaginatedHelper

public static class PaginatedHelper.PaginatedVerticalHelper
extends OrientationHelper.VerticalHelper
implements PaginatedHelper

Concrete implementation of PaginatedHelper to be used with PaginatedVirtualFlow when its VirtualFlow.orientationProperty() is VERTICAL, extends OrientationHelper.VerticalHelper.

Property Summary

Properties inherited from class io.github.palexdev.virtualizedfx.flow.OrientationHelper.AbstractOrientationHelper

estimatedLength, maxBreadth

Properties inherited from interface io.github.palexdev.virtualizedfx.flow.OrientationHelper

estimatedLength, maxBreadth

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.palexdev.virtualizedfx.flow.OrientationHelper

OrientationHelper.AbstractOrientationHelper, OrientationHelper.HorizontalHelper, OrientationHelper.VerticalHelper

Nested classes/interfaces inherited from interface io.github.palexdev.virtualizedfx.flow.paginated.PaginatedHelper

PaginatedHelper.PaginatedHorizontalHelper, PaginatedHelper.PaginatedVerticalHelper

Field Summary

Fields

Modifier and Type	Field	Description
protected PaginatedVirtualFlow<?,?>	pFlow

Fields inherited from class io.github.palexdev.virtualizedfx.flow.OrientationHelper.AbstractOrientationHelper

estimatedLength, manager, maxBreadth, virtualFlow

Constructor Summary

Constructors

Constructor	Description
PaginatedVerticalHelper(PaginatedVirtualFlow<?,?> virtualFlow)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes bindings/listeners that are not required anymore, for example when changing orientation and helper as well, the old is disposed.
void	goToPage(int page)	Scrolls the viewport to the desired page.
int	maxCells()
double	maxVScroll()	Overridden to return the pixel position of the last page.
double	pageToPos(int page)	Converts the given page number to the corresponding position in pixels.
void	scrollBy(double pixels)	This is unsupported as the PaginatedVirtualFlow can only scroll to certain pixel values, given by the pages.
void	scrollToIndex(int index)	Basically the same as goToPage(int), the index parameter is always clamped between 1 and PaginatedVirtualFlow.maxPageProperty().
void	scrollToPixel(double pixel)	This is unsupported as the PaginatedVirtualFlow can only scroll to certain pixel values, given by the pages.

Methods inherited from class io.github.palexdev.virtualizedfx.flow.OrientationHelper.VerticalHelper

computeBreadth, computeEstimatedLength, firstVisible, invalidatePos, lastVisible, layout, maxHScroll, xPosBinding, yPosBinding

Methods inherited from class io.github.palexdev.virtualizedfx.flow.OrientationHelper.AbstractOrientationHelper

estimatedLengthProperty, maxBreadthProperty

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.flow.OrientationHelper

computeBreadth, computeEstimatedLength, estimatedLengthProperty, firstVisible, invalidatePos, lastVisible, layout, maxBreadthProperty, maxHScroll, xPosBinding, yPosBinding

Field Details

pFlow

protected PaginatedVirtualFlow<?,?> pFlow

Constructor Details

PaginatedVerticalHelper

public PaginatedVerticalHelper(PaginatedVirtualFlow<?,?> virtualFlow)

Method Details

maxCells

public int maxCells()

Overridden to return PaginatedVirtualFlow.cellsPerPageProperty().

Specified by:

maxCells in interface OrientationHelper

Overrides:

maxCells in class OrientationHelper.VerticalHelper

Returns:

the maximum number of cells the viewport can display, this also includes one cell of overscan/buffer

maxVScroll

public double maxVScroll()

Overridden to return the pixel position of the last page.

Specified by:

maxVScroll in interface OrientationHelper

Overrides:

maxVScroll in class OrientationHelper.VerticalHelper

Returns:

the maximum amount of pixels the virtual flow can scroll on the vertical direction

pageToPos

public double pageToPos(int page)

Converts the given page number to the corresponding position in pixels.

This is given by (page - 1) * cellsPerPage * cellSize.

Specified by:

pageToPos in interface PaginatedHelper

goToPage

public void goToPage(int page)

Scrolls the viewport to the desired page.

Implemented to use both pageToPos(int) and scrollToPixel(double).

Specified by:

goToPage in interface PaginatedHelper

scrollBy

public void scrollBy(double pixels)

This is unsupported as the PaginatedVirtualFlow can only scroll to certain pixel values, given by the pages.

Specified by:

scrollBy in interface OrientationHelper

Overrides:

scrollBy in class OrientationHelper.VerticalHelper

Throws:

UnsupportedOperationException

scrollToPixel

public void scrollToPixel(double pixel)

This is unsupported as the PaginatedVirtualFlow can only scroll to certain pixel values, given by the pages.

Specified by:

scrollToPixel in interface OrientationHelper

Overrides:

scrollToPixel in class OrientationHelper.VerticalHelper

Throws:

UnsupportedOperationException

scrollToIndex

public void scrollToIndex(int index)

Basically the same as goToPage(int), the index parameter is always clamped between 1 and PaginatedVirtualFlow.maxPageProperty().

Specified by:

scrollToIndex in interface OrientationHelper

Overrides:

scrollToIndex in class OrientationHelper.VerticalHelper

dispose

public void dispose()

Description copied from interface: OrientationHelper

Disposes bindings/listeners that are not required anymore, for example when changing orientation and helper as well, the old is disposed.

Specified by:

dispose in interface OrientationHelper

Overrides:

dispose in class OrientationHelper.VerticalHelper