001/* An interface for objects with a clear() method.
002
003 Copyright (c) 2003-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.vergil.toolbox;
029
030///////////////////////////////////////////////////////////////////
031//// TextEditorFactory
032
033/**
034 An interface for objects with a clear() method.
035 This is implemented, for example, by TextEditorConfigureFactory and
036 TextEditorTableauFactory, which regrettably have no useful common
037 base class.
038
039 @see TextEditorConfigureFactory
040 @see TextEditorTableauFactory
041
042 @author Edward A. Lee
043 @version $Id$
044 @since Ptolemy II 4.0
045 @Pt.ProposedRating Yellow (eal)
046 @Pt.AcceptedRating Red (ptolemy)
047 */
048public interface TextEditorFactory {
049    ///////////////////////////////////////////////////////////////////
050    ////                         public methods                    ////
051
052    /** Clear the object.
053     */
054    public void clear();
055
056    /** Return the current text in the editor.
057     *  @return The current text in the editor.
058     */
059    public String getText();
060}