io.github.palexdev.virtualizedfx.table.defaults.VFXDefaultTableColumnSkin Maven / Gradle / Ivy
/*
* 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
* The layout is simple, there are at max three nodes.
*
- a {@link BoundLabel} to show the column's text
*
- a generic {@link Node} specified by the column's {@link VFXTableColumn#graphicProperty()}. It is highly recommended
* to use this "slot" just for icons
*
- a {@link Region} called 'overlay' which can be used to indicate selection, hovering or other states for the column.
* This region can be selected in CSS by the selector '.overlay'.
*
* See also: {@link VFXDefaultTableColumn#enableOverlayProperty()}, {@link VFXDefaultTableColumn#overlayOnHeaderProperty()}.
*
* There are three ways to arrange the text and the 'icon' as specified by the {@link VFXDefaultTableColumn#iconAlignmentProperty()}.
* For {@link HPos#LEFT} and {@link HPos#RIGHT}, the 'icon' is going to be placed to the left and right respectively of the
* label. For {@link HPos#CENTER} only the 'icon' will be visible at the center of the area, the label will be hidden.
*/
public class VFXDefaultTableColumnSkin> extends SkinBase, VFXTableColumnBehavior> {
//================================================================================
// Properties
//================================================================================
private final BoundLabel label;
private final Region overlay;
private final TextMeasurementCache tmc;
//================================================================================
// Constructors
//================================================================================
public VFXDefaultTableColumnSkin(VFXDefaultTableColumn column) {
super(column);
// Init text node
label = new BoundLabel(column);
label.graphicProperty().unbind();
label.setGraphic(null);
label.setMaxSize(Double.MAX_VALUE, Double.MAX_VALUE);
tmc = new TextMeasurementCache(column);
// Init overlay
overlay = new Region();
overlay.getStyleClass().add("overlay");
overlay.setManaged(false);
// Finalize initialization
addListeners();
getChildren().addAll(label, overlay);
}
//================================================================================
// Methods
//================================================================================
/**
* Adds listeners to the following component's properties.
* - Listener on the {@link VFXTableColumn#graphicProperty()} to call {@link #handleIcon(Node, Node)} when it changes,
* this is also called at init time by using {@link When#executeNow()}
*
- Listener on the {@link VFXDefaultTableColumn#iconAlignmentProperty()} to update the layout when it changes
*
- Listener on the {@link VFXTableColumn#gestureResizableProperty()} to enable or disable the feature by calling
* {@link VFXTableColumnBehavior#onResizableChanged()}; this is also called at init time by using {@link When#executeNow()}
*/
private void addListeners() {
VFXDefaultTableColumn column = getColumn();
listeners(
onChanged(column.graphicProperty())
.then(this::handleIcon)
.executeNow(),
onInvalidated(column.iconAlignmentProperty())
.then(a -> column.requestLayout()),
onInvalidated(column.gestureResizableProperty())
.then(r -> getBehavior().onResizableChanged())
);
}
/**
* Simply removed the old icon from the children list and adds the new one (after {@code null} checks ofc).
*/
protected void handleIcon(Node oldIcon, Node newIcon) {
if (oldIcon != null) getChildren().remove(oldIcon);
if (newIcon != null) getChildren().addFirst(newIcon);
}
/**
* Convenience method to cast {@link #getSkinnable()} to {@link VFXDefaultTableColumn}.
*/
protected VFXDefaultTableColumn getColumn() {
return (VFXDefaultTableColumn) getSkinnable();
}
//================================================================================
// Overridden Methods
//================================================================================
@Override
protected void initBehavior(VFXTableColumnBehavior behavior) {
behavior.init();
}
@Override
protected double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) {
VFXTableColumn column = getSkinnable();
Node icon = column.getGraphic();
return leftInset +
((icon != null) ? LayoutUtils.boundWidth(icon) + column.getGraphicTextGap() : 0.0) +
tmc.getSnappedWidth() +
rightInset;
}
@Override
protected void layoutChildren(double x, double y, double w, double h) {
VFXDefaultTableColumn column = getColumn();
Node icon = column.getGraphic();
HPos ia = column.getIconAlignment();
double gap = column.getGraphicTextGap();
double iw = 0;
if (icon != null) {
switch (ia) {
case LEFT -> layoutInArea(icon, x, y, w, h, 0, HPos.LEFT, VPos.CENTER);
case CENTER -> layoutInArea(icon, x, y, w, h, 0, HPos.CENTER, VPos.CENTER);
case RIGHT -> layoutInArea(icon, x, y, w, h, 0, HPos.RIGHT, VPos.CENTER);
}
iw = icon.getLayoutBounds().getWidth();
}
switch (ia) {
case LEFT -> {
layoutInArea(label, x + gap + iw + snappedLeftInset(), y, w - iw - gap, h, 0, HPos.LEFT, VPos.CENTER);
label.setVisible(true);
}
case CENTER -> label.setVisible(false);
case RIGHT -> {
layoutInArea(label, x, y, w, h, 0, HPos.LEFT, VPos.CENTER);
label.setVisible(true);
}
}
// Overlay layout
VFXTable table = column.getTable();
double oW = snappedRightInset() + w + snappedLeftInset();
double oH = (table != null) ? table.getHeight() : 0.0;
double oY = (column.isOverlayOnHeader()) ? 0.0 : h;
overlay.resizeRelocate(0.0, oY, oW, oH);
}
}