ctf: Handle traces with unknown event attributes

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

/*****************************************************************************\r
 * Copyright (c) 2007 Intel Corporation, 2009, 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
 *   Alvaro Sanchez-Leon - Updated for TMF\r
 *   Patrick Tasse - Refactoring\r
 *\r
 *****************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets;\r
\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.events.PaintEvent;\r
import org.eclipse.swt.events.PaintListener;\r
import org.eclipse.swt.graphics.Color;\r
import org.eclipse.swt.graphics.Rectangle;\r
import org.eclipse.swt.widgets.Canvas;\r
import org.eclipse.swt.widgets.Composite;\r
\r
/**\r
 * Base control abstract class for the time graph widget\r
 *\r
 * @version 1.0\r
 * @author Alvaro Sanchez-Leon\r
 * @author Patrick Tasse\r
 */\r
public abstract class TimeGraphBaseControl extends Canvas implements PaintListener {\r
\r
    /** Default left margin size */\r
    static public final int MARGIN = 4;\r
\r
    /** Default expanded size */\r
    static public final int EXPAND_SIZE = 9; // the [+] or [-] control size\r
\r
    /** Default size of the right margin */\r
    static public final int RIGHT_MARGIN = 1; // 1 pixels less to make sure end time is visible\r
\r
    /** Default size for small icons */\r
    static public final int SMALL_ICON_SIZE = 16;\r
\r
    protected TimeGraphColorScheme _colors;\r
    protected int _fontHeight = 0;\r
\r
    /**\r
     * Basic constructor. Uses a default style value\r
     *\r
     * @param parent\r
     *            The parent composite object\r
     * @param colors\r
     *            The color scheme to use\r
     */\r
    public TimeGraphBaseControl(Composite parent, TimeGraphColorScheme colors) {\r
        this(parent, colors, SWT.NO_BACKGROUND | SWT.NO_FOCUS);\r
    }\r
\r
    /**\r
     * Standard constructor\r
     *\r
     * @param parent\r
     *            The parent composite object\r
     * @param colors\r
     *            The color scheme to use\r
     * @param style\r
     *            The index of the style to use\r
     */\r
    public TimeGraphBaseControl(Composite parent, TimeGraphColorScheme colors, int style) {\r
        super(parent, style);\r
        _colors = colors;\r
        addPaintListener(this);\r
    }\r
\r
    @Override\r
    public void dispose() {\r
        super.dispose();\r
    }\r
\r
    @Override\r
    public void paintControl(PaintEvent e) {\r
        if (e.widget != this) {\r
            return;\r
        }\r
        _fontHeight = e.gc.getFontMetrics().getHeight();\r
        Rectangle bound = getClientArea();\r
        if (!bound.isEmpty()) {\r
            Color colBackup = e.gc.getBackground();\r
            paint(bound, e);\r
            e.gc.setBackground(colBackup);\r
        }\r
    }\r
\r
    /**\r
     * Retrieve the current font's height\r
     *\r
     * @return The height\r
     */\r
    public int getFontHeight() {\r
        return _fontHeight;\r
    }\r
\r
    abstract void paint(Rectangle bound, PaintEvent e);\r
}\r