jdplus.toolkit.desktop.plugin.properties.AutoCompletedPropertyEditor Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 National Bank of Belgium
 * 
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved 
 * by the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * 
 * http://ec.europa.eu/idabc/eupl
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and 
 * limitations under the Licence.
 */
package jdplus.toolkit.desktop.plugin.properties;

import jdplus.toolkit.desktop.plugin.completion.AutoCompletionManager;
import jdplus.main.desktop.design.SwingEditorAttribute;
import ec.util.completion.AutoCompletionSource;
import ec.util.completion.swing.JAutoCompletion;
import ec.util.various.swing.TextPrompt;
import internal.ui.properties.JAutoCompletedComponent;
import org.openide.explorer.propertysheet.InplaceEditor;
import org.openide.explorer.propertysheet.PropertyEnv;

import javax.swing.*;
import java.awt.*;
import java.beans.PropertyEditor;
import java.util.concurrent.Callable;

/**
 *
 * @author Philippe Charles
 */
public final class AutoCompletedPropertyEditor extends AbstractExPropertyEditor {

    @SwingEditorAttribute
    public static final String SERVICE_PATH_ATTRIBUTE = "servicePath";

    @SwingEditorAttribute
    public static final String AUTO_FOCUS_ATTRIBUTE = "autoFocus";

    @SwingEditorAttribute
    public static final String DELAY_ATTRIBUTE = "delay";

    @SwingEditorAttribute
    public static final String MIN_LENGTH_ATTRIBUTE = "minLength";

    @SwingEditorAttribute
    public static final String SEPARATOR_ATTRIBUTE = "separator";

    @SwingEditorAttribute
    public static final String SOURCE_ATTRIBUTE = "source";

    @SwingEditorAttribute
    public static final String CELL_RENDERER_ATTRIBUTE = "cellRenderer";

    @SwingEditorAttribute
    public static final String PROMPT_TEXT_ATTRIBUTE = "promptText";

    @SwingEditorAttribute
    public static final String DEFAULT_VALUE_SUPPLIER_ATTRIBUTE = "defaultValueSupplier";

    private final JAutoCompletedComponent customEditor;
    private PropertyEnv currentEnv;

    public AutoCompletedPropertyEditor() {
        this.customEditor = new JAutoCompletedComponent();
        this.currentEnv = null;

        customEditor.setPreferredSize(new Dimension(300, 180));
        customEditor.addPropertyChangeListener(evt -> {
            switch (evt.getPropertyName()) {
                case JAutoCompletedComponent.VALUE_PROPERTY:
                    setValue(customEditor.getValue());
                    break;
                case JAutoCompletedComponent.RUNNING_PROPERTY:
                    currentEnv.setState(customEditor.isRunning() ? PropertyEnv.STATE_INVALID : PropertyEnv.STATE_VALID);
                    break;
            }
        });
    }

    @Override
    protected InplaceEditor createInplaceEditor() {
        return new AC3InplaceEditor();
    }

    @Override
    public void attachEnv(PropertyEnv env) {
        super.attachEnv(env);
        currentEnv = env;
    }

    @Override
    public String getAsText() {
        return attr(currentEnv, SEPARATOR_ATTRIBUTE, String.class)
                .map(this::replaceSeparatorWithPrettyChar)
                .orElseGet(super::getAsText);
    }

    private String replaceSeparatorWithPrettyChar(String s) {
        final String result = super.getAsText();
        return result != null ? result.replace(s, " \u27A1 ") : result;
    }

    @Override
    public boolean supportsCustomEditor() {
        return attr(currentEnv, SEPARATOR_ATTRIBUTE, String.class).isPresent();
    }

    @Override
    public Component getCustomEditor() {
        customEditor.setValue((String) getValue());
        customEditor.setAutoCompletion(o -> applyAutoCompletion(currentEnv, o));
        attr(currentEnv, SEPARATOR_ATTRIBUTE, String.class).ifPresent(customEditor::setSeparator);
        attr(currentEnv, DEFAULT_VALUE_SUPPLIER_ATTRIBUTE, Callable.class).ifPresent(customEditor::setDefaultValueSupplier);
        return customEditor;
    }

    private static void applyAutoCompletion(PropertyEnv env, JTextField component) {
        JAutoCompletion completion = attr(env, SERVICE_PATH_ATTRIBUTE, String.class)
                .map(servicePath -> AutoCompletionManager.get().bind(servicePath, component))
                .orElseGet(() -> new JAutoCompletion(component));
        attr(env, AUTO_FOCUS_ATTRIBUTE, Boolean.class).ifPresent(completion::setAutoFocus);
        attr(env, DELAY_ATTRIBUTE, Integer.class).ifPresent(completion::setDelay);
        attr(env, MIN_LENGTH_ATTRIBUTE, Integer.class).ifPresent(completion::setMinLength);
        attr(env, SEPARATOR_ATTRIBUTE, String.class).ifPresent(completion::setSeparator);
        attr(env, SOURCE_ATTRIBUTE, AutoCompletionSource.class).ifPresent(completion::setSource);
        attr(env, CELL_RENDERER_ATTRIBUTE, ListCellRenderer.class).ifPresent(completion.getList()::setCellRenderer);
        attr(env, PROMPT_TEXT_ATTRIBUTE, String.class).ifPresent(o -> new TextPrompt(o, component).setEnabled(false));
    }

    private static final class AC3InplaceEditor extends AbstractInplaceEditor {

        private JTextField component;

        @Override
        public void connect(PropertyEditor propertyEditor, PropertyEnv env) {
            component = new JTextField();
            applyAutoCompletion(env, component);
            super.connect(propertyEditor, env);
        }

        @Override
        public JComponent getComponent() {
            return component;
        }

        @Override
        public Object getValue() {
            return component.getText();
        }

        @Override
        public void setValue(Object o) {
            component.setText((String) o);
        }
    }
}