package org.uberfire.ext.layout.editor.client;

import java.util.Map;

import com.google.gwt.user.client.ui.Widget;
import org.jboss.errai.common.client.api.RemoteCallback;
import org.uberfire.backend.vfs.Path;
import org.uberfire.ext.layout.editor.client.structure.EditorWidget;
import org.uberfire.ext.layout.editor.client.util.LayoutDragComponent;
import org.uberfire.ext.plugin.model.LayoutEditorModel;
import org.uberfire.ext.plugin.model.PluginType;
import org.uberfire.mvp.ParameterizedCommand;

public interface LayoutEditorPluginAPI {

    void init( PluginType pluginType,
               String layoutName,
               LayoutDragComponent... layoutDragComponent );

    Widget asWidget();

    void load( PluginType pluginType,
               Path currentPath,
               ParameterizedCommand<LayoutEditorModel> loadCallBack );

    void save( Path path,
               RemoteCallback<Path> saveSuccessCallback );

    int getCurrentModelHash();

    void addLayoutProperty( String key,
                            String value );

    String getLayoutProperty( String key );

    Map<String, String> getLayoutComponentProperties( EditorWidget component );

    void addComponentProperty( EditorWidget component,
                               String htmlCode,
                               String text );
}