A combo box that when changed, dispatches a command with the current selection as the arg.

git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@737 ed5b42cb-e716-0410-a449-f6a68f950b19
This commit is contained in:
Bruno Garcia
2008-12-11 23:38:40 +00:00
parent ae517a93d9
commit dc48461f10
@@ -0,0 +1,78 @@
//
// $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.flex {
import flash.events.Event;
import mx.controls.ComboBox;
import mx.events.ListEvent;
import com.threerings.util.CommandEvent;
/**
* A combo box that dispatches a command (or calls a function) when it is toggled. NOTE: Unlike the
* other Command* controls, CommandComboBox does not guarantee that the CommandEvent is dispatched
* after notifying all other listeners.
*/
public class CommandComboBox extends ComboBox
{
/**
* Create a command combobox. The 'data' attribute of the selectedItem object is used as
* an argument of the command or function.
*
* @param cmdOrFn either a String, which will be the CommandEvent command to dispatch,
* or a function, which will be called when changed.
*/
public function CommandComboBox (cmdOrFn :* = null)
{
CommandButton.validateCmd(cmdOrFn);
_cmdOrFn = cmdOrFn;
addEventListener(ListEvent.CHANGE, handleChange);
}
/**
* Set the command and argument to be issued when this button is pressed.
*/
public function setCommand (cmd :String) :void
{
_cmdOrFn = cmd;
}
/**
* Set a callback function to call when the button is pressed.
*/
public function setCallback (fn :Function) :void
{
_cmdOrFn = fn;
}
protected function handleChange (event :ListEvent) :void
{
CommandEvent.dispatch(this, _cmdOrFn, this.selectedItem.data);
}
/** The command (String) to submit, or the function (Function) to call
* when changed, */
protected var _cmdOrFn :Object;
}
}