/*******************************************************************************
* CogTool Copyright Notice and Distribution Terms
* CogTool 1.3, Copyright (c) 2005-2013 Carnegie Mellon University
* This software is distributed under the terms of the FSF Lesser
* Gnu Public License (see LGPL.txt).
*
* CogTool is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* CogTool 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with CogTool; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* CogTool makes use of several third-party components, with the
* following notices:
*
* Eclipse SWT version 3.448
* Eclipse GEF Draw2D version 3.2.1
*
* Unless otherwise indicated, all Content made available by the Eclipse
* Foundation is provided to you under the terms and conditions of the Eclipse
* Public License Version 1.0 ("EPL"). A copy of the EPL is provided with this
* Content and is also available at http://www.eclipse.org/legal/epl-v10.html.
*
* CLISP version 2.38
*
* Copyright (c) Sam Steingold, Bruno Haible 2001-2006
* This software is distributed under the terms of the FSF Gnu Public License.
* See COPYRIGHT file in clisp installation folder for more information.
*
* ACT-R 6.0
*
* Copyright (c) 1998-2007 Dan Bothell, Mike Byrne, Christian Lebiere &
* John R Anderson.
* This software is distributed under the terms of the FSF Lesser
* Gnu Public License (see LGPL.txt).
*
* Apache Jakarta Commons-Lang 2.1
*
* This product contains software developed by the Apache Software Foundation
* (http://www.apache.org/)
*
* jopt-simple version 1.0
*
* Copyright (c) 2004-2013 Paul R. Holser, Jr.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* Mozilla XULRunner 1.9.0.5
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/.
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
* License for the specific language governing rights and limitations
* under the License.
*
* The J2SE(TM) Java Runtime Environment version 5.0
*
* Copyright 2009 Sun Microsystems, Inc., 4150
* Network Circle, Santa Clara, California 95054, U.S.A. All
* rights reserved. U.S.
* See the LICENSE file in the jre folder for more information.
******************************************************************************/
package edu.cmu.cs.hcii.cogtool.view;
import java.util.List;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.MenuAdapter;
import org.eclipse.swt.events.MenuEvent;
import org.eclipse.swt.events.MenuListener;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.Shell;
import edu.cmu.cs.hcii.cogtool.util.ListenerIdentifier;
import edu.cmu.cs.hcii.cogtool.util.ListenerIdentifierMap;
import edu.cmu.cs.hcii.cogtool.util.MenuUtil;
import edu.cmu.cs.hcii.cogtool.util.RcvrUIException;
import edu.cmu.cs.hcii.cogtool.util.ListenerIdentifier.ILIDTransmuter;
import edu.cmu.cs.hcii.cogtool.util.MenuUtil.MenuItemDefinition;
public class ContextMenuManager
{
protected boolean contextSelection = false;
protected Menu[] menus;
protected ListenerIdentifierMap lidMap;
protected ILIDTransmuter transmuter;
/**
* variable which holds a dynamic menu. This may be null.
*/
protected Menu dynamicMenu = null;
/**
* The shell for which to display menu objects.
*/
protected Shell shell;
/**
* Menu item selection support
*/
protected MenuListener menuListener =
new MenuAdapter() {
@Override
public void menuHidden(MenuEvent evt)
{
transmuter.cleanup(false, true);
}
};
// Delegate the work when a menu item is selected
protected Listener eventListener =
new Listener() {
public void handleEvent(Event e)
{
transmuter.performAction((ListenerIdentifier) e.widget.getData(),
contextSelection);
}
};
/**
* Constructs the set of context menus
* @param shell the window to which the menus will be attached
* @param lid the LID map for the menu
* @param muter the LID transmuter to use when an item is chosen
* @param items an array of MenuItemDefinition[] for each context menu
* @param handler handles selection on each of the context menus
*/
public ContextMenuManager(Shell inShell,
ListenerIdentifierMap lid,
ILIDTransmuter muter,
MenuItemDefinition[][] items)
{
lidMap = lid;
transmuter = muter;
shell = inShell;
// Build the context menus
menus = buildMenuList(items);
}
/**
* Create a pop-up context menu supporting some CogTool operations
*/
public Menu createContextMenu(MenuItemDefinition[] menuItems)
{
Menu contextMenu = MenuUtil.createMenu(shell,
SWT.POP_UP,
menuItems,
ListenerIdentifierMap.CONTEXT,
eventListener,
lidMap);
contextMenu.addMenuListener(menuListener);
return contextMenu;
}
protected Menu[] buildMenuList(MenuItemDefinition[][] items)
{
Menu[] menusList = new Menu[items.length];
for (int i = 0; i < menusList.length; i++) {
menusList[i] = createContextMenu(items[i]);
}
return menusList;
}
/**
* This lets you specify a custom list of menu item definitions
* If a previous dynamic menu was used, clean it up.
* @param items
*/
public Menu createDynamicMenu(List<MenuItemDefinition> items)
{
// Check and see if the dynamic menu was called previously, and clean
// it up if it exists.
if (dynamicMenu != null) {
dynamicMenu.removeMenuListener(menuListener);
dynamicMenu.dispose();
dynamicMenu = null;
}
MenuItemDefinition[] menuItems =
items.toArray(new MenuItemDefinition[0]);
dynamicMenu = createContextMenu(menuItems);
return dynamicMenu;
}
/**
* Specifies whether or not to use the context selection state
* (as opposed to the standard selection state)
* @param isContext true for context state; false for standard
*/
public void setContextSelection(boolean isContext)
{
contextSelection = isContext;
}
/**
* Show a particular context menu on the screen
* @param index the index of the menu to display
*/
public Menu getMenu(int index)
{
try {
return menus[index];
}
catch (IndexOutOfBoundsException e) {
throw new RcvrUIException("Tried to show nonexistent menu", e);
}
}
public void dispose()
{
for (Menu menu : menus) {
menu.dispose();
}
if (dynamicMenu != null) {
dynamicMenu.dispose();
}
}
}