ModernDocking.layouts.DockingSimplePanelNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of modern-docking-api Show documentation
Modern docking library for Java Swing
There is a newer version: 0.11.6
/*
Copyright (c) 2022-2023 Andrew Auclair

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */
package ModernDocking.layouts;

import ModernDocking.DockingRegion;
import ModernDocking.api.DockingAPI;
import ModernDocking.settings.Settings;

import javax.swing.*;
import java.util.HashMap;
import java.util.Map;

/**
 * Docking layout node for a simple panel. A that contains a single dockable.
 */
public class DockingSimplePanelNode implements DockingLayoutNode {
	private final DockingAPI docking;
	private final String persistentID;
	private final String className;

	private Map properties = new HashMap<>();
	private DockingLayoutNode parent;

	/**
	 * Create a new DockingSimplePanelNode with just a persistent ID
	 *
	 * @param persistentID The persistent ID of the contained dockable
	 */
	public DockingSimplePanelNode(DockingAPI docking, String persistentID, String className) {
		this.docking = docking;
		this.persistentID = persistentID;
		this.className = className;
	}

	/**
	 * Create a new DockingSimplePanelNode with properties
	 *
	 * @param persistentID The persistent ID of the contained dockable
	 * @param properties Properties of the dockable
	 */
	public DockingSimplePanelNode(DockingAPI docking, String persistentID, String className, Map properties) {
		this.docking = docking;
		this.persistentID = persistentID;
		this.className = className;
		this.properties.putAll(properties);
	}

	@Override
	public DockingLayoutNode getParent() {
		return parent;
	}

	public void setParent(DockingLayoutNode parent) {
		this.parent = parent;
	}

	@Override
	public DockingLayoutNode findNode(String persistentID) {
		if (this.persistentID.equals(persistentID)) {
			return this;
		}
		return null;
	}

	@Override
	public void dock(String persistentID, DockingRegion region, double dividerProportion) {
		if (getParent() instanceof DockingTabPanelNode) {
			getParent().dock(persistentID, region, dividerProportion);
		}
		else if (region == DockingRegion.CENTER) {
			DockingTabPanelNode tab = new DockingTabPanelNode(docking, persistentID);

			tab.addTab(this.persistentID);
			tab.addTab(persistentID);

			parent.replaceChild(this, tab);
		}
		else {
			int orientation = region == DockingRegion.EAST || region == DockingRegion.WEST ? JSplitPane.HORIZONTAL_SPLIT : JSplitPane.VERTICAL_SPLIT;

			DockingLayoutNode left;
			DockingLayoutNode right;

			if (Settings.alwaysDisplayTabsMode()) {
				if (orientation == JSplitPane.HORIZONTAL_SPLIT) {
					left = region == DockingRegion.EAST ? this : new DockingTabPanelNode(docking, persistentID);
					right = region == DockingRegion.EAST ? new DockingTabPanelNode(docking, persistentID) : this;
				}
				else {
					left = region == DockingRegion.SOUTH ? this : new DockingTabPanelNode(docking, persistentID);
					right = region == DockingRegion.SOUTH ? new DockingTabPanelNode(docking, persistentID) : this;
				}
			}
			else {
				if (orientation == JSplitPane.HORIZONTAL_SPLIT) {
					left = region == DockingRegion.EAST ? this : new DockingSimplePanelNode(docking, persistentID, className);
					right = region == DockingRegion.EAST ? new DockingSimplePanelNode(docking, persistentID, className) : this;
				}
				else {
					left = region == DockingRegion.SOUTH ? this : new DockingSimplePanelNode(docking, persistentID, className);
					right = region == DockingRegion.SOUTH ? new DockingSimplePanelNode(docking, persistentID, className) : this;
				}
			}

			if (region == DockingRegion.EAST || region == DockingRegion.SOUTH) {
				dividerProportion = 1.0 - dividerProportion;
			}

			DockingLayoutNode oldParent = parent;
			DockingSplitPanelNode split = new DockingSplitPanelNode(docking, left, right, orientation, dividerProportion);
			oldParent.replaceChild(this, split);
		}
	}

	@Override
	public void replaceChild(DockingLayoutNode child, DockingLayoutNode newChild) {
	}

	/**
	 * Get Persistent ID of the contained dockable
	 *
	 * @return Persistent ID
	 */
	public String getPersistentID() {
		return persistentID;
	}

	public String getClassName() {
		return className;
	}

	/**
	 * Get the properties of the dockable
	 *
	 * @return properties map
	 */
	public Map getProperties() {
		return properties;
	}

	public void setProperties(Map properties) {
		this.properties = new HashMap<>(properties);
	}
}