platform/platform-impl/src/com/intellij/ui/wizard/WizardStep.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.ui.wizard;
  17
  18 import com.intellij.openapi.util.IconLoader;
  19
  20 import javax.swing.*;
  21
  22 public abstract class WizardStep<T extends WizardModel> {
  23
  24   public static final WizardStep FORCED_GOAL_DROPPED = new Empty();
  25   public static final WizardStep FORCED_GOAL_ACHIEVED = new Empty();
  26
  27   private String myTitle = "";
  28   private String myExplanation = "";
  29 //todo:
  30   private Icon myIcon = IconLoader.getIcon("/newprojectwizard.png");
  31   private String myHelpId;
  32
  33   protected WizardStep() {
  34   }
  35
  36   public WizardStep(String title) {
  37     myTitle = title;
  38   }
  39
  40   public WizardStep(String title, String explanation) {
  41     myTitle = title;
  42     myExplanation = explanation;
  43   }
  44
  45   public WizardStep(String title, String explanation, Icon icon) {
  46     myTitle = title;
  47     myExplanation = explanation;
  48     myIcon = icon;
  49   }
  50
  51   public WizardStep(String title, String explanation, Icon icon, String helpId) {
  52     myTitle = title;
  53     myExplanation = explanation;
  54     myIcon = icon;
  55     myHelpId = helpId;
  56   }
  57
  58   public String getTitle() {
  59     return myTitle;
  60   }
  61
  62   public String getExplanation() {
  63     return myExplanation;
  64   }
  65
  66   public abstract JComponent prepare(WizardNavigationState state);
  67
  68   public WizardStep onNext(T model) {
  69     return model.getNextFor(this);
  70   }
  71
  72   public WizardStep onPrevious(T model) {
  73     return model.getPreviousFor(this);
  74   }
  75
  76   public boolean onCancel() {
  77     return true;
  78   }
  79
  80   public boolean onFinish() {
  81     return true;
  82   }
  83
  84   public Icon getIcon() {
  85     return myIcon;
  86   }
  87
  88   public String getHelpId() {
  89     return myHelpId;
  90   }
  91
  92   public static class Empty extends WizardStep {
  93     public JComponent prepare(WizardNavigationState state) {
  94       return null;
  95     }
  96   }
  97
  98 }