/* $Id: AbstractActionNavigate.java 17881 2010-01-12 21:09:28Z linus $

  *****************************************************************************

  * Copyright (c) 2009 Contributors - see below

  * All rights reserved. This program and the accompanying materials

  * are made available under the terms of the Eclipse Public License v1.0

  * which accompanies this distribution, and is available at

  * http://www.eclipse.org/legal/epl-v10.html

  *

  * Contributors:

  *    bobtarling

  *****************************************************************************

  *

  * Some portions of this file was previously release using the BSD License:

  */

 // Copyright (c) 2003-2007 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.ui;

 import java.awt.event.ActionEvent;

 import javax.swing.Action;

 import javax.swing.Icon;

 import org.argouml.application.helpers.ResourceLoaderWrapper;

 import org.argouml.i18n.Translator;

 import org.argouml.model.Model;

 import org.argouml.ui.targetmanager.TargetEvent;

 import org.argouml.ui.targetmanager.TargetListener;

 import org.argouml.ui.targetmanager.TargetManager;

 import org.argouml.ui.UndoableAction;

 /**

  *

  * @author mkl

  *

  */

 public abstract class AbstractActionNavigate extends UndoableAction 

     implements TargetListener {

     /**

      * The constructor.

      */

     public AbstractActionNavigate() {

         this("button.go-up", true);

     }

     /**

      * @param key The key (to be localized) of the name of the action.

      * @param hasIcon true if there is an icon for this action

      */

     public AbstractActionNavigate(String key, boolean hasIcon) {

         super(Translator.localize(key),

                         hasIcon ? ResourceLoaderWrapper.lookupIcon(key) : null);

         // Set the tooltip string:

         putValue(Action.SHORT_DESCRIPTION, 

                 Translator.localize(key));

         putValue(Action.SMALL_ICON,

                  ResourceLoaderWrapper.lookupIconResource("NavigateUp"));

     }

     /**

      * @param newIcon the icon for this action

      * @return this action

      */

     public AbstractActionNavigate setIcon(Icon newIcon) {

         putValue(Action.SMALL_ICON, newIcon);

         return this;

     }

     /**

      * Abstract method to do the navigation. The actual navigation is performed

      * by actionPerformed.

      *

      * @param source

      *            the object to navigate from

      * @return the object to navigate to

      */

     protected abstract Object navigateTo(Object source);

     /*

      * @see javax.swing.Action#isEnabled()

      */

     public boolean isEnabled() {

         Object target = TargetManager.getInstance().getModelTarget();

         return ((target != null) && (navigateTo(target) != null));

     }

     /*

      * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)

      */

     public void actionPerformed(ActionEvent e) {

             super.actionPerformed(e);

         Object target = TargetManager.getInstance().getModelTarget();

         if (Model.getFacade().isAUMLElement(target)) {

             Object elem = target;

             Object nav = navigateTo(elem);

             if (nav != null) {

                 TargetManager.getInstance().setTarget(nav);

             }

         }

     }

     /*

      * @see org.argouml.ui.targetmanager.TargetListener#targetAdded(org.argouml.ui.targetmanager.TargetEvent)

      */

     public void targetAdded(TargetEvent e) {

         setEnabled(isEnabled());

     }

     /*

      * @see org.argouml.ui.targetmanager.TargetListener#targetRemoved(org.argouml.ui.targetmanager.TargetEvent)

      */

     public void targetRemoved(TargetEvent e) {

         setEnabled(isEnabled());

     }

     /*

      * @see org.argouml.ui.targetmanager.TargetListener#targetSet(org.argouml.ui.targetmanager.TargetEvent)

      */

     public void targetSet(TargetEvent e) {

         setEnabled(isEnabled());

     }

 }