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: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. 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: * File : IProgressIndicator.java
044: * Version : 1.0
045: * Description : Interface for a progress indicator.
046: * Author : Darshan
047: */
048: package org.netbeans.modules.uml.integration.ide.dialogs;
049:
050: /**
051: * Interface for a progress indicator (from Trey Spiva's ProgressIndicator
052: * code).
053: *
054: * @author Darshan
055: */
056: public interface IProgressIndicator {
057: /**
058: * Shows the progress indicator. This method should exit silently if the
059: * progress indicator is already displayed.
060: */
061: public void show();
062:
063: /**
064: * Sets the maximum range of the progress bar. The maximum value is used to
065: * detimine the position of the progress bar. Increasing this range when
066: * visible typically can cause the progress indicator to move backwards
067: * (usually undesirable).
068: *
069: * @param value The maximum value.
070: */
071: public void setMaxRange(int value);
072:
073: /**
074: * Returns the maximum range of the progress bar.
075: * @return The maximum value.
076: */
077: public int getMaxRange();
078:
079: /**
080: * Sets the minimum range of the progress bar. The minimum value is used to
081: * detimine the position of the progress.
082: * @param value The minimum value.
083: */
084: public void setMinRange(int value);
085:
086: /**
087: * Sets the current progress information.
088: * @param msg A message to be displayed to the user.
089: * @param rangeCompleted The value to indicate the progress.
090: */
091: public void setProgress(String msg, int rangeCompleted);
092:
093: /**
094: * Increments the progress.
095: * @param msg A message to be displayed to the user.
096: */
097: public void incrementProgress(String msg);
098:
099: /**
100: * Closes the progress indicator. This should fail silently if the progress
101: * indicator has not been displayed yet, or has already been closed.
102: */
103: public void done();
104: }
|