/*
!=======================================================================
!
!  PROGRAM  PHASE-Viewer  (PHASE-Viewer 2014.01 ver.3.3.0)
!
!  Created on 2006/10/17, 12:05
!  AUTHOR(S): KOGA, Junichiro
!  File : InputWizard.java
!  
!  Contact address :  Phase System Consortium
!                     E-mail: phase_system@nims.go.jp URL https://azuma.nims.go.jp
!
!
!   Since 2002, this program set had been intensively developed as a part of the following 
!  national projects supported by the Ministry of Education, Culture, Sports, Science and
!  Technology (MEXT) of Japan; "Frontier Simulation Software for Industrial Science
!  (FSIS)" from 2002 to 2005, "Revolutionary Simulation Software (RSS21)" from 2006 to
!  2008. "Research and Development of Innovative Simulation Software (RISS)" from 2008
!  to 2013. These projects is lead by the Center for Research on Innovative Simulation 
!  Software (CISS), the Institute of Industrial Science (IIS), the University of Tokyo.
!   Since 2013, this program set has been further developed centering on PHASE System
!  Consortium. 
!   The activity of development of this program set has been supervised by Takahisa Ohno.
!
!=======================================================================
 */

package ciss.phase_viewer.input;

import java.util.HashMap;

import javax.swing.JPanel;

import ciss.phase_viewer.inputinterface.Input;

/**
 * 入力ファイル作成ウィザードのインターフェース
 * 
 * @author
 */
public interface InputWizard {

    /**
     * このWizardの名前を返す.
     * 
     * @return このWizardの名前
     */
    public String getName();

    /**
     * '次へ'進むボタンを有効にすべきか否かを返す.
     * 
     * @return 上記の通り
     */
    public boolean hasNext();

    /**
     * '戻る'ボタンを有効にすべきか否かを返す.
     * 
     * @return 上記の通り
     */
    public boolean hasPrevious();

    /**
     * '終了'ボタンを有効にすべきか否かを返す.
     * 
     * @return 上記の通り
     */
    public boolean hasFinished();

    /**
     * '終了'ボタンを押したあとに実行されるメソッド. ここで実際の入力作成操作などを行う.
     * 
     * @return 必要に応じてメッセージを返す.
     */
    public String process();

    /**
     * 作用するInputを登録するメソッド
     * 
     * @param input
     *            作用するメソッド
     */
    public void setInput(Input input);

    /**
     * このWizardの説明を返す
     * 
     * @return 説明
     */
    public String getDescription();

    /**
     * 編集用のGUIを作成し, 返す.
     * 
     * @return 編集用のGUI
     */
    public JPanel getGUI();

    /**
     * InputWizard間で色んな情報を共有するために利用する.
     * 
     * @param 色んな情報を含み得るHashMap
     */
    public void setProperties(HashMap properties);

    /**
     * 関連付けられた"InputWizardController"を登録する.
     * 
     * @param parent
     */
    public void setParent(InputWizardController parent);

}
