net.java.truelicense.ui.wizard.WizardView Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truelicense-ui Show documentation

The TrueLicense UI module provides a user interface technology independent model for wizard dialogs in general and license management wizard dialogs in particular.

There is a newer version: 2.6.6

Show newest version

/*
 * Copyright (C) 2005-2017 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */

package net.java.truelicense.ui.wizard;

/**
 * A view for a generic wizard user interface.
 * 
 * In a Swing app, this could be a {@link javax.swing.JPanel}.
 * 
In a JSF app, this could be the backing bean in a Facelet.
 * 
 *
 * @param   the type of the wizard's states.
 * @author Christian Schlichtherle
 * @since  TrueLicense 2.3
 */
public interface WizardView {

    /**
     * Returns the state to switch to when the back-button gets pressed,
     * or the current state if switching is not possible.
     */
    S backState();

    /**
     * Returns the state to switch to when the next-button gets pressed,
     * or the current state if switching is not possible.
     */
    S nextState();

    /**
     * This hook gets called by the controller before the state of the model
     * changes.
     * A typical implementation may want to hide this view.
     */
    void onBeforeStateSwitch();

    /**
     * This hook gets called by the controller after the state of the model
     * has changed.
     * A typical implementation may want to show this view.
     */
    void onAfterStateSwitch();
}