001/* An interface for objects that creates an editor.
002
003 Copyright (c) 1998-2013 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028package ptolemy.actor.gui;
029
030import java.awt.Frame;
031
032import ptolemy.kernel.util.NamedObj;
033
034///////////////////////////////////////////////////////////////////
035//// Editable
036
037/**
038 This is an interface for objects that can create an editor for interactively
039 configuring something.
040
041 @see EditorFactory
042 @author Edward A. Lee
043 @version $Id$
044 @since Ptolemy II 10.0
045 @Pt.ProposedRating Red (eal)
046 @Pt.AcceptedRating Red (johnr)
047 */
048public interface Editable {
049
050    ///////////////////////////////////////////////////////////////////
051    ////                         public methods                    ////
052
053    /** Create an editor.
054     *  This editor will have no parent window.
055     */
056    public void createEditor();
057
058    /** Create an editor for configuring the specified object.
059     *  This editor will have no parent window.
060     *  @param object The object to configure.
061     */
062    public void createEditor(NamedObj object);
063
064    /** Create an editor for configuring the specified object with the
065     *  specified parent window.
066     *  @param object The object to configure.
067     *  @param parent The parent window, or null if there is none.
068     */
069    public void createEditor(NamedObj object, Frame parent);
070}