//
// $Id$
//
// Nenya library - tools for developing networked games
// Copyright (C) 2002-2007 Three Rings Design, Inc., All Rights Reserved
// http://www.threerings.net/code/nenya/
//
// This library 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.
//
// This library 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 this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package com.threerings.flash {

import flash.ui.ContextMenuItem;
import flash.events.ContextMenuEvent;

import com.threerings.util.CommandEvent;

/**
 */
public class MenuUtil
{
    /**
     * Create a menu item that will submit a controller command when selected.
     */
    public static function createControllerMenuItem (
            caption :String, cmdOrFn :Object, arg :Object = null,
            separatorBefore :Boolean = false, enabled :Boolean = true,
            visible :Boolean = true) :ContextMenuItem
    {
        var item :ContextMenuItem =
            new ContextMenuItem(caption, separatorBefore, enabled, visible);
        item.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
            function (event :ContextMenuEvent) :void {
                CommandEvent.dispatch(event.mouseTarget, cmdOrFn, arg);
            });
        return item;
    }
}
}
