ImageTag.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2019 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.autopsy.contentviewers.imagetagging;

import com.sun.javafx.event.EventDispatchChainImpl;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import javafx.collections.ListChangeListener;
import javafx.scene.Cursor;
import javafx.scene.Group;
import javafx.scene.Node;
import javafx.scene.control.Tooltip;
import javafx.scene.image.ImageView;
import javafx.scene.input.MouseEvent;
import javafx.scene.paint.Color;
import javafx.scene.shape.Circle;
import javafx.scene.shape.Rectangle;
import org.sleuthkit.autopsy.casemodule.services.contentviewertags.ContentViewerTagManager.ContentViewerTag;

public final class ImageTag extends Group {

    // Used to tell the 8 edit handles to hide if this tag is no longer selected
    private final EventDispatchChainImpl ALL_CHILDREN;
    
    //Notifies listeners that the user has editted the tag boundaries
    private final PropertyChangeSupport pcs = new PropertyChangeSupport(this);
    
    //The underlying presistent tag details that this image tag originates from
    private final ContentViewerTag<ImageTagRegion> appTag;

    public ImageTag(ContentViewerTag<ImageTagRegion> contentViewerTag, ImageView image) {
        ALL_CHILDREN = new EventDispatchChainImpl();
        this.appTag = contentViewerTag;

        this.getChildren().addListener((ListChangeListener<Node>) change -> {
            change.next();
            change.getAddedSubList().forEach((node) -> ALL_CHILDREN.append(node.getEventDispatcher()));
        });

        ImageTagRegion details = contentViewerTag.getDetails();
        PhysicalTag physicalTag = new PhysicalTag(details);

        //Defines the max allowable boundary that a user may drag any given handle.
        Boundary dragBoundary = (x, y) -> {
            double boundingX = image.getX();
            double boundingY = image.getY();
            double width = image.getImage().getWidth();
            double height = image.getImage().getHeight();

            return x > boundingX + details.getStrokeThickness() / 2
                    && x < boundingX + width - details.getStrokeThickness() / 2
                    && y > boundingY + details.getStrokeThickness() / 2
                    && y < boundingY + height - details.getStrokeThickness() / 2;
        };

        EditHandle bottomLeft = new EditHandle(physicalTag)
                .setPosition(Position.bottom(), Position.left())
                .setDrag(dragBoundary, Draggable.bottom(), Draggable.left());

        EditHandle bottomRight = new EditHandle(physicalTag)
                .setPosition(Position.bottom(), Position.right())
                .setDrag(dragBoundary, Draggable.bottom(), Draggable.right());

        EditHandle topLeft = new EditHandle(physicalTag)
                .setPosition(Position.top(), Position.left())
                .setDrag(dragBoundary, Draggable.top(), Draggable.left());

        EditHandle topRight = new EditHandle(physicalTag)
                .setPosition(Position.top(), Position.right())
                .setDrag(dragBoundary, Draggable.top(), Draggable.right());

        EditHandle bottomMiddle = new EditHandle(physicalTag)
                .setPosition(Position.bottom(), Position.xMiddle())
                .setDrag(dragBoundary, Draggable.bottom());

        EditHandle topMiddle = new EditHandle(physicalTag)
                .setPosition(Position.top(), Position.xMiddle())
                .setDrag(dragBoundary, Draggable.top());

        EditHandle rightMiddle = new EditHandle(physicalTag)
                .setPosition(Position.right(), Position.yMiddle())
                .setDrag(dragBoundary, Draggable.right());

        EditHandle leftMiddle = new EditHandle(physicalTag)
                .setPosition(Position.left(), Position.yMiddle())
                .setDrag(dragBoundary, Draggable.left());

        //The "logical" tag is the Group
        this.getChildren().addAll(physicalTag, bottomLeft, bottomRight, topLeft,
                topRight, bottomMiddle, topMiddle, rightMiddle, leftMiddle);

        Tooltip.install(this, new Tooltip(contentViewerTag.getContentTag()
                .getName().getDisplayName()));

        this.addEventHandler(ImageTagControls.NOT_FOCUSED, event -> ALL_CHILDREN.dispatchEvent(event));
        this.addEventHandler(ImageTagControls.FOCUSED, event -> ALL_CHILDREN.dispatchEvent(event));
    }

    public void subscribeToEditEvents(PropertyChangeListener listener) {
        pcs.addPropertyChangeListener(listener);
    }

    public ContentViewerTag<ImageTagRegion> getContentViewerTag() {
        return appTag;
    }

    class PhysicalTag extends Rectangle {

        public PhysicalTag(ImageTagRegion details) {
            this.setStroke(Color.RED);
            this.setFill(Color.RED.deriveColor(0, 0, 0, 0));
            this.setStrokeWidth(details.getStrokeThickness());

            setX(details.getX());
            setY(details.getY());
            setWidth(details.getWidth());
            setHeight(details.getHeight());

            this.addEventHandler(ImageTagControls.NOT_FOCUSED, event -> this.setOpacity(1));
            this.addEventHandler(ImageTagControls.FOCUSED, event -> this.setOpacity(0.5));
        }

        public ImageTagRegion getState() {
            return new ImageTagRegion()
                    .setX(this.getX())
                    .setY(this.getY())
                    .setWidth(this.getWidth())
                    .setHeight(this.getHeight())
                    .setStrokeThickness(this.getStrokeWidth());
        }
    }

    class EditHandle extends Circle {

        private final PhysicalTag parent;

        public EditHandle(PhysicalTag parent) {
            this.setVisible(false);

            //Hide when the tag is not selected.
            this.addEventHandler(ImageTagControls.NOT_FOCUSED, event -> this.setVisible(false));
            this.addEventHandler(ImageTagControls.FOCUSED, event -> this.setVisible(true));

            this.setRadius(parent.getStrokeWidth());
            this.setFill(parent.getStroke());

            this.setOnDragDetected(event -> {
                this.getParent().setCursor(Cursor.CLOSED_HAND);
            });

            this.setOnMouseReleased(event -> {
                this.getParent().setCursor(Cursor.DEFAULT);
                pcs.firePropertyChange(new PropertyChangeEvent(this, "Tag Edit", null, parent.getState()));
            });

            this.parent = parent;
        }

        public EditHandle setPosition(Position... vals) {
            for (Position pos : vals) {
                parent.widthProperty().addListener((obs, oldVal, newVal) -> pos.set(parent, this));
                parent.heightProperty().addListener((obs, oldVal, newVal) -> pos.set(parent, this));
                pos.set(parent, this);
            }
            return this;
        }

        public EditHandle setDrag(Boundary bounds, Draggable... vals) {
            this.setOnMouseDragged((event) -> {
                for (Draggable drag : vals) {
                    drag.perform(parent, event, bounds);
                }
            });
            return this;
        }
    }

    static interface Position {

        void set(PhysicalTag parent, Circle knob);

        static Position left() {
            return (parent, knob) -> knob.centerXProperty().bind(parent.xProperty());
        }

        static Position right() {
            return (parent, knob) -> knob.centerXProperty().bind(parent.xProperty().add(parent.getWidth()));
        }

        static Position top() {
            return (parent, knob) -> knob.centerYProperty().bind(parent.yProperty());
        }

        static Position bottom() {
            return (parent, knob) -> knob.centerYProperty().bind(parent.yProperty().add(parent.getHeight()));
        }

        static Position xMiddle() {
            return (parent, knob) -> knob.centerXProperty().bind(parent.xProperty().add(parent.getWidth() / 2));
        }

        static Position yMiddle() {
            return (parent, knob) -> knob.centerYProperty().bind(parent.yProperty().add(parent.getHeight() / 2));
        }
    }

    @FunctionalInterface
    static interface Boundary {

        boolean isPointInBounds(double x, double y);
    }

    static interface Draggable {

        void perform(PhysicalTag parent, MouseEvent event, Boundary b);

        static Draggable bottom() {
            return (parent, event, bounds) -> {
                if (!bounds.isPointInBounds(event.getX(), event.getY())) {
                    return;
                }

                double deltaY = event.getY() - parent.getY();
                if (deltaY > 0) {
                    parent.setHeight(deltaY);
                }
            };
        }

        static Draggable top() {
            return (parent, event, bounds) -> {
                if (!bounds.isPointInBounds(event.getX(), event.getY())) {
                    return;
                }

                double deltaY = parent.getY() + parent.getHeight() - event.getY();
                if (deltaY < parent.getY() + parent.getHeight() && deltaY > 0) {
                    parent.setHeight(deltaY);
                    parent.setY(event.getY());
                }
            };
        }

        static Draggable left() {
            return (parent, event, bounds) -> {
                if (!bounds.isPointInBounds(event.getX(), event.getY())) {
                    return;
                }

                double deltaX = parent.getX() + parent.getWidth() - event.getX();
                if (deltaX < parent.getX() + parent.getWidth() && deltaX > 0) {
                    parent.setWidth(deltaX);
                    parent.setX(event.getX());
                }
            };
        }

        static Draggable right() {
            return (parent, event, bounds) -> {
                if (!bounds.isPointInBounds(event.getX(), event.getY())) {
                    return;
                }

                double deltaX = event.getX() - parent.getX();
                if (deltaX > 0) {
                    parent.setWidth(deltaX);
                }
            };
        }
    }
}