SetupUi.java

/*
 * Copyright (C) 2015-2017 PÂRIS Quentin
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 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 Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package org.phoenicis.scripts.ui;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.List;

/**
 * Represents a Setup UI.
 * This interfaces needs to be implemented by the UI.
 */
public interface SetupUi {
    /**
     * Set the top image
     * @param topImage The top image to set
     * @throws IOException If the top image cannot be loaded
     */
    void setTopImage(File topImage) throws IOException;

    /**
     * Set the left image text
     * @param leftImageText The left image text to set
     */
    void setLeftImageText(String leftImageText);

    /**
     * Set the top image
     * @param topImage The top image to set
     * @throws IOException If the top image cannot be loaded
     */
    void setTopImage(URL topImage) throws IOException;

    /**
     * Show a simple message and block until a response is given
     * @param textToShow The text to show to the user
     */
    void showSimpleMessageStep(Message<Void> doneCallback, String textToShow);

    void showYesNoQuestionStep();

    /**
     * Show a a text box and block until a response is given
     * @param textToShow The text to show to the user
     * @param defaultValue The default value
     */
    void showTextBoxStep(Message<String> doneCallback, String textToShow, String defaultValue);

    /**
     * Show a menu step and block until a response is given
     * @param textToShow The text to show to the user
     * @param menuItems The items in the menu
     * @param defaultValue The item which is selected by default
     */
    void showMenuStep(Message<MenuItem> doneCallback, String textToShow, List<String> menuItems, String defaultValue);

    /**
     * Show a wait message, and returns immediately
     * @param textToShow The text to show to the user
     */
    void showSpinnerStep(Message<Void> message, String textToShow);

    /**
     * Show a progress bar and returns immediately
     * @param textToShow The text to show to the user
     */
    void showProgressBar(Message<ProgressControl> message, String textToShow);

    /**
     * Shows a presentation step and blocks until a response is given
     * @param textToShow The text to show to the user
     */
    void showPresentationStep(Message<Void> doneCallback, String textToShow);

    /**
     * Shows a default script presentation step and blocks until a response is given
     *
     * @param htmlToShow The HTML to show to the user
     */
    void showHtmlPresentationStep(Message<Void> doneCallback, String htmlToShow);

    /**
     * Shows a licence step and blocks until a response is given
     * @param textToShow The text to show to the user
     * @param licenceText The licence content
     */
    void showLicenceStep(Message<Void> doneCallback, String textToShow, String licenceText);

    /**
     * Shows a file browser step, and blocks until a response is given
     * @param textToShow The text to show to the user
     * @param browseDirectory The default directory to browse
     * @param extensions Allowed extensions
     */
    void showBrowseStep(Message<String> doneCallback, String textToShow, File browseDirectory, List<String> extensions);

    /**
     * Close the Setup UI
     */
    void close();
}