// $Id: FigStateVertex.java,v 1.16 2004/07/26 11:13:13 mvw Exp $
// Copyright (c) 1996-2004 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.uml.diagram.state.ui;

import org.argouml.model.ModelFacade;
import org.argouml.model.uml.behavioralelements.statemachines.StateMachinesHelper;
import org.argouml.uml.diagram.activity.ui.SelectionActionState;
import org.argouml.uml.diagram.ui.FigNodeModelElement;
import org.tigris.gef.base.Selection;
import org.tigris.gef.graph.GraphModel;
import org.tigris.gef.presentation.Fig;

/**
 * Abstract class to with common behavior for nestable nodes in UML Statechart
 * diagrams.
 */
public abstract class FigStateVertex extends FigNodeModelElement {

    ////////////////////////////////////////////////////////////////
    // constructors

    /**
     * The main constructor
     */
    public FigStateVertex() {
    }

    /** The constructor which hooks the Fig into the UML element
     * @param gm ignored
     * @param node the UML elm
     */
    public FigStateVertex(GraphModel gm, Object node) {
        this();
        setOwner(node);
    }

    ////////////////////////////////////////////////////////////////
    // nestable nodes

    /**
     * Overriden to make it possible to include a statevertex in a composite
     * state.
     * @see org.tigris.gef.presentation.Fig#setEnclosingFig(org.tigris.gef.presentation.Fig)
     */
    public void setEnclosingFig(Fig encloser) {
        super.setEnclosingFig(encloser);
        if (!(ModelFacade.isAStateVertex(getOwner()))) return;
        Object stateVertex = getOwner();
        Object compositeState = null;
        if (encloser != null
                && (ModelFacade.isACompositeState(encloser.getOwner()))) {
            compositeState = encloser.getOwner();
        } else {
            compositeState = StateMachinesHelper.getHelper().getTop(
                    StateMachinesHelper.getHelper()
                            .getStateMachine(stateVertex));
        }
        if (compositeState != null)
                ModelFacade.setContainer(stateVertex, compositeState);
    }

    /**
     * return selectors, depending whether we deal with activity or state
     * diagrams.
     * 
     * @see org.tigris.gef.presentation.Fig#makeSelection()
     */
    public Selection makeSelection() {
        Object pstate = getOwner();

        if (pstate != null) {

            if (org.argouml.model.ModelFacade.isAActivityGraph(ModelFacade
                    .getStateMachine(ModelFacade.getContainer(pstate)))) {
                return new SelectionActionState(this);
            } else {
                return new SelectionState(this);
            }
        }
        return null;
    }

} /* end class FigStateVertex */