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):
025: * The Original Software is NetBeans. The Initial Developer of the Original
026: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
027: * Microsystems, Inc. All Rights Reserved.
028: *
029: * If you wish your version of this file to be governed by only the CDDL
030: * or only the GPL Version 2, indicate your decision by adding
031: * "[Contributor] elects to include this software in this distribution
032: * under the [CDDL or GPL Version 2] license." If you do not indicate a
033: * single choice of license, a recipient has the option to distribute
034: * your version of this file under either the CDDL, the GPL Version 2 or
035: * to extend the choice of license to its licensees as provided above.
036: * However, if you add GPL Version 2 code and therefore, elected the GPL
037: * Version 2 license, then the option applies only if the new code is
038: * made subject to such option by the copyright holder.
039: */
040:
041: package org.netbeans.lib.profiler.client;
042:
043: import org.netbeans.lib.profiler.wireprotocol.Command;
044:
045: /**
046: * A utility interface, used to handle (by displaying things in GUI) various app status changes.
047: *
048: * @author Misha Dmitriev
049: */
050: public interface AppStatusHandler {
051: //~ Inner Interfaces ---------------------------------------------------------------------------------------------------------
052:
053: /**
054: * An interface for a dialog that displays a message and a Cancel button.
055: * The intended usage is in situations when some action is done in background, and the user should be able to
056: * interrupt it at any moment.
057: * The dialog is displayed using display(). Then the status of the Cancel button should be polled periodically
058: * using cancelPressed() method, and finally the dialog can be closed using close(). Note that display() inevitably
059: * blocks the thread that called it, so it should be called in a thread separate from the one in which the background
060: * action is performed.
061: */
062: public static interface AsyncDialog {
063: //~ Methods --------------------------------------------------------------------------------------------------------------
064:
065: /** Checks if this dialog is being displayed (is visible) */
066: public boolean isDisplayed();
067:
068: public boolean cancelPressed();
069:
070: public void close();
071:
072: /**
073: * This method is called to display the asynchronous wait dialog. It should block
074: * until the user explicitely cancels or method AsyncDialog.close is called
075: */
076: public void display();
077: }
078:
079: /**
080: * A utility class, used to handle (by displaying things in GUI and by updating some parent class internal variables)
081: * commands coming from the server.
082: */
083: public static interface ServerCommandHandler {
084: //~ Methods --------------------------------------------------------------------------------------------------------------
085:
086: public void handleServerCommand(Command cmd);
087: }
088:
089: //~ Methods ------------------------------------------------------------------------------------------------------------------
090:
091: public AsyncDialog getAsyncDialogInstance(String message,
092: boolean showProgress, boolean cancelAllowed);
093:
094: // The following methods should display messages asynchronously, i.e. they shouldn't block the current
095: // thread waiting for the user pressing OK.
096: public void displayError(String msg);
097:
098: // These 3 methods SHOULD wait for the user to press ok, since they may be used in a sequence of displayed
099: // panels, and the next one shouldn't be displayed before the previous one is read and understood.
100: public void displayErrorAndWaitForConfirm(String msg);
101:
102: public void displayErrorWithDetailsAndWaitForConfirm(
103: String shortMsg, String detailsMsg);
104:
105: public void displayNotification(String msg);
106:
107: public void displayNotificationAndWaitForConfirm(String msg);
108:
109: public void displayNotificationWithDetailsAndWaitForConfirm(
110: String shortMsg, String detailsMsg);
111:
112: public void displayWarning(String msg);
113:
114: public void displayWarningAndWaitForConfirm(String msg);
115:
116: /** Called each time profiling results will become available for the first time using current instrumentation */
117: public void resultsAvailable();
118:
119: public void takeSnapshot();
120:
121: /**
122: * Called from the profiler engine in case the waiting for reply timed out.
123: * The profiler can decide (e.g. by asking the user) whether to keep waiting or cancel the profiling.
124: *
125: * @return true to keep waiting for reply, false to cancel profiling
126: */
127: boolean confirmWaitForConnectionReply();
128:
129: void handleShutdown();
130:
131: /**
132: * Called from the engine to signal that the profiler should not be getting results
133: * because some internal change is in progress.
134: */
135: void pauseLiveUpdates();
136:
137: /**
138: * Called from the engine to signal that it is again safe to start getting results
139: */
140: void resumeLiveUpdates();
141: }
|