com.legyver.fenxlib.widgets.filetree.BaseFileExplorer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fenxlib.widgets.filetree Show documentation
FileTree widget for Fenxlib projects
There is a newer version: 3.0.2
Show newest version
package com.legyver.fenxlib.widgets.filetree;

import com.legyver.fenxlib.core.api.util.GuidUtil;
import com.legyver.fenxlib.extensions.tuktukfx.task.adapter.JavaFxAdapter;
import com.legyver.fenxlib.extensions.tuktukfx.task.exec.TaskExecutor;
import com.legyver.fenxlib.widgets.filetree.factory.FileTreeItemContextMenuFactory;
import com.legyver.fenxlib.widgets.filetree.nodes.FileReference;
import com.legyver.fenxlib.widgets.filetree.nodes.IFileReference;
import com.legyver.fenxlib.widgets.filetree.nodes.INodeReference;
import com.legyver.fenxlib.widgets.filetree.registry.FileTreeRegistry;
import com.legyver.fenxlib.widgets.filetree.scan.FileSystemEvent;
import com.legyver.fenxlib.widgets.filetree.scan.FileWatcherEventConstants;
import com.legyver.fenxlib.widgets.filetree.scan.IFileWatchHandler;
import com.legyver.fenxlib.widgets.filetree.task.FileSystemWatchTaskContext;
import com.legyver.fenxlib.widgets.filetree.task.FileSystemWatchTaskFactory;
import com.legyver.fenxlib.widgets.filetree.tree.TreeFolder;
import com.legyver.fenxlib.widgets.filetree.tree.internal.TreeRoot;
import javafx.application.Platform;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.collections.ListChangeListener;
import javafx.collections.ObservableList;
import javafx.scene.control.ContextMenu;
import javafx.scene.control.Control;
import javafx.scene.control.Skin;
import javafx.scene.control.TreeItem;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.util.stream.Collectors;

/**
 * Base class for FileExplorer widgets.
 * Known concrete implementations: See {@link SimpleFileExplorer}.
 *
 * @param  type of the nodes associated with the explorer
 * @param  type of the registry associated with the file explorer instance
 */
public abstract class BaseFileExplorer> extends Control {
    private static final Logger logger = LogManager.getLogger(BaseFileExplorer.class);
    /**
     * The root node in the tree all root folders will be children of
     */
    private final TreeRoot pseudoRoot;
    /**
     * A special case reference for the root node's association.
     * This is essentially to simplify how tree icons are associated with an {@link INodeReference}
     */
    private final FileReference pseudoRootFileReference;
    /**
     * Refresh pulse that can be monitored for when a node changes state
     */
    private final BooleanProperty refreshPulse = new SimpleBooleanProperty(false);

    /**
     * Construct a BaseFileExplorer with the supplied file registry and fileWatch handler.
     * This constructor
     * - Registers the root tree node with the {@link com.legyver.fenxlib.core.api.locator.IComponentRegistry} so it can be queried from anywhere in the application.
     * -- format will be the registered name of the file explorer + "_root"
     * - Adds a listener to the root files of the registry associated with this file explorer.
     * --  use the {@link FileTreeRegistry#addToRoot(INodeReference)} method when adding root-level folders.
     * - Creates a task to watch the filesystem and sync all changes in files/folders represented in this tree.
     * @param fileTreeRegistry the registry that all nodes associated with the explorer tree will be registered with
     * @param fileWatchHandler the handler that is notified whenever the node associated with a tree item is removed/added/renamed on the filesystem
     * @param areaContextMenu the context menu displayed when clicking on blank area of explorer
     */
    protected BaseFileExplorer(U fileTreeRegistry, IFileWatchHandler fileWatchHandler, ContextMenu areaContextMenu) {
        this.pseudoRootFileReference = new PseudoReference() {
            @Override
            public String getUniqueIdentifier() {
                String guid =  getExplorerGuid() + "_root";//unique to explorer instance
                GuidUtil.setGuid(pseudoRoot, guid);
                return guid;
            }
        };
        this.pseudoRoot = new TreeRoot(pseudoRootFileReference);

        FileSystemWatchTaskContext context = new FileSystemWatchTaskContext(fileTreeRegistry.getFiles(), fileWatchHandler);

        fileTreeRegistry.getRoots().addListener(new ListChangeListener() {
            @Override
            public void onChanged(Change c) {
                logger.trace("Refreshing explorer nodes");
                c.next();
                if (c.wasAdded()) {
                    for (IFileReference node : c.getAddedSubList()) {
                        logger.trace("Refreshing node: {}", node.getUniqueIdentifier());
                        //reuse the new file functionality to handle layout in tree consistently
                        fileWatchHandler.handle(FileWatcherEventConstants.ENTRY_CREATE_NAME, new FileSystemEvent(pseudoRootFileReference, node, null));
                    }
                } else if (c.wasRemoved()) {
                    for (IFileReference node : c.getRemoved()) {
                        //don't need to do more than log it, because removal happens when a file/directory is deleted on the filesystem
                        //therefore removal has already happened (deleted on filesystem calls a FileSystemEvent for delete, which then in turn removes it from the list)
                        logger.trace("Removing node: {}", node.getUniqueIdentifier());
                    }
                }
                Platform.runLater(() -> {
                    if (logger.isTraceEnabled()) {
                        @SuppressWarnings("unchecked")
                        ObservableList children = pseudoRoot.getChildren();
                        String topLevel = children.stream()
                                .map(treeItem -> treeItem.getValue())
                                .map(Object::toString)
                                .collect(Collectors.joining("\n"));
                        logger.trace("Root children: {}", topLevel);
                    }

                    pseudoRoot.setExpanded(true);
                    refreshPulse.set(!refreshPulse.get());
                });
            }
        });

        setContextMenu(areaContextMenu);
        JavaFxAdapter adapter = FileSystemWatchTaskFactory.createScanTask(context);
        TaskExecutor.INSTANCE.submitTask(adapter);
    }

    private String getExplorerGuid() {
        return GuidUtil.getGuid(this);
    }

    /**
     * Refresh the entire tree
     */
    public void refresh() {
        pseudoRoot.refresh();
    }

    //below methods package-private because it should only be used by the Skin
    TreeFolder getPseudoRoot() {
        return pseudoRoot;
    }

    boolean isRefreshPulse() {
        return refreshPulse.get();
    }

    BooleanProperty refreshPulseProperty() {
        return refreshPulse;
    }

    void setRefreshPulse(boolean refreshPulse) {
        this.refreshPulse.set(refreshPulse);
    }

    @Override
    protected Skin createDefaultSkin() {
        return new FileExplorerSkin(this);
    }


    private static class PseudoReference extends FileReference {

        private PseudoReference() {
            super(null);
        }

        @Override
        public boolean isDirectory() {
            return true;
        }

        @Override
        public String getName() {
            return null;
        }
    }
}