org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/dialogs/EnableChannelDialog.java

   1 /**********************************************************************
   2  * Copyright (c) 2012 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Bernd Hufmann - Initial API and implementation
  11  **********************************************************************/
  12 package org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs;
  13
  14 import org.eclipse.jface.dialogs.Dialog;
  15 import org.eclipse.jface.dialogs.IDialogConstants;
  16 import org.eclipse.jface.dialogs.MessageDialog;
  17 import org.eclipse.linuxtools.internal.lttng2.ui.Activator;
  18 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.Messages;
  19 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.IChannelInfo;
  20 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.ChannelInfo;
  21 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceDomainComponent;
  22 import org.eclipse.swt.SWT;
  23 import org.eclipse.swt.events.VerifyEvent;
  24 import org.eclipse.swt.events.VerifyListener;
  25 import org.eclipse.swt.layout.GridData;
  26 import org.eclipse.swt.layout.GridLayout;
  27 import org.eclipse.swt.widgets.Button;
  28 import org.eclipse.swt.widgets.Composite;
  29 import org.eclipse.swt.widgets.Control;
  30 import org.eclipse.swt.widgets.Group;
  31 import org.eclipse.swt.widgets.Label;
  32 import org.eclipse.swt.widgets.Shell;
  33 import org.eclipse.swt.widgets.Text;
  34
  35 /**
  36  * <b><u>EnableChannelDialog</u></b>
  37  * <p>
  38  * Dialog box for collecting channel information when enabling a channel (which will be created).
  39  * </p>
  40  */
  41 public class EnableChannelDialog extends Dialog implements IEnableChannelDialog {
  42
  43     // ------------------------------------------------------------------------
  44     // Constants
  45     // ------------------------------------------------------------------------
  46     /**
  47      * The icon file for this dialog box.
  48      */
  49     public static final String ENABLE_CHANNEL_ICON_FILE = "icons/elcl16/add_button.gif"; //$NON-NLS-1$
  50
  51     // ------------------------------------------------------------------------
  52     // Attributes
  53     // ------------------------------------------------------------------------
  54     /**
  55      * The dialog composite.
  56      */
  57     private Composite fDialogComposite = null;
  58     /**
  59      * The text widget for the channel name
  60      */
  61     private Text fChannelNameText = null;
  62     /**
  63      * The discard mode of the channel.
  64      */
  65     private Button fDiscardModeButton = null;
  66     /**
  67      * The overwrite mode of the channel.
  68      */
  69     private Button fOverwriteModeButton = null;
  70     /**
  71      * The sub-buffer size of the channel.
  72      */
  73     private Text fSubBufferSizeText = null;
  74     /**
  75      * The number of sub-buffers of the channel.
  76      */
  77     private Text fNumberOfSubBuffersText = null;
  78     /**
  79      * The switch timer interval of the channel.
  80      */
  81     private Text fSwitchTimerText = null;
  82     /**
  83      * The read timer interval of the channel.
  84      */
  85     private Text fReadTimerText = null;
  86     /**
  87      * Group composite for domain selection.
  88      */
  89     private Group fDomainGroup = null;
  90     /**
  91      * Radio button for selecting kernel domain.
  92      */
  93     private Button fKernelButton = null;
  94     /**
  95      * Radio button for selecting UST domain.
  96      */
  97     private Button fUstButton = null;
  98     /**
  99      * The parent domain component where the channel node should be added.
 100      * Null in case of creation on session level.
 101      */
 102     private TraceDomainComponent fDomain = null;
 103     /**
 104      * Common verify listener for numeric text input.
 105      */
 106     private VerifyListener fVerifyListener = null;
 107     /**
 108      * Output channel information.
 109      */
 110     private IChannelInfo fChannelInfo = null;
 111     /**
 112      * Output domain information. True in case of Kernel domain. False for UST.
 113      */
 114     private boolean fIsKernel;
 115
 116     // ------------------------------------------------------------------------
 117     // Constructors
 118     // ------------------------------------------------------------------------
 119
 120     /**
 121      * Constructor
 122      * @param shell - a shell for the display of the dialog
 123      */
 124     public EnableChannelDialog(Shell shell) {
 125        super(shell);
 126        fIsKernel = true;
 127
 128         // Common verify listener
 129         fVerifyListener = new VerifyListener() {
 130             @Override
 131             public void verifyText(VerifyEvent e) {
 132                 // only numbers are allowed.
 133                 e.doit = e.text.matches("[0-9]*"); //$NON-NLS-1$
 134             }
 135         };
 136         setShellStyle(SWT.RESIZE);
 137     }
 138
 139     // ------------------------------------------------------------------------
 140     // Accessors
 141     // ------------------------------------------------------------------------
 142     /*
 143      * (non-Javadoc)
 144      * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.ICreateChannelDialog#getChannelInfo()
 145      */
 146     @Override
 147     public IChannelInfo getChannelInfo() {
 148         return fChannelInfo;
 149     }
 150
 151     /*
 152      * (non-Javadoc)
 153      * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.ICreateChannelDialog#setDomainComponent(org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceDomainComponent)
 154      */
 155     @Override
 156     public void setDomainComponent(TraceDomainComponent domain) {
 157         fDomain = domain;
 158         if (fDomain != null) {
 159             fIsKernel = fDomain.isKernel();
 160         } else {
 161             fIsKernel = true;
 162         }
 163     }
 164
 165     /*
 166      * (non-Javadoc)
 167      * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.ICreateChannelDialog#isKernel()
 168      */
 169     @Override
 170     public boolean isKernel() {
 171         return fIsKernel;
 172     }
 173
 174     // ------------------------------------------------------------------------
 175     // Operations
 176     // ------------------------------------------------------------------------
 177     /*
 178      * (non-Javadoc)
 179      * @see org.eclipse.jface.window.Window#configureShell(org.eclipse.swt.widgets.Shell)
 180      */
 181     @Override
 182     protected void configureShell(Shell newShell) {
 183         super.configureShell(newShell);
 184         newShell.setText(Messages.TraceControl_EnableChannelDialogTitle);
 185         newShell.setImage(Activator.getDefault().loadIcon(ENABLE_CHANNEL_ICON_FILE));
 186     }
 187
 188     /*
 189      * (non-Javadoc)
 190      * @see org.eclipse.jface.dialogs.Dialog#createDialogArea(org.eclipse.swt.widgets.Composite)
 191      */
 192     @Override
 193     protected Control createDialogArea(Composite parent) {
 194
 195         // Main dialog panel
 196         fDialogComposite = new Composite(parent, SWT.NONE);
 197         GridLayout layout = new GridLayout(3, true);
 198         fDialogComposite.setLayout(layout);
 199
 200         Label channelNameLabel = new Label(fDialogComposite, SWT.RIGHT);
 201         channelNameLabel.setText(Messages.TraceControl_EnableChannelNameLabel);
 202         fChannelNameText = new Text(fDialogComposite, SWT.NONE);
 203         fChannelNameText.setToolTipText(Messages.TraceControl_EnableChannelNameTooltip);
 204
 205         Label subBufferSizeLabel = new Label(fDialogComposite, SWT.RIGHT);
 206         subBufferSizeLabel.setText(Messages.TraceControl_SubBufferSizePropertyName);
 207         fSubBufferSizeText = new Text(fDialogComposite, SWT.NONE);
 208         fSubBufferSizeText.setToolTipText(Messages.TraceControl_EnableChannelSubBufferSizeTooltip);
 209         fSubBufferSizeText.addVerifyListener(fVerifyListener);
 210
 211         Label numSubBufferLabel = new Label(fDialogComposite, SWT.RIGHT);
 212         numSubBufferLabel.setText(Messages.TraceControl_NbSubBuffersPropertyName);
 213         fNumberOfSubBuffersText = new Text(fDialogComposite, SWT.NONE);
 214         fNumberOfSubBuffersText.setToolTipText(Messages.TraceControl_EnableChannelNbSubBuffersTooltip);
 215         fNumberOfSubBuffersText.addVerifyListener(fVerifyListener);
 216
 217         Label switchTimerLabel = new Label(fDialogComposite, SWT.RIGHT);
 218         switchTimerLabel.setText(Messages.TraceControl_SwitchTimerPropertyName);
 219         fSwitchTimerText = new Text(fDialogComposite, SWT.NONE);
 220         fSwitchTimerText.setToolTipText(Messages.TraceControl_EnableChannelSwitchTimerTooltip);
 221         fSwitchTimerText.addVerifyListener(fVerifyListener);
 222
 223         Label readTimerLabel = new Label(fDialogComposite, SWT.RIGHT);
 224         readTimerLabel.setText(Messages.TraceControl_ReadTimerPropertyName);
 225         fReadTimerText = new Text(fDialogComposite, SWT.NONE);
 226         fReadTimerText.setToolTipText(Messages.TraceControl_EnableChannelReadTimerTooltip);
 227         fReadTimerText.addVerifyListener(fVerifyListener);
 228
 229         Group discardModeGroup = new Group(fDialogComposite, SWT.SHADOW_NONE);
 230         discardModeGroup.setText(Messages.TraceControl_EnableChannelDiscardModeGroupName);
 231         layout = new GridLayout(2, true);
 232         discardModeGroup.setLayout(layout);
 233
 234         fDiscardModeButton = new  Button(discardModeGroup, SWT.RADIO);
 235         fDiscardModeButton.setText(Messages.TraceControl_EnableChannelDiscardModeLabel);
 236         fDiscardModeButton.setToolTipText(Messages.TraceControl_EnableChannelDiscardModeTooltip);
 237         fDiscardModeButton.setSelection(true);
 238
 239         fOverwriteModeButton = new Button(discardModeGroup, SWT.RADIO);
 240         fOverwriteModeButton.setText(Messages.TraceControl_EnableChannelOverwriteModeLabel);
 241         fOverwriteModeButton.setToolTipText(Messages.TraceControl_EnableChannelOverwriteModeTooltip);
 242         fOverwriteModeButton.setSelection(false);
 243
 244         fDomainGroup = new Group(fDialogComposite, SWT.SHADOW_NONE);
 245         fDomainGroup.setText(Messages.TraceControl_DomainDisplayName);
 246         layout = new GridLayout(2, true);
 247         fDomainGroup.setLayout(layout);
 248
 249         fKernelButton = new Button(fDomainGroup, SWT.RADIO);
 250         fKernelButton.setText(Messages.TraceControl_KernelDomainDisplayName);
 251         fKernelButton.setSelection(fIsKernel);
 252         fUstButton = new Button(fDomainGroup, SWT.RADIO);
 253         fUstButton.setText(Messages.TraceControl_UstDisplayName);
 254         fUstButton.setSelection(!fIsKernel);
 255
 256         if (fDomain != null) {
 257             fKernelButton.setEnabled(false);
 258             fUstButton.setEnabled(false);
 259         }
 260
 261         // layout widgets
 262         GridData data = new GridData(GridData.FILL, GridData.CENTER, false, false, 3, 1);
 263         discardModeGroup.setLayoutData(data);
 264         data = new GridData(SWT.BEGINNING, SWT.BEGINNING, true, true);
 265         fDiscardModeButton.setLayoutData(data);
 266         data = new GridData(SWT.BEGINNING, SWT.BEGINNING, true, true);
 267         fOverwriteModeButton.setLayoutData(data);
 268
 269         data = new GridData(GridData.FILL, GridData.CENTER, false, false, 3, 1);
 270         fDomainGroup.setLayoutData(data);
 271
 272         data = new GridData(SWT.BEGINNING, SWT.BEGINNING, true, true);
 273         fKernelButton.setLayoutData(data);
 274         data = new GridData(SWT.BEGINNING, SWT.BEGINNING, true, true);
 275         fUstButton.setLayoutData(data);
 276
 277         data = new GridData(GridData.FILL_HORIZONTAL);
 278         data.horizontalSpan = 2;
 279
 280         fChannelNameText.setLayoutData(data);
 281         fSubBufferSizeText.setLayoutData(data);
 282         fNumberOfSubBuffersText.setLayoutData(data);
 283         fSwitchTimerText.setLayoutData(data);
 284         fReadTimerText.setLayoutData(data);
 285
 286         setDefaults();
 287
 288         return fDialogComposite;
 289     }
 290
 291     /*
 292      * (non-Javadoc)
 293      * @see org.eclipse.jface.dialogs.Dialog#createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)
 294      */
 295     @Override
 296     protected void createButtonsForButtonBar(Composite parent) {
 297         createButton(parent, IDialogConstants.DETAILS_ID, "&Default", true); //$NON-NLS-1$
 298         createButton(parent, IDialogConstants.CANCEL_ID, "&Cancel", true); //$NON-NLS-1$
 299         createButton(parent, IDialogConstants.OK_ID, "&Ok", true); //$NON-NLS-1$
 300     }
 301
 302     /*
 303      * (non-Javadoc)
 304      * @see org.eclipse.jface.dialogs.Dialog#okPressed()
 305      */
 306     @Override
 307     protected void okPressed() {
 308         // Set channel information
 309         fChannelInfo = new ChannelInfo(fChannelNameText.getText());
 310         fChannelInfo.setSubBufferSize(Long.parseLong(fSubBufferSizeText.getText()));
 311         fChannelInfo.setNumberOfSubBuffers(Integer.parseInt(fNumberOfSubBuffersText.getText()));
 312         fChannelInfo.setSwitchTimer(Long.parseLong(fSwitchTimerText.getText()));
 313         fChannelInfo.setReadTimer(Long.parseLong(fReadTimerText.getText()));
 314         fChannelInfo.setOverwriteMode(fOverwriteModeButton.getSelection());
 315
 316         fIsKernel = fKernelButton.getSelection();
 317
 318         // Check for invalid names
 319         if (!fChannelInfo.getName().matches("^[a-zA-Z0-9\\-\\_]{1,}$")) { //$NON-NLS-1$
 320             MessageDialog.openError(getShell(),
 321                   Messages.TraceControl_EnableChannelDialogTitle,
 322                   Messages.TraceControl_InvalidChannelNameError + " (" + fChannelInfo.getName() + ") \n");  //$NON-NLS-1$ //$NON-NLS-2$
 323             return;
 324         }
 325
 326         // Check for duplicate names
 327         if (fDomain != null && fDomain.containsChild(fChannelInfo.getName())) {
 328             MessageDialog.openError(getShell(),
 329                     Messages.TraceControl_EnableChannelDialogTitle,
 330                     Messages.TraceControl_ChannelAlreadyExistsError + " (" + fChannelInfo.getName() + ") \n");  //$NON-NLS-1$ //$NON-NLS-2$
 331             return;
 332         }
 333
 334         // validation successful -> call super.okPressed()
 335         super.okPressed();
 336     }
 337
 338     /*
 339      * (non-Javadoc)
 340      * @see org.eclipse.jface.dialogs.Dialog#buttonPressed(int)
 341      */
 342     @Override
 343     protected void buttonPressed(int buttonId) {
 344         if (buttonId == IDialogConstants.DETAILS_ID) {
 345             setDefaults();
 346             return;
 347         }
 348         super.buttonPressed(buttonId);
 349     }
 350
 351     // ------------------------------------------------------------------------
 352     // Helper methods
 353     // ------------------------------------------------------------------------
 354     /**
 355      * Sets default value depending on Kernel or UST
 356      */
 357     private void setDefaults() {
 358         fSwitchTimerText.setText(String.valueOf(IChannelInfo.DEFAULT_SWITCH_TIMER));
 359         fReadTimerText.setText(String.valueOf(IChannelInfo.DEFAULT_READ_TIMER));
 360         fOverwriteModeButton.setSelection(IChannelInfo.DEFAULT_OVERWRITE_MODE);
 361         if (fKernelButton.getSelection()) {
 362             fSubBufferSizeText.setText(String.valueOf(IChannelInfo.DEFAULT_SUB_BUFFER_SIZE_KERNEL));
 363             fNumberOfSubBuffersText.setText(String.valueOf(IChannelInfo.DEFAULT_NUMBER_OF_SUB_BUFFERS_KERNEL));
 364         } else {
 365             fSubBufferSizeText.setText(String.valueOf(IChannelInfo.DEFAULT_SUB_BUFFER_SIZE_UST));
 366             fNumberOfSubBuffersText.setText(String.valueOf(IChannelInfo.DEFAULT_NUMBER_OF_SUB_BUFFERS_UST));
 367         }
 368     }
 369 }