View Javadoc

1   /* ===================================================================
2    * Copyright 2002-04 SRI International.
3    * Released under the MOZILLA PUBLIC LICENSE Version 1.1
4    * which can be obtained at http://www.mozilla.org/MPL/MPL-1.1.html
5    * This software is distributed on an "AS IS"
6    * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
7    * See the License for the specific language governing rights and
8    * limitations under the License.
9    * =================================================================== */
10  package com.sri.emo.wizard;
11  
12  /***
13   * Monitor that often delegates to logging packages, but can be extended
14   * for more useful monitoring.
15   *
16   * @author Michael Rimov
17   */
18  public interface WizardMonitor {
19      /***
20       * Debugging event for when a page is fired.
21       *
22       * @param src the source of the event.
23       */
24      void onEnterPage(WizardPage src);
25  
26      /***
27       * Fired when forward id pressed on a wizard page.
28       *
29       * @param src the source page.
30       */
31      void onForward(WizardPage src);
32  
33      /***
34       * Fired when back id is pressed on a wizard page.
35       *
36       * @param src the page source.
37       */
38      void onBack(WizardPage src);
39  
40      /***
41       * Fired when the finish button is pressed on a wizard page.
42       *
43       * @param src the page source.
44       */
45      void onFinish(WizardPage src);
46  
47      /***
48       * Fired when the cancel button is pressed on a wizard page.
49       *
50       * @param src the source of the event.
51       */
52      void onCancel(WizardPage src);
53  
54      /***
55       * Fired when an error occurs while processing the wizard page.
56       *
57       * @param src   the source of the event.
58       * @param error the Exeception.
59       */
60      void onError(WizardPage src, Throwable error);
61  }