org.fxmisc.flowless.OrientationHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of richtextfx Show documentation
FX-Text-Area for formatted text and other special effects.
There is a newer version: 1.11
package org.fxmisc.flowless;

import javafx.beans.property.DoubleProperty;
import javafx.geometry.Bounds;
import javafx.geometry.Orientation;
import javafx.scene.Node;

import org.reactfx.value.Val;
import org.reactfx.value.Var;

/**
 * Helper class for returning the correct value (should the {@code width} or {@code height} be returned?) or calling
 * the correct method (should {@code setWidth(args)} or {@code setHeight(args)}, so that one one class can be used
 * instead of a generic with two implementations. See its implementations for more details ({@link VerticalHelper}
 * and {@link HorizontalHelper}) on what "layoutX", "layoutY", and "viewport offset" values represent.
 */
interface OrientationHelper {
    Orientation getContentBias();
    double getX(double x, double y);
    double getY(double x, double y);
    double length(Bounds bounds);
    double breadth(Bounds bounds);
    double minX(Bounds bounds);
    double minY(Bounds bounds);
    default double maxX(Bounds bounds) { return minX(bounds) + breadth(bounds); }
    default double maxY(Bounds bounds) { return minY(bounds) + length(bounds); }
    double layoutX(Node node);
    double layoutY(Node node);
    DoubleProperty layoutYProperty(Node node);
    default double length(Node node) { return length(node.getLayoutBounds()); }
    default double breadth(Node node) { return breadth(node.getLayoutBounds()); }
    default Val minYProperty(Node node) {
        return Val.combine(
                layoutYProperty(node),
                node.layoutBoundsProperty(),
                (layoutY, layoutBounds) -> layoutY.doubleValue() + minY(layoutBounds));
    }
    default double minY(Node node) { return layoutY(node) + minY(node.getLayoutBounds()); }
    default double maxY(Node node) { return minY(node) + length(node); }
    default double minX(Node node) { return layoutX(node) + minX(node.getLayoutBounds()); }
    default double maxX(Node node) { return minX(node) + breadth(node); }
    default double length(Cell cell) { return length(cell.getNode()); }
    default double breadth(Cell cell) { return breadth(cell.getNode()); }
    default Val minYProperty(Cell cell) { return minYProperty(cell.getNode()); }
    default double minY(Cell cell) { return minY(cell.getNode()); }
    default double maxY(Cell cell) { return maxY(cell.getNode()); }
    default double minX(Cell cell) { return minX(cell.getNode()); }
    default double maxX(Cell cell) { return maxX(cell.getNode()); }
    double minBreadth(Node node);
    default double minBreadth(Cell cell) { return minBreadth(cell.getNode()); }
    double prefBreadth(Node node);
    double prefLength(Node node, double breadth);
    default double prefLength(Cell cell, double breadth) { return prefLength(cell.getNode(), breadth); }
    void resizeRelocate(Node node, double b0, double l0, double breadth, double length);
    void resize(Node node, double breadth, double length);
    void relocate(Node node, double b0, double l0);
    default void resize(Cell cell, double breadth, double length) { resize(cell.getNode(), breadth, length); }
    default void relocate(Cell cell, double b0, double l0) { relocate(cell.getNode(), b0, l0); }

    Val widthEstimateProperty(VirtualFlow content);
    Val heightEstimateProperty(VirtualFlow content);
    Var estimatedScrollXProperty(VirtualFlow content);
    Var estimatedScrollYProperty(VirtualFlow content);

    void scrollHorizontallyBy(VirtualFlow content, double dx);
    void scrollVerticallyBy(VirtualFlow content, double dy);
    void scrollHorizontallyToPixel(VirtualFlow content, double pixel);
    void scrollVerticallyToPixel(VirtualFlow content, double pixel);

    > VirtualFlowHit hitBeforeCells(double bOff, double lOff);
    > VirtualFlowHit hitAfterCells(double bOff, double lOff);
    > VirtualFlowHit cellHit(int itemIndex, C cell, double bOff, double lOff);
}

/**
 * Implementation of {@link OrientationHelper} where {@code length} represents width of the node/viewport and
 * {@code breadth} represents the height of the node/viewport. "layoutY" is {@link javafx.scene.Node#layoutX} and
 * "layoutX" is {@link javafx.scene.Node#layoutY}. "viewport offset" values are based on width. The viewport's "top"
 * and "bottom" edges are either it's left/right edges (See {@link org.fxmisc.flowless.VirtualFlow.Gravity}).
 */
final class HorizontalHelper implements OrientationHelper {

    @Override
    public Orientation getContentBias() {
        return Orientation.VERTICAL;
    }

    @Override
    public double getX(double x, double y) {
        return y;
    }

    @Override
    public double getY(double x, double y) {
        return x;
    }

    @Override
    public double minBreadth(Node node) {
        return node.minHeight(-1);
    }

    @Override
    public double prefBreadth(Node node) {
        return node.prefHeight(-1);
    }

    @Override
    public double prefLength(Node node, double breadth) {
        return node.prefWidth(breadth);
    }

    @Override
    public double breadth(Bounds bounds) {
        return bounds.getHeight();
    }

    @Override
    public double length(Bounds bounds) {
        return bounds.getWidth();
    }

    @Override
    public double minX(Bounds bounds) {
        return bounds.getMinY();
    }

    @Override
    public double minY(Bounds bounds) {
        return bounds.getMinX();
    }

    @Override
    public double layoutX(Node node) {
        return node.getLayoutY();
    }

    @Override
    public double layoutY(Node node) {
        return node.getLayoutX();
    }

    @Override
    public DoubleProperty layoutYProperty(Node node) {
        return node.layoutXProperty();
    }

    @Override
    public void resizeRelocate(
            Node node, double b0, double l0, double breadth, double length) {
        node.resizeRelocate(l0, b0, length, breadth);
    }

    @Override
    public void resize(Node node, double breadth, double length) {
        node.resize(length, breadth);
    }

    @Override
    public void relocate(Node node, double b0, double l0) {
        node.relocate(l0, b0);
    }

    @Override
    public Val widthEstimateProperty(
            VirtualFlow content) {
        return content.totalLengthEstimateProperty();
    }

    @Override
    public Val heightEstimateProperty(
            VirtualFlow content) {
        return content.totalBreadthEstimateProperty();
    }

    @Override
    public Var estimatedScrollXProperty(
            VirtualFlow content) {
        return content.lengthOffsetEstimateProperty();
    }

    @Override
    public Var estimatedScrollYProperty(
            VirtualFlow content) {
        return content.breadthOffsetProperty();
    }

    @Override
    public void scrollHorizontallyBy(VirtualFlow content, double dx) {
        content.scrollLength(dx);
    }

    @Override
    public void scrollVerticallyBy(VirtualFlow content, double dy) {
        content.scrollBreadth(dy);
    }

    @Override
    public void scrollHorizontallyToPixel(VirtualFlow content, double pixel) {
        content.setLengthOffset(pixel);
    }

    @Override
    public void scrollVerticallyToPixel(VirtualFlow content, double pixel) {
        content.setBreadthOffset(pixel);
    }

    @Override
    public > VirtualFlowHit hitBeforeCells(
            double bOff, double lOff) {
        return VirtualFlowHit.hitBeforeCells(lOff, bOff);
    }

    @Override
    public > VirtualFlowHit hitAfterCells(
            double bOff, double lOff) {
        return VirtualFlowHit.hitAfterCells(lOff, bOff);
    }

    @Override
    public > VirtualFlowHit cellHit(
            int itemIndex, C cell, double bOff, double lOff) {
        return VirtualFlowHit.cellHit(itemIndex, cell, lOff, bOff);
    }
}

/**
 * Implementation of {@link OrientationHelper} where {@code breadth} represents width of the node/viewport and
 * {@code length} represents the height of the node/viewport. "layoutX" is {@link javafx.scene.Node#layoutX} and
 * "layoutY" is {@link javafx.scene.Node#layoutY}. "viewport offset" values are based on height. The viewport's "top"
 * and "bottom" edges are either it's top/bottom edges (See {@link org.fxmisc.flowless.VirtualFlow.Gravity}).
 */
final class VerticalHelper implements OrientationHelper {

    @Override
    public Orientation getContentBias() {
        return Orientation.HORIZONTAL;
    }

    @Override
    public double getX(double x, double y) {
        return x;
    }

    @Override
    public double getY(double x, double y) {
        return y;
    }

    @Override
    public double minBreadth(Node node) {
        return node.minWidth(-1);
    }

    @Override
    public double prefBreadth(Node node) {
        return node.prefWidth(-1);
    }

    @Override
    public double prefLength(Node node, double breadth) {
        return node.prefHeight(breadth);
    }

    @Override
    public double breadth(Bounds bounds) {
        return bounds.getWidth();
    }

    @Override
    public double length(Bounds bounds) {
        return bounds.getHeight();
    }

    @Override
    public double minX(Bounds bounds) {
        return bounds.getMinX();
    }

    @Override
    public double minY(Bounds bounds) {
        return bounds.getMinY();
    }

    @Override
    public double layoutX(Node node) {
        return node.getLayoutX();
    }

    @Override
    public double layoutY(Node node) {
        return node.getLayoutY();
    }

    @Override
    public DoubleProperty layoutYProperty(Node node) {
        return node.layoutYProperty();
    }

    @Override
    public void resizeRelocate(
            Node node, double b0, double l0, double breadth, double length) {
        node.resizeRelocate(b0, l0, breadth, length);
    }

    @Override
    public void resize(Node node, double breadth, double length) {
        node.resize(breadth, length);
    }

    @Override
    public void relocate(Node node, double b0, double l0) {
        node.relocate(b0, l0);
    }

    @Override
    public Val widthEstimateProperty(
            VirtualFlow content) {
        return content.totalBreadthEstimateProperty();
    }

    @Override
    public Val heightEstimateProperty(
            VirtualFlow content) {
        return content.totalLengthEstimateProperty();
    }

    @Override
    public Var estimatedScrollXProperty(
            VirtualFlow content) {
        return content.breadthOffsetProperty();
    }

    @Override
    public Var estimatedScrollYProperty(
            VirtualFlow content) {
        return content.lengthOffsetEstimateProperty();
    }

    @Override
    public void scrollHorizontallyBy(VirtualFlow content, double dx) {
        content.scrollBreadth(dx);
    }

    @Override
    public void scrollVerticallyBy(VirtualFlow content, double dy) {
        content.scrollLength(dy);
    }

    @Override
    public void scrollHorizontallyToPixel(VirtualFlow content, double pixel) {
        content.setBreadthOffset(pixel);
    }

    @Override
    public void scrollVerticallyToPixel(VirtualFlow content, double pixel) { // length
        content.setLengthOffset(pixel);
    }

    @Override
    public > VirtualFlowHit hitBeforeCells(
            double bOff, double lOff) {
        return VirtualFlowHit.hitBeforeCells(bOff, lOff);
    }

    @Override
    public > VirtualFlowHit hitAfterCells(
            double bOff, double lOff) {
        return VirtualFlowHit.hitAfterCells(bOff, lOff);
    }

    @Override
    public > VirtualFlowHit cellHit(
            int itemIndex, C cell, double bOff, double lOff) {
        return VirtualFlowHit.cellHit(itemIndex, cell, bOff, lOff);
    }
}