ModernDocking.api.WindowLayoutBuilderAPI 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 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.api;

import ModernDocking.DockingRegion;
import ModernDocking.layouts.*;

/**
 * Utility to help create layouts without directly applying them to the actual app
 */
public class WindowLayoutBuilderAPI {
	private final DockingLayoutRootNode rootNode;

	/**
	 * Start building a new layout
	 *
	 * @param firstID First dockable ID in the layout
	 */
	protected WindowLayoutBuilderAPI(DockingAPI docking, String firstID) {
		rootNode = new DockingLayoutRootNode(docking);
		rootNode.dock(firstID, DockingRegion.CENTER, 0.0);
	}

	/**
	 * Dock a new dockable into this layout
	 *
	 * @param sourceID The new dockable
	 * @param targetID The dockable to dock to the center of
	 * @return This builder in order to chain calls
	 */
	public WindowLayoutBuilderAPI dock(String sourceID, String targetID) {
		return dock(sourceID, targetID, DockingRegion.CENTER);
	}

	/**
	 * Dock a new dockable into this layout
	 *
	 * @param sourceID The new dockable
	 * @param targetID The dockable to dock to
	 * @param region The region on the dockable to dock to
	 * @return This builder in order to chain calls
	 */
	public WindowLayoutBuilderAPI dock(String sourceID, String targetID, DockingRegion region) {
		return dock(sourceID, targetID, region, 0.5);
	}

	/**
	 * Dock a new dockable into this layout
	 *
	 * @param sourceID The new dockable
	 * @param targetID The dockable to dock to
	 * @param region The region on the dockable to dock to
	 * @param dividerProportion The divider proportion to use if creating a split pane
	 * @return This builder in order to chain calls
	 */
	public WindowLayoutBuilderAPI dock(String sourceID, String targetID, DockingRegion region, double dividerProportion) {
		DockingLayoutNode node = findNode(targetID);

		if (exists(sourceID)) {
			throw new RuntimeException("Dockable already in layout: " + sourceID);
		}
		node.dock(sourceID, region, dividerProportion);

		return this;
	}

	public WindowLayoutBuilderAPI dockToRoot(String persistentID, DockingRegion region) {
		return dockToRoot(persistentID, region, 0.25);
	}

	public WindowLayoutBuilderAPI dockToRoot(String persistentID, DockingRegion region, double dividerProportion) {
		if (exists(persistentID)) {
			throw new RuntimeException("Dockable already in layout: " + persistentID);
		}

		rootNode.dock(persistentID, region, dividerProportion);
		return this;
	}

	public WindowLayoutBuilderAPI display(String persistentID) {
		DockingLayoutNode node = findNode(persistentID);

		if (node.getParent() != null && node.getParent() instanceof DockingTabPanelNode) {
			((DockingTabPanelNode) node.getParent()).bringToFront(node);
		}

		return this;
	}

	// build a WindowLayout using the rootNode
	public WindowLayout build() {
		return new WindowLayout(rootNode.getNode());
	}

	// shortcut for building an ApplicationLayout from this builder's WindowLayout
	public ApplicationLayout buildApplicationLayout() {
		return new ApplicationLayout(build());
	}

	public DockingLayoutNode findNode(String persistentID) {
		DockingLayoutNode node = rootNode.findNode(persistentID);

		if (node == null) {
			throw new RuntimeException("No node for dockable ID found: " + persistentID);
		}
		return node;
	}

	private boolean exists(String persistentID) {
		DockingLayoutNode node = rootNode.findNode(persistentID);

		return node != null;
	}
}