reportbuilder/java/com/sun/star/report/JobProgressIndicator.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 package com.sun.star.report;
  28
  29 /**
  30  * Based on
  31  * http://api.libreoffice.org/docs/common/ref/com/sun/star/task/XStatusIndicator.html
  32  *
  33  * @author Thomas Morgner
  34  */
  35 public interface JobProgressIndicator
  36 {
  37
  38     /**
  39      * Updates the progress description.
  40      *
  41      * @param string the new description
  42      */
  43     void setText(String string);
  44
  45     /**
  46      * Initializes the progress indicator and sets the progress description to
  47      * the text given in the parameter <code>text</code>. The progress values
  48      * passed to this indicator will not exceed the given <code>maxValue</code>.
  49      * The value range of this indicator is set to 0 to <code>maxValue</code>
  50      * Stopped indicators must ignore that call.
  51      *
  52      * @param string the progress description
  53      * @param text
  54      * @param maxValue the maximum value
  55      * @see JobProgressIndicator#setText(String)
  56      */
  57     void start(String text, int maxValue);
  58
  59     /**
  60      * Updates the value to the specified value. Invalid values must be ignored.
  61      * Stopped indicators must ignore that call.
  62      *
  63      * @param value the new value that should be shown now. This must fit the
  64      * range [0..maxValue] as defined in {@link JobProgressIndicator#start(String, int)}.
  65      */
  66     void setValue(int value);
  67
  68     /**
  69      * Stop the progress. A progress indicator cannot be destructed before end()
  70      * has been called.
  71      */
  72     void end();
  73
  74     /**
  75      * Clear progress value and description. Calling of setValue(0) and
  76      * setText("") should do the same. Stopped indicators must ignore this call.
  77      */
  78     void reset();
  79 }