/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.autoupdate;

/** This class is used for performing long tasks which have to
 * show a modal dialog with cancel button.
 * @author  phrebejk 
 */
interface ProgressDialog {

    static final int PARTIAL_GAUGE = 1;
    static final int OVERALL_GAUGE = 2;
    static final int EXTRA_GAUGE = 4;

    static final int PARTIAL_LABEL = 1;
    static final int OVERALL_LABEL = 2;
    static final int EXTRA_LABEL = 4;

    /** Indexed getter for property gaugeValue.
     *@param index Index of the property.
     *@return Value of the property at index.
     */
    public int getGaugeValue(int gauge);

    /** Indexed setter for property gaugeValue.
     *@param index Index of the property.
     *@param gaugeValue New value of the property at index.
     */
    public void setGaugeValue(int gauge, int gaugeValue);

    /** Indexed setter for property gaugeBounds.
     *@param index Index of the property.
     *@param gaugeBounds New value of the property at index.
     */
    public void setGaugeBounds(int gauge, int gaugeMin, int gaugeMax );

    /** Indexed getter for property labelText.
     *@param index Index of the property.
     *@return Value of the property at index.
     */ 
    public String getLabelText(int label);

    /** Indexed setter for property labelText.
     *@param index Index of the property.
     *@param labelText New value of the property at index.
     */
    public void setLabelText(int label, String labelText);

    /** Getter for property title.
     *@return Value of property title.
     */
    String getTitle();

    /** Setter for property title.
     *@param title New value of property title.
     */
    void setTitle(String title);
}