View Javadoc

1   package com.explosion.expfmodules.wizard;
2   
3   
4   
5   
6   /* =============================================================================
7    *       
8    *     Copyright 2004 Stephen Cowx
9    *
10   *     Licensed under the Apache License, Version 2.0 (the "License");
11   *     you may not use this file except in compliance with the License.
12   *     You may obtain a copy of the License at
13   *
14   *     http://www.apache.org/licenses/LICENSE-2.0
15   *
16   *     Unless required by applicable law or agreed to in writing, software
17   *     distributed under the License is distributed on an "AS IS" BASIS,
18   *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19   *     See the License for the specific language governing permissions and
20   *     limitations under the License.
21   * 
22   * =============================================================================
23   */
24  
25  /***
26   * Created on 01-Dec-2004
27   * This interface provides a means for instructing a view component for a wizard.
28   * It is a means of allowing implementors to customize what gets shown by way of dataItems 
29   * in the input panel of a step in the wizard.
30   * 
31   * The methods will be called in a specific order as follows:
32   * 
33   * 1) Init gets called to allow it to initialise
34   * 2) Close gets called to allow it to set values in the dataitems of the 
35   *    StepDefinition
36   * @author Stephen Cowx
37   */
38  public interface StepView
39  {
40  
41      /***
42       * Allows the view to construct itself.
43       * @param step
44       */
45      public void init(StepDefinition stepDefinition) throws Exception;
46      
47  }