FeatureEditorDialog.java

/**
 * Copyright (c) 2002-2009 IBM Corporation and others.
 * 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:
 *   IBM - Initial API and implementation
 */
package org.eclipse.emf.edit.ui.celleditor;


import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.viewers.AbstractTreeViewer;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.IContentProvider;
import org.eclipse.jface.viewers.IDoubleClickListener;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
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.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.Display;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.dialogs.PatternFilter;

import org.eclipse.emf.common.notify.AdapterFactory;
import org.eclipse.emf.common.notify.impl.AdapterFactoryImpl;
import org.eclipse.emf.common.ui.celleditor.ExtendedComboBoxCellEditor;
import org.eclipse.emf.common.util.BasicEList;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EClassifier;
import org.eclipse.emf.ecore.EDataType;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.emf.edit.provider.ComposedAdapterFactory;
import org.eclipse.emf.edit.provider.ItemProvider;
import org.eclipse.emf.edit.ui.EMFEditUIPlugin;
import org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider;


public class FeatureEditorDialog extends Dialog
{
  protected ILabelProvider labelProvider;
  protected IContentProvider contentProvider;
  protected Object object;
  protected EClassifier eClassifier;
  protected String displayName;
  protected ItemProvider values;
  protected List<?> choiceOfValues;
  protected EList<?> result;
  protected boolean multiLine;
  protected boolean unique;

  /**
   * @since 2.6
   */
  public FeatureEditorDialog
    (Shell parent, 
     ILabelProvider labelProvider, 
     Object object, 
     EClassifier eClassifier, 
     List<?> currentValues, 
     String displayName, 
     List<?> choiceOfValues,
     boolean multiLine,
     boolean sortChoices,
     boolean unique)
  {
    super(parent);
    setShellStyle(getShellStyle() | SWT.RESIZE | SWT.MAX);
    this.labelProvider = labelProvider;
    this.object = object;
    this.eClassifier = eClassifier;
    this.displayName = displayName;
    this.choiceOfValues = choiceOfValues;
    this.multiLine = multiLine;
    this.unique = unique;

    AdapterFactory adapterFactory = new ComposedAdapterFactory(Collections.<AdapterFactory>emptyList());
    values = new ItemProvider(adapterFactory, currentValues);
    contentProvider = new AdapterFactoryContentProvider(adapterFactory);
    if (sortChoices && choiceOfValues != null)
    {
      this.choiceOfValues = new ArrayList<Object>(choiceOfValues);
      ExtendedComboBoxCellEditor.createItems(this.choiceOfValues, labelProvider, true);
    }
  }

  /**
   * @deprecated Use {@link #FeatureEditorDialog(Shell, ILabelProvider, Object, EClassifier, List, String, List, boolean, boolean, boolean)},
   * which provides proper behaviour for unique and non-unique features. This form retains the old behaviour, where
   * specifying a list of choices enforces uniqueness.
   */
  @Deprecated
  public FeatureEditorDialog
  (Shell parent, 
   ILabelProvider labelProvider, 
   Object object, 
   EClassifier eClassifier, 
   List<?> currentValues, 
   String displayName, 
   List<?> choiceOfValues,
   boolean multiLine,
   boolean sortChoices)
  {
    this(parent, labelProvider, object, eClassifier, currentValues, displayName, choiceOfValues, multiLine, sortChoices, choiceOfValues != null);
  }

  /**
   * @deprecated Use {@link #FeatureEditorDialog(Shell, ILabelProvider, Object, EClassifier, List, String, List, boolean, boolean, boolean)},
   * which provides proper behaviour for unique and non-unique features. This form retains the old behaviour, where
   * specifying a list of choices enforces uniqueness.
   */
  @Deprecated
  public FeatureEditorDialog
    (Shell parent, 
     ILabelProvider labelProvider, 
     Object object, 
     EClassifier eClassifier, 
     List<?> currentValues, 
     String displayName, 
     List<?> choiceOfValues)
  {
    this(parent, labelProvider, object, eClassifier, currentValues, displayName, choiceOfValues, false, false, choiceOfValues != null);
  }

  public FeatureEditorDialog
    (Shell parent, 
     ILabelProvider labelProvider, 
     EObject eObject, 
     EStructuralFeature eStructuralFeature, 
     String displayName, 
     List<?> choiceOfValues)
  {
    this(parent,
         labelProvider,
         eObject,
         eStructuralFeature.getEType(),
         (List<?>)eObject.eGet(eStructuralFeature),
         displayName,
         choiceOfValues,
         false,
         false,
         eStructuralFeature.isUnique());
  }

  @Override
  protected void configureShell(Shell shell) 
  {
    super.configureShell(shell);
    shell.setText
      (EMFEditUIPlugin.INSTANCE.getString
         ("_UI_FeatureEditorDialog_title", new Object [] { displayName, labelProvider.getText(object) }));
    shell.setImage(labelProvider.getImage(object));
  }

  @Override
  protected Control createDialogArea(Composite parent) 
  {
    Composite contents = (Composite)super.createDialogArea(parent);

    GridLayout contentsGridLayout = (GridLayout)contents.getLayout();
    contentsGridLayout.numColumns = 3;

    GridData contentsGridData = (GridData)contents.getLayoutData();
    contentsGridData.horizontalAlignment = SWT.FILL;
    contentsGridData.verticalAlignment = SWT.FILL;

    Text patternText = null;

    if (choiceOfValues != null) 
    {
      Group filterGroupComposite = new Group(contents, SWT.NONE);
      filterGroupComposite.setText(EMFEditUIPlugin.INSTANCE.getString("_UI_Choices_pattern_group"));
      filterGroupComposite.setLayout(new GridLayout(2, false));
      filterGroupComposite.setLayoutData(new GridData(SWT.FILL, SWT.DEFAULT, true, false, 3, 1));

      Label label = new Label(filterGroupComposite, SWT.NONE);
      label.setText(EMFEditUIPlugin.INSTANCE.getString("_UI_Choices_pattern_label"));

      patternText = new Text(filterGroupComposite, SWT.BORDER);
      patternText.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
    }

    Composite choiceComposite = new Composite(contents, SWT.NONE);
    {
      GridData data = new GridData(SWT.FILL, SWT.FILL, true, true);
      data.horizontalAlignment = SWT.END;
      choiceComposite.setLayoutData(data);

      GridLayout layout = new GridLayout();
      data.horizontalAlignment = SWT.FILL;
      layout.marginHeight = 0;
      layout.marginWidth = 0;
      layout.numColumns = 1;
      choiceComposite.setLayout(layout);
    }

    Label choiceLabel = new Label(choiceComposite, SWT.NONE);
    choiceLabel.setText
      (choiceOfValues == null ? 
         EMFEditUIPlugin.INSTANCE.getString("_UI_Value_label") : 
         EMFEditUIPlugin.INSTANCE.getString("_UI_Choices_label"));
    GridData choiceLabelGridData = new GridData();
    choiceLabelGridData.verticalAlignment = SWT.FILL;
    choiceLabelGridData.horizontalAlignment = SWT.FILL;
    choiceLabel.setLayoutData(choiceLabelGridData);

    final Table choiceTable = choiceOfValues == null ? null : new Table(choiceComposite, SWT.MULTI | SWT.BORDER);
    if (choiceTable != null)
    {
      GridData choiceTableGridData = new GridData();
      choiceTableGridData.widthHint = Display.getCurrent().getBounds().width / 5;
      choiceTableGridData.heightHint = Display.getCurrent().getBounds().height / 3;
      choiceTableGridData.verticalAlignment = SWT.FILL;
      choiceTableGridData.horizontalAlignment = SWT.FILL;
      choiceTableGridData.grabExcessHorizontalSpace= true;
      choiceTableGridData.grabExcessVerticalSpace= true;
      choiceTable.setLayoutData(choiceTableGridData);
    }

    final TableViewer choiceTableViewer = choiceOfValues == null ? null : new TableViewer(choiceTable);
    if (choiceTableViewer != null)
    {
      choiceTableViewer.setContentProvider(new AdapterFactoryContentProvider(new AdapterFactoryImpl()));
      choiceTableViewer.setLabelProvider(labelProvider);
      final PatternFilter filter =
        new PatternFilter()
        {
          @Override
          protected boolean isParentMatch(Viewer viewer, Object element)
          {
            return viewer instanceof AbstractTreeViewer && super.isParentMatch(viewer, element);
          }
        };
      choiceTableViewer.addFilter(filter);
      if (patternText != null)
      {
        patternText.addModifyListener
          (new ModifyListener()
           {
             public void modifyText(ModifyEvent e)
             {
               filter.setPattern(((Text)e.widget).getText());
               choiceTableViewer.refresh();
             }
           });
      }
      choiceTableViewer.setInput(new ItemProvider(choiceOfValues));
    }

    // We use multi even for a single line because we want to respond to the enter key.
    //
    int style = multiLine ?
      SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL | SWT.BORDER :
      SWT.MULTI | SWT.BORDER;
    final Text choiceText = choiceOfValues == null ? new Text(choiceComposite, style) : null;
    if (choiceText != null)
    {
      GridData choiceTextGridData = new GridData();
      choiceTextGridData.widthHint = Display.getCurrent().getBounds().width / 5;
      choiceTextGridData.verticalAlignment = SWT.BEGINNING;
      choiceTextGridData.horizontalAlignment = SWT.FILL;
      choiceTextGridData.grabExcessHorizontalSpace = true;
      if (multiLine)
      {
        choiceTextGridData.verticalAlignment = SWT.FILL;
        choiceTextGridData.grabExcessVerticalSpace = true;
      }
      choiceText.setLayoutData(choiceTextGridData);
    }

    Composite controlButtons = new Composite(contents, SWT.NONE);
    GridData controlButtonsGridData = new GridData();
    controlButtonsGridData.verticalAlignment = SWT.FILL;
    controlButtonsGridData.horizontalAlignment = SWT.FILL;
    controlButtons.setLayoutData(controlButtonsGridData);

    GridLayout controlsButtonGridLayout = new GridLayout();
    controlButtons.setLayout(controlsButtonGridLayout);

    new Label(controlButtons, SWT.NONE);
    
    final Button addButton = new Button(controlButtons, SWT.PUSH);
    addButton.setText(EMFEditUIPlugin.INSTANCE.getString("_UI_Add_label"));
    GridData addButtonGridData = new GridData();
    addButtonGridData.verticalAlignment = SWT.FILL;
    addButtonGridData.horizontalAlignment = SWT.FILL;
    addButton.setLayoutData(addButtonGridData);

    final Button removeButton = new Button(controlButtons, SWT.PUSH);
    removeButton.setText(EMFEditUIPlugin.INSTANCE.getString("_UI_Remove_label"));
    GridData removeButtonGridData = new GridData();
    removeButtonGridData.verticalAlignment = SWT.FILL;
    removeButtonGridData.horizontalAlignment = SWT.FILL;
    removeButton.setLayoutData(removeButtonGridData);
    
    Label spaceLabel = new Label(controlButtons, SWT.NONE);
    GridData spaceLabelGridData = new GridData();
    spaceLabelGridData.verticalSpan = 2;
    spaceLabel.setLayoutData(spaceLabelGridData);
    
    final Button upButton = new Button(controlButtons, SWT.PUSH);
    upButton.setText(EMFEditUIPlugin.INSTANCE.getString("_UI_Up_label"));
    GridData upButtonGridData = new GridData();
    upButtonGridData.verticalAlignment = SWT.FILL;
    upButtonGridData.horizontalAlignment = SWT.FILL;
    upButton.setLayoutData(upButtonGridData);

    final Button downButton = new Button(controlButtons, SWT.PUSH);
    downButton.setText(EMFEditUIPlugin.INSTANCE.getString("_UI_Down_label"));
    GridData downButtonGridData = new GridData();
    downButtonGridData.verticalAlignment = SWT.FILL;
    downButtonGridData.horizontalAlignment = SWT.FILL;
    downButton.setLayoutData(downButtonGridData);

    Composite featureComposite = new Composite(contents, SWT.NONE);
    {
      GridData data = new GridData(SWT.FILL, SWT.FILL, true, true);
      data.horizontalAlignment = SWT.END;
      featureComposite.setLayoutData(data);

      GridLayout layout = new GridLayout();
      data.horizontalAlignment = SWT.FILL;
      layout.marginHeight = 0;
      layout.marginWidth = 0;
      layout.numColumns = 1;
      featureComposite.setLayout(layout);
    }

    Label featureLabel = new Label(featureComposite, SWT.NONE);
    featureLabel.setText(EMFEditUIPlugin.INSTANCE.getString("_UI_Feature_label"));
    GridData featureLabelGridData = new GridData();
    featureLabelGridData.horizontalSpan = 2;
    featureLabelGridData.horizontalAlignment = SWT.FILL;
    featureLabelGridData.verticalAlignment = SWT.FILL;
    featureLabel.setLayoutData(featureLabelGridData);
    
    final Table featureTable = new Table(featureComposite, SWT.MULTI | SWT.BORDER);
    GridData featureTableGridData = new GridData();
    featureTableGridData.widthHint = Display.getCurrent().getBounds().width / 5;
    featureTableGridData.heightHint = Display.getCurrent().getBounds().height / 3;
    featureTableGridData.verticalAlignment = SWT.FILL;
    featureTableGridData.horizontalAlignment = SWT.FILL;
    featureTableGridData.grabExcessHorizontalSpace= true;
    featureTableGridData.grabExcessVerticalSpace= true;
    featureTable.setLayoutData(featureTableGridData);

    final TableViewer featureTableViewer = new TableViewer(featureTable);
    featureTableViewer.setContentProvider(contentProvider);
    featureTableViewer.setLabelProvider(labelProvider);
    featureTableViewer.setInput(values);
    if (!values.getChildren().isEmpty())
    {
      featureTableViewer.setSelection(new StructuredSelection(values.getChildren().get(0)));
    }
    
    if (choiceTableViewer != null)
    {
      choiceTableViewer.addDoubleClickListener(new IDoubleClickListener()
        {
          public void doubleClick(DoubleClickEvent event)
          {
            if (addButton.isEnabled())
            {
              addButton.notifyListeners(SWT.Selection, null);
            }
          }
        });

      featureTableViewer.addDoubleClickListener(new IDoubleClickListener()
      {
        public void doubleClick(DoubleClickEvent event)
        {
          if (removeButton.isEnabled())
          {
            removeButton.notifyListeners(SWT.Selection, null);
          }
        }
      });
    }
    
    if (choiceText != null)
    {
      choiceText.addKeyListener(
        new KeyAdapter()
        {
          @Override
          public void keyPressed(KeyEvent event)
          {
            if (!multiLine && (event.character == '\r' || event.character == '\n'))
            {
              try
              {
                Object value = EcoreUtil.createFromString((EDataType)eClassifier, choiceText.getText());
                values.getChildren().add(value);
                choiceText.setText("");
                featureTableViewer.setSelection(new StructuredSelection(value));
                event.doit = false;
              }
              catch (RuntimeException exception)
              {
                // Ignore
              }
            }
            else if (event.character == '\33')
            {
              choiceText.setText("");
              event.doit = false;
            }
          }
        });
    }
        
    upButton.addSelectionListener(
      new SelectionAdapter()
      {
        @Override
        public void widgetSelected(SelectionEvent event)
        {
          IStructuredSelection selection = (IStructuredSelection)featureTableViewer.getSelection();
          int minIndex = 0;
          for (Iterator<?> i = selection.iterator(); i.hasNext();)
          {
            Object value = i.next();
            int index = values.getChildren().indexOf(value);
            values.getChildren().move(Math.max(index - 1, minIndex++), value);
          }
        }
      });

    downButton.addSelectionListener(
      new SelectionAdapter()
      {
        @Override
        public void widgetSelected(SelectionEvent event)
        {
          IStructuredSelection selection = (IStructuredSelection)featureTableViewer.getSelection();
          int maxIndex = values.getChildren().size() - selection.size();
          for (Iterator<?> i = selection.iterator(); i.hasNext();)
          {
            Object value = i.next();
            int index = values.getChildren().indexOf(value);
            values.getChildren().move(Math.min(index + 1, maxIndex++), value);
          }
        }
      });

    addButton.addSelectionListener(
      new SelectionAdapter()
      {
        // event is null when choiceTableViewer is double clicked
        @Override
        public void widgetSelected(SelectionEvent event)
        {
          if (choiceTableViewer != null)
          {
            IStructuredSelection selection = (IStructuredSelection)choiceTableViewer.getSelection();
            for (Iterator<?> i = selection.iterator(); i.hasNext();)
            {
              Object value = i.next();
              if (!unique || !values.getChildren().contains(value))
              {
                values.getChildren().add(value);
              }
            }
            featureTableViewer.setSelection(selection);
          }
          else if (choiceText != null)
          {
            try
            {
              Object value = EcoreUtil.createFromString((EDataType)eClassifier, choiceText.getText());
              if (!unique || !values.getChildren().contains(value))
              {
                values.getChildren().add(value);
                choiceText.setText("");
              }
              featureTableViewer.setSelection(new StructuredSelection(value));
            }
            catch (RuntimeException exception)
            {
              // Ignore
            }
          }
        }
      });

    removeButton.addSelectionListener(
      new SelectionAdapter()
      {
        // event is null when featureTableViewer is double clicked 
        @Override
        public void widgetSelected(SelectionEvent event)
        {
          IStructuredSelection selection = (IStructuredSelection)featureTableViewer.getSelection();
          Object firstValue = null;
          for (Iterator<?> i = selection.iterator(); i.hasNext();)
          {
            Object value = i.next();
            if (firstValue == null)
            {
              firstValue = value;
            }
            values.getChildren().remove(value);
          }

          if (!values.getChildren().isEmpty())
          {
            featureTableViewer.setSelection(new StructuredSelection(values.getChildren().get(0)));
          }

          if (choiceTableViewer != null)
          {
            choiceTableViewer.setSelection(selection);
          }
          else if (choiceText != null)
          {
            if (firstValue != null)
            {
              String value = EcoreUtil.convertToString((EDataType)eClassifier, firstValue);
              choiceText.setText(value);
            }
          }
        }
      });    
        
    return contents;
  }

  @Override
  protected void okPressed()
  {
    result = new BasicEList<Object>(values.getChildren());
    super.okPressed();
  }

  @Override
  public boolean close()
  {
    contentProvider.dispose();
    return super.close();
  }

  public EList<?> getResult()
  {
    return result;
  }
}