EditScreen.java

/*
 * Copyright 2015 JBoss, by Red Hat, Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.uberfire.ext.plugin.client.perspective.editor.layout.editor.popups;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.google.gwt.core.client.GWT;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.uibinder.client.UiBinder;
import com.google.gwt.uibinder.client.UiField;
import com.google.gwt.uibinder.client.UiHandler;
import com.google.gwt.user.client.Command;
import com.google.gwt.user.client.ui.Widget;
import org.gwtbootstrap3.client.shared.event.ModalHiddenEvent;
import org.gwtbootstrap3.client.shared.event.ModalHiddenHandler;
import org.gwtbootstrap3.client.ui.FormGroup;
import org.gwtbootstrap3.client.ui.HelpBlock;
import org.gwtbootstrap3.client.ui.TextBox;
import org.gwtbootstrap3.client.ui.constants.ValidationState;
import org.uberfire.ext.layout.editor.client.api.ModalConfigurationContext;
import org.uberfire.ext.plugin.client.resources.i18n.CommonConstants;
import org.uberfire.ext.plugin.client.validation.NameValidator;
import org.uberfire.ext.properties.editor.client.PropertyEditorWidget;
import org.uberfire.ext.properties.editor.model.PropertyEditorCategory;
import org.uberfire.ext.properties.editor.model.PropertyEditorEvent;
import org.uberfire.ext.properties.editor.model.PropertyEditorFieldInfo;
import org.uberfire.ext.properties.editor.model.PropertyEditorType;
import org.uberfire.ext.widgets.common.client.common.popups.BaseModal;
import org.uberfire.ext.widgets.common.client.common.popups.ButtonPressed;
import org.uberfire.ext.widgets.common.client.common.popups.footers.ModalFooterOKCancelButtons;

import static org.uberfire.ext.plugin.client.perspective.editor.layout.editor.ScreenLayoutDragComponent.PLACE_NAME_PARAMETER;

public class EditScreen
        extends BaseModal {

    public static String PROPERTY_EDITOR_KEY = "LayoutEditor";
    private static Binder uiBinder = GWT.create(Binder.class);
    private final ModalConfigurationContext configContext;
    protected List<String> availableWorkbenchScreensIds = new ArrayList<String>();
    @UiField
    TextBox key;
    @UiField
    FormGroup paramKeyControlGroup;
    @UiField
    HelpBlock paramKeyInline;
    @UiField
    TextBox value;
    @UiField
    PropertyEditorWidget propertyEditor;
    private ButtonPressed buttonPressed = ButtonPressed.CLOSE;
    private Map<String, String> lastParametersSaved = new HashMap<String, String>();

    public EditScreen(ModalConfigurationContext configContext,
                      List<String> availableWorkbenchScreensIds) {
        this.availableWorkbenchScreensIds = availableWorkbenchScreensIds;
        this.configContext = configContext;
        setTitle(CommonConstants.INSTANCE.EditComponent());
        setBody(uiBinder.createAndBindUi(EditScreen.this));
        propertyEditor.handle(generateEvent(generateScreenSettingsCategory()));
        saveOriginalState();
        add(new ModalFooterOKCancelButtons(
                    new Command() {
                        @Override
                        public void execute() {
                            okButton();
                        }
                    },
                    new Command() {
                        @Override
                        public void execute() {
                            cancelButton();
                        }
                    }
            )
        );
        addHiddenHandler();
    }

    private void saveOriginalState() {
        lastParametersSaved = new HashMap<String, String>();
        Map<String, String> layoutComponentProperties = configContext.getComponentProperties();
        for (String key : layoutComponentProperties.keySet()) {
            lastParametersSaved.put(key,
                                    layoutComponentProperties.get(key));
        }
    }

    protected void addHiddenHandler() {
        addHiddenHandler(new ModalHiddenHandler() {
            @Override
            public void onHidden(ModalHiddenEvent hiddenEvent) {
                if (userPressedCloseOrCancel()) {
                    revertChanges();
                    configContext.configurationCancelled();
                }
            }
        });
    }

    private boolean userPressedCloseOrCancel() {
        return ButtonPressed.CANCEL.equals(buttonPressed) || ButtonPressed.CLOSE.equals(buttonPressed);
    }

    private void revertChanges() {
        configContext.resetComponentProperties();
        for (String key : lastParametersSaved.keySet()) {
            configContext.setComponentProperty(key,
                                               lastParametersSaved.get(key));
        }
    }

    public void show() {
        super.show();
    }

    void okButton() {
        buttonPressed = ButtonPressed.OK;

        // Make sure a default screen is set before finish
        if (configContext.getComponentProperty(PLACE_NAME_PARAMETER) == null) {
            if (!availableWorkbenchScreensIds.isEmpty()) {
                configContext.setComponentProperty(PLACE_NAME_PARAMETER,
                                                   availableWorkbenchScreensIds.get(0));
                configContext.configurationFinished();
            } else {
                // If no screens are available then cancel
                configContext.configurationCancelled();
            }
        } else {
            configContext.configurationFinished();
        }

        hide();
    }

    void cancelButton() {
        buttonPressed = ButtonPressed.CANCEL;
        hide();
    }

    @Override
    public void hide() {
        super.hide();
    }

    @UiHandler("add")
    void add(final ClickEvent event) {
        final PropertyEditorCategory property = addProperty();
        if (property == null) {
            return;
        }
        propertyEditor.handle(generateEvent(property));
        key.setText("");
        value.setText("");
    }

    private PropertyEditorCategory addProperty() {
        paramKeyInline.setText("");
        paramKeyControlGroup.setValidationState(ValidationState.NONE);

        //Check the Key is valid
        final NameValidator validator = NameValidator.parameterNameValidator();
        if (!validator.isValid(key.getText())) {
            paramKeyControlGroup.setValidationState(ValidationState.ERROR);
            paramKeyInline.setText(validator.getValidationError());
            return null;
        }

        //Check the Key is unique
        Map<String, String> properties = configContext.getComponentProperties();
        for (String parameterKey : properties.keySet()) {
            if (key.getText().equals(parameterKey)) {
                paramKeyControlGroup.setValidationState(ValidationState.ERROR);
                paramKeyInline.setText(CommonConstants.INSTANCE.DuplicateParameterName());
                return null;
            }
        }

        configContext.setComponentProperty(key.getText(),
                                           value.getText());
        return generateScreenSettingsCategory();
    }

    private PropertyEditorCategory generateScreenSettingsCategory() {

        //Override getFields() so we can remove Parameter from ScreenEditor when collection is modified by PropertiesWidget
        PropertyEditorCategory category = new PropertyEditorCategory(CommonConstants.INSTANCE.ScreenConfiguration()) {

            @Override
            public List<PropertyEditorFieldInfo> getFields() {
                return new ArrayList<PropertyEditorFieldInfo>(super.getFields()) {

                    @Override
                    public boolean remove(Object o) {
                        if (o instanceof PropertyEditorFieldInfo) {
                            final PropertyEditorFieldInfo info = (PropertyEditorFieldInfo) o;
                            configContext.removeComponentProperty(info.getLabel());
                        }
                        return super.remove(o);
                    }
                };
            }
        };

        // Add the screen selector property
        final Map<String, String> parameters = configContext.getComponentProperties();
        String selectedScreenId = parameters.get(PLACE_NAME_PARAMETER);

        category.withField(new PropertyEditorFieldInfo(CommonConstants.INSTANCE.PlaceName(),
                                                       selectedScreenId == null ? "" : selectedScreenId,
                                                       PropertyEditorType.COMBO)
                                   .withComboValues(availableWorkbenchScreensIds)
                                   .withKey(configContext.hashCode() + PLACE_NAME_PARAMETER));

        // Add the rest of the screen's properties
        for (final String key : parameters.keySet()) {
            if (!PLACE_NAME_PARAMETER.equals(key)) {
                category.withField(new PropertyEditorFieldInfo(key,
                                                               parameters.get(key),
                                                               PropertyEditorType.TEXT)
                                           .withKey(configContext.hashCode() + key)
                                           .withRemovalSupported(true));
            }
        }

        // Ensure the screen category is always expanded after loadEmptyLayout
        propertyEditor.setLastOpenAccordionGroupTitle(category.getName());
        return category;
    }

    private PropertyEditorEvent generateEvent(PropertyEditorCategory category) {
        PropertyEditorEvent event = new PropertyEditorEvent(PROPERTY_EDITOR_KEY,
                                                            category);
        return event;
    }

    protected ModalConfigurationContext getConfigContext() {
        return this.configContext;
    }

    interface Binder
            extends
            UiBinder<Widget, EditScreen> {

    }
}