// $Id: ActionCompartmentDisplay.java,v 1.5 2004/09/27 21:18:23 mvw Exp $
// Copyright (c) 1996-2001 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.

// File: ActionCompartmentDisplay.java
// Classes: ActionCompartmentDisplay
// Original Author: your email address here
// $Id: ActionCompartmentDisplay.java,v 1.5 2004/09/27 21:18:23 mvw Exp $

// 8 Apr 2002: Jeremy Bennett (mail@jeremybennett.com). Extended to support
// compartments for extension points on use cases.


package org.argouml.uml.diagram.ui;

import org.argouml.uml.diagram.static_structure.ui.*;
import org.argouml.uml.diagram.use_case.ui.*;
import org.argouml.uml.ui.UMLAction;
import org.tigris.gef.base.*;
import org.tigris.gef.presentation.*;
import java.awt.event.*;
import java.util.*;


/**
 * A class to implement the actions involved in hiding and showing
 * compartments on interfaces, classes and use cases.

 *
 * This implementation extended to handle compartments for extension points
 * on use cases.

 *
 * The class declares a number of static instances, each with an
 * actionPerformed method that performs the required action.
 */
public class ActionCompartmentDisplay extends UMLAction {


    ///////////////////////////////////////////////////////////////////////////
    //
    // Instance variables
    //
    ///////////////////////////////////////////////////////////////////////////

    /**
     * 
A flag to indicate whether the action should show or hide the
     *   relevant compartment.
     */
    private boolean display = false;


    /**
     * 
A string indicating the action desired.
     */
    private String compartment = "";


    ///////////////////////////////////////////////////////////////////////////
    //
    // Class variables
    //
    ///////////////////////////////////////////////////////////////////////////

    /**
     * Static instance to show the attribute compartment of a class.
     */
    private static final UMLAction SHOW_ATTR_COMPARTMENT =
        new ActionCompartmentDisplay(true, "action.show-attribute-compartment");

    /**
     * Static instance to hide the attribute compartment of a class.
     */
    private static final UMLAction HIDE_ATTR_COMPARTMENT =
        new ActionCompartmentDisplay(false, 
                "action.hide-attribute-compartment");

    /**
     * Static instance to show the operation compartment of a class.
     */
    private static final UMLAction SHOW_OPER_COMPARTMENT =
        new ActionCompartmentDisplay(true, "action.show-operation-compartment");

    /**
     * Static instance to hide the operation compartment of a class.
     */
    private static final UMLAction HIDE_OPER_COMPARTMENT =
        new ActionCompartmentDisplay(false, 
				     "action.hide-operation-compartment");

    /**
     * Static instance to show the extension point compartment of a use
     * case.
     */
    private static final UMLAction SHOW_EXTPOINT_COMPARTMENT =
        new ActionCompartmentDisplay(true,
                                     "action.show-extension-point-compartment");

    /**
     * Static instance to hide the extension point compartment of a use
     *   case.
     */
    private static final UMLAction HIDE_EXTPOINT_COMPARTMENT =
        new ActionCompartmentDisplay(false,
                                     "action.hide-extension-point-compartment");

    /**
     * Static instance to show both compartments of a class.
     */
    private static final UMLAction SHOW_ALL_COMPARTMENTS =
        new ActionCompartmentDisplay(true, "action.show-all-compartments");

    /**
     * Static instance to hide both compartments of a class.
     */
    private static final UMLAction HIDE_ALL_COMPARTMENTS =
        new ActionCompartmentDisplay(false, "action.hide-all-compartments");


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

    /**
     * Constructor for a new instance. Can only be called by this class or
     * its children, since used to create static instances only.
     *
     * @param d  true if the compartment is to be shown,
     *           false if it is to be hidden.
     *
     * @param c  The text to be displayed for this action.
     */
    protected ActionCompartmentDisplay(boolean d, String c) {

        // Invoke the parent constructor
	super(c, NO_ICON);

        // Save copies of the parameters
	display = d;
	compartment = c;
    }


    ///////////////////////////////////////////////////////////////////////////
    //
    // main methods
    //
    ///////////////////////////////////////////////////////////////////////////

    /**
     * 
Action method invoked when an event triggers this action.
     *
     * 
The {@link #compartment} instance variable defines the action to
     *   take, and the {@link #display} instance variable whether it should
     *   set visibility or note.
     *
     * 
Note. The {@link #display} instance variable is really
     *   redundant. Its value is implied by the operation.
     *
     * @param ae  The event that triggered us.
     */
    public void actionPerformed(ActionEvent ae) {

        // Only do anything if we have a single item selected (surely this
        // should work for multiple selections as well?).

	Vector sels = Globals.curEditor().getSelectionManager().selections();

	if ( sels.size() == 1 ) {
	    Selection sel = (Selection) sels.firstElement();
	    Fig       f   = sel.getContent();

            // Perform the action

	    if (compartment.equals("action.show-attribute-compartment")) {
		((FigClass) f).setAttributesVisible(display);
            }
	    else if (compartment.equals("action.hide-attribute-compartment")) {
		((FigClass) f).setAttributesVisible(display);
            }
	    else if (compartment.equals("action.show-operation-compartment")
		  || compartment.equals("action.hide-operation-compartment")) {
		if (f instanceof FigClass)
			((FigClass) f).setOperationsVisible(display);
		if (f instanceof FigInterface)
			((FigInterface) f).setOperationsVisible(display);
            }
	    else if (compartment.equals(
                "action.show-extension-point-compartment")) {
		((FigUseCase) f).setExtensionPointVisible(display);
            }
	    else if (compartment.equals(
                "action.hide-extension-point-compartment")) {
		((FigUseCase) f).setExtensionPointVisible(display);
            }
	    else if (compartment.equals("action.show-all-compartments")) {
		((FigClass) f).setAttributesVisible(display);
		((FigClass) f).setOperationsVisible(display);
	    }
	    else {
		((FigClass) f).setAttributesVisible(display);
		((FigClass) f).setOperationsVisible(display);
	    }
	}
    }


    /**
     * 
Indicate whether this action should be enabled.
     *
     * 
Always returns true in this implementation.
     *
     * @return  true if the action should be enabled,
     *          false otherwise. Always returns true
     *          in this implementation.
     */

    public boolean shouldBeEnabled() {
	return true;
    }


    /**
     * @return the action to show the attribute compartment
     */
    public static UMLAction showAttrCompartment() {
        return SHOW_ATTR_COMPARTMENT;
    }


    /**
     * @return the action to hide the attribute compartment
     */
    public static UMLAction hideAttrCompartment() {
        return HIDE_ATTR_COMPARTMENT;
    }


    /**
     * @return the action to show the operation compartment
     */
    public static UMLAction showOperCompartment() {
        return SHOW_OPER_COMPARTMENT;
    }


    /**
     * @return the action to hide the operation compartment
     */
    public static UMLAction hideOperCompartment() {
        return HIDE_OPER_COMPARTMENT;
    }


    /**
     * @return the action to show the extension point compartment
     */
    public static UMLAction showExtPointCompartment() {
        return SHOW_EXTPOINT_COMPARTMENT;
    }


    /**
     * @return the action to hide the extension point compartment
     */
    public static UMLAction hideExtPointCompartment() {
        return HIDE_EXTPOINT_COMPARTMENT;
    }


    /**
     * @return the action to show all the compartments
     */
    public static UMLAction showAllCompartments() {
        return SHOW_ALL_COMPARTMENTS;
    }


    /**
     * @return the action to hide all compartments
     */
    public static UMLAction hideAllCompartments() {
        return HIDE_ALL_COMPARTMENTS;
    }

} /* end class ActionCompartmentDisplay */