MacroChooserView.java

/*******************************************************************************
 * Copyright (c) 2012-2017 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.macro.chooser;

import com.google.gwt.view.client.ListDataProvider;

import org.eclipse.che.ide.api.macro.Macro;
import org.eclipse.che.ide.api.mvp.View;

/**
 * Defines requirements for the view for the macros explorer.
 *
 * @author Artem Zatsarynnyi
 */
public interface MacroChooserView extends View<MacroChooserView.ActionDelegate> {

    /** Show the view. */
    void show();

    /** Close the view. */
    void close();

    /** Bind the given {@code dataProvider} to the view. */
    void bindMacrosList(ListDataProvider<Macro> dataProvider);

    /** The delegate to receive events from this view. */
    interface ActionDelegate {

        /**
         * Called when macro has been chosen.
         *
         * @param macro
         *         {@link Macro} which has been chosen
         */
        void onMacroChosen(Macro macro);

        /**
         * Called when filtering macros list is requested.
         *
         * @param filterValue
         *         value for filtering the macros list
         */
        void onFilterChanged(String filterValue);
    }
}