tmf: Update Javadoc throughout tmf.ui

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

/*******************************************************************************\r
 * Copyright (c) 2010, 2012 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
 *   Bernd Hufmann - Updated to use RGB for the tick color\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.views.colors;\r
\r
import java.util.ArrayList;\r
import java.util.Arrays;\r
import java.util.List;\r
\r
import org.eclipse.linuxtools.internal.tmf.ui.Activator;\r
import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.widgets.Display;\r
\r
/**\r
 * Static class for managing color settings.\r
 *\r
 * @version 1.0\r
 * @author Patrick Tasse\r
 *\r
 */\r
public class ColorSettingsManager {\r
\r
    // The color settings file name\r
	private static final String COLOR_SETTINGS_FILE_NAME = "color_settings.xml"; //$NON-NLS-1$\r
\r
	// The path for the color settings file\r
	private static final String COLOR_SETTINGS_PATH_NAME =\r
        Activator.getDefault().getStateLocation().addTrailingSeparator().append(COLOR_SETTINGS_FILE_NAME).toString();\r
\r
	// The default color setting\r
	private static final ColorSetting DEFAULT_COLOR_SETTING = new ColorSetting(\r
			Display.getDefault().getSystemColor(SWT.COLOR_LIST_FOREGROUND).getRGB(),\r
			Display.getDefault().getSystemColor(SWT.COLOR_LIST_BACKGROUND).getRGB(),\r
			Display.getDefault().getSystemColor(SWT.COLOR_LIST_FOREGROUND).getRGB(),\r
			null);\r
\r
	/**\r
	 * Special value for priority if unknown.\r
	 */\r
	public static final int PRIORITY_NONE = Integer.MAX_VALUE;\r
\r
	// The stored color settings\r
	private static ColorSetting[] fColorSettings = ColorSettingsXML.load(COLOR_SETTINGS_PATH_NAME);\r
\r
	// The listener list\r
	private static List<IColorSettingsListener> fListeners = new ArrayList<IColorSettingsListener>();\r
\r
	/**\r
	 * Returns an array of color settings.\r
	 *\r
	 * @return an array of color settings.\r
	 */\r
	public static ColorSetting[] getColorSettings() {\r
		return (fColorSettings != null) ? Arrays.copyOf(fColorSettings, fColorSettings.length) : null;\r
	}\r
\r
	/**\r
	 * Sets the array of color settings.\r
	 *\r
	 * @param colorSettings A array of color settings to set\r
	 */\r
	public static void setColorSettings(ColorSetting[] colorSettings) {\r
		fColorSettings = (colorSettings != null) ? Arrays.copyOf(colorSettings, colorSettings.length) : null;\r
		ColorSettingsXML.save(COLOR_SETTINGS_PATH_NAME, fColorSettings);\r
		fireColorSettingsChanged();\r
	}\r
\r
	    /**\r
     * Gets the color settings that matches the filter for given event.\r
     *\r
     * @param event\r
     *            The event to check\r
     *\r
     * @return color settings defined for filter if found else default color\r
     *         settings\r
     */\r
	public static ColorSetting getColorSetting(ITmfEvent event) {\r
        for (int i = 0; i < fColorSettings.length; i++) {\r
        	ColorSetting colorSetting = fColorSettings[i];\r
        	if (colorSetting.getFilter() != null && colorSetting.getFilter().matches(event)) {\r
        		return colorSetting;\r
        	}\r
        }\r
        return DEFAULT_COLOR_SETTING;\r
	}\r
\r
	/**\r
	 * Gets the color settings priority for the given event.\r
	 *\r
	 * @param event A event the event to check\r
	 * @return the priority defined for the filter else PRIORITY_NONE\r
	 */\r
	public static int getColorSettingPriority(ITmfEvent event) {\r
        for (int i = 0; i < fColorSettings.length; i++) {\r
        	ColorSetting colorSetting = fColorSettings[i];\r
        	if (colorSetting.getFilter() != null && colorSetting.getFilter().matches(event)) {\r
        		return i;\r
        	}\r
        }\r
        return PRIORITY_NONE;\r
	}\r
\r
	/**\r
	 * Returns the color settings based the priority.\r
	 *\r
	 * @param priority A priority (index) of color settings\r
	 * @return the color settings defined for the priority else default color settings\r
	 */\r
	public static ColorSetting getColorSetting(int priority) {\r
		if (priority < fColorSettings.length) {\r
			return fColorSettings[priority];\r
		}\r
		return DEFAULT_COLOR_SETTING;\r
	}\r
\r
	/**\r
	 * Adds a color settings listener.\r
	 *\r
	 * @param listener A listener to add.\r
	 */\r
	public static void addColorSettingsListener(IColorSettingsListener listener) {\r
		if (! fListeners.contains(listener)) {\r
			fListeners.add(listener);\r
		}\r
	}\r
\r
	/**\r
	 * Removes a color settings listener.\r
	 *\r
	 * @param listener A listener to remove.\r
	 */\r
	public static void removeColorSettingsListener(IColorSettingsListener listener) {\r
		fListeners.remove(listener);\r
	}\r
\r
	// Notify listeners\r
	private static void fireColorSettingsChanged() {\r
		for (IColorSettingsListener listener : fListeners) {\r
			listener.colorSettingsChanged(fColorSettings);\r
		}\r
	}\r
}\r