trunk/ruta-ep-ide-ui/src/main/java/org/apache/uima/ruta/ide/ui/preferences/RutaSmartTypingConfigurationBlock.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.uima.ruta.ide.ui.preferences;

import java.util.ArrayList;
import java.util.List;

import org.apache.uima.ruta.ide.RutaIdeUIPlugin;
import org.apache.uima.ruta.ide.ui.RutaPreferenceConstants;
import org.eclipse.core.runtime.Assert;
import org.eclipse.dltk.internal.corext.util.Messages;
import org.eclipse.dltk.ui.CodeFormatterConstants;
import org.eclipse.dltk.ui.PreferenceConstants;
import org.eclipse.dltk.ui.preferences.AbstractConfigurationBlock;
import org.eclipse.dltk.ui.preferences.OverlayPreferenceStore;
import org.eclipse.dltk.ui.preferences.PreferencesMessages;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.DisposeListener;
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.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Link;
import org.eclipse.ui.dialogs.PreferencesUtil;

/**
 * Configures Editor typing preferences.
 */
class RutaSmartTypingConfigurationBlock extends AbstractConfigurationBlock {

  public RutaSmartTypingConfigurationBlock(OverlayPreferenceStore store) {
    super(store);

    store.addKeys(createOverlayStoreKeys());
  }

  private OverlayPreferenceStore.OverlayKey[] createOverlayStoreKeys() {

    List keys = new ArrayList();

    keys.add(new OverlayPreferenceStore.OverlayKey(OverlayPreferenceStore.BOOLEAN,
            PreferenceConstants.EDITOR_CLOSE_STRINGS));
    keys.add(new OverlayPreferenceStore.OverlayKey(OverlayPreferenceStore.BOOLEAN,
            PreferenceConstants.EDITOR_CLOSE_BRACKETS));
    keys.add(new OverlayPreferenceStore.OverlayKey(OverlayPreferenceStore.BOOLEAN,
            PreferenceConstants.EDITOR_CLOSE_BRACES));
    keys.add(new OverlayPreferenceStore.OverlayKey(OverlayPreferenceStore.BOOLEAN,
            PreferenceConstants.EDITOR_SMART_TAB));
    keys.add(new OverlayPreferenceStore.OverlayKey(OverlayPreferenceStore.INT,
            RutaPreferenceConstants.EDITOR_SMART_PASTE_MODE));

    return (OverlayPreferenceStore.OverlayKey[]) keys
            .toArray(new OverlayPreferenceStore.OverlayKey[keys.size()]);
  }

  public Control createControl(Composite parent) {
    Composite control = new Composite(parent, SWT.NONE);
    GridLayout layout = new GridLayout();
    control.setLayout(layout);

    Composite composite = createSubsection(control, null,
            RutaPreferencesMessages.RutaSmartTypingConfigurationBlock_autoclose_title);
    addAutoclosingSection(composite);

    composite = createSubsection(control, null,
            RutaPreferencesMessages.RutaSmartTypingConfigurationBlock_tabs_title);
    addTabSection(composite);

    composite = createSubsection(control, null,
            PreferencesMessages.SmartTypingConfigurationBlock_pasting_title);
    addPasteSection(composite);

    return control;
  }

  private void addPasteSection(Composite composite) {
    GridLayout layout = new GridLayout();
    composite.setLayout(layout);

    String label = null;

    label = RutaPreferencesMessages.RutaSmartTypingConfigurationBlock_smartPaste_simple;
    addRadioButton(composite, label, RutaPreferenceConstants.EDITOR_SMART_PASTE_MODE,
            RutaPreferenceConstants.EDITOR_SMART_PASTE_MODE_SIMPLE);

    label = RutaPreferencesMessages.RutaSmartTypingConfigurationBlock_smartPaste_full;
    addRadioButton(composite, label, RutaPreferenceConstants.EDITOR_SMART_PASTE_MODE,
            RutaPreferenceConstants.EDITOR_SMART_PASTE_MODE_FULL);

  }

  private void addTabSection(Composite composite) {
    GridLayout layout = new GridLayout();
    composite.setLayout(layout);

    String label;
    label = RutaPreferencesMessages.RutaSmartTypingConfigurationBlock_typing_smartTab;
    addCheckBox(composite, label, PreferenceConstants.EDITOR_SMART_TAB, 0);

    createMessage(composite);
  }

  private void addAutoclosingSection(Composite composite) {
    GridLayout layout = new GridLayout();
    layout.numColumns = 1;
    composite.setLayout(layout);

    String label;

    label = RutaPreferencesMessages.RutaSmartTypingConfigurationBlock_closeStrings;
    addCheckBox(composite, label, PreferenceConstants.EDITOR_CLOSE_STRINGS, 0);

    label = RutaPreferencesMessages.RutaSmartTypingConfigurationBlock_closeBrackets;
    addCheckBox(composite, label, PreferenceConstants.EDITOR_CLOSE_BRACKETS, 0);

    label = RutaPreferencesMessages.RutaSmartTypingConfigurationBlock_closeBraces;
    addCheckBox(composite, label, PreferenceConstants.EDITOR_CLOSE_BRACES, 0);
  }

  private void createMessage(final Composite composite) {
    // TODO create a link with an argument, so the formatter preference page
    // can open the
    // current profile automatically.
    String linkTooltip = PreferencesMessages.SmartTypingConfigurationBlock_tabs_message_tooltip;
    String text;
    String indentMode = RutaIdeUIPlugin.getDefault().getPreferenceStore()
            .getString(CodeFormatterConstants.FORMATTER_TAB_CHAR);
    if (CodeFormatterConstants.TAB.equals(indentMode))
      text = Messages.format(
              PreferencesMessages.SmartTypingConfigurationBlock_tabs_message_tab_text,
              new String[] { Integer.toString(getTabDisplaySize()) });
    else
      text = Messages.format(
              PreferencesMessages.SmartTypingConfigurationBlock_tabs_message_others_text,
              new String[] { Integer.toString(getTabDisplaySize()), getIndentMode() });

    final Link link = new Link(composite, SWT.NONE);
    link.setText(text);
    link.setToolTipText(linkTooltip);
    GridData gd = new GridData(SWT.FILL, SWT.BEGINNING, true, false);
    gd.widthHint = 300; // don't get wider initially
    link.setLayoutData(gd);
    link.addSelectionListener(new SelectionAdapter() {
      @Override
      public void widgetSelected(SelectionEvent e) {
        PreferencesUtil.createPreferenceDialogOn(link.getShell(),
                "org.apache.uima.ruta.ide.ui.EditorPreferences", null, null); //$NON-NLS-1$
      }
    });

    final IPreferenceStore combinedStore = getPreferenceStore();
    final IPropertyChangeListener propertyChangeListener = new IPropertyChangeListener() {
      private boolean fHasRun = false;

      public void propertyChange(PropertyChangeEvent event) {
        if (fHasRun)
          return;
        if (composite.isDisposed())
          return;
        String property = event.getProperty();
        if (CodeFormatterConstants.FORMATTER_TAB_CHAR.equals(property)
                || CodeFormatterConstants.FORMATTER_TAB_SIZE.equals(property)) {
          fHasRun = true;
          link.dispose();
          createMessage(composite);
          Dialog.applyDialogFont(composite);
          composite.redraw();
          composite.layout();
        }
      }
    };
    combinedStore.addPropertyChangeListener(propertyChangeListener);
    link.addDisposeListener(new DisposeListener() {
      public void widgetDisposed(org.eclipse.swt.events.DisposeEvent e) {
        combinedStore.removePropertyChangeListener(propertyChangeListener);
      }
    });
  }

  private String getIndentMode() {
    String indentMode = RutaIdeUIPlugin.getDefault().getPreferenceStore()
            .getString(CodeFormatterConstants.FORMATTER_TAB_CHAR);

    if (CodeFormatterConstants.SPACE.equals(indentMode))
      return PreferencesMessages.SmartTypingConfigurationBlock_tabs_message_spaces;

    if (CodeFormatterConstants.TAB.equals(indentMode))
      return PreferencesMessages.SmartTypingConfigurationBlock_tabs_message_tabs;

    if (CodeFormatterConstants.MIXED.equals(indentMode))
      return PreferencesMessages.SmartTypingConfigurationBlock_tabs_message_tabsAndSpaces;

    Assert.isTrue(false, "Illegal indent mode - must not happen"); //$NON-NLS-1$
    return null;
  }

  private int getTabDisplaySize() {
    return RutaIdeUIPlugin.getDefault().getPreferenceStore()
            .getInt(CodeFormatterConstants.FORMATTER_TAB_SIZE);
  }

}