001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s): Alexandre Iline.
025: *
026: * The Original Software is the Jemmy library.
027: * The Initial Developer of the Original Software is Alexandre Iline.
028: * All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: *
041: *
042: *
043: * $Id: CommentWindow.java,v 1.4 2007/10/05 11:37:30 jskrivanek Exp $ $Revision: 1.4 $ $Date: 2007/10/05 11:37:30 $
044: *
045: */
046:
047: package org.netbeans.jemmy.demo;
048:
049: /**
050: *
051: * Interface implementation defines a way to display step comments
052: * during demo or test debug.
053: *
054: * @author Alexandre Iline (alexandre.iline@sun.com)
055: *
056: *
057: */
058:
059: public interface CommentWindow {
060: /**
061: * Defines either test(demo) has been stopped or not.
062: * @return true if test (demo) execution has been stopped.
063: * Like when user is reading step comments.
064: * false if test execution can be continued.
065: */
066: public boolean isStopped();
067:
068: /**
069: * Defines either test execution should be interrupted or not.
070: * @return If true, execution will be interrupted.
071: */
072: public boolean isInterrupted();
073:
074: /**
075: * Defines window title.
076: * @param title Title to display.
077: */
078: public void setTitle(String title);
079:
080: /**
081: * Should display next step comment.
082: * @param stepComment Comments to be displayed.
083: */
084: public void nextStep(String stepComment);
085:
086: /**
087: * Method is invoked at the end of test(demo).
088: * @param stepComment Comment to be displayed.
089: */
090: public void showFinalComment(String stepComment);
091:
092: /**
093: * Closes the window.
094: */
095: public void close();
096:
097: /**
098: * Returns a message for a case when test needs to be interrupted.
099: * @return Interrupted message if test should be interrupted.
100: */
101: public String getInterruptMessage();
102: }
|