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 / filter / FilterView.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
 *   Yuriy Vashchuk - Initial API and implementation\r
 *   based on Francois Chouinard ProjectView code.\r
 */\r
\r
package org.eclipse.linuxtools.tmf.ui.views.filter;\r
\r
import java.io.IOException;\r
\r
import javax.xml.parsers.ParserConfigurationException;\r
\r
import org.eclipse.core.resources.IResource;\r
import org.eclipse.core.resources.IWorkspace;\r
import org.eclipse.core.resources.ResourcesPlugin;\r
import org.eclipse.core.runtime.CoreException;\r
import org.eclipse.jface.action.Action;\r
import org.eclipse.jface.action.IToolBarManager;\r
import org.eclipse.jface.action.Separator;\r
import org.eclipse.jface.resource.ImageDescriptor;\r
import org.eclipse.jface.viewers.ISelectionChangedListener;\r
import org.eclipse.jface.viewers.IStructuredSelection;\r
import org.eclipse.jface.viewers.SelectionChangedEvent;\r
import org.eclipse.linuxtools.tmf.core.filter.model.ITmfFilterTreeNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterRootNode;\r
import org.eclipse.linuxtools.tmf.core.filter.xml.TmfFilterXMLParser;\r
import org.eclipse.linuxtools.tmf.core.filter.xml.TmfFilterXMLWriter;\r
import org.eclipse.linuxtools.tmf.ui.TmfUiPlugin;\r
import org.eclipse.linuxtools.tmf.ui.internal.Messages;\r
import org.eclipse.linuxtools.tmf.ui.views.TmfView;\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.graphics.Image;\r
import org.eclipse.swt.widgets.Composite;\r
import org.eclipse.swt.widgets.FileDialog;\r
import org.eclipse.swt.widgets.Shell;\r
import org.eclipse.ui.IActionBars;\r
import org.xml.sax.SAXException;\r
\r
/**\r
 * <b><u>FilterView</u></b>\r
 * <p>\r
 * View that contain UI to the TMF filter.\r
 */\r
public class FilterView extends TmfView {\r
\r
	public static final String ID = "org.eclipse.linuxtools.tmf.ui.views.filter"; //$NON-NLS-1$\r
\r
	private static final Image SAVE_IMAGE = TmfUiPlugin.getDefault().getImageFromPath("/icons/elcl16/save_button.gif"); //$NON-NLS-1$\r
    private static final Image ADD_IMAGE = TmfUiPlugin.getDefault().getImageFromPath("/icons/elcl16/add_button.gif"); //$NON-NLS-1$\r
    private static final Image DELETE_IMAGE = TmfUiPlugin.getDefault().getImageFromPath("/icons/elcl16/delete_button.gif"); //$NON-NLS-1$\r
    private static final Image IMPORT_IMAGE = TmfUiPlugin.getDefault().getImageFromPath("/icons/elcl16/import_button.gif"); //$NON-NLS-1$\r
    private static final Image EXPORT_IMAGE = TmfUiPlugin.getDefault().getImageFromPath("/icons/elcl16/export_button.gif"); //$NON-NLS-1$\r
    \r
    // ------------------------------------------------------------------------\r
    // Main data structures\r
    // ------------------------------------------------------------------------\r
\r
	private FilterViewer fViewer;\r
    private ITmfFilterTreeNode fRoot;\r
\r
    private IWorkspace fWorkspace;\r
\r
    private SaveAction fSaveAction;\r
	private AddAction fAddAction;\r
	private DeleteAction fDeleteAction;\r
	private ExportAction fExportAction;\r
	private ImportAction fImportAction;\r
\r
    /**\r
     * Getter for the Filter Tree Root\r
     * \r
     * @return The root of builded tree\r
     */\r
    public ITmfFilterTreeNode getFilterRoot() {\r
    	return fRoot;\r
    }\r
\r
    \r
    // ------------------------------------------------------------------------\r
    // Constructor\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     *  Default Constructor\r
     */\r
	public FilterView() {\r
		super("Filter"); //$NON-NLS-1$\r
		\r
		fWorkspace = ResourcesPlugin.getWorkspace();\r
		try {\r
            fWorkspace.getRoot().refreshLocal(IResource.DEPTH_INFINITE, null);\r
        } catch (CoreException e) {\r
            e.printStackTrace();\r
        }\r
        \r
        fRoot = new TmfFilterRootNode();\r
        for (ITmfFilterTreeNode node : FilterManager.getSavedFilters()) {\r
        	fRoot.addChild(node);\r
        }\r
	}\r
\r
	\r
	/**\r
	 * Refresh the tree widget\r
	 */\r
	public void refresh() {\r
		fViewer.refresh();\r
	}\r
	\r
	/**\r
	 * Setter for selection\r
	 * \r
	 * @param node The node to select\r
	 */\r
	public void setSelection(ITmfFilterTreeNode node) {\r
		fViewer.setSelection(node, true);\r
	}\r
\r
	/*\r
	 * (non-Javadoc)\r
	 * @see org.eclipse.linuxtools.tmf.ui.views.TmfView#createPartControl(org.eclipse.swt.widgets.Composite)\r
	 */\r
	@Override\r
	public void createPartControl(Composite parent) {\r
\r
		fViewer = new FilterViewer(parent, SWT.NONE);\r
		fViewer.setInput(fRoot);\r
		\r
		contributeToActionBars();\r
		\r
		fViewer.addSelectionChangedListener(new ISelectionChangedListener() {\r
			@Override\r
			public void selectionChanged(SelectionChangedEvent event) {\r
				if (!(event.getSelection().isEmpty()) && event.getSelection() instanceof IStructuredSelection) {\r
					fDeleteAction.setEnabled(true);\r
					fExportAction.setEnabled(true);\r
				} else {\r
					fDeleteAction.setEnabled(false);\r
					fExportAction.setEnabled(false);\r
				}\r
			}\r
		});\r
	}\r
\r
	\r
	// ------------------------------------------------------------------------\r
    // ViewPart\r
    // ------------------------------------------------------------------------\r
	\r
	/*\r
	 * (non-Javadoc)\r
	 * @see java.lang.Object#toString()\r
	 */\r
	@Override\r
	public String toString() {\r
		return "[FilterView]"; //$NON-NLS-1$\r
	}	\r
\r
	\r
    /**\r
     * Builds the menu toolbar\r
     */\r
	private void contributeToActionBars() {\r
		IActionBars bars = getViewSite().getActionBars();\r
		//fillLocalPullDown(bars.getMenuManager());\r
		fillLocalToolBar(bars.getToolBarManager());\r
	}\r
\r
	\r
	/**\r
	 * Build the popup menu\r
	 * \r
	 * @param manager The manager to build\r
	 */\r
	private void fillLocalToolBar(IToolBarManager manager) {\r
		\r
		fSaveAction = new SaveAction();\r
		fSaveAction.setImageDescriptor(ImageDescriptor.createFromImage(SAVE_IMAGE));\r
		fSaveAction.setToolTipText(Messages.FilterView_SaveActionToolTipText);\r
		\r
		fAddAction = new AddAction();\r
		fAddAction.setImageDescriptor(ImageDescriptor.createFromImage(ADD_IMAGE));\r
		fAddAction.setToolTipText(Messages.FilterView_AddActionToolTipText);	\r
\r
		fDeleteAction = new DeleteAction();\r
		fDeleteAction.setImageDescriptor(ImageDescriptor.createFromImage(DELETE_IMAGE));\r
		fDeleteAction.setToolTipText(Messages.FilterView_DeleteActionToolTipText);\r
		fDeleteAction.setEnabled(false);\r
\r
		fExportAction = new ExportAction();\r
		fExportAction.setImageDescriptor(ImageDescriptor.createFromImage(EXPORT_IMAGE));\r
		fExportAction.setToolTipText(Messages.FilterView_ExportActionToolTipText);\r
\r
		fImportAction = new ImportAction();\r
		fImportAction.setImageDescriptor(ImageDescriptor.createFromImage(IMPORT_IMAGE));\r
		fImportAction.setToolTipText(Messages.FilterView_ImportActionToolTipText);\r
\r
		manager.add(fSaveAction);\r
		manager.add(new Separator());\r
		manager.add(fAddAction);\r
		manager.add(fDeleteAction);\r
		manager.add(new Separator());\r
		manager.add(fExportAction);\r
		manager.add(fImportAction);\r
	}\r
\r
	private class SaveAction extends Action {\r
		@Override\r
		public void run() {\r
			FilterManager.setSavedFilters(fRoot.getChildren());\r
		}\r
	}\r
	\r
	private class AddAction extends Action {\r
		@Override\r
		public void run() {\r
			\r
			TmfFilterNode newNode = new TmfFilterNode(fRoot, ""); //$NON-NLS-1$\r
			refresh();\r
			setSelection(newNode);\r
		}\r
	}\r
	\r
	private class DeleteAction extends Action {\r
		@Override\r
		public void run() {\r
			ITmfFilterTreeNode node = fViewer.getSelection();\r
			if (node != null) {\r
				node.remove();\r
			}\r
			refresh();\r
		}\r
	}\r
	\r
	private class ExportAction extends Action {\r
		@Override\r
		public void run() {\r
			try {\r
				FileDialog dlg = new FileDialog(new Shell(), SWT.SAVE);\r
				dlg.setFilterNames(new String[] {Messages.FilterView_FileDialogFilterName + " (*.filter.xml)"}); //$NON-NLS-1$\r
				dlg.setFilterExtensions(new String[] {"*.filter.xml"}); //$NON-NLS-1$\r
				\r
				String fn = dlg.open();\r
		        if (fn != null) {\r
					TmfFilterXMLWriter writerXML = new TmfFilterXMLWriter(fRoot);\r
					writerXML.saveTree(fn);\r
		        }\r
				\r
			} catch (ParserConfigurationException e) {\r
				e.printStackTrace();\r
			} catch (IOException e) {\r
				e.printStackTrace();\r
			}\r
		}\r
	}\r
	\r
	private class ImportAction extends Action {\r
		@Override\r
		public void run() {\r
			if (fViewer != null) {\r
				ITmfFilterTreeNode root = null;\r
				try {\r
					FileDialog dlg = new FileDialog(new Shell(), SWT.OPEN);\r
					dlg.setFilterNames(new String[] {Messages.FilterView_FileDialogFilterName + " (*.filter.xml)"}); //$NON-NLS-1$\r
					dlg.setFilterExtensions(new String[] {"*.filter.xml"}); //$NON-NLS-1$\r
					\r
					TmfFilterXMLParser parserXML = null;\r
					String fn = dlg.open();\r
			        if (fn != null) {\r
			        	parserXML = new TmfFilterXMLParser(fn);\r
						root = parserXML.getTree();\r
			        }\r
					\r
				} catch (SAXException e) {\r
					e.printStackTrace();\r
				} catch (IOException e) {\r
					e.printStackTrace();\r
				}\r
\r
				if (root != null) {\r
    				for (ITmfFilterTreeNode node : root.getChildren()) {\r
    					if (node instanceof TmfFilterNode) {\r
    						fRoot.addChild(node);\r
    						refresh();\r
    						fViewer.setSelection(node);\r
    					}\r
    				}\r
				}\r
			}\r
		}\r
	}\r
	\r
}