jaxx.runtime.swing.wizard.ext.WizardExtStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxx-runtime Show documentation
JAXX Runtime api
There is a newer version: 3.0-alpha-6
/*
 * #%L
 * JAXX :: Runtime
 * 
 * $Id: WizardExtStep.java 2225 2011-02-19 20:15:00Z tchemit $
 * $HeadURL: https://nuiton.org/svn/jaxx/tags/jaxx-2.8.2/jaxx-runtime/src/main/java/jaxx/runtime/swing/wizard/ext/WizardExtStep.java $
 * %%
 * Copyright (C) 2008 - 2010 CodeLutin
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */
package jaxx.runtime.swing.wizard.ext;

import jaxx.runtime.swing.wizard.WizardStep;
import jaxx.runtime.swing.wizard.WizardStepUI;


/**
 * Extension de {@link WizardStep} avec des états supplémentaires.
 * 
 * Chaque étape possède un modèle de type {@link #getModelClass()}.
 * Ce modèle peut être partagé par plusieurs étapes.
 * 

 * De plus, on a deux drapeaux {@link #isConfig()} pour savoir si l'étape est une phase de configuration.
 * 
 * Le drapeau {@link #isOperation()} quand à lui permet de savoir si l'étape est une opération.
 *
 * @author tchemit 
 * @since 2.1
 */
public interface WizardExtStep extends WizardStep {

    /** @return le label de l'opération */
    String getOperationLabel();

    /** @return la description de l'opération */
    String getOperationDescription();

    /** @return le type du modèle de l'action */
    Class> getModelClass();

    /** @return le type de l'ui de l'opération */
    Class> getUiClass();

    /** @return {@code true} si l'étape a une opération associée, {@code false} sinon. */
    boolean isOperation();

    /** @return {@code true} si l'étape est une phase de configuration, {@code false} sinon. */
    boolean isConfig();

    /**
     * Instancie le modèle associée à l'étape.
     *
     * @return le nouveau modèle associé à l'étape
     */
    WizardExtStepModel newModel();

    /**
     * Construit l'ui associée à l'étape.
     *
     * @param ui l'ui principale du wiard
     * @return la noveau ui associé à l'étape
     */
    WizardStepUI newUI(WizardExtUI ui);
}