|
|
@@ -0,0 +1,303 @@ |
|
|
|
|
|
/* |
|
|
|
|
|
* The Apache Software License, Version 1.1 |
|
|
|
|
|
* |
|
|
|
|
|
* Copyright (c) 1999, 2000 The Apache Software Foundation. All rights |
|
|
|
|
|
* reserved. |
|
|
|
|
|
* |
|
|
|
|
|
* Redistribution and use in source and binary forms, with or without |
|
|
|
|
|
* modification, are permitted provided that the following conditions |
|
|
|
|
|
* are met: |
|
|
|
|
|
* |
|
|
|
|
|
* 1. Redistributions of source code must retain the above copyright |
|
|
|
|
|
* notice, this list of conditions and the following disclaimer. |
|
|
|
|
|
* |
|
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright |
|
|
|
|
|
* notice, this list of conditions and the following disclaimer in |
|
|
|
|
|
* the documentation and/or other materials provided with the |
|
|
|
|
|
* distribution. |
|
|
|
|
|
* |
|
|
|
|
|
* 3. The end-user documentation included with the redistribution, if |
|
|
|
|
|
* any, must include the following acknowlegement: |
|
|
|
|
|
* "This product includes software developed by the |
|
|
|
|
|
* Apache Software Foundation (http://www.apache.org/)." |
|
|
|
|
|
* Alternately, this acknowlegement may appear in the software itself, |
|
|
|
|
|
* if and wherever such third-party acknowlegements normally appear. |
|
|
|
|
|
* |
|
|
|
|
|
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software |
|
|
|
|
|
* Foundation" must not be used to endorse or promote products derived |
|
|
|
|
|
* from this software without prior written permission. For written |
|
|
|
|
|
* permission, please contact apache@apache.org. |
|
|
|
|
|
* |
|
|
|
|
|
* 5. Products derived from this software may not be called "Apache" |
|
|
|
|
|
* nor may "Apache" appear in their names without prior written |
|
|
|
|
|
* permission of the Apache Group. |
|
|
|
|
|
* |
|
|
|
|
|
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
|
|
|
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
|
|
|
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|
|
|
|
|
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
|
|
|
|
|
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
|
|
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
|
|
|
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
|
|
|
|
|
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
|
|
|
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
|
|
|
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
|
|
|
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
|
|
|
|
|
* SUCH DAMAGE. |
|
|
|
|
|
* ==================================================================== |
|
|
|
|
|
* |
|
|
|
|
|
* This software consists of voluntary contributions made by many |
|
|
|
|
|
* individuals on behalf of the Apache Software Foundation. For more |
|
|
|
|
|
* information on the Apache Software Foundation, please see |
|
|
|
|
|
* <http://www.apache.org/>. |
|
|
|
|
|
*/ |
|
|
|
|
|
package org.apache.tools.ant.gui; |
|
|
|
|
|
|
|
|
|
|
|
import org.apache.tools.ant.gui.event.*; |
|
|
|
|
|
import javax.swing.*; |
|
|
|
|
|
import java.awt.event.ActionEvent; |
|
|
|
|
|
import java.awt.event.ActionListener; |
|
|
|
|
|
import java.util.*; |
|
|
|
|
|
import java.net.URL; |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Manager of antidote actions. Receives its configuration from the action |
|
|
|
|
|
* ResourceBundle. |
|
|
|
|
|
* |
|
|
|
|
|
* @version $Revision$ |
|
|
|
|
|
* @author Simeon Fitch |
|
|
|
|
|
*/ |
|
|
|
|
|
public class ActionManager { |
|
|
|
|
|
private ResourceBundle _resources = |
|
|
|
|
|
ResourceBundle.getBundle( |
|
|
|
|
|
"org.apache.tools.ant.gui.resources.action"); |
|
|
|
|
|
|
|
|
|
|
|
/** Array of action identifiers. */ |
|
|
|
|
|
private String[] _actionIDs = null; |
|
|
|
|
|
|
|
|
|
|
|
/** Look table of all defined actions. */ |
|
|
|
|
|
private Map _actions = new HashMap(); |
|
|
|
|
|
|
|
|
|
|
|
/** Event bus. */ |
|
|
|
|
|
private EventBus _bus = null; |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Standard ctor. |
|
|
|
|
|
* |
|
|
|
|
|
* @param bus Event bus to post events to. |
|
|
|
|
|
*/ |
|
|
|
|
|
public ActionManager(EventBus bus) { |
|
|
|
|
|
_bus = bus; |
|
|
|
|
|
|
|
|
|
|
|
// Configure the set of actions. |
|
|
|
|
|
String toTok = _resources.getString("actions"); |
|
|
|
|
|
StringTokenizer tok = new StringTokenizer(toTok, ", "); |
|
|
|
|
|
_actionIDs = new String[tok.countTokens()]; |
|
|
|
|
|
for(int i = 0; i < _actionIDs.length; i++) { |
|
|
|
|
|
_actionIDs[i] = tok.nextToken(); |
|
|
|
|
|
_actions.put(_actionIDs[i], new AntAction(_actionIDs[i])); |
|
|
|
|
|
} |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Create a menubar for the application based on the configuration file. |
|
|
|
|
|
* |
|
|
|
|
|
* @return Menubar. |
|
|
|
|
|
*/ |
|
|
|
|
|
public JMenuBar createMenuBar() { |
|
|
|
|
|
JMenuBar retval = new JMenuBar(); |
|
|
|
|
|
Map menus = new HashMap(); |
|
|
|
|
|
|
|
|
|
|
|
String toTok = _resources.getString("menus"); |
|
|
|
|
|
StringTokenizer tok = new StringTokenizer(toTok, ", "); |
|
|
|
|
|
while(tok.hasMoreTokens()) { |
|
|
|
|
|
String name = tok.nextToken(); |
|
|
|
|
|
JMenu menu = new JMenu(name); |
|
|
|
|
|
retval.add(menu); |
|
|
|
|
|
menus.put(name, menu); |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
for(int i = 0; i < _actionIDs.length; i++) { |
|
|
|
|
|
AntAction action = (AntAction) _actions.get(_actionIDs[i]); |
|
|
|
|
|
String parent = action.getParentMenuName(); |
|
|
|
|
|
if(parent != null) { |
|
|
|
|
|
JMenu menu = (JMenu) menus.get(parent); |
|
|
|
|
|
// A well configured file shouldn't cause this, |
|
|
|
|
|
// but be safe anyway. |
|
|
|
|
|
if(menu == null) { |
|
|
|
|
|
menu = new JMenu(parent); |
|
|
|
|
|
retval.add(menu); |
|
|
|
|
|
menus.put(parent, menu); |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
if(action.isPreceededBySeparator()) { |
|
|
|
|
|
menu.addSeparator(); |
|
|
|
|
|
} |
|
|
|
|
|
JMenuItem item = menu.add(action); |
|
|
|
|
|
addNiceStuff(item, action); |
|
|
|
|
|
} |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
return retval; |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Create a tool bar based on the current configuration. |
|
|
|
|
|
* |
|
|
|
|
|
* @return Toolbar ready for action. |
|
|
|
|
|
*/ |
|
|
|
|
|
public JToolBar createToolBar() { |
|
|
|
|
|
JToolBar retval = new JToolBar(); |
|
|
|
|
|
|
|
|
|
|
|
for(int i = 0; i < _actionIDs.length; i++) { |
|
|
|
|
|
AntAction action = (AntAction) _actions.get(_actionIDs[i]); |
|
|
|
|
|
// If it has an icon, then we add it to the toolbar. |
|
|
|
|
|
if(action.getIcon() != null) { |
|
|
|
|
|
if(action.isPreceededBySeparator()) { |
|
|
|
|
|
retval.addSeparator(); |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
JButton button = retval.add(action); |
|
|
|
|
|
button.setText(null); |
|
|
|
|
|
|
|
|
|
|
|
addNiceStuff(button, action); |
|
|
|
|
|
} |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
return retval; |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
private void addNiceStuff(AbstractButton button, AntAction action) { |
|
|
|
|
|
// Set the action command so that it is consitent |
|
|
|
|
|
// no matter what language the display is in. |
|
|
|
|
|
button.setActionCommand(action.getID()); |
|
|
|
|
|
String tip = action.getShortDescription(); |
|
|
|
|
|
if(tip != null) { |
|
|
|
|
|
button.setToolTipText(tip); |
|
|
|
|
|
} |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Convenience method for looking put a resource with the name |
|
|
|
|
|
* "id.key". Will return null if the resource doesn't exist. |
|
|
|
|
|
* |
|
|
|
|
|
* @param id Action id. |
|
|
|
|
|
* @param key Key name for the action. |
|
|
|
|
|
* @return String resource for composite key, or null if not found. |
|
|
|
|
|
*/ |
|
|
|
|
|
private String getString(String id, String key) { |
|
|
|
|
|
String retval = null; |
|
|
|
|
|
try { |
|
|
|
|
|
retval = _resources.getString(id + "." + key); |
|
|
|
|
|
} |
|
|
|
|
|
catch(MissingResourceException ex) { |
|
|
|
|
|
// Its ok to be missing a resource name... |
|
|
|
|
|
// Too bad the API throws an exception in this case. |
|
|
|
|
|
} |
|
|
|
|
|
return retval; |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** Class representing an action in the Antidote application. */ |
|
|
|
|
|
private class AntAction extends AbstractAction { |
|
|
|
|
|
/** Property name for the parent menu item. */ |
|
|
|
|
|
public static final String PARENT_MENU_NAME = "parentMenuName"; |
|
|
|
|
|
public static final String SEPARATOR = "separator"; |
|
|
|
|
|
|
|
|
|
|
|
/** Unique id. */ |
|
|
|
|
|
private String _id = null; |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Standard ctor. |
|
|
|
|
|
* |
|
|
|
|
|
* @param id Unique id for the action |
|
|
|
|
|
*/ |
|
|
|
|
|
public AntAction(String id) { |
|
|
|
|
|
_id = id; |
|
|
|
|
|
putValue(NAME, getString(id, "name")); |
|
|
|
|
|
putValue(SHORT_DESCRIPTION, getString(id, "shortDescription")); |
|
|
|
|
|
putValue(PARENT_MENU_NAME, getString(id, "parentMenuName")); |
|
|
|
|
|
putValue(SEPARATOR, getString(id, "separator")); |
|
|
|
|
|
|
|
|
|
|
|
String iconName = getString(id, "icon"); |
|
|
|
|
|
if(iconName != null) { |
|
|
|
|
|
try { |
|
|
|
|
|
URL imageLoc = |
|
|
|
|
|
AntAction.class.getResource("resources/" + iconName); |
|
|
|
|
|
if(imageLoc != null) { |
|
|
|
|
|
putValue(SMALL_ICON, new ImageIcon(imageLoc)); |
|
|
|
|
|
} |
|
|
|
|
|
} |
|
|
|
|
|
catch(Exception ex) { |
|
|
|
|
|
// XXX log me. |
|
|
|
|
|
ex.printStackTrace(); |
|
|
|
|
|
} |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Unique id for the action. |
|
|
|
|
|
* |
|
|
|
|
|
* @return Action id. |
|
|
|
|
|
*/ |
|
|
|
|
|
public String getID() { |
|
|
|
|
|
return _id; |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Get the name of the menu in the menu bar that this action shoul |
|
|
|
|
|
* appear under. |
|
|
|
|
|
* |
|
|
|
|
|
* @return Menu to appear under, or null if not a menu action. |
|
|
|
|
|
*/ |
|
|
|
|
|
public String getParentMenuName() { |
|
|
|
|
|
return (String) getValue(PARENT_MENU_NAME); |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Get the localized name for the action. |
|
|
|
|
|
* |
|
|
|
|
|
* @return Name |
|
|
|
|
|
*/ |
|
|
|
|
|
public String getName() { |
|
|
|
|
|
return (String) getValue(NAME); |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Get the short description. Used in tool tips. |
|
|
|
|
|
* |
|
|
|
|
|
* @return Short description. |
|
|
|
|
|
*/ |
|
|
|
|
|
public String getShortDescription() { |
|
|
|
|
|
return (String) getValue(SHORT_DESCRIPTION); |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Determine if a separator should appear before the action. |
|
|
|
|
|
* |
|
|
|
|
|
* @return True if add separator, false otherwise. |
|
|
|
|
|
*/ |
|
|
|
|
|
public boolean isPreceededBySeparator() { |
|
|
|
|
|
return Boolean.valueOf( |
|
|
|
|
|
String.valueOf(getValue(SEPARATOR))).booleanValue(); |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Get the icon. |
|
|
|
|
|
* |
|
|
|
|
|
* @return Icon for action, or null if none. |
|
|
|
|
|
*/ |
|
|
|
|
|
public Icon getIcon() { |
|
|
|
|
|
return (Icon) getValue(SMALL_ICON); |
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
|
|
* Pass the action on to the EventBus. |
|
|
|
|
|
* |
|
|
|
|
|
* @param e Event to forward. |
|
|
|
|
|
*/ |
|
|
|
|
|
public void actionPerformed(ActionEvent e) { |
|
|
|
|
|
_bus.postEvent(e); |
|
|
|
|
|
} |
|
|
|
|
|
} |
|
|
|
|
|
} |
Conor MacNeill
