de.jcup.egradle.eclipse.ui.MultipleInputDialog.java Source code

Java tutorial

Introduction

Here is the source code for de.jcup.egradle.eclipse.ui.MultipleInputDialog.java

Source

/*
 * Copyright 2016 Albert Tregnaghi
 *
 * 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 de.jcup.egradle.eclipse.ui;

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

import org.eclipse.debug.ui.StringVariableSelectionDialog;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.TraverseEvent;
import org.eclipse.swt.events.TraverseListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.DirectoryDialog;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;

public class MultipleInputDialog extends Dialog {
    private static final String EMPTY_STRING = "";
    protected static final String FIELD_NAME = "FIELD_NAME"; //$NON-NLS-1$
    protected static final int TEXT = 100;
    protected static final int BROWSE = 101;
    protected static final int VARIABLE = 102;
    protected static final int MULTILINE_VARIABLE = 103;

    protected Composite panel;

    protected List<FieldSummary> fieldList = new ArrayList<FieldSummary>();
    protected List<Text> controlList = new ArrayList<Text>();
    protected List<Validator> validators = new ArrayList<Validator>();
    protected Map<Object, String> valueMap = new HashMap<Object, String>();

    private String title;

    public MultipleInputDialog(Shell shell, String title) {
        super(shell);
        this.title = title;
        setShellStyle(getShellStyle() | SWT.RESIZE);
    }

    @Override
    protected void configureShell(Shell shell) {
        super.configureShell(shell);
        if (title != null) {
            shell.setText(title);
        }

    }

    @Override
    protected Control createButtonBar(Composite parent) {
        Control bar = super.createButtonBar(parent);
        validateFields();
        return bar;
    }

    @Override
    protected Control createDialogArea(Composite parent) {
        Composite container = (Composite) super.createDialogArea(parent);
        container.setLayout(new GridLayout(2, false));
        container.setLayoutData(new GridData(GridData.FILL_BOTH));

        panel = new Composite(container, SWT.NONE);
        GridLayout layout = new GridLayout(2, false);
        panel.setLayout(layout);
        panel.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        for (FieldSummary field : fieldList) {
            switch (field.type) {
            case TEXT:
                createTextField(field.name, field.initialValue, field.allowsEmpty);
                break;
            case BROWSE:
                createBrowseField(field.name, field.initialValue, field.allowsEmpty);
                break;
            case VARIABLE:
                createVariablesField(field.name, field.initialValue, field.allowsEmpty);
                break;
            case MULTILINE_VARIABLE:
                createMultilineVariablesField(field.name, field.initialValue, field.allowsEmpty);
                break;
            default:
                break;
            }
        }

        fieldList = null; // allow it to be gc'd
        Dialog.applyDialogFont(container);
        return container;
    }

    public void addBrowseField(String labelText, String initialValue, boolean allowsEmpty) {
        fieldList.add(new FieldSummary(BROWSE, labelText, initialValue, allowsEmpty));
    }

    public void addTextField(String labelText, String initialValue, boolean allowsEmpty) {
        fieldList.add(new FieldSummary(TEXT, labelText, initialValue, allowsEmpty));
    }

    public void addVariablesField(String labelText, String initialValue, boolean allowsEmpty) {
        fieldList.add(new FieldSummary(VARIABLE, labelText, initialValue, allowsEmpty));
    }

    public void addMultilinedVariablesField(String labelText, String initialValue, boolean allowsEmpty) {
        fieldList.add(new FieldSummary(MULTILINE_VARIABLE, labelText, initialValue, allowsEmpty));
    }

    protected void createTextField(String labelText, String initialValue, boolean allowEmpty) {
        Label label = new Label(panel, SWT.NONE);
        label.setText(labelText);
        label.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_BEGINNING));

        final Text text = new Text(panel, SWT.SINGLE | SWT.BORDER);
        text.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
        text.setData(FIELD_NAME, labelText);

        // make sure rows are the same height on both panels.
        label.setSize(label.getSize().x, text.getSize().y);

        if (initialValue != null) {
            text.setText(initialValue);
        }

        if (!allowEmpty) {
            validators.add(new Validator() {
                @Override
                public boolean validate() {
                    return !text.getText().equals(EMPTY_STRING);
                }
            });
            text.addModifyListener(new ModifyListener() {
                @Override
                public void modifyText(ModifyEvent e) {
                    validateFields();
                }
            });
        }

        controlList.add(text);
    }

    protected void createBrowseField(String labelText, String initialValue, boolean allowEmpty) {
        Label label = new Label(panel, SWT.NONE);
        label.setText(labelText);
        label.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_BEGINNING));

        Composite comp = new Composite(panel, SWT.NONE);
        GridLayout layout = new GridLayout();
        layout.marginHeight = 0;
        layout.marginWidth = 0;
        comp.setLayout(layout);
        comp.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

        final Text text = new Text(comp, SWT.SINGLE | SWT.BORDER);
        GridData data = new GridData(GridData.FILL_HORIZONTAL);
        data.widthHint = 200;
        text.setLayoutData(data);
        text.setData(FIELD_NAME, labelText);

        // make sure rows are the same height on both panels.
        label.setSize(label.getSize().x, text.getSize().y);

        if (initialValue != null) {
            text.setText(initialValue);
        }

        if (!allowEmpty) {
            validators.add(new Validator() {
                @Override
                public boolean validate() {
                    return !text.getText().equals(EMPTY_STRING);
                }
            });

            text.addModifyListener(new ModifyListener() {
                @Override
                public void modifyText(ModifyEvent e) {
                    validateFields();
                }
            });
        }

        Button button = createButton(comp, IDialogConstants.IGNORE_ID, "&Browse...", false);
        button.addSelectionListener(new SelectionAdapter() {
            @Override
            public void widgetSelected(SelectionEvent e) {
                DirectoryDialog dialog = new DirectoryDialog(getShell());
                dialog.setMessage("Select a file:");
                String currentWorkingDir = text.getText();
                if (!currentWorkingDir.trim().equals(EMPTY_STRING)) {
                    File path = new File(currentWorkingDir);
                    if (path.exists()) {
                        dialog.setFilterPath(currentWorkingDir);
                    }
                }

                String selectedDirectory = dialog.open();
                if (selectedDirectory != null) {
                    text.setText(selectedDirectory);
                }
            }
        });

        controlList.add(text);

    }

    public void createVariablesField(String labelText, String initialValue, boolean allowEmpty) {
        Label label = new Label(panel, SWT.NONE);
        label.setText(labelText);
        label.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_BEGINNING));

        Composite comp = new Composite(panel, SWT.NONE);
        GridLayout layout = new GridLayout();
        layout.marginHeight = 0;
        layout.marginWidth = 0;
        comp.setLayout(layout);
        comp.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

        final Text text = new Text(comp, SWT.SINGLE | SWT.BORDER);
        GridData data = new GridData(GridData.FILL_HORIZONTAL);
        data.widthHint = 200;
        text.setLayoutData(data);
        text.setData(FIELD_NAME, labelText);

        // make sure rows are the same height on both panels.
        label.setSize(label.getSize().x, text.getSize().y);

        if (initialValue != null) {
            text.setText(initialValue);
        }

        if (!allowEmpty) {
            validators.add(new Validator() {
                @Override
                public boolean validate() {
                    return !text.getText().equals(EMPTY_STRING);
                }
            });

            text.addModifyListener(new ModifyListener() {
                @Override
                public void modifyText(ModifyEvent e) {
                    validateFields();
                }
            });
        }

        Button button = createButton(comp, IDialogConstants.IGNORE_ID, "Varia&bles...", false);
        button.addSelectionListener(new SelectionAdapter() {
            @Override
            public void widgetSelected(SelectionEvent e) {
                StringVariableSelectionDialog dialog = new StringVariableSelectionDialog(getShell());
                int code = dialog.open();
                if (code == IDialogConstants.OK_ID) {
                    String variable = dialog.getVariableExpression();
                    if (variable != null) {
                        text.insert(variable);
                    }
                }
            }
        });

        controlList.add(text);

    }

    public void createMultilineVariablesField(String labelText, String initialValue, boolean allowEmpty) {
        Label label = new Label(panel, SWT.NONE);
        label.setText(labelText);
        GridData gd = new GridData(GridData.HORIZONTAL_ALIGN_BEGINNING);
        gd.horizontalSpan = 2;
        label.setLayoutData(gd);

        final Text text = new Text(panel, SWT.MULTI | SWT.BORDER | SWT.V_SCROLL);
        gd = new GridData(GridData.FILL_BOTH);
        gd.widthHint = 300;
        gd.heightHint = 4 * text.getLineHeight();
        gd.horizontalSpan = 2;
        text.setLayoutData(gd);
        text.setData(FIELD_NAME, labelText);

        text.addTraverseListener(new TraverseListener() {
            @Override
            public void keyTraversed(TraverseEvent e) {
                if (e.detail == SWT.TRAVERSE_RETURN && e.stateMask == SWT.SHIFT) {
                    e.doit = true;
                }
            }
        });

        // make sure rows are the same height on both panels.
        label.setSize(label.getSize().x, text.getSize().y);

        if (initialValue != null) {
            text.setText(initialValue);
        }

        if (!allowEmpty) {
            validators.add(new Validator() {
                @Override
                public boolean validate() {
                    return !text.getText().equals(EMPTY_STRING);
                }
            });

            text.addModifyListener(new ModifyListener() {
                @Override
                public void modifyText(ModifyEvent e) {
                    validateFields();
                }
            });
        }
        Composite comp = SWTFactory.createComposite(panel, panel.getFont(), 1, 2, GridData.HORIZONTAL_ALIGN_END);
        GridLayout ld = (GridLayout) comp.getLayout();
        ld.marginHeight = 1;
        ld.marginWidth = 0;
        ld.horizontalSpacing = 0;
        Button button = createButton(comp, IDialogConstants.IGNORE_ID, "Varia&bles...", false);

        button.addSelectionListener(new SelectionAdapter() {
            @Override
            public void widgetSelected(SelectionEvent e) {
                StringVariableSelectionDialog dialog = new StringVariableSelectionDialog(getShell());
                int code = dialog.open();
                if (code == IDialogConstants.OK_ID) {
                    String variable = dialog.getVariableExpression();
                    if (variable != null) {
                        text.insert(variable);
                    }
                }
            }
        });

        controlList.add(text);
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.jface.dialogs.Dialog#okPressed()
     */
    @Override
    protected void okPressed() {
        for (Text control : controlList) {
            valueMap.put(control.getData(FIELD_NAME), control.getText());
        }
        controlList = null;
        super.okPressed();
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.jface.window.Window#open()
     */
    @Override
    public int open() {
        applyDialogFont(panel);
        return super.open();
    }

    public Object getValue(String key) {
        return valueMap.get(key);
    }

    public String getStringValue(String key) {
        return (String) getValue(key);
    }

    public void validateFields() {
        for (Validator validator : validators) {
            if (!validator.validate()) {
                getButton(IDialogConstants.OK_ID).setEnabled(false);
                return;
            }
        }
        getButton(IDialogConstants.OK_ID).setEnabled(true);
    }

    protected class FieldSummary {
        int type;
        String name;
        String initialValue;
        boolean allowsEmpty;

        public FieldSummary(int type, String name, String initialValue, boolean allowsEmpty) {
            this.type = type;
            this.name = name;
            this.initialValue = initialValue;
            this.allowsEmpty = allowsEmpty;
        }
    }

    protected class Validator {
        boolean validate() {
            return true;
        }
    }
}