com.actelion.research.gui.dock.Dockable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openchemlib Show documentation
Open Source Chemistry Library
There is a newer version: 2024.11.2
package com.actelion.research.gui.dock;

import javax.swing.*;
import java.awt.*;

/**
 * A lightweight component derived from JPanel that features certain subcomponents
 * that make it look similar to a frame or internal frame. It shows a titlebar above
 * its content component. The title bar has an
 * optional icon on the left, a title text and an optional toolbar on the right.
 */
public class Dockable extends JPanel {
	private static final long serialVersionUID = 0x20070720;

	private DockableHeader mHeader;
	private JDockingPanel mDockingPanel;
	private JComponent mContent;
	private boolean mIsSelected,mIsVisible;

	/**
	 * Constructs a TitledComponent with the specified title and content panel.
	 * @param dockingPanel
	 * @param content
	 * @param title the initial title, which must be unique within the JDockingPanel
	 * @param toolBar containing content specific functionality, e.g. config- and close-buttons
	 */
	public Dockable(JDockingPanel dockingPanel, JComponent content, String title, JToolBar toolBar) {
		super(new BorderLayout());
		setBorder(new ShadowBorder());

		mDockingPanel = dockingPanel;
		mContent = content;
		mHeader = new DockableHeader(this, title, toolBar);
		mIsVisible = false;
		add(mHeader, BorderLayout.NORTH);
		add(content, BorderLayout.CENTER);

		mHeader.update(mIsSelected);
		}

	/**
	 * Sets the minimum size of the encapsulated content component
	 * and sets the minimum width of the dockable header.
	 * This effectively limits the minimum size of the content component.
	 */
	public void setContentMinimumSize(Dimension size) {
		mContent.setMinimumSize(size);
		mHeader.setMinimumSize(new Dimension(size.width, mHeader.getPreferredSize().height));
		}

	/**
	 * Returns the title of dockable header.
	 * @return String the current title text
	 */
	public String getTitle() {
		return mHeader.getTitle();
	}

	/**
	 * @return the header of this dockable
	 */
	public DockableHeader getHeader() {
		return mHeader;
	}

	/**
	 * @return the JDockingPanel this Dockable is docked to.
	 */
	public JDockingPanel getDockingPanel() {
		return mDockingPanel;
	}

	/**
	 * Sets a new title text of the dockable header.
	 * @param newText the title text to be set
	 */
	public void setTitle(String newText) {
		String oldText = getTitle();
		mHeader.setTitle(newText);
		firePropertyChange("title", oldText, newText);
		}

	/**
	 * Removes the content temporarily to be added to another container
	 * Must be followed later by a endBorrowContent() call.
	 * @return the current content
	 */
	public JComponent borrowContent() {
		try {
			remove(mContent);
			}
		catch (Exception e) {
			e.printStackTrace();
			}
		return mContent;
		}

	/**
	 * Returns the content from temporarily adding it to another copntainer.
	 * Must be followed later by a returnContent() call.
	 * @return the current content
	 */
	public void endBorrowContent() {
		add(mContent, BorderLayout.CENTER);
		}

	/**
	 * Returns the content - null, if none has been set.
	 * 
	 * @return the current content
	 */
	public JComponent getContent() {
		return mContent;
		}

	/**
	 * Answers if the panel is currently selected, i.e. the active one. In the selected state,
	 * the header background is rendered differently.
	 * @return boolean
	 */
	public boolean isSelected() {
		return mIsSelected;
		}

	public boolean isMaximized() {
		return mDockingPanel.isMaximized();
		}

	/**
	 * Method used by the JDockingPanel to inform the dockable when its visibility changes.
	 * @param isVisible new visibility
	 */
	protected void notifyVisibility(boolean isVisible) {
		mIsVisible = isVisible;
		}

	/**
	 * Answers if the panel is currently visible, i.e. docked and not hidden by other dockables in a tabbed pane.
	 * @return boolean
	 */
	public boolean isVisibleDockable() {
		return mIsVisible;
		}

	/**
	 * This panel draws its title bar differently if it is selected, which may be used to indicate to the user
	 * that this panel has the focus, or should get more attention than other simple internal frames.
	 * 
	 * @param selected a boolean, where true means the frame is selected (currently active) and false means it
	 *			is not
	 */
	public void setSelected(boolean selected) {
		if (mIsSelected != selected) {
			mIsSelected = selected;
			mHeader.update(selected);
			if (selected)
				mContent.requestFocus();
			firePropertyChange("selected", !selected, selected);
			}
		}

	/**
	 * Updates the UI. In addition to the superclass behavior, we need to update the header component.
	 */
	public void updateUI() {
		super.updateUI();
		if (mHeader != null)
			mHeader.update(mIsSelected);
		}

	public Component getDragHandle() {
		return mHeader;
		}

	public PopupProvider getPopupProvider() {
		return mHeader.getPopupProvider();
		}

	public void setPopupProvider(PopupProvider p) {
		mHeader.setPopupProvider(p);
		}
	}