RecipeEditorView.java

/*******************************************************************************
 * Copyright (c) 2012-2016 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.ide.extension.machine.client.perspective.widgets.recipe.editor;

import com.google.inject.ImplementedBy;

import org.eclipse.che.ide.api.editor.EditorPartPresenter;
import org.eclipse.che.ide.api.mvp.View;

import javax.validation.constraints.NotNull;
import java.util.List;

/**
 * The visual part of recipe that has an ability to show script of a recipe.
 *
 * @author Valeriy Svydenko
 */
@ImplementedBy(RecipeEditorViewImpl.class)
public interface RecipeEditorView extends View<RecipeEditorView.ActionDelegate> {
    /**
     * Sets URL of the recipe's script.
     *
     * @param url
     *         script's url
     */
    void setScriptUrl(@NotNull String url);

    /**
     * Sets tags of the recipe which used for recipes search.
     *
     * @param tags
     *         list of tags
     */
    void setTags(@NotNull List<String> tags);

    /** Returns script's url */
    @NotNull
    String getScriptUrl();

    /** Gets name of the recipe */
    @NotNull
    String getName();

    /** Sets name of the recipe */
    void setName(@NotNull String name);

    /** Returns tags which used for recipes search */
    @NotNull
    List<String> getTags();

    /**
     * Changes enable state of 'Save' button.
     *
     * @param enable
     *         enable state of button
     */
    void setEnableSaveButton(boolean enable);

    /**
     * Changes enable state of 'Cancel' button.
     *
     * @param enable
     *         enable state of button
     */
    void setEnableCancelButton(boolean enable);

    /**
     * Changes enable state of 'Clone' button.
     *
     * @param enable
     *         enable state of button
     */
    void setEnableCloneButton(boolean enable);

    /**
     * Changes enable state of 'Delete' button.
     *
     * @param enable
     *         enable state of button
     */
    void setEnableDeleteButton(boolean enable);

    /**
     * Sets visibility of the button save.
     *
     * @param visible
     *         state button visibility
     */
    void setVisibleSaveButton(boolean visible);

    /**
     * Sets visibility of the button clone.
     *
     * @param visible
     *         state button visibility
     */
    void setVisibleCloneButton(boolean visible);

    /**
     * Sets visibility of the button delete.
     *
     * @param visible
     *         state button visibility
     */
    void setVisibleDeleteButton(boolean visible);

    /**
     * Sets visibility of the button cancel.
     *
     * @param visible
     *         state button visibility
     */
    void setVisibleCancelButton(boolean visible);

    /**
     * Show a given editor in the special place on the container.
     *
     * @param editor
     *         editor that needs to be shown
     */
    void showEditor(@NotNull EditorPartPresenter editor);

    /** Hides panel with property buttons. */
    void hideButtonsPanel();

    interface ActionDelegate {
        void showEditor();

        /** Performs some actions in response to user's clicking on the 'Clone' button. */
        void onCloneButtonClicked();

        /** Performs some actions in response to user's clicking on the 'New' button. */
        void onNewButtonClicked();

        /** Performs some actions in response to user's clicking on the 'Save' button. */
        void onSaveButtonClicked();

        /** Performs some actions in response to user's clicking on the 'Delete' button. */
        void onDeleteButtonClicked();

        /** Performs some actions in response to user's clicking on the 'Cancel' button. */
        void onCancelButtonClicked();
    }

}