tmf: Use tabs in statistics view for each traces

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.ui / src / org / eclipse / linuxtools / internal / lttng / ui / views / latency / dialogs / AbstractDialog.java

/*******************************************************************************\r
 * Copyright (c) 2010, 2011 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Philippe Sawicki (INF4990.A2010@gmail.com)   - Initial API and implementation\r
 *   Mathieu Denis    (mathieu.denis55@gmail.com) - Refactored code\r
 *   Bernd Hufmann - Adapted to new messages file, fixed warnings\r
 *******************************************************************************/\r
package org.eclipse.linuxtools.internal.lttng.ui.views.latency.dialogs;\r
\r
import java.util.Vector;\r
\r
import org.eclipse.jface.dialogs.IDialogSettings;\r
import org.eclipse.jface.dialogs.IMessageProvider;\r
import org.eclipse.jface.dialogs.TitleAreaDialog;\r
import org.eclipse.linuxtools.internal.lttng.core.latency.analyzer.EventMatcher;\r
import org.eclipse.linuxtools.internal.lttng.core.util.EventsPair;\r
import org.eclipse.linuxtools.internal.lttng.ui.Activator;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.model.LatencyController;\r
import org.eclipse.swt.widgets.Composite;\r
import org.eclipse.swt.widgets.Control;\r
import org.eclipse.swt.widgets.Display;\r
import org.eclipse.swt.widgets.Shell;\r
\r
/**\r
 * <b><u>AbstractDialog</u></b>\r
 * <p> \r
 * Includes the main functions shared by all the different dialogs.\r
 * \r
 * @author Philippe Sawicki\r
 */\r
public abstract class AbstractDialog extends TitleAreaDialog {\r
\r
    // ------------------------------------------------------------------------\r
    // Attributes\r
    // ------------------------------------------------------------------------\r
    \r
    /**\r
     * The dialog window title.\r
     */\r
    protected String fDialogTitle;\r
    /**\r
     * The dialog window message.\r
     */\r
    protected String fDialogMessage;\r
\r
    /**\r
     * The code returned by the dialog when the user closes the "Add" dialog.\r
     */\r
    public static final int ADD = 53445;\r
    /**\r
     * The code returned by the dialog when the user closes the "Delete" dialog.\r
     */\r
    public static final int DELETE = ADD + 1;\r
    /**\r
     * The code returned by the dialog when the user resets the latency pair to default.\r
     */\r
    public static final int RESET = DELETE + 1;\r
\r
    /**\r
     * String ID of the number of pairs saved in the settings file.\r
     */\r
    protected static final String LATENCY_NB_MATCH_PAIRS = "NB_LATENCY_MATCH_PAIRS"; //$NON-NLS-1$\r
    /**\r
     * String ID of the start event pairs saved in the settings file.\r
     */\r
    protected static final String LATENCY_PAIRS_START = "LATENCY_PAIRS_START"; //$NON-NLS-1$\r
    /**\r
     * String ID of the end event pairs saved in the settings file.\r
     */\r
    protected static final String LATENCY_PAIRS_END = "LATENCY_PAIRS_END"; //$NON-NLS-1$\r
\r
    /**\r
     * Dialog settings, saves the event pairs across sessions.\r
     */\r
    protected IDialogSettings fSettings;\r
\r
    /**\r
     * Do the graphs canvas need to be redrawn due to latency pairs changes ?\r
     */\r
    protected boolean fRedrawGraphs = false;\r
    \r
    // ------------------------------------------------------------------------\r
    // Constructors\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Constructor.\r
     * @param parentShell\r
     *            The parent shell.\r
     * @param title\r
     *            The dialog window's title.\r
     * @param message\r
     *            The dialog window's message.\r
     */\r
    public AbstractDialog(Shell parentShell, String title, String message) {\r
        super(parentShell);\r
        fDialogTitle = title;\r
        fDialogMessage = message;\r
\r
        fSettings = Activator.getDefault().getDialogSettings();\r
    }\r
\r
    /**\r
     * Constructor\r
     * @param parentShell\r
     *            The parent shell.\r
     * @param title\r
     *            The dialog window's title.\r
     */\r
    @SuppressWarnings("nls")\r
    public AbstractDialog(Shell parentShell, String title) {\r
        this(parentShell, title, "");\r
    }\r
\r
    /**\r
     * Constructor.\r
     * @param parentShell\r
     *            The parent shell.\r
     */\r
    @SuppressWarnings("nls")\r
    public AbstractDialog(Shell parentShell) {\r
        this(parentShell, "", "");\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Operations\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Creates the dialog.\r
     * \r
     * <b>Note :</b> Since there is an issue with the table's vertical scroll bar, this dialog "resize" is necessary to\r
     * ensure a minimal height for the window.\r
     */\r
    @Override\r
    public void create() {\r
        super.create();\r
        // Set the title\r
        setTitle(fDialogTitle);\r
        // Set the message\r
        setMessage(fDialogMessage, IMessageProvider.INFORMATION);\r
\r
        // Position the dialog at the center of the screen\r
        int windowWidth = Display.getCurrent().getPrimaryMonitor().getBounds().width;\r
        int windowHeight = Display.getCurrent().getPrimaryMonitor().getBounds().height;\r
        int dialogWidth = getShell().getSize().x;\r
        int dialogHeight = windowHeight / 2;\r
\r
        int x = (windowWidth - dialogWidth) / 2;\r
        int y = (windowHeight - dialogHeight) / 2;\r
\r
        getShell().setSize(getShell().getSize().x, dialogHeight);\r
        getShell().setLocation(x, y);\r
    }\r
\r
    /**\r
     * Formats the "#" of the event in the table by adding "00" before it.\r
     * @param number\r
     *            The number to format.\r
     * @param max\r
     *            The maximum number of event pairs in the list.\r
     * @return The formatted string.\r
     */\r
    @SuppressWarnings("nls")\r
    protected String formatListNumber(int number, int max) {\r
        return String.format("%0" + max + "d", number);\r
    }\r
\r
    /**\r
     * Returns the match pairs saved in the settings file.\r
     * @return The match pairs saved in the settings file.\r
     */\r
    protected EventsPair getMatchPairs() {\r
        try {\r
            // Check if the settings file has already some data (i.e. try provoking an exception)\r
            fSettings.getInt(LATENCY_NB_MATCH_PAIRS);\r
\r
            String[] starts = fSettings.getArray(LATENCY_PAIRS_START);\r
            String[] ends = fSettings.getArray(LATENCY_PAIRS_END);\r
\r
            EventMatcher.getInstance().resetMatches();\r
            for (int i = 0; i < starts.length; i++) {\r
                EventMatcher.getInstance().addMatch(starts[i], ends[i]);\r
            }\r
\r
            return EventMatcher.getInstance().getEvents();\r
        } catch (NumberFormatException e) {\r
            return EventMatcher.getInstance().getEvents();\r
        }\r
    }\r
\r
    /**\r
     * Saves the event match pairs to a settings file.\r
     * @param start\r
     *            The start event types.\r
     * @param end\r
     *            The end event types.\r
     */\r
    protected void saveMatchPairs(Vector<String> start, Vector<String> end) {\r
        fSettings.put(LATENCY_NB_MATCH_PAIRS, start.size());\r
        fSettings.put(LATENCY_PAIRS_START, start.toArray(new String[] {}));\r
        fSettings.put(LATENCY_PAIRS_END, end.toArray(new String[] {}));\r
    }\r
\r
    /**\r
     * Ask the LatencyView to send a new analysis request to the views, so that they can be redrawn.\r
     */\r
    protected void redrawGraphs() {\r
        LatencyController.getInstance().refreshModels();\r
    }\r
\r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.jface.dialogs.TitleAreaDialog#createDialogArea(org.eclipse.swt.widgets.Composite)\r
     */\r
    @Override\r
    protected abstract Control createDialogArea(Composite parent);\r
\r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.jface.dialogs.Dialog#createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)\r
     */\r
    @Override\r
    protected abstract void createButtonsForButtonBar(Composite parent);\r
    \r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.jface.dialogs.Dialog#isResizable()\r
     */\r
    @Override\r
    protected boolean isResizable() {\r
        return true;\r
    }\r
}