e958737baa36f530fed4cef43cb396c22c0e1ca6
[idea/community.git] / platform / platform-api / src / com / intellij / ide / wizard / Step.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.ide.wizard;
17
18 import javax.swing.*;
19
20 /**
21  * @author nick
22  * Date: 14.03.2003
23  * Time: 19:07:06
24  */
25 public interface Step {
26   /**
27    * {@link AbstractWizard} calls this method every time step becomes visible.
28    */
29   void _init();
30   /**
31    * {@link AbstractWizard} calls this method every time when step should "commit"
32    * all its internal data, i.e. when user presses "Next", "Previous" or "Finish" button.
33    *
34    * @exception CommitStepException if current data is not accepted by the step. {@link AbstractWizard}
35    * will show exception's message to the user, so message should be descriptive.
36    * @param finishChosen - true if the user chose "Finish" button. It's expected that a step will
37    * commit all necessary data in this case since an enclosing wizard will inevitably disappear
38    */
39   void _commit(boolean finishChosen) throws CommitStepException;
40   /**
41    * @return step's icon. This method can return <code>null</code>.
42    */
43   Icon getIcon();
44   /**
45    * @return {@link JComponent} that represents step's UI in the wizard. This
46    * method should not return <code>null</code>.
47    */
48   JComponent getComponent();
49
50   JComponent getPreferredFocusedComponent();
51 }