net.java.truelicense.ui.wizard.WizardController 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-2015 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */

package net.java.truelicense.ui.wizard;

/**
 * A controller for a generic wizard user interface.
 *
 * @author Christian Schlichtherle
 * @since  TrueLicense 2.3
 */
public interface WizardController {

    /**
     * Returns {@code true} if and only if the back-state of the current view
     * does not equal the current state of the model.
     */
    boolean switchBackEnabled();

    /**
     * Switches to the back-state of the current view.
     * If the back-state of the current view equals the current state of the
     * model, then nothing happens.
     * Otherwise, the current view gets hidden and the view for the back-state
     * gets shown.
     */
    void switchBack();

    /**
     * Returns {@code true} if and only if the next-state of the current view
     * does not equal the current state of the model.
     */
    boolean switchNextEnabled();

    /**
     * Switches to the next-state of the current view.
     * If the next-state of the current view equals the current state of the
     * model, then nothing happens.
     * Otherwise, the current view gets hidden and the view for the next-state
     * gets shown.
     */
    void switchNext();
}