[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / widgets / timegraph / TimeGraphViewer.java

/*****************************************************************************\r
 * Copyright (c) 2007, 2008 Intel Corporation, 2009, 2010, 2011, 2012 Ericsson.\r
 * All rights reserved. This program and the accompanying materials\r
 * are made available under the terms of the Eclipse Public License v1.0\r
 * which accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 *\r
 * Contributors:\r
 *   Intel Corporation - Initial API and implementation\r
 *   Ruslan A. Scherbakov, Intel - Initial API and implementation\r
 *   Alexander N. Alexeev, Intel - Add monitors statistics support\r
 *   Alvaro Sanchez-Leon - Adapted for TMF\r
 *   Patrick Tasse - Refactoring\r
 *\r
 *****************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.widgets.timegraph;\r
\r
import java.util.ArrayList;\r
\r
import org.eclipse.jface.action.Action;\r
import org.eclipse.jface.viewers.ISelectionProvider;\r
import org.eclipse.linuxtools.internal.tmf.ui.Activator;\r
import org.eclipse.linuxtools.internal.tmf.ui.ITmfImageConstants;\r
import org.eclipse.linuxtools.internal.tmf.ui.Messages;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.dialogs.TimeGraphLegend;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model.ITimeEvent;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model.ITimeGraphEntry;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets.ITimeDataProvider;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets.TimeGraphColorScheme;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets.TimeGraphControl;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets.TimeGraphScale;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets.TimeGraphTooltipHandler;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets.Utils;\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.events.ControlAdapter;\r
import org.eclipse.swt.events.ControlEvent;\r
import org.eclipse.swt.events.KeyAdapter;\r
import org.eclipse.swt.events.KeyEvent;\r
import org.eclipse.swt.events.MouseEvent;\r
import org.eclipse.swt.events.MouseWheelListener;\r
import org.eclipse.swt.events.SelectionAdapter;\r
import org.eclipse.swt.events.SelectionEvent;\r
import org.eclipse.swt.events.SelectionListener;\r
import org.eclipse.swt.graphics.Rectangle;\r
import org.eclipse.swt.layout.FillLayout;\r
import org.eclipse.swt.layout.GridData;\r
import org.eclipse.swt.layout.GridLayout;\r
import org.eclipse.swt.widgets.Composite;\r
import org.eclipse.swt.widgets.Control;\r
import org.eclipse.swt.widgets.ScrollBar;\r
import org.eclipse.swt.widgets.Slider;\r
\r
/**\r
 * Generic time graph viewer implementation\r
 *\r
 * @version 1.0\r
 * @author Patrick Tasse, and others\r
 */\r
public class TimeGraphViewer implements ITimeDataProvider, SelectionListener {\r
\r
    /** vars */\r
    private long _minTimeInterval;\r
    private long _selectedTime;\r
    private ITimeGraphEntry _selectedEntry;\r
    private long _beginTime;\r
    private long _endTime;\r
    private long _time0;\r
    private long _time1;\r
    private long _time0_;\r
    private long _time1_;\r
    private long _time0_extSynch = 0;\r
    private long _time1_extSynch = 0;\r
    private boolean _timeRangeFixed;\r
    private int _nameWidthPref = 200;\r
    private int _minNameWidth = 6;\r
    private int _nameWidth;\r
    private Composite _dataViewer;\r
\r
    private TimeGraphControl _stateCtrl;\r
    private TimeGraphScale _timeScaleCtrl;\r
    private Slider _verticalScrollBar;\r
    private TimeGraphTooltipHandler _threadTip;\r
    private TimeGraphColorScheme _colors;\r
    private ITimeGraphPresentationProvider fTimeGraphProvider;\r
\r
    ArrayList<ITimeGraphSelectionListener> fSelectionListeners = new ArrayList<ITimeGraphSelectionListener>();\r
    ArrayList<ITimeGraphTimeListener> fTimeListeners = new ArrayList<ITimeGraphTimeListener>();\r
    ArrayList<ITimeGraphRangeListener> fRangeListeners = new ArrayList<ITimeGraphRangeListener>();\r
\r
    // Calender Time format, using Epoch reference or Relative time\r
    // format(default\r
    private boolean calendarTimeFormat = false;\r
    private int borderWidth = 0;\r
    private int timeScaleHeight = 22;\r
\r
    private Action resetScale;\r
    private Action showLegendAction;\r
    private Action nextEventAction;\r
    private Action prevEventAction;\r
    private Action nextItemAction;\r
    private Action previousItemAction;\r
    private Action zoomInAction;\r
    private Action zoomOutAction;\r
\r
    /**\r
     * Standard constructor\r
     *\r
     * @param parent\r
     *            The parent UI composite object\r
     * @param style\r
     *            The style to use\r
     */\r
    public TimeGraphViewer(Composite parent, int style) {\r
        createDataViewer(parent, style);\r
    }\r
\r
    /**\r
     * Sets the timegraph provider used by this timegraph viewer.\r
     *\r
     * @param timeGraphProvider the timegraph provider\r
     */\r
    public void setTimeGraphProvider(ITimeGraphPresentationProvider timeGraphProvider) {\r
        fTimeGraphProvider = timeGraphProvider;\r
        _stateCtrl.setTimeGraphProvider(timeGraphProvider);\r
        _threadTip = new TimeGraphTooltipHandler(_dataViewer.getShell(), fTimeGraphProvider, this);\r
        _threadTip.activateHoverHelp(_stateCtrl);\r
    }\r
\r
    /**\r
     * Sets or clears the input for this time graph viewer.\r
     * The input array should only contain top-level elements.\r
     *\r
     * @param input the input of this time graph viewer, or <code>null</code> if none\r
     */\r
    public void setInput(ITimeGraphEntry[] input) {\r
        if (null != _stateCtrl) {\r
            if (null == input) {\r
                input = new ITimeGraphEntry[0];\r
            }\r
            setTimeRange(input);\r
            _verticalScrollBar.setEnabled(true);\r
            setTopIndex(0);\r
            _selectedTime = 0;\r
            _selectedEntry = null;\r
            refreshAllData(input);\r
        }\r
    }\r
\r
    /**\r
     * Refresh the view\r
     */\r
    public void refresh() {\r
        setInput(_stateCtrl.getTraces());\r
    }\r
\r
    /**\r
     * Callback for when the control is moved\r
     *\r
     * @param e\r
     *            The caller event\r
     */\r
    public void controlMoved(ControlEvent e) {\r
    }\r
\r
    /**\r
     * Callback for when the control is resized\r
     *\r
     * @param e\r
     *            The caller event\r
     */\r
    public void controlResized(ControlEvent e) {\r
        resizeControls();\r
    }\r
\r
    /**\r
     * Handler for when the model is updated. Called from the display order in\r
     * the API\r
     *\r
     * @param traces\r
     *            The traces in the model\r
     * @param start\r
     *            The start time\r
     * @param end\r
     *            The end time\r
     * @param updateTimeBounds\r
     *            Should we updated the time bounds too\r
     */\r
    public void modelUpdate(ITimeGraphEntry[] traces, long start,\r
            long end, boolean updateTimeBounds) {\r
        if (null != _stateCtrl) {\r
            //loadOptions();\r
            updateInternalData(traces, start, end);\r
            if (updateTimeBounds) {\r
                _timeRangeFixed = true;\r
                // set window to match limits\r
                setStartFinishTime(_time0_, _time1_);\r
            } else {\r
                _stateCtrl.redraw();\r
                _timeScaleCtrl.redraw();\r
            }\r
        }\r
    }\r
\r
    protected String getViewTypeStr() {\r
        return "viewoption.threads"; //$NON-NLS-1$\r
    }\r
\r
    int getMarginWidth(int idx) {\r
        return 0;\r
    }\r
\r
    int getMarginHeight(int idx) {\r
        return 0;\r
    }\r
\r
    void loadOptions() {\r
        _minTimeInterval = 1;\r
        _selectedTime = -1;\r
        _nameWidth = Utils.loadIntOption(getPreferenceString("namewidth"), //$NON-NLS-1$\r
                _nameWidthPref, _minNameWidth, 1000);\r
    }\r
\r
    void saveOptions() {\r
        Utils.saveIntOption(getPreferenceString("namewidth"), _nameWidth); //$NON-NLS-1$\r
    }\r
\r
    protected Control createDataViewer(Composite parent, int style) {\r
        loadOptions();\r
        _colors = new TimeGraphColorScheme();\r
        _dataViewer = new Composite(parent, style) {\r
            @Override\r
            public void redraw() {\r
                _timeScaleCtrl.redraw();\r
                _stateCtrl.redraw();\r
                super.redraw();\r
            }\r
        };\r
        GridLayout gl = new GridLayout(2, false);\r
        gl.marginHeight = borderWidth;\r
        gl.marginWidth = 0;\r
        gl.verticalSpacing = 0;\r
        gl.horizontalSpacing = 0;\r
        _dataViewer.setLayout(gl);\r
\r
        _timeScaleCtrl = new TimeGraphScale(_dataViewer, _colors);\r
        _timeScaleCtrl.setTimeProvider(this);\r
        _timeScaleCtrl.setLayoutData(new GridData(SWT.FILL, SWT.DEFAULT, true, false));\r
        _timeScaleCtrl.setHeight(timeScaleHeight);\r
\r
        _verticalScrollBar = new Slider(_dataViewer, SWT.VERTICAL | SWT.NO_FOCUS);\r
        _verticalScrollBar.setLayoutData(new GridData(SWT.DEFAULT, SWT.FILL, false, true, 1, 2));\r
        _verticalScrollBar.addSelectionListener(new SelectionAdapter() {\r
            @Override\r
            public void widgetSelected(SelectionEvent e) {\r
                setTopIndex(_verticalScrollBar.getSelection());\r
            }\r
        });\r
        _verticalScrollBar.setEnabled(false);\r
\r
        _stateCtrl = createTimeGraphControl();\r
\r
        _stateCtrl.setTimeProvider(this);\r
        _stateCtrl.addSelectionListener(this);\r
        _stateCtrl.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 2));\r
        _stateCtrl.addMouseWheelListener(new MouseWheelListener() {\r
            @Override\r
            public void mouseScrolled(MouseEvent e) {\r
                adjustVerticalScrollBar();\r
            }\r
        });\r
        _stateCtrl.addKeyListener(new KeyAdapter() {\r
            @Override\r
            public void keyPressed(KeyEvent e) {\r
                adjustVerticalScrollBar();\r
            }\r
        });\r
\r
        Composite filler = new Composite(_dataViewer, SWT.NONE);\r
        GridData gd = new GridData(SWT.DEFAULT, SWT.DEFAULT, false, false);\r
        gd.heightHint = _stateCtrl.getHorizontalBar().getSize().y;\r
        filler.setLayoutData(gd);\r
        filler.setLayout(new FillLayout());\r
\r
        _stateCtrl.addControlListener(new ControlAdapter() {\r
            @Override\r
            public void controlResized(ControlEvent event) {\r
                resizeControls();\r
            }\r
        });\r
        resizeControls();\r
        _dataViewer.update();\r
        adjustVerticalScrollBar();\r
        return _dataViewer;\r
    }\r
\r
    /**\r
     * Dispose the view.\r
     */\r
    public void dispose() {\r
        saveOptions();\r
        _stateCtrl.dispose();\r
        _dataViewer.dispose();\r
        _colors.dispose();\r
    }\r
\r
    protected TimeGraphControl createTimeGraphControl() {\r
        return new TimeGraphControl(_dataViewer, _colors);\r
    }\r
\r
    /**\r
     * Resize the controls\r
     */\r
    public void resizeControls() {\r
        Rectangle r = _dataViewer.getClientArea();\r
        if (r.isEmpty()) {\r
            return;\r
        }\r
\r
        int width = r.width;\r
        if (_nameWidth > width - _minNameWidth) {\r
            _nameWidth = width - _minNameWidth;\r
        }\r
        if (_nameWidth < _minNameWidth) {\r
            _nameWidth = _minNameWidth;\r
        }\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Try to set most convenient time range for display.\r
     *\r
     * @param traces\r
     *            The traces in the model\r
     */\r
    public void setTimeRange(ITimeGraphEntry traces[]) {\r
        _endTime = 0;\r
        _beginTime = -1;\r
        for (int i = 0; i < traces.length; i++) {\r
            ITimeGraphEntry entry = traces[i];\r
            if (entry.getEndTime() >= entry.getStartTime() && entry.getEndTime() > 0) {\r
                if (_beginTime < 0 || entry.getStartTime() < _beginTime) {\r
                    _beginTime = entry.getStartTime();\r
                }\r
                if (entry.getEndTime() > _endTime) {\r
                    _endTime = entry.getEndTime();\r
                }\r
            }\r
        }\r
\r
        if (_beginTime < 0) {\r
            _beginTime = 0;\r
        }\r
    }\r
\r
    /**\r
     * Recalculate the time bounds\r
     */\r
    public void setTimeBounds() {\r
        //_time0_ = _beginTime - (long) ((_endTime - _beginTime) * 0.02);\r
        _time0_ = _beginTime;\r
        if (_time0_ < 0) {\r
            _time0_ = 0;\r
        }\r
        // _time1_ = _time0_ + (_endTime - _time0_) * 1.05;\r
        _time1_ = _endTime;\r
        // _time0_ = Math.floor(_time0_);\r
        // _time1_ = Math.ceil(_time1_);\r
        if (!_timeRangeFixed) {\r
            _time0 = _time0_;\r
            _time1 = _time1_;\r
        }\r
        if (_time1 - _time0 < _minTimeInterval) {\r
            _time1 = Math.min(_time1_, _time0 + _minTimeInterval);\r
        }\r
    }\r
\r
    /**\r
     * @param traces\r
     * @param start\r
     * @param end\r
     */\r
    void updateInternalData(ITimeGraphEntry[] traces, long start, long end) {\r
        if (null == traces) {\r
            traces = new ITimeGraphEntry[0];\r
        }\r
        if ((start == 0 && end == 0) || start < 0 || end < 0) {\r
            // Start and end time are unspecified and need to be determined from\r
            // individual processes\r
            setTimeRange(traces);\r
        } else {\r
            _beginTime = start;\r
            _endTime = end;\r
        }\r
\r
        refreshAllData(traces);\r
    }\r
\r
    /**\r
     * @param traces\r
     */\r
    private void refreshAllData(ITimeGraphEntry[] traces) {\r
        setTimeBounds();\r
        if (_selectedTime < _beginTime) {\r
            _selectedTime = _beginTime;\r
        } else if (_selectedTime > _endTime) {\r
            _selectedTime = _endTime;\r
        }\r
        _stateCtrl.refreshData(traces);\r
        _timeScaleCtrl.redraw();\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Callback for when this view is focused\r
     */\r
    public void setFocus() {\r
        if (null != _stateCtrl) {\r
            _stateCtrl.setFocus();\r
        }\r
    }\r
\r
    /**\r
     * Get the current focus status of this view.\r
     *\r
     * @return If the view is currently focused, or not\r
     */\r
    public boolean isInFocus() {\r
        return _stateCtrl.isInFocus();\r
    }\r
\r
    /**\r
     * Get the view's current selection\r
     *\r
     * @return The entry that is selected\r
     */\r
    public ITimeGraphEntry getSelection() {\r
        return _stateCtrl.getSelectedTrace();\r
    }\r
\r
    /**\r
     * Get the index of the current selection\r
     *\r
     * @return The index\r
     */\r
    public int getSelectionIndex() {\r
        return _stateCtrl.getSelectedIndex();\r
    }\r
\r
    @Override\r
    public long getTime0() {\r
        return _time0;\r
    }\r
\r
    @Override\r
    public long getTime1() {\r
        return _time1;\r
    }\r
\r
    @Override\r
    public long getMinTimeInterval() {\r
        return _minTimeInterval;\r
    }\r
\r
    @Override\r
    public int getNameSpace() {\r
        return _nameWidth;\r
    }\r
\r
    @Override\r
    public void setNameSpace(int width) {\r
        _nameWidth = width;\r
        width = _stateCtrl.getClientArea().width;\r
        if (_nameWidth > width - 6) {\r
            _nameWidth = width - 6;\r
        }\r
        if (_nameWidth < 6) {\r
            _nameWidth = 6;\r
        }\r
        _stateCtrl.adjustScrolls();\r
        _stateCtrl.redraw();\r
        _timeScaleCtrl.redraw();\r
    }\r
\r
    @Override\r
    public int getTimeSpace() {\r
        int w = _stateCtrl.getClientArea().width;\r
        return w - _nameWidth;\r
    }\r
\r
    @Override\r
    public long getSelectedTime() {\r
        return _selectedTime;\r
    }\r
\r
    @Override\r
    public long getBeginTime() {\r
        return _beginTime;\r
    }\r
\r
    @Override\r
    public long getEndTime() {\r
        return _endTime;\r
    }\r
\r
    @Override\r
    public long getMaxTime() {\r
        return _time1_;\r
    }\r
\r
    @Override\r
    public long getMinTime() {\r
        return _time0_;\r
    }\r
\r
    /*\r
     * (non-Javadoc)\r
     *\r
     * @see\r
     * org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.widgets.ITimeDataProvider\r
     * #setStartFinishTimeNotify(long, long)\r
     */\r
    @Override\r
    public void setStartFinishTimeNotify(long time0, long time1) {\r
        setStartFinishTime(time0, time1);\r
        notifyRangeListeners(time0, time1);\r
    }\r
\r
\r
    /* (non-Javadoc)\r
     * @see org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.widgets.ITimeDataProvider#notifyStartFinishTime()\r
     */\r
    @Override\r
    public void notifyStartFinishTime() {\r
        notifyRangeListeners(_time0, _time1);\r
    }\r
\r
    /*\r
     * (non-Javadoc)\r
     *\r
     * @see\r
     * org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.widgets.ITimeDataProvider\r
     * #setStartFinishTime(long, long)\r
     */\r
    @Override\r
    public void setStartFinishTime(long time0, long time1) {\r
        _time0 = time0;\r
        if (_time0 < _time0_) {\r
            _time0 = _time0_;\r
        }\r
        if (_time0 > _time1_) {\r
            _time0 = _time1_;\r
        }\r
        _time1 = time1;\r
        if (_time1 < _time0_) {\r
            _time1 = _time0_;\r
        }\r
        if (_time1 > _time1_) {\r
            _time1 = _time1_;\r
        }\r
        if (_time1 - _time0 < _minTimeInterval) {\r
            _time1 = Math.min(_time1_, _time0 + _minTimeInterval);\r
        }\r
        _timeRangeFixed = true;\r
        _stateCtrl.adjustScrolls();\r
        _stateCtrl.redraw();\r
        _timeScaleCtrl.redraw();\r
    }\r
\r
    /**\r
     * Set the time bounds to the provided values\r
     *\r
     * @param beginTime\r
     *            The start time of the window\r
     * @param endTime\r
     *            The end time\r
     */\r
    public void setTimeBounds(long beginTime, long endTime) {\r
        _beginTime = beginTime;\r
        _endTime = endTime;\r
        _time0_ = beginTime;\r
        _time1_ = endTime;\r
        _stateCtrl.adjustScrolls();\r
    }\r
\r
    @Override\r
    public void resetStartFinishTime() {\r
        setStartFinishTimeNotify(_time0_, _time1_);\r
        _timeRangeFixed = false;\r
    }\r
\r
    @Override\r
    public void setSelectedTimeNotify(long time, boolean ensureVisible) {\r
        setSelectedTimeInt(time, ensureVisible, true);\r
    }\r
\r
    @Override\r
    public void setSelectedTime(long time, boolean ensureVisible) {\r
        setSelectedTimeInt(time, ensureVisible, false);\r
    }\r
\r
    private void setSelectedTimeInt(long time, boolean ensureVisible, boolean doNotify) {\r
        long time0 = _time0;\r
        long time1 = _time1;\r
        if (ensureVisible) {\r
            long timeSpace = (long) ((_time1 - _time0) * .02);\r
            long timeMid = (long) ((_time1 - _time0) * .5);\r
            if (time < _time0 + timeSpace) {\r
                long dt = _time0 - time + timeMid;\r
                _time0 -= dt;\r
                _time1 -= dt;\r
            } else if (time > _time1 - timeSpace) {\r
                long dt = time - _time1 + timeMid;\r
                _time0 += dt;\r
                _time1 += dt;\r
            }\r
            if (_time0 < _time0_) {\r
                _time1 = Math.min(_time1_, _time1 + (_time0_ - _time0));\r
                _time0 = _time0_;\r
            } else if (_time1 > _time1_) {\r
                _time0 = Math.max(_time0_, _time0 - (_time1 - _time1_));\r
                _time1 = _time1_;\r
            }\r
        }\r
        if (_time1 - _time0 < _minTimeInterval) {\r
            _time1 = Math.min(_time1_, _time0 + _minTimeInterval);\r
        }\r
        _stateCtrl.adjustScrolls();\r
        _stateCtrl.redraw();\r
        _timeScaleCtrl.redraw();\r
\r
\r
        boolean notifySelectedTime = (time != _selectedTime);\r
        _selectedTime = time;\r
\r
        if (doNotify && ((time0 != _time0) || (time1 != _time1))) {\r
            notifyRangeListeners(_time0, _time1);\r
        }\r
\r
        if (doNotify && notifySelectedTime) {\r
            notifyTimeListeners(_selectedTime);\r
        }\r
    }\r
\r
    @Override\r
    public void widgetDefaultSelected(SelectionEvent e) {\r
        if (_selectedEntry != getSelection()) {\r
            _selectedEntry = getSelection();\r
            notifySelectionListeners(_selectedEntry);\r
        }\r
    }\r
\r
    @Override\r
    public void widgetSelected(SelectionEvent e) {\r
        if (_selectedEntry != getSelection()) {\r
            _selectedEntry = getSelection();\r
            notifySelectionListeners(_selectedEntry);\r
        }\r
    }\r
\r
    /**\r
     * Callback for when the next event is selected\r
     */\r
    public void selectNextEvent() {\r
        _stateCtrl.selectNextEvent();\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Callback for when the previous event is selected\r
     */\r
    public void selectPrevEvent() {\r
        _stateCtrl.selectPrevEvent();\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Callback for when the next item is selected\r
     */\r
    public void selectNextItem() {\r
        _stateCtrl.selectNextTrace();\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Callback for when the previous item is selected\r
     */\r
    public void selectPrevItem() {\r
        _stateCtrl.selectPrevTrace();\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Callback for the show legend action\r
     */\r
    public void showLegend() {\r
        if (_dataViewer == null || _dataViewer.isDisposed()) {\r
            return;\r
        }\r
\r
        TimeGraphLegend.open(_dataViewer.getShell(), fTimeGraphProvider);\r
    }\r
\r
    /**\r
     * Callback for the Zoom In action\r
     */\r
    public void zoomIn() {\r
        _stateCtrl.zoomIn();\r
    }\r
\r
    /**\r
     * Callback for the Zoom Out action\r
     */\r
    public void zoomOut() {\r
        _stateCtrl.zoomOut();\r
    }\r
\r
    private String getPreferenceString(String string) {\r
        return getViewTypeStr() + "." + string; //$NON-NLS-1$\r
    }\r
\r
    /**\r
     * Add a selection listener\r
     *\r
     * @param listener\r
     *            The listener to add\r
     */\r
    public void addSelectionListener(ITimeGraphSelectionListener listener) {\r
        fSelectionListeners.add(listener);\r
    }\r
\r
    /**\r
     * Remove a selection listener\r
     *\r
     * @param listener\r
     *            The listener to remove\r
     */\r
    public void removeSelectionListener(ITimeGraphSelectionListener listener) {\r
        fSelectionListeners.remove(listener);\r
    }\r
\r
    private void notifySelectionListeners(ITimeGraphEntry selection) {\r
        TimeGraphSelectionEvent event = new TimeGraphSelectionEvent(this, selection);\r
\r
        for (ITimeGraphSelectionListener listener : fSelectionListeners) {\r
            listener.selectionChanged(event);\r
        }\r
    }\r
\r
    /**\r
     * Add a time listener\r
     *\r
     * @param listener\r
     *            The listener to add\r
     */\r
    public void addTimeListener(ITimeGraphTimeListener listener) {\r
        fTimeListeners.add(listener);\r
    }\r
\r
    /**\r
     * Remove a time listener\r
     *\r
     * @param listener\r
     *            The listener to remove\r
     */\r
    public void removeTimeListener(ITimeGraphTimeListener listener) {\r
        fTimeListeners.remove(listener);\r
    }\r
\r
    private void notifyTimeListeners(long time) {\r
        TimeGraphTimeEvent event = new TimeGraphTimeEvent(this, time);\r
\r
        for (ITimeGraphTimeListener listener : fTimeListeners) {\r
            listener.timeSelected(event);\r
        }\r
    }\r
\r
    /**\r
     * Add a range listener\r
     *\r
     * @param listener\r
     *            The listener to add\r
     */\r
    public void addRangeListener(ITimeGraphRangeListener listener) {\r
        fRangeListeners.add(listener);\r
    }\r
\r
    /**\r
     * Remove a range listener\r
     *\r
     * @param listener\r
     *            The listener to remove\r
     */\r
    public void removeRangeListener(ITimeGraphRangeListener listener) {\r
        fRangeListeners.remove(listener);\r
    }\r
\r
    private void notifyRangeListeners(long startTime, long endTime) {\r
        // Check if the time has actually changed from last notification\r
        if (startTime != _time0_extSynch || endTime != _time1_extSynch) {\r
            // Notify Time Scale Selection Listeners\r
            TimeGraphRangeUpdateEvent event = new TimeGraphRangeUpdateEvent(this, startTime, endTime);\r
\r
            for (ITimeGraphRangeListener listener : fRangeListeners) {\r
                listener.timeRangeUpdated(event);\r
            }\r
\r
            // update external synch timers\r
            updateExtSynchTimers();\r
        }\r
    }\r
\r
    /**\r
     * Callback to set a selected event in the view\r
     *\r
     * @param event\r
     *            The event that was selected\r
     * @param source\r
     *            The source of this selection event\r
     */\r
    public void setSelectedEvent(ITimeEvent event, Object source) {\r
        if (event == null || source == this) {\r
            return;\r
        }\r
        _selectedEntry = event.getEntry();\r
        _stateCtrl.selectItem(_selectedEntry, false);\r
\r
        setSelectedTimeInt(event.getTime(), true, true);\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Set the seeked time of a trace\r
     *\r
     * @param trace\r
     *            The trace that was seeked\r
     * @param time\r
     *            The target time\r
     * @param source\r
     *            The source of this seek event\r
     */\r
    public void setSelectedTraceTime(ITimeGraphEntry trace, long time, Object source) {\r
        if (trace == null || source == this) {\r
            return;\r
        }\r
        _selectedEntry = trace;\r
        _stateCtrl.selectItem(trace, false);\r
\r
        setSelectedTimeInt(time, true, true);\r
    }\r
\r
    /**\r
     * Callback for a trace selection\r
     *\r
     * @param trace\r
     *            The trace that was selected\r
     */\r
    public void setSelection(ITimeGraphEntry trace) {\r
        _selectedEntry = trace;\r
        _stateCtrl.selectItem(trace, false);\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Callback for a time window selection\r
     *\r
     * @param time0\r
     *            Start time of the range\r
     * @param time1\r
     *            End time of the range\r
     * @param source\r
     *            Source of the event\r
     */\r
    public void setSelectVisTimeWindow(long time0, long time1, Object source) {\r
        if (source == this) {\r
            return;\r
        }\r
\r
        setStartFinishTime(time0, time1);\r
\r
        // update notification time values since we are now in synch with the\r
        // external application\r
        updateExtSynchTimers();\r
    }\r
\r
    /**\r
     * update the cache timers used to identify the need to send a time window\r
     * update to external registered listeners\r
     */\r
    private void updateExtSynchTimers() {\r
        // last time notification cache\r
        _time0_extSynch = _time0;\r
        _time1_extSynch = _time1;\r
    }\r
\r
    /**\r
     * Set the calendar format\r
     *\r
     * @param toAbsoluteCaltime\r
     *            True for absolute time, false for relative\r
     */\r
    public void setTimeCalendarFormat(boolean toAbsoluteCaltime) {\r
        calendarTimeFormat = toAbsoluteCaltime;\r
    }\r
\r
    @Override\r
    public boolean isCalendarFormat() {\r
        return calendarTimeFormat;\r
    }\r
\r
    /**\r
     * Retrieve the border width\r
     *\r
     * @return The width\r
     */\r
    public int getBorderWidth() {\r
        return borderWidth;\r
    }\r
\r
    /**\r
     * Set the border width\r
     *\r
     * @param borderWidth\r
     *            The width\r
     */\r
    public void setBorderWidth(int borderWidth) {\r
        if (borderWidth > -1) {\r
            this.borderWidth = borderWidth;\r
            GridLayout gl = (GridLayout)_dataViewer.getLayout();\r
            gl.marginHeight = borderWidth;\r
        }\r
    }\r
\r
    /**\r
     * Retrieve the height of the header\r
     *\r
     * @return The height\r
     */\r
    public int getHeaderHeight() {\r
        return timeScaleHeight;\r
    }\r
\r
    /**\r
     * Set the height of the header\r
     *\r
     * @param headerHeight\r
     *            The height to set\r
     */\r
    public void setHeaderHeight(int headerHeight) {\r
        if (headerHeight > -1) {\r
            this.timeScaleHeight = headerHeight;\r
            _timeScaleCtrl.setHeight(headerHeight);\r
        }\r
    }\r
\r
    /**\r
     * Retrieve the height of an item row\r
     *\r
     * @return The height\r
     */\r
    public int getItemHeight() {\r
        if (_stateCtrl != null) {\r
            return _stateCtrl.getItemHeight();\r
        }\r
        return 0;\r
    }\r
\r
    /**\r
     * Set the height of an item row\r
     *\r
     * @param rowHeight\r
     *            The height to set\r
     */\r
    public void setItemHeight(int rowHeight) {\r
        if (_stateCtrl != null) {\r
            _stateCtrl.setItemHeight(rowHeight);\r
        }\r
    }\r
\r
    /**\r
     * Set the minimum item width\r
     *\r
     * @param width\r
     *            The min width\r
     */\r
    public void setMinimumItemWidth(int width) {\r
        if (_stateCtrl != null) {\r
            _stateCtrl.setMinimumItemWidth(width);\r
        }\r
    }\r
\r
    /**\r
     * Set the width for the name column\r
     *\r
     * @param width The width\r
     */\r
    public void setNameWidthPref(int width) {\r
        _nameWidthPref = width;\r
        if (width == 0) {\r
            _minNameWidth = 0;\r
            _nameWidth = 0;\r
        }\r
    }\r
\r
    /**\r
     * Retrieve the configure width for the name column\r
     *\r
     * @param width\r
     *            Unused?\r
     * @return The width\r
     */\r
    public int getNameWidthPref(int width) {\r
        return _nameWidthPref;\r
    }\r
\r
    /**\r
     * Returns the primary control associated with this viewer.\r
     *\r
     * @return the SWT control which displays this viewer's content\r
     */\r
    public Control getControl() {\r
        return _dataViewer;\r
    }\r
\r
    /**\r
     * Returns the time graph control associated with this viewer.\r
     *\r
     * @return the time graph control\r
     */\r
    TimeGraphControl getTimeGraphControl() {\r
        return _stateCtrl;\r
    }\r
\r
    /**\r
     * Returns the time graph scale associated with this viewer.\r
     *\r
     * @return the time graph scale\r
     */\r
    TimeGraphScale getTimeGraphScale() {\r
        return _timeScaleCtrl;\r
    }\r
\r
    /**\r
     * Get the selection provider\r
     *\r
     * @return the selection provider\r
     */\r
    public ISelectionProvider getSelectionProvider() {\r
        return _stateCtrl;\r
    }\r
\r
    /**\r
     * Wait for the cursor\r
     *\r
     * @param waitInd\r
     *            Wait indefinitely?\r
     */\r
    public void waitCursor(boolean waitInd) {\r
        _stateCtrl.waitCursor(waitInd);\r
    }\r
\r
    /**\r
     * Get the horizontal scroll bar object\r
     *\r
     * @return The scroll bar\r
     */\r
    public ScrollBar getHorizontalBar() {\r
        return _stateCtrl.getHorizontalBar();\r
    }\r
\r
    /**\r
     * Get the vertical scroll bar object\r
     *\r
     * @return The scroll bar\r
     */\r
    public Slider getVerticalBar() {\r
        return _verticalScrollBar;\r
    }\r
\r
    /**\r
     * Set the given index as the top one\r
     *\r
     * @param index\r
     *            The index that will go to the top\r
     */\r
    public void setTopIndex(int index) {\r
        _stateCtrl.setTopIndex(index);\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Retrieve the current top index\r
     *\r
     * @return The top index\r
     */\r
    public int getTopIndex() {\r
        return _stateCtrl.getTopIndex();\r
    }\r
\r
    /**\r
     * Set the expanded state of an entry\r
     *\r
     * @param entry\r
     *            The entry to expand/collapse\r
     * @param expanded\r
     *            True for expanded, false for collapsed\r
     */\r
    public void setExpandedState(ITimeGraphEntry entry, boolean expanded) {\r
        _stateCtrl.setExpandedState(entry, expanded);\r
        adjustVerticalScrollBar();\r
    }\r
\r
    /**\r
     * Get the number of sub-elements when expanded\r
     *\r
     * @return The element count\r
     */\r
    public int getExpandedElementCount() {\r
        return _stateCtrl.getExpandedElementCount();\r
    }\r
\r
    /**\r
     * Get the sub-elements\r
     *\r
     * @return The array of entries that are below this one\r
     */\r
    public ITimeGraphEntry[] getExpandedElements() {\r
        return _stateCtrl.getExpandedElements();\r
    }\r
\r
    /**\r
     * Add a tree listener\r
     *\r
     * @param listener\r
     *            The listener to add\r
     */\r
    public void addTreeListener(ITimeGraphTreeListener listener) {\r
        _stateCtrl.addTreeListener(listener);\r
    }\r
\r
    /**\r
     * Remove a tree listener\r
     *\r
     * @param listener\r
     *            The listener to remove\r
     */\r
    public void removeTreeListener(ITimeGraphTreeListener listener) {\r
        _stateCtrl.removeTreeListener(listener);\r
    }\r
\r
    /**\r
     * Get the reset scale action.\r
     *\r
     * @return The Action object\r
     */\r
    public Action getResetScaleAction() {\r
        if (resetScale == null) {\r
            // resetScale\r
            resetScale = new Action() {\r
                @Override\r
                public void run() {\r
                    resetStartFinishTime();\r
                }\r
            };\r
            resetScale.setText(Messages.TmfTimeGraphViewer_ResetScaleActionNameText);\r
            resetScale.setToolTipText(Messages.TmfTimeGraphViewer_ResetScaleActionToolTipText);\r
            resetScale.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_HOME_MENU));\r
        }\r
        return resetScale;\r
    }\r
\r
    /**\r
     * Get the show legend action.\r
     *\r
     * @return The Action object\r
     */\r
    public Action getShowLegendAction() {\r
        if (showLegendAction == null) {\r
            // showLegend\r
            showLegendAction = new Action() {\r
                @Override\r
                public void run() {\r
                    showLegend();\r
                }\r
            };\r
            showLegendAction.setText(Messages.TmfTimeGraphViewer_LegendActionNameText);\r
            showLegendAction.setToolTipText(Messages.TmfTimeGraphViewer_LegendActionToolTipText);\r
            showLegendAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_SHOW_LEGEND));\r
        }\r
\r
        return showLegendAction;\r
    }\r
\r
    /**\r
     * Get the the next event action.\r
     *\r
     * @return The action object\r
     */\r
    public Action getNextEventAction() {\r
        if (nextEventAction == null) {\r
            nextEventAction = new Action() {\r
                @Override\r
                public void run() {\r
                    selectNextEvent();\r
                }\r
            };\r
\r
            nextEventAction.setText(Messages.TmfTimeGraphViewer_NextEventActionNameText);\r
            nextEventAction.setToolTipText(Messages.TmfTimeGraphViewer_NextEventActionToolTipText);\r
            nextEventAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_NEXT_EVENT));\r
        }\r
\r
        return nextEventAction;\r
    }\r
\r
    /**\r
     * Get the previous event action.\r
     *\r
     * @return The Action object\r
     */\r
    public Action getPreviousEventAction() {\r
        if (prevEventAction == null) {\r
            prevEventAction = new Action() {\r
                @Override\r
                public void run() {\r
                    selectPrevEvent();\r
                }\r
            };\r
\r
            prevEventAction.setText(Messages.TmfTimeGraphViewer_PreviousEventActionNameText);\r
            prevEventAction.setToolTipText(Messages.TmfTimeGraphViewer_PreviousEventActionToolTipText);\r
            prevEventAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_PREV_EVENT));\r
        }\r
\r
        return prevEventAction;\r
    }\r
\r
    /**\r
     * Get the next item action.\r
     *\r
     * @return The Action object\r
     */\r
    public Action getNextItemAction() {\r
        if (nextItemAction == null) {\r
\r
            nextItemAction = new Action() {\r
                @Override\r
                public void run() {\r
                    selectNextItem();\r
                }\r
            };\r
            nextItemAction.setText(Messages.TmfTimeGraphViewer_NextItemActionNameText);\r
            nextItemAction.setToolTipText(Messages.TmfTimeGraphViewer_NextItemActionToolTipText);\r
            nextItemAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_NEXT_ITEM));\r
        }\r
        return nextItemAction;\r
    }\r
\r
    /**\r
     * Get the previous item action.\r
     *\r
     * @return The Action object\r
     */\r
    public Action getPreviousItemAction() {\r
        if (previousItemAction == null) {\r
\r
            previousItemAction = new Action() {\r
                @Override\r
                public void run() {\r
                    selectPrevItem();\r
                }\r
            };\r
            previousItemAction.setText(Messages.TmfTimeGraphViewer_PreviousItemActionNameText);\r
            previousItemAction.setToolTipText(Messages.TmfTimeGraphViewer_PreviousItemActionToolTipText);\r
            previousItemAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_PREV_ITEM));\r
        }\r
        return previousItemAction;\r
    }\r
\r
    /**\r
     * Get the zoom in action\r
     *\r
     * @return The Action object\r
     */\r
    public Action getZoomInAction() {\r
        if (zoomInAction == null) {\r
            zoomInAction = new Action() {\r
                @Override\r
                public void run() {\r
                    zoomIn();\r
                }\r
            };\r
            zoomInAction.setText(Messages.TmfTimeGraphViewer_ZoomInActionNameText);\r
            zoomInAction.setToolTipText(Messages.TmfTimeGraphViewer_ZoomInActionToolTipText);\r
            zoomInAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_ZOOM_IN_MENU));\r
        }\r
        return zoomInAction;\r
    }\r
\r
    /**\r
     * Get the zoom out action\r
     *\r
     * @return The Action object\r
     */\r
    public Action getZoomOutAction() {\r
        if (zoomOutAction == null) {\r
            zoomOutAction = new Action() {\r
                @Override\r
                public void run() {\r
                    zoomOut();\r
                }\r
            };\r
            zoomOutAction.setText(Messages.TmfTimeGraphViewer_ZoomOutActionNameText);\r
            zoomOutAction.setToolTipText(Messages.TmfTimeGraphViewer_ZoomOutActionToolTipText);\r
            zoomOutAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_ZOOM_OUT_MENU));\r
        }\r
        return zoomOutAction;\r
    }\r
\r
\r
    private void adjustVerticalScrollBar() {\r
        int topIndex = _stateCtrl.getTopIndex();\r
        int countPerPage = _stateCtrl.countPerPage();\r
        int expandedElementCount = _stateCtrl.getExpandedElementCount();\r
        if (topIndex + countPerPage > expandedElementCount) {\r
            _stateCtrl.setTopIndex(Math.max(0, expandedElementCount - countPerPage));\r
        }\r
\r
        int selection = _stateCtrl.getTopIndex();\r
        int min = 0;\r
        int max = Math.max(1, expandedElementCount - 1);\r
        int thumb = Math.min(max, Math.max(1, countPerPage - 1));\r
        int increment = 1;\r
        int pageIncrement = Math.max(1, countPerPage);\r
        _verticalScrollBar.setValues(selection, min, max, thumb, increment, pageIncrement);\r
    }\r
\r
\r
\r
}\r