org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/dialogs/SearchFilterDialog.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2012 IBM Corporation, Ericsson
   3  * All rights reserved.   This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM - Initial API and implementation
  10  *     Bernd Hufmann - Updated for TMF
  11  **********************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.dialogs;
  14
  15 import java.util.ArrayList;
  16 import java.util.List;
  17
  18 import org.eclipse.jface.dialogs.Dialog;
  19 import org.eclipse.jface.dialogs.DialogSettings;
  20 import org.eclipse.jface.dialogs.IDialogConstants;
  21 import org.eclipse.linuxtools.internal.tmf.ui.Activator;
  22 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDView;
  23 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.AsyncMessage;
  24 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.AsyncMessageReturn;
  25 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode;
  26 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.Lifeline;
  27 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.Stop;
  28 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.SyncMessage;
  29 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.SyncMessageReturn;
  30 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDFindProvider;
  31 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDGraphNodeSupporter;
  32 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.util.SDMessages;
  33 import org.eclipse.swt.SWT;
  34 import org.eclipse.swt.widgets.Button;
  35 import org.eclipse.swt.widgets.Composite;
  36 import org.eclipse.swt.widgets.Control;
  37 import org.eclipse.swt.widgets.TabFolder;
  38
  39 /**
  40  * This is the common dialog to define Find and/or Filter Criteria(s)
  41  *
  42  * @version 1.0
  43  * @author Bernd Hufmann
  44  */
  45 public class SearchFilterDialog extends Dialog {
  46
  47     // ------------------------------------------------------------------------
  48     // Constants
  49     // ------------------------------------------------------------------------
  50     /**
  51      * The find criteria property name
  52      */
  53     protected static final String FIND_CRITERIA = "findCriteria"; //$NON-NLS-1$
  54     /**
  55      * The find expression list property name
  56      */
  57     protected static final String FIND_EXPRESSION_LIST = "findExpressionList"; //$NON-NLS-1$
  58     /**
  59      * The filter criteria poperty name
  60      */
  61     protected static final String FILTER_CRITERIA = "filterCriteria"; //$NON-NLS-1$
  62     /**
  63      * The filter expression list property name
  64      */
  65     protected static final String FILTER_EXPRESSION_LIST = "filterExpressionList"; //$NON-NLS-1$
  66     /**
  67      * The maximum number of expressions stored.
  68      */
  69     protected static final int MAX_EXPRESSION_LIST = 7;
  70
  71     // ------------------------------------------------------------------------
  72     // Attributes
  73     // ------------------------------------------------------------------------
  74
  75     /**
  76      * The sequence diagram view reference.
  77      */
  78     protected SDView fSdView = null;
  79
  80     /**
  81      * The tab with the controls for a Criteria
  82      */
  83     protected TabFolder fTabFolder = null;
  84
  85     /**
  86      * The Criteria updated by this dialog
  87      */
  88     protected Criteria fCriteria = null;
  89
  90     /**
  91      * The find/filter provider telling which graph nodes are supported
  92      */
  93     protected ISDGraphNodeSupporter fProvider = null;
  94
  95     /**
  96      * The okText is the text for the Ok button and title is the title of the dialog.<br>
  97      * Both depend (okText and title (below)) on the usage that is done of this dialog
  98      * (find or filter).
  99      */
 100     protected String fOkText;
 101
 102     /**
 103      * The title is the title of the dialog.<br>
 104      * Both depend (okText and title) on the usage that is done of this dialog
 105      * (find or filter).
 106      */
 107     protected String fTitle;
 108
 109     /**
 110      * List of string expressions that have been searched already
 111      */
 112     protected String[] fExpressionList;
 113
 114     /**
 115      * find is true if the dialog is for the find feature and false for filter feature
 116      */
 117     protected boolean fIsFind;
 118
 119     // ------------------------------------------------------------------------
 120     // Constructors
 121     // ------------------------------------------------------------------------
 122     /**
 123      * Standard constructor
 124      *
 125      * @param view A sequence diagram view reference
 126      * @param provider A graph node supporter provider
 127      * @param filter A flag to indicate filtering (true) or finding (false)
 128      * @param style Style bits
 129      */
 130     public SearchFilterDialog(SDView view, ISDGraphNodeSupporter provider, boolean filter, int style) {
 131         super(view.getSDWidget().getShell());
 132         setShellStyle(SWT.DIALOG_TRIM | style);
 133         fProvider = provider;
 134         fSdView = view;
 135         fIsFind = !filter;
 136     }
 137
 138     // ------------------------------------------------------------------------
 139     // Methods
 140     // ------------------------------------------------------------------------
 141
 142     /*
 143      * (non-Javadoc)
 144      * @see org.eclipse.jface.dialogs.Dialog#createDialogArea(org.eclipse.swt.widgets.Composite)
 145      */
 146     @Override
 147     public Control createDialogArea(Composite arg0) {
 148         if (fIsFind) {
 149             fExpressionList = Activator.getDefault().getDialogSettings().getArray(FIND_EXPRESSION_LIST);
 150         } else {
 151             fExpressionList = Activator.getDefault().getDialogSettings().getArray(FILTER_EXPRESSION_LIST);
 152         }
 153         if (fExpressionList == null) {
 154             fExpressionList = new String[0];
 155         }
 156         return new TabContents(arg0, fProvider, getButton(IDialogConstants.OK_ID), fExpressionList);
 157     }
 158
 159     /**
 160      * Open the dialog box
 161      */
 162     @Override
 163     public int open() {
 164         create();
 165
 166         if (fCriteria == null) {
 167             loadCriteria();
 168         }
 169
 170         if (fCriteria == null) {
 171             fCriteria = new Criteria();
 172             fCriteria.setLifeLineSelected(fProvider.isNodeSupported(ISDGraphNodeSupporter.LIFELINE));
 173             fCriteria.setSyncMessageSelected(fProvider.isNodeSupported(ISDGraphNodeSupporter.SYNCMESSAGE));
 174             fCriteria.setSyncMessageReturnSelected(fProvider.isNodeSupported(ISDGraphNodeSupporter.SYNCMESSAGERETURN));
 175             fCriteria.setAsyncMessageSelected(fProvider.isNodeSupported(ISDGraphNodeSupporter.ASYNCMESSAGE));
 176             fCriteria.setAsyncMessageReturnSelected(fProvider.isNodeSupported(ISDGraphNodeSupporter.ASYNCMESSAGERETURN));
 177             fCriteria.setStopSelected(fProvider.isNodeSupported(ISDGraphNodeSupporter.STOP));
 178         }
 179         copyFromCriteria(fCriteria);
 180
 181         if (fOkText != null) {
 182             getButton(IDialogConstants.OK_ID).setText(fOkText);
 183         } else {
 184             getButton(IDialogConstants.OK_ID).setText(SDMessages._21);
 185         }
 186
 187         if (fIsFind) {
 188             getButton(IDialogConstants.CANCEL_ID).setText(SDMessages._22);
 189         }
 190
 191         Button okButton = getButton(IDialogConstants.OK_ID);
 192         ((TabContents) getDialogArea()).setOkButton(okButton);
 193         if (fCriteria == null || !((fCriteria.getExpression() != null && !fCriteria.getExpression().equals("")) && //$NON-NLS-1$
 194                 (fCriteria.isAsyncMessageReturnSelected() || fCriteria.isAsyncMessageSelected() || fCriteria.isLifeLineSelected() || fCriteria.isStopSelected() || fCriteria.isSyncMessageReturnSelected() || fCriteria.isSyncMessageSelected()))) {
 195             okButton.setEnabled(false);
 196         }
 197
 198         if (fTitle != null) {
 199             getShell().setText(fTitle);
 200         } else {
 201             getShell().setText(SDMessages._24);
 202         }
 203
 204         getShell().pack();
 205         getShell().setLocation(getShell().getDisplay().getCursorLocation());
 206
 207         fCriteria = null;
 208         return super.open();
 209     }
 210
 211     /**
 212          * Loads criteria from the dialog settings which are saved in the workspace.
 213          */
 214     @SuppressWarnings("rawtypes")
 215     protected void loadCriteria() {
 216
 217         String CRITERIA = FIND_CRITERIA;
 218         if (!fIsFind) {
 219             CRITERIA = FILTER_CRITERIA;
 220         }
 221
 222         DialogSettings section = (DialogSettings) Activator.getDefault().getDialogSettings().getSection(CRITERIA);
 223         List selection = fSdView.getSDWidget().getSelection();
 224         if ((selection == null || selection.size() != 1) || (!fIsFind)) {
 225             if (section != null) {
 226                 fCriteria = new Criteria();
 227                 fCriteria.load(section);
 228             }
 229         } else {
 230             GraphNode gn = (GraphNode) selection.get(0);
 231             fCriteria = new Criteria();
 232             fCriteria.setExpression(gn.getName());
 233             fCriteria.setCaseSenstiveSelected(true);
 234             if (gn instanceof Lifeline && fProvider.isNodeSupported(ISDGraphNodeSupporter.LIFELINE)) {
 235                 fCriteria.setLifeLineSelected(true);
 236             } else if (gn instanceof SyncMessageReturn && fProvider.isNodeSupported(ISDGraphNodeSupporter.SYNCMESSAGERETURN)) {
 237                 fCriteria.setSyncMessageReturnSelected(true);
 238             } else if ((gn instanceof SyncMessageReturn || gn instanceof SyncMessage) && fProvider.isNodeSupported(ISDGraphNodeSupporter.SYNCMESSAGE)) {
 239                 fCriteria.setSyncMessageSelected(true);
 240             } else if (gn instanceof AsyncMessageReturn && fProvider.isNodeSupported(ISDGraphNodeSupporter.ASYNCMESSAGERETURN)) {
 241                 fCriteria.setAsyncMessageReturnSelected(true);
 242             } else if ((gn instanceof AsyncMessageReturn || gn instanceof AsyncMessage) && fProvider.isNodeSupported(ISDGraphNodeSupporter.ASYNCMESSAGE)) {
 243                 fCriteria.setAsyncMessageSelected(true);
 244             } else if (gn instanceof Stop && fProvider.isNodeSupported(ISDGraphNodeSupporter.STOP)) {
 245                 fCriteria.setStopSelected(true);
 246             }
 247         }
 248     }
 249
 250     /**
 251      * Called when the dialog box ok button is pressed and calls back
 252      * the appropriate action provider (ISDFilterProvider or ISDFindProvider).
 253      */
 254     @Override
 255     public void okPressed() {
 256         copyToCriteria();
 257         if (!fIsFind) {
 258             saveCriteria();
 259             super.close(); // Filter is modal
 260         }
 261         if ((fProvider != null) && (fProvider instanceof ISDFindProvider) && fIsFind) {
 262             boolean result = ((ISDFindProvider) fProvider).find(fCriteria);
 263             TabContents content = getTabContents();
 264             content.setResult(result);
 265         }
 266     }
 267
 268     /*
 269      * (non-Javadoc)
 270      * @see org.eclipse.jface.dialogs.Dialog#cancelPressed()
 271      */
 272     @Override
 273     public void cancelPressed() {
 274         if (fIsFind) {
 275             copyToCriteria();
 276             if (fProvider instanceof ISDFindProvider) {
 277                 ((ISDFindProvider) fProvider).cancel();
 278             }
 279             saveCriteria();
 280         }
 281         super.cancelPressed();
 282     }
 283
 284     /**
 285          * Saves the criteria to the dialog settings within the workspace.
 286          */
 287     public void saveCriteria() {
 288         String CRITERIA = FIND_CRITERIA;
 289         String EXPRESSION_LIST = FIND_EXPRESSION_LIST;
 290         if (!fIsFind) {
 291             CRITERIA = FILTER_CRITERIA;
 292             EXPRESSION_LIST = FILTER_EXPRESSION_LIST;
 293         }
 294         DialogSettings settings = (DialogSettings) Activator.getDefault().getDialogSettings();
 295         DialogSettings section = (DialogSettings) settings.getSection(CRITERIA);
 296         if (section == null) {
 297             section = (DialogSettings) settings.addNewSection(CRITERIA);
 298         }
 299         fCriteria.save(section);
 300
 301         if (fCriteria.getExpression().length() > 0) {
 302             ArrayList<String> list = new ArrayList<String>();
 303             for (int i = 0; i < fExpressionList.length; i++) {
 304                 list.add(fExpressionList[i]);
 305             }
 306             // Remove the used expression if one from the dropdown list
 307             list.remove(fCriteria.getExpression());
 308             // Put the new expression at the beginning
 309             list.add(0, fCriteria.getExpression());
 310             // Fill in the expressionList, truncating to MAX_EXPRESSION_LIST
 311             int size = Math.min(list.size(), MAX_EXPRESSION_LIST);
 312             String[] temp = new String[size];
 313             for (int i = 0; i < size; i++) {
 314                 temp[i] = list.get(i);
 315             }
 316             fExpressionList = temp;
 317             settings.put(EXPRESSION_LIST, fExpressionList);
 318         }
 319     }
 320
 321     /**
 322          * Returns the criteria
 323          *
 324          * @return the criteria
 325          */
 326     public Criteria getCriteria() {
 327         return fCriteria;
 328     }
 329
 330     /**
 331      * Sets the criteria.
 332      *
 333      * @param criteria the criteria to set.
 334      */
 335     public void setCriteria(Criteria criteria) {
 336         fCriteria = criteria;
 337     }
 338
 339     /**
 340      * Get the current end-user settings from the dialog to a Criteria
 341      */
 342     public void copyToCriteria() {
 343         fCriteria = new Criteria();
 344         TabContents content = getTabContents();
 345         fCriteria.setLifeLineSelected(content.isLifelineButtonSelected());
 346         fCriteria.setSyncMessageSelected(content.isSynMessageButtonSelected());
 347         fCriteria.setSyncMessageReturnSelected(content.isSynMessageReturnButtonSelected());
 348         fCriteria.setAsyncMessageSelected(content.isAsynMessageButtonSelected());
 349         fCriteria.setAsyncMessageReturnSelected(content.isAsynMessageReturnButtonSelected());
 350         fCriteria.setStopSelected(content.isStopButtonSelected());
 351         fCriteria.setCaseSenstiveSelected(content.isCaseSensitiveSelected());
 352         fCriteria.setExpression(content.getSearchText());
 353     }
 354
 355     /**
 356      * Returns the tab content reference.
 357      *
 358      * @return the tab content
 359      */
 360     protected TabContents getTabContents() {
 361         TabContents content = null;
 362         if (fTabFolder == null) {
 363             content = (TabContents) getDialogArea();
 364         } else {
 365             content = (TabContents) fTabFolder.getSelection()[0].getControl();
 366         }
 367         return content;
 368     }
 369
 370     /**
 371      * Initialize the dialog with the settings of an existing Criteria<br>
 372      * Criteria must not be null and the TabContents must have been created
 373      *
 374      * @param from the criteria to copy from
 375      */
 376     public void copyFromCriteria(Criteria from) {
 377         TabContents content = getTabContents();
 378         content.setLifelineButtonSelection(from.isLifeLineSelected());
 379         content.setSynMessageButtonSelection(from.isSyncMessageSelected());
 380         content.setSynMessageReturnButtonSelection(from.isSyncMessageReturnSelected());
 381         content.setAsynMessageButtonSelection(from.isAsyncMessageSelected());
 382         content.setAsynMessageReturnButtonSelection(from.isSyncMessageReturnSelected());
 383         content.setStopButtonSelection(from.isStopSelected());
 384         content.setCaseSensitiveSelection(from.isCaseSenstiveSelected());
 385         if (from.getExpression() != null) {
 386             content.setSearchText(from.getExpression());
 387         }
 388     }
 389
 390     /**
 391      * Sets the text to be used for the ok button
 392      *
 393      * @param okText text to set
 394      */
 395     public void setOkText(String okText) {
 396         fOkText = okText;
 397     }
 398
 399     /**
 400      * Sets the title to be used for the dialog box.
 401      *
 402      * @param title The title to set
 403      */
 404     public void setTitle(String title) {
 405         fTitle = title;
 406     }
 407 }