/*
    *  XNap - A P2P framework and client.
    *
    *  See the file AUTHORS for copyright information.
    *
    *  This program is free software; you can redistribute it and/or modify
    *  it under the terms of the GNU General Public License as published by
    *  the Free Software Foundation.
    *
   *  This program is distributed in the hope that it will be useful,
   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   *  GNU General Public License for more details.
   *
   *  You should have received a copy of the GNU General Public License
   *  along with this program; if not, write to the Free Software
   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  package org.xnap.gui.shortcut;
  
  import java.util.Iterator;
  import java.util.LinkedList;
  import javax.swing.Action;
  import javax.swing.InputMap;
  import javax.swing.JComponent;
  import javax.swing.KeyStroke;
  import org.xnap.XNap;
  import org.xnap.action.AbstractXNapAction;
  import org.xnap.util.PreferencesProvider;
  
  /***
   * Provides an action based shortcut.
   * 
   * The action has to provide several values to make use of the shortcut.
   * 
   * It must provide the following values:
   * 
   * Action.ACTION_COMMAND_KEY, the preferences key
   *
   * It should provide values for the following keys:
   * 
   * AbstractXNapAction.DEFAULT_KEYSTROKE, the default KeyStroke
   * AbstractXNapAction.SHORTCUT_CATEGORY, category used in the
   * ShortcutsPrefsPanel
   */
  public class ActionShortcut implements Shortcut 
  {
  
      //--- Constant(s) ---
  
      //--- Data field(s) ---
  
      private String category;
  	private String description;
  	
      private PreferencesProvider prefs;
      private String prefsKey;
  
      private KeyStroke defaultKeyStroke;
  	private KeyStroke currentKeyStroke;
  
  	private LinkedList components = new LinkedList();
  	
      //--- Constructor(s) ---
  
      public ActionShortcut(Action action, JComponent c, 
  						  PreferencesProvider prefs)
      {
  		String cat = (String)action.getValue
  			(AbstractXNapAction.SHORTCUT_CATEGORY);
  		category = (cat != null) ? cat : XNap.tr("General");
  
  		String desc = 
  			(String)action.getValue(AbstractXNapAction.SHORTCUT_DESCRIPTION);
  		description =  (desc != null) ? desc 
  			: (String)action.getValue(Action.SHORT_DESCRIPTION);
  
      	defaultKeyStroke = (KeyStroke)action.getValue
  			(AbstractXNapAction.DEFAULT_KEYSTROKE);
  
  		currentKeyStroke = defaultKeyStroke;
      	
  		this.prefs = prefs;
      	prefsKey = (String)action.getValue(Action.ACTION_COMMAND_KEY);
  
  		if (prefs != null && prefsKey != null) {
  			currentKeyStroke = prefs.getKeyStroke(prefsKey + "Shortcut");
  		}
  
  		addComponent(c, action);
      }   
  
      //--- Method(s) ---
  
      /***
  	 * Installs the action into the action map of the component and sets up
  	 * the shortcut mapping.  
  	 */
  	public void addComponent(JComponent c, Action a)
 	{
 		// install action into action map
 		c.getActionMap().put(prefsKey, a);
 		components.add(c);
 		setKeyStroke(currentKeyStroke, c);
 	}
 
 	/***
 	 * Removes the action mapping from the given component and removes it
 	 * from its list of components.
 	 * @param c the component this shortcuts is registered on
 	 */
 	public void removeComponent(JComponent c)
 	{
 		// remove action from action map
 		c.getActionMap().remove(prefsKey);
 		components.remove(c);
 	}
 
 	public String getPrefsKey()
 	{
 		return prefsKey;
 	}
 
 	public int getNumberOfComponents()
 	{
 		return components.size();
 	}
 
     /***
      *  @see org.xnap.gui.shortcut.Shortcut#getCategory()
      */
     public String getCategory() 
     {
 		return category;
     }
 
     /***
      *  @see org.xnap.gui.shortcut.Shortcut#getDescription()
      */
     public String getDescription() 
     {
 		return description;
     }
 
     /***
      *  @see org.xnap.gui.shortcut.Shortcut#getKeystroke()
      */
     public KeyStroke getKeyStroke() 
     {
 		return currentKeyStroke;
     }
 
 	private void setKeyStroke(KeyStroke stroke, JComponent c)
 	{
 		InputMap m = c.getInputMap
 			(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
 
 		// remove old mapping
 		if (getKeyStroke() != null) {
 			m.remove(getKeyStroke());
 		}
 		// install new mapping
 		if (stroke != null) {
 			m.put(stroke, prefsKey);
 		}
 	}
 
     /***
      *  @see org.xnap.gui.shortcut.Shortcut#setKeystroke(javax.swing.KeyStroke)
      */
     public void setKeyStroke(KeyStroke stroke) 
     {
 		for (Iterator i = components.iterator(); i.hasNext();) {
 			JComponent c = (JComponent)i.next();
 			setKeyStroke(stroke, c);
 		}
 		
 		currentKeyStroke = stroke;
 
 		if (prefs != null && prefsKey != null) {
 			prefs.set(prefsKey + "Shortcut", stroke);
 		}
     }
 
     /***
      *  @see org.xnap.gui.shortcut.Shortcut#getDefaultKeyStroke()
      */
     public KeyStroke getDefaultKeyStroke() 
     {
 		return defaultKeyStroke;
     }
 }