content: /*
  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 io.github.andrewauclair.moderndocking.internal;
  
  import io.github.andrewauclair.moderndocking.Dockable;
  import io.github.andrewauclair.moderndocking.DockableTabPreference;
  import io.github.andrewauclair.moderndocking.DockingRegion;
  import io.github.andrewauclair.moderndocking.api.DockingAPI;
  import io.github.andrewauclair.moderndocking.internal.floating.DockedTabbedPanelFloatListener;
  import io.github.andrewauclair.moderndocking.internal.floating.FloatListener;
  import io.github.andrewauclair.moderndocking.internal.floating.Floating;
  import io.github.andrewauclair.moderndocking.settings.Settings;
  import io.github.andrewauclair.moderndocking.ui.DockingSettings;
  import java.awt.BorderLayout;
  import java.awt.Color;
  import java.awt.Component;
  import java.awt.GridBagConstraints;
  import java.awt.GridBagLayout;
  import java.awt.Point;
  import java.awt.Rectangle;
  import java.awt.dnd.DragGestureListener;
  import java.awt.event.MouseAdapter;
  import java.awt.event.MouseEvent;
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.List;
  import java.util.Objects;
  import java.util.function.IntConsumer;
  import javax.swing.BorderFactory;
  import javax.swing.Icon;
  import javax.swing.ImageIcon;
  import javax.swing.JButton;
  import javax.swing.JLabel;
  import javax.swing.JPanel;
  import javax.swing.JSplitPane;
  import javax.swing.JTabbedPane;
  import javax.swing.SwingConstants;
  import javax.swing.SwingUtilities;
  import javax.swing.UIManager;
  import javax.swing.event.ChangeEvent;
  import javax.swing.event.ChangeListener;
  
  /**
   * DockingPanel that has a JTabbedPane inside its center
   */
  public class DockedTabbedPanel extends DockingPanel implements ChangeListener {
  	/**
  	 * Wrapper objects of the contained dockables in this tabbed panel
  	 */
  	private final List<DockableWrapper> panels = new ArrayList<>();
  
  	/**
  	 * The listener using this tabbed panel
  	 */
  	private FloatListener floatListener;
  	/**
  	 * All the drag listeners tied to this tabbed panel
  	 */
  	private List<DragGestureListener> listeners = new ArrayList<>();
  
  	/**
  	 * The JTabbedPane to display
  	 */
  	private final CustomTabbedPane tabs = new CustomTabbedPane();
  	/**
  	 * The docking instance this tabbed panel is tied to
  	 */
  	private final DockingAPI docking;
  
  	/**
  	 * The anchor this tabbed panel belongs to
  	 */
  	private String anchor = "";
  
  	/**
  	 * The parent of this DockedTabbedPanel
  	 */
  	private DockingPanel parent;
  
  	/**
  	 * The selected tab index. default to -1 and set properly when state changes
  	 */
  	private int selectedTab = -1;
  
  	private static Icon settingsIcon = new ImageIcon(Objects.requireNonNull(DockedTabbedPanel.class.getResource("/api_icons/settings.png")));
  
  	/**
  	 * Create a new instance of DockedTabbedPanel
  	 *
  	 * @param docking The docking instance
  	 * @param dockable The first dockable in the tabbed pane
  	 * @param anchor The anchor associated with this docking panel
  	 */
  	public DockedTabbedPanel(DockingAPI docking, DockableWrapper dockable, String anchor) {
  		this.docking = docking;
  		this.anchor = anchor;
  		setLayout(new BorderLayout());
  
  		// set the initial border. Docking handles the border after this using a global AWT listener
  		setNotSelectedBorder();
  
  		// 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) {
  			tabs.setTabPlacement(JTabbedPane.TOP);
  		}
  		else {
  			tabs.setTabPlacement(JTabbedPane.BOTTOM);
  		}
  
  		tabs.setTabLayoutPolicy(Settings.getTabLayoutPolicy());
  
  		if (Settings.alwaysDisplayTabsMode()) {
  			configureTrailingComponent();
  		}
  
  		add(tabs, BorderLayout.CENTER);
  
  		addPanel(dockable);
  	}
  
  	public static void setSettingsIcon(Icon icon) {
  		settingsIcon = icon;
  	}
  
  	private void configureTrailingComponent() {
  		JPanel panel = new JPanel(new GridBagLayout());
  
  		GridBagConstraints gbc = new GridBagConstraints();
  		gbc.anchor = GridBagConstraints.EAST;
  		gbc.fill = GridBagConstraints.NONE;
  		gbc.gridwidth = 1;
  		gbc.gridheight = 1;
  		gbc.weightx = 1.0;
  		gbc.weighty = 0.0;
  
  		JButton menu = new JButton(settingsIcon);
  
  		setupButton(menu);
  
  		menu.addActionListener(e -> {
  			DockableWrapper dockable = panels.get(tabs.getSelectedIndex());
  
  			dockable.getHeaderUI().displaySettingsMenu(menu);
  		});
  
  		panel.add(menu, gbc);
  
  		tabs.putClientProperty("JTabbedPane.trailingComponent", panel);
  		tabs.putClientProperty("JTabbedPane.tabCloseCallback", (IntConsumer) tabIndex -> {
  			Dockable dockable = panels.get(tabIndex).getDockable();
  
  			if (dockable.requestClose()) {
  				docking.undock(dockable);
  			}
  		});
  	}
  
  	// sets the button up for being on a toolbar
  	private void setupButton(JButton button) {
  		Color color = DockingSettings.getHeaderBackground();
  		button.setBackground(color);
  		button.setBorder(BorderFactory.createEmptyBorder(2, 2, 2, 2));
  		button.setFocusable(false);
  		button.setOpaque(false);
  		button.setContentAreaFilled(false);
  
  		button.addMouseListener(new MouseAdapter() {
  			@Override
  			public void mouseEntered(MouseEvent e) {
  				button.setContentAreaFilled(true);
  				button.setOpaque(true);
  			}
  
  			@Override
  			public void mouseExited(MouseEvent e) {
  				button.setContentAreaFilled(false);
  				button.setOpaque(false);
  			}
  		});
  	}
  
  	@Override
  	public void addNotify() {
  		super.addNotify();
  
  		tabs.addChangeListener(this);
  
  		floatListener = new DockedTabbedPanelFloatListener(docking, this, tabs);
  	}
  
  	@Override
  	public void removeNotify() {
  		tabs.removeChangeListener(this);
  
  		floatListener = null;
  
  		super.removeNotify();
  	}
  
  	/**
  	 * Add a new panel to this tabbed panel.
  	 *
  	 * @param dockable The dockable to add
  	 */
  	public void addPanel(DockableWrapper dockable) {
  		panels.add(dockable);
  		tabs.add(dockable.getDockable().getTabText(), dockable.getDisplayPanel());
  
  		DragGestureListener draggingFromTabPanel = dge -> {
  			Point dragOrigin = new Point(dge.getDragOrigin());
  			SwingUtilities.convertPointToScreen(dragOrigin, dge.getComponent());
  
  			int targetTabIndex = tabs.getTargetTabIndex(dragOrigin, true);
  
  			if (targetTabIndex != -1) {
  				DockableWrapper dockableWrapper = panels.get(targetTabIndex);
  
  				if (dockableWrapper == dockable) {
  					dockableWrapper.getFloatListener().startDrag(dge);
  				}
  			}
  		};
  		listeners.add(draggingFromTabPanel);
  
  		dockable.getFloatListener().addAlternateDragSource(tabs, draggingFromTabPanel);
  
  		DockableTabPreference tabPreference = Settings.defaultTabPreference();
  
  		// 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 (tabPreference == DockableTabPreference.TOP_ALWAYS && usingFlatLaf) {
  			tabs.setTabPlacement(SwingConstants.TOP);
  		}
  		else if (tabPreference == DockableTabPreference.BOTTOM_ALWAYS) {
  			tabs.setTabPlacement(SwingConstants.BOTTOM);
  		}
  		else if (tabPreference == DockableTabPreference.TOP && usingFlatLaf) {
  			// in the normal top preference case, only switch if we add a dockable that prefers the top tab position
  			if (dockable.getDockable().getTabPreference() == DockableTabPreference.TOP) {
  				tabs.setTabPlacement(SwingConstants.TOP);
  			}
  		}
  
  		// 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()) {
  			dockable.getDisplayPanel().putClientProperty("JTabbedPane.tabClosable", true);
  		}
  
  		dockable.setParent(this);
  		dockable.setAnchor(anchor);
  	}
  
  	/**
  	 * Remove a panel from this DockedTabbedPanel. This is done when the dockable is closed or docked elsewhere
  	 *
  	 * @param dockable The dockable to remove
  	 */
  	public void removePanel(DockableWrapper dockable) {
  		if (panels.contains(dockable)) {
  			int index = panels.indexOf(dockable);
  
  			dockable.getFloatListener().removeAlternateDragSource(listeners.get(index));
  			listeners.remove(index);
  
  			tabs.remove(dockable.getDisplayPanel());
  			panels.remove(dockable);
  
  			dockable.setParent(null);
  		}
  	}
  
  	/**
  	 * Get a list of the dockables in this tabbed panel
  	 *
  	 * @return List of persistent IDs of dockable tabs
  	 */
  	public List<DockableWrapper> getDockables() {
  		return Collections.unmodifiableList(panels);
  	}
  
  	@Override
  	public String getAnchor() {
  		return anchor;
  	}
  
  	@Override
  	public void setAnchor(String anchor) {
  		this.anchor = anchor;
  	}
  
  	@Override
  	public void setParent(DockingPanel parent) {
  		this.parent = parent;
  	}
  
  	@Override
  	public void dock(Dockable dockable, DockingRegion region, double dividerProportion) {
  		DockableWrapper wrapper = DockingInternal.get(docking).getWrapper(dockable);
  		wrapper.setWindow(panels.get(0).getWindow());
  
  		if (region == DockingRegion.CENTER) {
  			addPanel(wrapper);
  		}
  		else {
  			DockedSplitPanel split = new DockedSplitPanel(docking, panels.get(0).getWindow(), anchor);
  			parent.replaceChild(this, split);
  
  			DockingPanel newPanel;
  
  			if (wrapper.isAnchor()) {
  				newPanel = new DockedAnchorPanel(docking, wrapper);
  			}
  			else if (Settings.alwaysDisplayTabsMode()) {
  				newPanel = new DockedTabbedPanel(docking, wrapper, anchor);
  			}
  			else {
  				newPanel = new DockedSimplePanel(docking, wrapper, anchor);
  			}
  
  			if (region == DockingRegion.EAST || region == DockingRegion.SOUTH) {
  				split.setLeft(this);
  				split.setRight(newPanel);
  				dividerProportion = 1.0 - dividerProportion;
  			}
  			else {
  				split.setLeft(newPanel);
  				split.setRight(this);
  			}
  
  			if (region == DockingRegion.EAST || region == DockingRegion.WEST) {
  				split.setOrientation(JSplitPane.HORIZONTAL_SPLIT);
  			}
  			else {
  				split.setOrientation(JSplitPane.VERTICAL_SPLIT);
  			}
  
  			split.setDividerLocation(dividerProportion);
  		}
  
  		revalidate();
  		repaint();
  	}
  
  	/**
  	 * Dock a dockable at the specific index. Other dockables will be moved to the right one index
  	 *
  	 * @param dockable The dockable to dock
  	 * @param index The index to dock at
  	 */
  	public void dockAtIndex(Dockable dockable, int index) {
  		DockableWrapper wrapper = DockingInternal.get(docking).getWrapper(dockable);
  		wrapper.setWindow(panels.get(0).getWindow());
  
  		addPanel(DockingInternal.get(docking).getWrapper(dockable));
  
  		if (index != -1) {
  			int lastIndex = tabs.getTabCount() - 1;
  
  			for (int i = index; i < lastIndex; i++) {
  				DockableWrapper panel = panels.get(index);
  
  				removePanel(panel);
  				addPanel(panel);
  			}
  
  			tabs.setSelectedIndex(index);
  		}
  	}
  
  	@Override
  	public void undock(Dockable dockable) {
  		removePanel(DockingInternal.get(docking).getWrapper(dockable));
  
  		if (!Floating.isFloatingTabbedPane() && !Settings.alwaysDisplayTabsMode() && panels.size() == 1 && parent != null && panels.get(0).getDockable().getTabPreference() != DockableTabPreference.TOP) {
  			parent.replaceChild(this, new DockedSimplePanel(docking, panels.get(0), anchor));
  		}
  
  		// protect against bad instances when failing to restore a layout
  		if (parent != null && panels.isEmpty()) {
  			DockableWrapper anchorWrapper = DockingInternal.get(docking).getAnchor(anchor);
  
  			anchor = "";
  
  			if (anchorWrapper == null || !DockingComponentUtils.isAnchorEmpty(docking, anchorWrapper.getDockable())) {
  				parent.removeChild(this);
  			}
  			else {
  				anchor = "";
  				parent.replaceChild(this, new DockedAnchorPanel(docking, anchorWrapper));
  				anchorWrapper.setWindow(DockingInternal.get(docking).getWrapper(dockable).getWindow());
  			}
  		}
  	}
  
  	@Override
  	public void replaceChild(DockingPanel child, DockingPanel newChild) {
  		// no-op, docked tab can't have panel children, wrappers only
  	}
  
  	@Override
  	public void removeChild(DockingPanel child) {
  		// no-op, docked tab can't have panel children, wrappers only
  	}
  
  	public List<DockingPanel> getChildren() {
  		return Collections.emptyList();
  	}
  
  	private void setNotSelectedBorder() {
  		Color color = UIManager.getColor("Component.borderColor");
  
  		setBorder(
  				BorderFactory.createCompoundBorder(
  						BorderFactory.createEmptyBorder(1, 1, 1, 1),
  						BorderFactory.createLineBorder(color, 1)
  				)
  		);
  	}
  
  	/**
  	 * Set the specified dockable as the selected tab in the tab pane
  	 *
  	 * @param dockable Dockable to bring to front
  	 */
  	public void bringToFront(Dockable dockable) {
  		for (int i = 0; i < panels.size(); i++) {
  			DockableWrapper panel = panels.get(i);
  
  			if (panel.getDockable() == dockable) {
  				if (tabs.getSelectedIndex() != i) {
  					if (tabs.getSelectedIndex() != -1) {
  						DockingListeners.fireHiddenEvent(panels.get(tabs.getSelectedIndex()).getDockable());
  					}
  					DockingListeners.fireShownEvent(panels.get(i).getDockable());
  				}
  				tabs.setSelectedIndex(i);
  				selectedTab = tabs.getSelectedIndex();
  			}
  		}
  	}
  
  	/**
  	 * Get the persistent ID of the selected tab
  	 *
  	 * @return The persistent ID of the selected tab
  	 */
  	public String getSelectedTabID() {
  		return panels.get(tabs.getSelectedIndex()).getDockable().getPersistentID();
  	}
  
  	public int getSelectedTabIndex() {
  		return tabs.getSelectedIndex();
  	}
  
  	@Override
  	public void stateChanged(ChangeEvent e) {
  		docking.getAppState().persist();
  
  		if (tabs.getSelectedIndex() == -1) {
  			return;
  		}
  
  		if (selectedTab != -1 && !Floating.isFloating()) {
  			DockingListeners.fireHiddenEvent(panels.get(selectedTab).getDockable());
  		}
  		selectedTab = tabs.getSelectedIndex();
  
  		if (selectedTab != -1) {
  			DockingListeners.fireShownEvent(panels.get(selectedTab).getDockable());
  		}
  	}
  
  	/**
  	 * Check if this tabbed panel is using top tabs
  	 *
  	 * @return Are the tabs placed on the top?
  	 */
  	public boolean isUsingTopTabs() {
  		return tabs.getTabPlacement() == JTabbedPane.TOP;
  	}
  
  	/**
  	 * Check if this tabbed panel is using bottom tabs
  	 *
  	 * @return Are the tabs placed on the bottom?
  	 */
  	public boolean isUsingBottomTabs() {
  		return tabs.getTabPlacement() == JTabbedPane.BOTTOM;
  	}
  
  	/**
  	 * Get the tab component for a dockable
  	 *
  	 * @param wrapper The dockable to find
  	 *
  	 * @return The tab component or null
  	 */
  	public Component getTabForDockable(DockableWrapper wrapper) {
  		for (int i = 0; i < panels.size(); i++) {
  			DockableWrapper panel = panels.get(i);
  
  			if (panel.getDockable() == wrapper.getDockable()) {
  				return tabs.getTabComponentAt(i);
  			}
  		}
  		return null;
  	}
  
  	public void updateTabInfo(Dockable dockable) {
  		for (int i = 0; i < panels.size(); i++) {
  			DockableWrapper panel = panels.get(i);
  
  			if (panel.getDockable() == dockable) {
  				tabs.setTitleAt(i, dockable.getTabText());
  				tabs.setToolTipTextAt(i, dockable.getTabTooltip());
  
  				Component tabComponent = tabs.getTabComponentAt(i);
  
  				if (tabComponent instanceof JLabel) {
  					((JLabel) tabComponent).setText(dockable.getTabText());
  					((JLabel) tabComponent).setToolTipText(dockable.getTabTooltip());
  				}
  			}
  		}
  	}
  
  	public int getTargetTabIndex(Point mousePosOnScreen) {
  		return tabs.getTargetTabIndex(mousePosOnScreen, false);
  	}
  
  	/**
  	 * Get the index of a specific panel
  	 *
  	 * @param displayPanel The panel to look for
  	 * @return The index of the panel or -1 if not found
  	 */
  	public int getIndexOfPanel(DisplayPanel displayPanel) {
  		for (int i = 0; i < panels.size(); i++) {
  			if (panels.get(i).getDisplayPanel() == displayPanel) {
  				return i;
  			}
  		}
  		return -1;
  	}
  
  	/**
  	 * Check if a drag has started in the "gutter" of a tabbed panel
  	 *
  	 * @param point The point of the drag
  	 *
  	 * @return Are we dragging from the tabbed panel?
  	 */
  	public boolean isDraggingFromTabGutter(Point point) {
  		Rectangle boundsAt = tabs.getBoundsAt(0);
  
  		return boundsAt.y <= point.y && (boundsAt.y + boundsAt.height) >= point.y;
  
  	}
  }
  