Dockables can now indicate their tab preference (TOP or BOTTOM) and t…

…his will be used when docking the dockable. (#143) If any dockables in a tab group prefer TOP tabs, then the tab group will switch to top tabs. The tab group will continue to be top tabs even after all the dockables with TOP as the preference have been removed.
andrewauclair · Dec 3, 2023 · b31692d · b31692d
1 parent 69ce480
commit b31692d
Show file tree

Hide file tree

Showing 14 changed files with 38 additions and 15 deletions.
diff --git a/demo-single-app/src/basic/AlwaysDisplayedPanel.java b/demo-single-app/src/basic/AlwaysDisplayedPanel.java
@@ -21,6 +21,8 @@ of this software and associated documentation files (the "Software"), to deal
  */
 package basic;
 
+import javax.swing.*;
+
 // Docking panel that is always displayed and cannot be closed
 public class AlwaysDisplayedPanel extends SimplePanel {
 	// create a new basic.AlwaysDisplayedPanel with the given title and persistentID
@@ -42,4 +44,9 @@ public boolean isFloatingAllowed() {
 	public boolean isLimitedToRoot() {
 		return true;
 	}
+
+	@Override
+	public int getTabPosition() {
+		return SwingConstants.TOP;
+	}
 }
diff --git a/docking-api/src/ModernDocking/Dockable.java b/docking-api/src/ModernDocking/Dockable.java
@@ -175,6 +175,10 @@ default boolean getHasMoreOptions() {
 		return false;
 	}
 
+	default int getTabPosition() {
+		return SwingConstants.BOTTOM;
+	}
+
 	/**
 	 * add the more options to the popup menu. defaults to an empty block to handle the case of hasMoreOptions() = false
 	 *

diff --git a/docking-api/src/ModernDocking/api/RootDockingPanelAPI.java b/docking-api/src/ModernDocking/api/RootDockingPanelAPI.java
@@ -261,7 +261,7 @@ public void dock(Dockable dockable, DockingRegion region, double dividerProporti
 		if (panel != null) {
 			panel.dock(dockable, region, dividerProportion);
 		}
-		else if (Settings.alwaysDisplayTabsMode()) {
+		else if (Settings.alwaysDisplayTabsMode(dockable)) {
 			setPanel(new DockedTabbedPanel(docking, wrapper));
 			wrapper.setWindow(window);
 		}

diff --git a/docking-api/src/ModernDocking/floating/FloatListener.java b/docking-api/src/ModernDocking/floating/FloatListener.java
@@ -346,7 +346,7 @@ public void mouseDragStarted(Point point) {
 		RootDockingPanelAPI currentRoot = DockingComponentUtils.rootForWindow(docking, originalWindow);
 
 		if (floatingPanel instanceof DisplayPanel) {
-			if (Settings.alwaysDisplayTabsMode()) {
+			if (Settings.alwaysDisplayTabsMode(((DisplayPanel) floatingPanel).getWrapper().getDockable())) {
 				floatingFrame = new TempFloatingFrame(Collections.singletonList(((DisplayPanel) floatingPanel).getWrapper()), 0, source, floatingPanel.getSize());
 			}
 			else {

diff --git a/docking-api/src/ModernDocking/floating/TempFloatingFrame.java b/docking-api/src/ModernDocking/floating/TempFloatingFrame.java
@@ -53,7 +53,7 @@ public TempFloatingFrame(List<DockableWrapper> dockables, int selectedIndex, JCo
 		// we only support tabs on top if we have FlatLaf because we can add a trailing component for our menu
 		boolean usingFlatLaf = tabs.getUI().getClass().getPackageName().startsWith("com.formdev.flatlaf");
 
-		if (Settings.alwaysDisplayTabsMode() && usingFlatLaf) {
+		if (Settings.alwaysDisplayTabsMode(dockables.get(0).getDockable()) && usingFlatLaf) {
 			tabs.setTabPlacement(JTabbedPane.TOP);
 		}
 		else {

diff --git a/docking-api/src/ModernDocking/internal/DisplayPanel.java b/docking-api/src/ModernDocking/internal/DisplayPanel.java
@@ -58,7 +58,7 @@ private void buildUI() {
 		gbc.fill = GridBagConstraints.HORIZONTAL;
 		gbc.weightx = 1.0;
 
-		if (!Settings.alwaysDisplayTabsMode() || wrapper.isUnpinned()) {
+		if (!Settings.alwaysDisplayTabsMode(wrapper.getDockable()) || wrapper.isUnpinned()) {
 			if (!(wrapper.getParent() instanceof DockedTabbedPanel) || ((DockedTabbedPanel) wrapper.getParent()).isUsingBottomTabs()) {
 				add((Component) wrapper.getHeaderUI(), gbc);
 				gbc.gridy++;

diff --git a/docking-api/src/ModernDocking/internal/DockedSimplePanel.java b/docking-api/src/ModernDocking/internal/DockedSimplePanel.java
@@ -114,7 +114,7 @@ else if (region == DockingRegion.CENTER) {
 
 			DockingPanel newPanel;
 
-			if (Settings.alwaysDisplayTabsMode()) {
+			if (Settings.alwaysDisplayTabsMode(wrapper.getDockable())) {
 				newPanel = new DockedTabbedPanel(docking, wrapper);
 			}
 			else {

diff --git a/docking-api/src/ModernDocking/internal/DockedSplitPanel.java b/docking-api/src/ModernDocking/internal/DockedSplitPanel.java
@@ -283,7 +283,7 @@ public void dock(Dockable dockable, DockingRegion region, double dividerProporti
 
 		DockingPanel newPanel;
 
-		if (Settings.alwaysDisplayTabsMode()) {
+		if (Settings.alwaysDisplayTabsMode(wrapper.getDockable())) {
 			newPanel = new DockedTabbedPanel(docking, wrapper);
 		}
 		else {

diff --git a/docking-api/src/ModernDocking/internal/DockedTabbedPanel.java b/docking-api/src/ModernDocking/internal/DockedTabbedPanel.java
@@ -81,7 +81,7 @@ public DockedTabbedPanel(DockingAPI docking, DockableWrapper dockable) {
 		// we only support tabs on top if we have FlatLaf because we can add a trailing component for our menu
 		boolean usingFlatLaf = tabs.getUI().getClass().getPackageName().startsWith("com.formdev.flatlaf");
 
-		if (Settings.alwaysDisplayTabsMode() && usingFlatLaf) {
+		if (Settings.alwaysDisplayTabsMode(dockable.getDockable()) && usingFlatLaf) {
 			tabs.setTabPlacement(JTabbedPane.TOP);
 		}
 		else {
@@ -90,7 +90,7 @@ public DockedTabbedPanel(DockingAPI docking, DockableWrapper dockable) {
 
 		tabs.setTabLayoutPolicy(Settings.getTabLayoutPolicy());
 
-		if (Settings.alwaysDisplayTabsMode()) {
+		if (Settings.alwaysDisplayTabsMode(dockable.getDockable())) {
 			configureTrailingComponent();
 		}
 
@@ -179,12 +179,17 @@ public void addPanel(DockableWrapper dockable) {
 		panels.add(dockable);
 		tabs.add(dockable.getDockable().getTabText(), dockable.getDisplayPanel());
 
+		// if any of the dockables use top tab position, switch this tabbedpanel to top tabs
+		if (tabs.getTabPlacement() != SwingConstants.TOP && dockable.getDockable().getTabPosition() == SwingConstants.TOP) {
+			tabs.setTabPlacement(SwingConstants.TOP);
+		}
+
 		tabs.setToolTipTextAt(tabs.getTabCount() - 1, dockable.getDockable().getTabTooltip());
 		tabs.setIconAt(tabs.getTabCount() - 1, dockable.getDockable().getIcon());
 		tabs.setSelectedIndex(tabs.getTabCount() - 1);
 		selectedTab = tabs.getSelectedIndex();
 
-		if (Settings.alwaysDisplayTabsMode() && dockable.getDockable().isClosable()) {
+		if (Settings.alwaysDisplayTabsMode(dockable.getDockable()) && dockable.getDockable().isClosable()) {
 			dockable.getDisplayPanel().putClientProperty("JTabbedPane.tabClosable", true);
 		}
 
@@ -235,7 +240,7 @@ public void dock(Dockable dockable, DockingRegion region, double dividerProporti
 
 			DockingPanel newPanel;
 
-			if (Settings.alwaysDisplayTabsMode()) {
+			if (Settings.alwaysDisplayTabsMode(wrapper.getDockable())) {
 				newPanel = new DockedTabbedPanel(docking, wrapper);
 			}
 			else {
@@ -290,7 +295,7 @@ public void dockAtIndex(Dockable dockable, int index) {
 	public void undock(Dockable dockable) {
 		removePanel(DockingInternal.get(docking).getWrapper(dockable));
 
-		if (!Settings.alwaysDisplayTabsMode() && tabs.getTabCount() == 1 && parent != null) {
+		if (!Settings.alwaysDisplayTabsMode(dockable) && tabs.getTabCount() == 1 && parent != null) {
 			parent.replaceChild(this, new DockedSimplePanel(docking, panels.get(0)));
 		}
 

diff --git a/docking-api/src/ModernDocking/layouts/DockingLayoutRootNode.java b/docking-api/src/ModernDocking/layouts/DockingLayoutRootNode.java
@@ -47,7 +47,7 @@ public void dock(String persistentID, DockingRegion region, double dividerPropor
         if (node != null) {
             node.dock(persistentID, region, dividerProportion);
         }
-        else if (Settings.alwaysDisplayTabsMode()) {
+        else if (Settings.alwaysDisplayTabsMode(DockingInternal.get(docking).getDockable(persistentID))) {
             node = new DockingTabPanelNode(docking, persistentID);
             node.setParent(this);
         }

diff --git a/docking-api/src/ModernDocking/layouts/DockingSimplePanelNode.java b/docking-api/src/ModernDocking/layouts/DockingSimplePanelNode.java
@@ -23,6 +23,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 import ModernDocking.DockingRegion;
 import ModernDocking.api.DockingAPI;
+import ModernDocking.internal.DockingInternal;
 import ModernDocking.settings.Settings;
 
 import javax.swing.*;
@@ -100,7 +101,7 @@ else if (region == DockingRegion.CENTER) {
 			DockingLayoutNode left;
 			DockingLayoutNode right;
 
-			if (Settings.alwaysDisplayTabsMode()) {
+			if (Settings.alwaysDisplayTabsMode(DockingInternal.get(docking).getDockable(persistentID))) {
 				if (orientation == JSplitPane.HORIZONTAL_SPLIT) {
 					left = region == DockingRegion.EAST ? this : new DockingTabPanelNode(docking, persistentID);
 					right = region == DockingRegion.EAST ? new DockingTabPanelNode(docking, persistentID) : this;

diff --git a/docking-api/src/ModernDocking/layouts/DockingSplitPanelNode.java b/docking-api/src/ModernDocking/layouts/DockingSplitPanelNode.java
@@ -97,7 +97,7 @@ public void dock(String persistentID, DockingRegion region, double dividerPropor
 			DockingLayoutNode left;
 			DockingLayoutNode right;
 
-			if (Settings.alwaysDisplayTabsMode()) {
+			if (Settings.alwaysDisplayTabsMode(DockingInternal.get(docking).getDockable(persistentID))) {
 				left = region == DockingRegion.NORTH || region == DockingRegion.WEST ? new DockingTabPanelNode(docking, persistentID) : this;
 				right = region == DockingRegion.NORTH || region == DockingRegion.WEST ? this : new DockingTabPanelNode(docking, persistentID);
 			}

diff --git a/docking-api/src/ModernDocking/layouts/DockingTabPanelNode.java b/docking-api/src/ModernDocking/layouts/DockingTabPanelNode.java
@@ -179,7 +179,7 @@ public void dock(String persistentID, DockingRegion region, double dividerPropor
 			DockingLayoutNode left;
 			DockingLayoutNode right;
 
-			if (Settings.alwaysDisplayTabsMode()) {
+			if (Settings.alwaysDisplayTabsMode(DockingInternal.get(docking).getDockable(persistentID))) {
 				left = region == DockingRegion.NORTH || region == DockingRegion.WEST ? new DockingTabPanelNode(docking, persistentID) : this;
 				right = region == DockingRegion.NORTH || region == DockingRegion.WEST ? this : new DockingTabPanelNode(docking, persistentID);
 			}

diff --git a/docking-api/src/ModernDocking/settings/Settings.java b/docking-api/src/ModernDocking/settings/Settings.java
@@ -21,6 +21,8 @@ of this software and associated documentation files (the "Software"), to deal
  */
 package ModernDocking.settings;
 
+import ModernDocking.Dockable;
+
 import javax.swing.*;
 
 public class Settings {
@@ -32,6 +34,10 @@ public static boolean alwaysDisplayTabsMode() {
         return alwaysDisplayTabsMode;
     }
 
+    public static boolean alwaysDisplayTabsMode(Dockable dockable) {
+        return alwaysDisplayTabsMode || dockable.getTabPosition() == SwingConstants.TOP;
+    }
+
     public static void setAlwaysDisplayTabMode(boolean alwaysDisplayTabsMode) {
         Settings.alwaysDisplayTabsMode = alwaysDisplayTabsMode;
     }