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

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