Re-structure LTTng sub-project as per the Linux Tools guidelines

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / colors / ColorSetting.java

/*******************************************************************************\r
 * Copyright (c) 2010 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
 *   Patrick Tasse - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.views.colors;\r
\r
import org.eclipse.linuxtools.tmf.core.filter.model.ITmfFilterTreeNode;\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.graphics.Color;\r
import org.eclipse.swt.graphics.RGB;\r
import org.eclipse.swt.widgets.Display;\r
import org.eclipse.ui.themes.ColorUtil;\r
\r
/**\r
 * Application code must explicitly invoke the ColorSetting.dispose() method to release the operating system\r
 * resources managed by each instance when those instances are no longer required. \r
 */\r
\r
public class ColorSetting {\r
\r
	private RGB fForegroundRGB;\r
	private RGB fBackgroundRGB;\r
	private Color fForegroundColor;\r
	private Color fBackgroundColor;\r
	private Color fDimmedForegroundColor;\r
	private Color fDimmedBackgroundColor;\r
	private int fTickColorIndex;\r
	private ITmfFilterTreeNode fFilter;\r
	\r
	/**\r
	 * You must dispose the color setting when it is no longer required.\r
	 */\r
	public ColorSetting(RGB foreground, RGB background, int tickColorIndex, ITmfFilterTreeNode filter) {\r
		fForegroundRGB = foreground;\r
		fBackgroundRGB = background;\r
		fTickColorIndex = tickColorIndex;\r
		fFilter = filter;\r
		Display display = Display.getDefault();\r
		fForegroundColor = new Color(display, fForegroundRGB);\r
		fBackgroundColor = new Color(display, fBackgroundRGB);\r
		fDimmedForegroundColor = new Color(display, ColorUtil.blend(\r
				fForegroundRGB, fBackgroundRGB));\r
		fDimmedBackgroundColor = new Color(display, ColorUtil.blend(\r
				fBackgroundRGB, display.getSystemColor(SWT.COLOR_LIST_BACKGROUND).getRGB()));\r
	}\r
	\r
	/**\r
	 * Dispose the color setting resources\r
	 */\r
	public void dispose() {\r
		fForegroundColor.dispose();\r
		fBackgroundColor.dispose();\r
		fDimmedForegroundColor.dispose();\r
		fDimmedBackgroundColor.dispose();\r
	}\r
	\r
	/**\r
	 * @return the foreground\r
	 */\r
	public RGB getForegroundRGB() {\r
		return fForegroundRGB;\r
	}\r
	\r
	/**\r
	 * @param foreground the foreground to set\r
	 */\r
	public void setForegroundRGB(RGB foreground) {\r
		fForegroundRGB = foreground;\r
		fForegroundColor.dispose();\r
		fDimmedForegroundColor.dispose();\r
		Display display = Display.getDefault();\r
		fForegroundColor = new Color(display, fForegroundRGB);\r
		fDimmedForegroundColor = new Color(display, ColorUtil.blend(\r
				fForegroundRGB, fBackgroundRGB));\r
	}\r
	\r
	/**\r
	 * @return the background\r
	 */\r
	public RGB getBackgroundRGB() {\r
		return fBackgroundRGB;\r
	}\r
	\r
	/**\r
	 * @param background the background to set\r
	 */\r
	public void setBackgroundRGB(RGB background) {\r
		fBackgroundRGB = background;\r
		fBackgroundColor.dispose();\r
		fDimmedBackgroundColor.dispose();\r
		Display display = Display.getDefault();\r
		fBackgroundColor = new Color(display, fBackgroundRGB);\r
		fDimmedBackgroundColor = new Color(display, ColorUtil.blend(\r
				fBackgroundRGB, display.getSystemColor(SWT.COLOR_LIST_BACKGROUND).getRGB()));\r
	}\r
	\r
	/**\r
	 * @return the tick color index (0-15)\r
	 * @see org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.widgets.TraceColorScheme\r
	 */\r
	public int getTickColorIndex() {\r
		return fTickColorIndex;\r
	}\r
	\r
	/**\r
	 * @param tickColorIndex the tick color index to set (0-15)\r
	 * @see org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.widgets.TraceColorScheme\r
	 */\r
	public void setTickColorIndex(int tickColorIndex) {\r
		fTickColorIndex = tickColorIndex;\r
	}\r
	\r
	/**\r
	 * @return the filter\r
	 */\r
	public ITmfFilterTreeNode getFilter() {\r
		return fFilter;\r
	}\r
	\r
	/**\r
	 * @param filter the filter to set\r
	 */\r
	public void setFilter(ITmfFilterTreeNode filter) {\r
		fFilter = filter;\r
	}\r
\r
	/**\r
	 * @return the foreground color\r
	 */\r
	public Color getForegroundColor() {\r
		return fForegroundColor;\r
	}\r
\r
	/**\r
	 * @return the background color\r
	 */\r
	public Color getBackgroundColor() {\r
		return fBackgroundColor;\r
	}\r
\r
	/**\r
	 * @return the dimmed foreground color\r
	 */\r
	public Color getDimmedForegroundColor() {\r
		return fDimmedForegroundColor;\r
	}\r
\r
	/**\r
	 * @return the dimmed background color\r
	 */\r
	public Color getDimmedBackgroundColor() {\r
		return fDimmedBackgroundColor;\r
	}\r
	\r
}\r