io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin Maven / Gradle / Ivy
Show all versions of virtualizedfx Show documentation
/*
* Copyright (C) 2024 Parisi Alessandro - [email protected]
* This file is part of VirtualizedFX (https://github.com/palexdev/VirtualizedFX)
*
* VirtualizedFX is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3 of the License,
* or (at your option) any later version.
*
* VirtualizedFX is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with VirtualizedFX. If not, see
* There's not much going on here, just the bare minimum to get the paginated variant work as intended.
*
* First of all, the list position is bound to the current page specified by {@link VFXPaginatedList#pageProperty()}.
* Only the position that is the same as the current orientation is bound. When the orientation changes, the binding is
* swapped by {@link #swapPositionBinding()}. Also, there are a couple of extra listeners, {@link #addListeners()}.
*
* As for the layout, the only thing that changes is that the container's size will adapt to the cell size and the number
* of cells per page, the exact computation is described and done by {@link #getLength()}.
*/
public class VFXPaginatedListSkin> extends VFXListSkin {
//================================================================================
// Properties
//================================================================================
protected DoubleBinding posBinding;
//================================================================================
// Constructors
//================================================================================
public VFXPaginatedListSkin(VFXPaginatedList list) {
super(list);
// Init pos binding
posBinding = DoubleBindingBuilder.build()
.setMapper(() -> list.getPage() * list.getCellsPerPage() * (list.getCellSize() + list.getSpacing()))
.addSources(list.pageProperty(), list.cellsPerPageProperty(), list.cellSizeProperty(), list.spacingProperty())
.get();
swapPositionBinding();
}
//================================================================================
// Methods
//================================================================================
/**
* Responsible for swapping the position's binding when the orientation changes. Since the base skin uses a similar
* mechanism for the scroll, this is called in the {@link #swapPositionListener()} method.
*/
protected void swapPositionBinding() {
if (posBinding == null) return;
VFXList list = getSkinnable();
Orientation o = list.getOrientation();
if (o == Orientation.VERTICAL) {
list.hPosProperty().unbind();
list.vPosProperty().bind(posBinding);
} else {
list.vPosProperty().unbind();
list.hPosProperty().bind(posBinding);
}
}
/**
* Computes the length the container should have, according to the following three properties:
* - {@link VFXPaginatedList#cellsPerPageProperty()}
*
- {@link VFXPaginatedList#cellSizeProperty()}
*
- {@link VFXPaginatedList#spacingProperty()}
*
* The formula is as follows: {@code (cellsPerPage * (cellSize + spacing)) - spacing}.
*
* The result is enforced by the 'compute min/pref/max width/height' methods defined by {@link SkinBase} and overridden here.
* Note that only the methods relative to the current orientation (VERTICAL -> height / HORIZONTAL -> width) will use
* the resulting value. Which means that the size in the opposite direction can be changed as preferred.
*/
protected final double getLength() {
VFXPaginatedList list = getList();
return (list.getCellsPerPage() * (list.getCellSize() + list.getSpacing())) - list.getSpacing();
}
/**
* Convenience method to cast {@link #getSkinnable()} to {@link VFXPaginatedList}.
*/
protected VFXPaginatedList getList() {
return (VFXPaginatedList) getSkinnable();
}
//================================================================================
// Overridden Methods
//================================================================================
/**
* {@inheritDoc}
*
* For the paginated variant there are the following additional listeners:
* - Listener on {@link VFXPaginatedList#cellsPerPageProperty()}, will invoke {@link VFXPaginatedListManager#onCellsPerPageChanged()}
*
- Listener on {@link VFXPaginatedList#maxPageProperty()}, will invoke {@link VFXPaginatedListManager#onMaxPageChanged()}
*/
@Override
protected void addListeners() {
VFXPaginatedList list = getList();
super.addListeners();
listeners(
When.onInvalidated(list.cellsPerPageProperty())
.then(cpp -> getBehavior().onCellsPerPageChanged()),
When.onInvalidated(list.maxPageProperty())
.then(mp -> getBehavior().onMaxPageChanged())
);
}
/**
* {@inheritDoc}
*
* Overridden to also call {@link #swapPositionBinding()}.
*/
@Override
protected void swapPositionListener() {
super.swapPositionListener();
swapPositionBinding();
}
/**
* Overridden to cast the behavior to {@link VFXPaginatedListManager}.
*
* Since {@link VFXPaginatedList} extends {@link VFXList} nothing prevents the user from using behaviors of type
* {@link VFXListManager}, but that would result in exceptions being thrown and invalid states.
* Long story short: don't do it!
*/
@Override
protected VFXPaginatedListManager getBehavior() {
return (VFXPaginatedListManager) super.getBehavior();
}
@Override
protected double computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) {
Orientation o = getSkinnable().getOrientation();
if (o == Orientation.HORIZONTAL) return getLength();
return super.computeMinWidth(height, topInset, rightInset, bottomInset, leftInset);
}
@Override
protected double computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) {
Orientation o = getSkinnable().getOrientation();
if (o == Orientation.VERTICAL) return getLength();
return super.computeMinHeight(width, topInset, rightInset, bottomInset, leftInset);
}
@Override
protected double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) {
Orientation o = getSkinnable().getOrientation();
if (o == Orientation.HORIZONTAL) return getLength();
return super.computePrefWidth(height, topInset, rightInset, bottomInset, leftInset);
}
@Override
protected double computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) {
Orientation o = getSkinnable().getOrientation();
if (o == Orientation.VERTICAL) return getLength();
return super.computePrefHeight(width, topInset, rightInset, bottomInset, leftInset);
}
@Override
protected double computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) {
Orientation o = getSkinnable().getOrientation();
if (o == Orientation.HORIZONTAL) return getLength();
return super.computeMaxWidth(height, topInset, rightInset, bottomInset, leftInset);
}
@Override
protected double computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) {
Orientation o = getSkinnable().getOrientation();
if (o == Orientation.VERTICAL) return getLength();
return super.computeMaxHeight(width, topInset, rightInset, bottomInset, leftInset);
}
}