/* An attribute that produces a custom node controller.
Copyright (c) 1998-2005 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the above
copyright notice and the following two paragraphs appear in all copies
of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.vergil.basic;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.kernel.util.NamedObj;
import ptolemy.kernel.util.SingletonAttribute;
import diva.graph.GraphController;
//////////////////////////////////////////////////////////////////////////
//// NodeControllerFactory
/**
This is an attribute that produces a custom node controller.
This base class produces a node controller that offers only a
configure command in the context menu, and invokes a dialog to
edit parameters in response to that command. It does this by
returning an instance of IconController
in its create() method. Derived classes can override this
base class to put whatever they want in the context menu,
invoking whatever dialogs are appropriate.
To use this class, just insert it as an attribute inside
any Ptolemy II object, and then right clicking on the icon for
that object will result in the use of the controller specified
here. The instance by convention will be named "_controllerFactory",
but the only reason to enforce this is that only the first such
controller factory found as an attribute will be used.
It is a singleton, so placing it any container will replace any
previous controller factory with the same name.
@author Edward A. Lee
@version $Id$
@since Ptolemy II 2.0
@Pt.ProposedRating Red (eal)
@Pt.AcceptedRating Red (johnr)
*/
public class NodeControllerFactory extends SingletonAttribute {
/** Construct a new attribute with the given container and name.
* @param container The container.
* @param name The name.
* @exception IllegalActionException If the attribute cannot be contained
* by the proposed container.
* @exception NameDuplicationException If the container already has an
* attribute with this name.
*/
public NodeControllerFactory(NamedObj container, String name)
throws NameDuplicationException, IllegalActionException {
super(container, name);
}
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Return a new node controller. This base class returns an
* instance of IconController. Derived
* classes can return some other class to customize the
* context menu.
* @param controller The associated graph controller.
* @return A new node controller.
*/
public NamedObjController create(GraphController controller) {
return new IconController(controller);
}
}