org.fxmisc.flowless.ScaledVirtualized 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.scene.Node;
import javafx.scene.layout.Region;
import javafx.scene.transform.Scale;
import org.reactfx.value.Val;
import org.reactfx.value.Var;

/**
 * Acts as an intermediate class between {@link VirtualizedScrollPane} and
 * its {@link Virtualized} content in that it scales the content without
 * also scaling the ScrollPane's scroll bars.
 *  *     {@code
 *     Virtualized actualContent = // creation code
 *     ScaledVirtualized wrapper = new ScaledVirtualized(actualContent);
 *     VirtualizedScrollPane vsPane = new VirtualizedScrollPane(wrapper);
 *
 *     // To scale actualContent without also scaling vsPane's scrollbars:
 *     wrapper.scaleProperty().setY(3);
 *     wrapper.scaleProperty().setX(2);
 *     }
 * 
 *
 * @param  the {@link Virtualized} content to be scaled when inside a {@link VirtualizedScrollPane}
 */
public class ScaledVirtualized extends Region implements Virtualized {
    private final V content;
    private Scale zoom = new Scale();

    private Val estHeight;
    private Val estWidth;
    private Var estScrollX;
    private Var estScrollY;

    public ScaledVirtualized(V content) {
        super();
        this.content = content;
        getChildren().add(content);
        getTransforms().add(zoom);

        estHeight = Val.combine(
                content.totalHeightEstimateProperty(),
                zoom.yProperty(),
                (estHeight, scaleFactor) -> estHeight * scaleFactor.doubleValue()
        );
        estWidth = Val.combine(
                content.totalWidthEstimateProperty(),
                zoom.xProperty(),
                (estWidth, scaleFactor) -> estWidth * scaleFactor.doubleValue()
        );
        estScrollX = Var.mapBidirectional(
                content.estimatedScrollXProperty(),
                scrollX -> scrollX * zoom.getX(),
                scrollX -> scrollX / zoom.getX()
        );
        estScrollY = Var.mapBidirectional(
                content.estimatedScrollYProperty(),
                scrollY -> scrollY * zoom.getY(),
                scrollY -> scrollY / zoom.getY()
        );

        zoom.xProperty()     .addListener((obs, ov, nv) -> requestLayout());
        zoom.yProperty()     .addListener((obs, ov, nv) -> requestLayout());
        zoom.zProperty()     .addListener((obs, ov, nv) -> requestLayout());
        zoom.pivotXProperty().addListener((obs, ov, nv) -> requestLayout());
        zoom.pivotYProperty().addListener((obs, ov, nv) -> requestLayout());
        zoom.pivotZProperty().addListener((obs, ov, nv) -> requestLayout());
    }

    @Override
    protected void layoutChildren() {
        double width = getLayoutBounds().getWidth();
        double height = getLayoutBounds().getHeight();
        content.resize(width / zoom.getX(), height/ zoom.getY());
    }

    @Override
    public Var estimatedScrollXProperty() {
        return estScrollX;
    }

    @Override
    public Var estimatedScrollYProperty() {
        return estScrollY;
    }

    @Override
    public Val totalHeightEstimateProperty() {
        return estHeight;
    }

    @Override
    public Val totalWidthEstimateProperty() {
        return estWidth;
    }

    @Override
    public void scrollXBy(double deltaX) {
        content.scrollXBy(deltaX);
    }

    @Override
    public void scrollYBy(double deltaY) {
        content.scrollYBy(deltaY);
    }

    @Override
    public void scrollXToPixel(double pixel) {
        content.scrollXToPixel(pixel);
    }

    @Override
    public void scrollYToPixel(double pixel) {
        content.scrollYToPixel(pixel);
    }

    /**
     * The {@link Scale} object that scales the virtualized content: named "zoom"
     * to prevent confusion with {@link Node#getScaleX()}, etc. Not to be confused
     * with {@link Node#getOnZoom()} or similar methods/objects.
     */
    public Scale getZoom() {
        return zoom;
    }
}