org.drombler.commons.docking.fx.DockingPane Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of drombler-commons-docking-fx Show documentation
Drombler Commons - Docking - FX provides a docking framework for JavaFX.
There is a newer version: 1.0
Show newest version
/*
 *         COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Notice
 *
 * The contents of this file are subject to the COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL)
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.opensource.org/licenses/cddl1.txt
 *
 * The Original Code is Drombler.org. The Initial Developer of the
 * Original Code is Florian Brunner (Sourceforge.net user: puce).
 * Copyright 2012 Drombler.org. All Rights Reserved.
 *
 * Contributor(s): .
 */
package org.drombler.commons.docking.fx;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableSet;
import javafx.collections.SetChangeListener;
import javafx.event.EventHandler;
import javafx.scene.Node;
import javafx.scene.Parent;
import javafx.scene.control.Control;
import org.drombler.commons.docking.DockingAreaDescriptor;
import org.drombler.commons.docking.DockingAreaKind;
import org.drombler.commons.docking.fx.impl.skin.Stylesheets;
import org.drombler.commons.fx.event.SimpleEventHandlerProperty;
import org.drombler.commons.fx.scene.Nodes;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * The DockingPane splits up the content area into any number of Docking Areas. The Docking Areas can be resized using the dividers. Each Docking Area can hold any number of Dockable Panes, which are
 * layed out as Tabs.
 *
 * Wiki: http://wiki.drombler.org/DockingFramework
 *
 * @author puce
 */
public class DockingPane extends Control {//extends BorderPane {// GridPane {

    private static final String DEFAULT_STYLE_CLASS = "docking-pane";
    private static final Logger LOG = LoggerFactory.getLogger(DockingPane.class);

    private final ObservableSet dockingAreaDescriptors = FXCollections.observableSet();
    private final ObservableSet dockables = FXCollections.observableSet();
    /**
     * The active Dockable.
     */
    private final ObjectProperty activeDockable = new SimpleObjectProperty<>(this, "activeDockable");
    // TODO: needed? useful?
    private final Set dockingAreaIds = new HashSet<>();
    // TODO: needed? useful?
    private final Map dockableEntryMap = new HashMap<>();

    // TODO: should this be a real event handler or a simple property?
    private final ObjectProperty> onDockableCloseRequest = new SimpleEventHandlerProperty<>(this, "onDockableCloseRequest",
            DockableCloseRequestEvent.DOCKABLE_CLOSE_REQUEST, this::setEventHandler);

    /**
     * Creates a new instance of this class.
     */
    public DockingPane() {
        getStyleClass().setAll(DEFAULT_STYLE_CLASS);
        dockingAreaDescriptors.addListener((SetChangeListener.Change change) -> {
            if (change.wasAdded()) {
                dockingAreaIds.add(change.getElementAdded().getId());
            } else if (change.wasRemoved()) {
                    dockingAreaIds.remove(change.getElementRemoved().getId());
                }
        });
        dockables.addListener((SetChangeListener.Change change) -> {
            if (change.wasAdded()) {
//                if (dockingAreaIds.contains(dockableEntry.getDockablePreferences().getAreaId())) { // TODO: needed?
                dockableEntryMap.put(change.getElementAdded().getDockable(), change.getElementAdded());
            } else if (change.wasRemoved()) {
                    dockableEntryMap.remove(change.getElementRemoved().getDockable());
                }
        });
        activeDockable.addListener((observable, oldValue, newValue) -> {
            if (newValue != null) {
                final Node currentFocusOwner = newValue.getDockable().getScene().getFocusOwner();
                if (currentFocusOwner == null || !isFocusInDockable(newValue.getDockable(), currentFocusOwner)) {
                    LOG.debug("Request focus for new active Dockable: '{}'!", newValue.getDockableData().getTitle());
                    newValue.getDockable().requestFocus();
                }
            }
        });
        setFocusTraversable(false);
    }

    private boolean isFocusInDockable(Node dockable, final Node currentFocusOwner) {
        return (dockable instanceof Parent) && Nodes.isParent((Parent) dockable, currentFocusOwner);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getUserAgentStylesheet() {
        return Stylesheets.getDefaultStylesheet();
    }

    // TODO: needed? useful?
    public void removeDockable(Node dockable) {
        FXDockableEntry dockableEntry = dockableEntryMap.get(dockable);
        if (dockableEntry != null) {
            removeDockable(dockableEntry);
        }
    }

    private void removeDockable(FXDockableEntry dockableEntry) {
        dockables.remove(dockableEntry);
    }

    /**
     * Gets the {@link DockingAreaDescriptor}s.
     *
     * @return the DockingAreaDescriptors
     */
    public ObservableSet getDockingAreaDescriptors() {
        return dockingAreaDescriptors;
    }

    /**
     * Gets the Dockable entry.
     *
     * @return the Dockable entry.
     */
    public ObservableSet getDockables() {
        return dockables;
    }

    public final FXDockableEntry getActiveDockable() {
        return activeDockableProperty().get();
    }

    public final void setActiveDockable(FXDockableEntry dockable) {
        activeDockableProperty().set(dockable);
    }

    public ObjectProperty activeDockableProperty() {
        return activeDockable;
    }

    public final EventHandler getOnDockableCloseRequest() {
        return onDockableCloseRequestProperty().get();
    }

    public final void setOnDockableCloseRequest(EventHandler eventHandler) {
        onDockableCloseRequestProperty().set(eventHandler);
    }

    public ObjectProperty> onDockableCloseRequestProperty() {
        return onDockableCloseRequest;
    }

    public String getDefaultEditorAreaId() {
        return dockingAreaDescriptors.stream()
                .filter(dockingAreaDescriptor -> dockingAreaDescriptor.getKind() == DockingAreaKind.EDITOR)
                .filter(dockingAreaDescriptor -> !dockingAreaDescriptor.isAdHoc())
                .map(DockingAreaDescriptor::getId)
                .findFirst()
                .orElse(null);
    }

}