// $Id: TabSpawnable.java,v 1.22 2004/09/04 07:47:51 mvw Exp $
// Copyright (c) 1996-99 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.ui;

import javax.swing.JPanel;

import org.apache.log4j.Logger;
import org.argouml.swingext.Orientable;
import org.argouml.swingext.Orientation;

/**
 * A subclass of JPanel that can act as a tab in the DetailsPane or
 * MultiEditorPane. When the tab is double-clicked, this JPanel will generate a
 * separate window of the same size and with the same contents. This is almost
 * like "tearing off" a tab.
 * 

 * TODO: Spawning of windows disabled in spawn()
 */
public class TabSpawnable extends JPanel implements Cloneable, Orientable {

    private static final Logger LOG = Logger.getLogger(TabSpawnable.class);

    private static final int OVERLAPP = 30;

    private static final String BUNDLE = "UMLMenu";

    ////////////////////////////////////////////////////////////////
    // instance variables

    private String title = "untitled";

    /**
     * if true, remove tab from parent JTabbedPane
     */
    private boolean tear = false;

    private Orientation orientation;

    /**
     * @return Returns the orientation.
     */
    public Orientation getOrientation() {
        return orientation;
    }
    ////////////////////////////////////////////////////////////////
    // constructor

    /**
     * The constructor.
     * 
     */
    public TabSpawnable() {
        this("untitled", false);
    }

    /**
     * The constructor.
     * 
     * @param tag the name
     */
    public TabSpawnable(String tag) {
        this(tag, false);
    }

    /**
     * The constructor.
     * 
     * @param tag the name
     * @param t if true, remove tab from parent JTabbedPane
     */
    public TabSpawnable(String tag, boolean t) {
        setTitle(tag);
        tear = t;
    }

    /**
     * This is not a real clone since it doesn't copy anything from the object
     * it is cloning. The
     * 
     * @see #spawn method copies the title and in some cases when we are a
     * @see TabToDoTarget or
     * @see TabModelTarget also the Target.
     * 
     * @return the new object or null if not possible.
     */
    public Object clone() {
        try {
            return this.getClass().newInstance();
        } catch (Exception ex) {
            LOG.error("exception in clone()", ex);
        }
        return null;
    }

    /**
     * Set the orientation of the property panel.
     *
     * @see org.argouml.swingext.Orientable#setOrientation(org.argouml.swingext.Orientation)
     */
    public void setOrientation(Orientation o) {
        this.orientation = o;
    }

    ////////////////////////////////////////////////////////////////
    // accessors

    /**
     * @return the title
     */
    public String getTitle() {
        return title;
    }

    /**
     * @param t the title
     */
    public void setTitle(String t) {
        title = t;
    }

    ////////////////////////////////////////////////////////////////
    // actions

    /**
     * this should take its inspiration from org.tigris.gef.base.CmdSpawn
     * 
     * 

     * The spawned/cloned tab will be a JFrame. Currently this feature is
     * disabled for ArgoUML and spawn always returns null to indicate that
     * spawning failed. Code should behave though as if spawning might work at a
     * later stage.
     * 
     * @return a copy of the frame or null if not clone-able.
     */
    public TabSpawnable spawn() {

        // TODO: this disables spawning
        return null;
        
/*        JDialog f = new JDialog(ProjectBrowser.getInstance());
        f.getContentPane().setLayout(new BorderLayout());
        f.setTitle(Translator.localize(BUNDLE, title));
        TabSpawnable newPanel = (TabSpawnable) clone();
        if (newPanel == null) return null; //failed to clone

        if (newPanel instanceof TabToDoTarget) {
            TabToDoTarget me = (TabToDoTarget) this;
            TabToDoTarget it = (TabToDoTarget) newPanel;
            it.setTarget(me.getTarget());
        } else if (newPanel instanceof TabModelTarget) {
            TabModelTarget me = (TabModelTarget) this;
            TabModelTarget it = (TabModelTarget) newPanel;
            it.setTarget(me.getTarget());
        } else if (newPanel instanceof TabDiagram) {
            TabDiagram me = (TabDiagram) this;
            TabDiagram it = (TabDiagram) newPanel;
            it.setTarget(me.getTarget());
        }

        newPanel.setTitle(Translator.localize(BUNDLE, title));

        f.getContentPane().add(newPanel, BorderLayout.CENTER);
        Rectangle bounds = getBounds();
        bounds.height += OVERLAPP * 2;
        f.setBounds(bounds);

        Point loc = new Point(0, 0);
        SwingUtilities.convertPointToScreen(loc, this);
        loc.y -= OVERLAPP;
        f.setLocation(loc);
        f.setVisible(true);

        if (tear && (getParent() instanceof JTabbedPane))
                ((JTabbedPane) getParent()).remove(this);

        return newPanel;
*/    
    }

} /* end class TabSpawnable */