// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

package com.symbian.smt.gui.smtwidgets.resources;

import java.util.ArrayList;

import java.util.HashMap;

import org.eclipse.jface.viewers.CheckStateChangedEvent;

import org.eclipse.jface.viewers.CheckboxTableViewer;

import org.eclipse.jface.viewers.ICheckStateListener;

import org.eclipse.jface.viewers.ILabelProvider;

import org.eclipse.jface.viewers.ILabelProviderListener;

import org.eclipse.jface.viewers.ISelectionChangedListener;

import org.eclipse.jface.viewers.IStructuredContentProvider;

import org.eclipse.jface.viewers.IStructuredSelection;

import org.eclipse.jface.viewers.ITableLabelProvider;

import org.eclipse.jface.viewers.ListViewer;

import org.eclipse.jface.viewers.SelectionChangedEvent;

import org.eclipse.jface.viewers.StructuredSelection;

import org.eclipse.jface.viewers.Viewer;

import org.eclipse.swt.SWT;

import org.eclipse.swt.custom.SashForm;

import org.eclipse.swt.events.SelectionAdapter;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.graphics.Image;

import org.eclipse.swt.layout.FillLayout;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.layout.RowData;

import org.eclipse.swt.layout.RowLayout;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Label;

import org.eclipse.swt.widgets.List;

import org.eclipse.swt.widgets.Table;

import com.symbian.smt.gui.Helper;

import com.symbian.smt.gui.ResourcesEnums;

public class ResourcesWidget extends Composite {

	/**

	 * This is the content provider for the list of resource types.

	 * 

	 * @author barbararosi-schwartz

	 */

	private class ResourceFilesContentProvider implements

			IStructuredContentProvider {

		public void dispose() {

		}

		@SuppressWarnings("unchecked")

		public Object[] getElements(Object inputElement) {

			return ResourcesWidgetHelper

					.toArrayOfCheckableResourceFilenames((java.util.List<CheckableResourceFilename>) inputElement);

		}

		public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {

		}

	}

	/**

	 * This is the label provider for the list of of resource types.

	 * 

	 * @author barbararosi-schwartz

	 */

	private class ResourceFilesLabelProvider implements ITableLabelProvider {

		public void addListener(ILabelProviderListener listener) {

		}

		public void dispose() {

		}

		public Image getColumnImage(Object element, int columnIndex) {

			return null;

		}

		public String getColumnText(Object element, int columnIndex) {

			CheckableResourceFilename crf = (CheckableResourceFilename) element;

			return (columnIndex == 0) ? crf.getFilename() : null;

		}

		public boolean isLabelProperty(Object element, String property) {

			return false;

		}

		public void removeListener(ILabelProviderListener listener) {

		}

	}

	/**

	 * This is the content provider for the list of resource types.

	 * 

	 * @author barbararosi-schwartz

	 */

	private class ResourceTypesContentProvider implements

			IStructuredContentProvider {

		public void dispose() {

		}

		public Object[] getElements(Object inputElement) {

			return (ResourcesEnums[]) inputElement;

		}

		public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {

		}

	}

	/**

	 * This is the label provider for the list of of resource types.

	 * 

	 * @author barbararosi-schwartz

	 */

	private class ResourceTypesLabelProvider implements ILabelProvider {

		public void addListener(ILabelProviderListener listener) {

		}

		public void dispose() {

		}

		public Image getImage(Object element) {

			return null;

		}

		public String getText(Object element) {

			return ((ResourcesEnums) element).arg();

		}

		public boolean isLabelProperty(Object element, String property) {

			return false;

		}

		public void removeListener(ILabelProviderListener listener) {

		}

	}

	/**

	 * The Map that caches all defined resource files, keyed by the

	 * ResourcesEnums enums.

	 */

	private final HashMap<ResourcesEnums, java.util.List<CheckableResourceFilename>> resourceFilesMap = new HashMap<ResourcesEnums, java.util.List<CheckableResourceFilename>>();

	/**

	 * The viewer associated with the Resource Files List widget.

	 */

	private CheckboxTableViewer resourceFilesViewer;

	/**

	 * The viewer associated with the Resource Types List widget.

	 */

	private ListViewer resourceTypesViewer;

	/**

	 * Creates a ResourcesWidget composite object

	 * 

	 * @return void

	 */

	public ResourcesWidget(final Composite parent, int style) {

		super(parent, style);

		initialiseMaps();

		this.setLayout(new FillLayout());

		// The Composite that contains all widgets

		final Composite gridLayoutComposite = new Composite(this, SWT.NONE);

		final GridLayout gridLayout = new GridLayout();

		gridLayout.numColumns = 1;

		gridLayoutComposite.setLayout(gridLayout);

		// The SashForm that contains the resource types and resource files

		// widgets

		// side by side

		SashForm sash = new SashForm(gridLayoutComposite, SWT.HORIZONTAL);

		GridData gd = new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1);

		sash.setLayoutData(gd);

		createResourceTypesComposite(sash);

		createResourceFilesComposite(sash);

		sash.setWeights(new int[] { 30, 70 });

		createButtonsComposite(gridLayoutComposite);

	}

	private void addAddResourceButton(Composite parent) {

		// The "Add" button

		final Button addResourceFileButton = new Button(parent, SWT.NONE);

		RowData rd = new RowData();

		rd.width = 75;

		addResourceFileButton.setLayoutData(rd);

		// The action that backs the "Add" button

		final AddResourceFileAction addResourceFileAction = new AddResourceFileAction(

				addResourceFileButton, resourceFilesViewer, resourceFilesMap,

				resourceTypesViewer);

		// When button is pressed, listener invokes the action's run() method,

		// then ensures that the newly added file is checked, guaranteeing that

		// all rules around multiple checked files are respected.

		// Finally refreshes the List of assigned options and set the selection

		// appropriately.

		// If the newly added file failed validation during the action's run()

		// method,

		// none of the operations above is taken and all is left as it was prior

		// to

		// the request to add a new file.

		addResourceFileButton.addSelectionListener(new SelectionAdapter() {

			public void widgetSelected(final SelectionEvent e) {

				addResourceFileAction.run();

				resourceFilesViewer.refresh();

				String newFileLocation = addResourceFileAction

						.getNewFileLocation();

				// newFile could be null if an error was detected in the

				// validations

				// performed in the action's run() method.

				if (newFileLocation != null) {

					ResourcesEnums type = ResourcesWidgetHelper

							.getSelectedResourceType(resourceTypesViewer);

					CheckableResourceFilename crf = ResourcesWidgetHelper

							.filename2checkableFilename(newFileLocation, type,

									resourceFilesMap);

					handleMultipleCheckRules(crf);

					StructuredSelection oldSel = (StructuredSelection) resourceFilesViewer

							.getSelection();

					StructuredSelection newSel = (newFileLocation == null) ? oldSel

							: new StructuredSelection(newFileLocation);

					resourceFilesViewer.setSelection(newSel);

				}

			}

		});

	}

	private void addMoveDownResourceButton(Composite parent) {

		// The "Move Down" button

		final Button moveResourceFileDownButton = new Button(parent, SWT.NONE);

		RowData rd = new RowData();

		rd.width = 75;

		moveResourceFileDownButton.setLayoutData(rd);

		// The action that backs the "Move Down" button

		final MoveResourceFileDownAction moveResourceFileDownAction = new MoveResourceFileDownAction(

				moveResourceFileDownButton, resourceFilesViewer,

				resourceFilesMap, resourceTypesViewer);

		// When button is pressed, listener invokes the action's run() method,

		// then refreshes the List of assigned options and set the selection

		// appropriately

		moveResourceFileDownButton.addSelectionListener(new SelectionAdapter() {

			public void widgetSelected(final SelectionEvent e) {

				moveResourceFileDownAction.run();

				resourceFilesViewer.refresh();

				StructuredSelection newSel = new StructuredSelection(

						moveResourceFileDownAction.getMovedCheckableFilename());

				resourceFilesViewer.setSelection(newSel);

			}

		});

	}

	private void addMoveUpResourceButton(Composite parent) {

		// The "Move Up" button

		final Button moveResourceFileUpButton = new Button(parent, SWT.NONE);

		RowData rd = new RowData();

		rd.width = 75;

		moveResourceFileUpButton.setLayoutData(rd);

		// The action that backs the "Move Up" button

		final MoveResourceFileUpAction moveResourceFileUpAction = new MoveResourceFileUpAction(

				moveResourceFileUpButton, resourceFilesViewer,

				resourceFilesMap, resourceTypesViewer);

		// When button is pressed, listener invokes the action's run() method,

		// then refreshes the List of assigned options and set the selection

		// appropriately

		moveResourceFileUpButton.addSelectionListener(new SelectionAdapter() {

			public void widgetSelected(final SelectionEvent e) {

				moveResourceFileUpAction.run();

				resourceFilesViewer.refresh();

				StructuredSelection newSel = new StructuredSelection(

						moveResourceFileUpAction.getMovedCheckableFilename());

				resourceFilesViewer.setSelection(newSel);

			}

		});

	}

	private void addRemoveResourceButton(Composite parent) {

		// The "Remove" button

		final Button removeResourceFileButton = new Button(parent, SWT.NONE);

		RowData rd = new RowData();

		rd.width = 75;

		removeResourceFileButton.setLayoutData(rd);

		// The action that backs the "Remove" button

		final RemoveResourceFileAction removeResourceFileAction = new RemoveResourceFileAction(

				removeResourceFileButton, resourceFilesViewer,

				resourceFilesMap, resourceTypesViewer);

		// When button is pressed, listener invokes the action's run() method,

		// then refreshes the List of assigned options and set the selection

		// appropriately

		removeResourceFileButton.addSelectionListener(new SelectionAdapter() {

			public void widgetSelected(SelectionEvent e) {

				removeResourceFileAction.run();

				resourceFilesViewer.refresh();

				Object firstElement = resourceFilesViewer.getElementAt(0);

				StructuredSelection ssel = (firstElement == null) ? new StructuredSelection(

						StructuredSelection.EMPTY)

						: new StructuredSelection(firstElement);

				resourceFilesViewer.setSelection(ssel);

			}

		});

	}

	private void checkFilesInResourceFilesTable(String[] filenames,

			ResourcesEnums resourceType) {

		if (filenames == null) {

			throw new IllegalArgumentException(

					"Argument filenames cannot be null.");

		}

		java.util.List<String> listOfFilenames = Helper

				.toListOfStrings(filenames);

		java.util.List<CheckableResourceFilename> checkableFilenames = resourceFilesMap

				.get(resourceType);

		if (checkableFilenames == null) {

			throw new IllegalArgumentException(

					"Could not find any elements of type [" + resourceType

							+ "] in resourceFilesMap.");

		}

		CheckableResourceFilename[] viewerElementsToBeChecked = new CheckableResourceFilename[filenames.length];

		int i = 0;

		for (String filename : listOfFilenames) {

			CheckableResourceFilename checkableFilename = ResourcesWidgetHelper

					.filename2checkableFilename(filename, resourceType,

							resourceFilesMap);

			checkableFilename.setChecked(true);

			viewerElementsToBeChecked[i] = checkableFilename;

			i++;

		}

		IStructuredSelection ssel = (IStructuredSelection) resourceTypesViewer.getSelection();

		if (!ssel.isEmpty()) {

			ResourcesEnums selectedType = (ResourcesEnums) ssel.getFirstElement();

			if (selectedType.equals(resourceType)) {

				resourceFilesViewer.setCheckedElements(viewerElementsToBeChecked);

			}

		}

	}

	private void createButtonsComposite(Composite parent) {

		// The Composite that contains all buttons in a horizontal stack

		final Composite buttonsComposite = new Composite(parent, SWT.NONE);

		final RowLayout rowLayout = new RowLayout(SWT.HORIZONTAL);

		rowLayout.spacing = 5;

		rowLayout.wrap = false;

		rowLayout.fill = true;

		buttonsComposite.setLayout(rowLayout);

		GridData gd = new GridData(SWT.BEGINNING, SWT.BEGINNING, true, false,

				1, 1);

		buttonsComposite.setLayoutData(gd);

		addAddResourceButton(buttonsComposite);

		addRemoveResourceButton(buttonsComposite);

		addMoveUpResourceButton(buttonsComposite);

		addMoveDownResourceButton(buttonsComposite);

	}

	private void createResourceFilesComposite(SashForm sash) {

		// The Composite that contains the resource files table, along with a

		// label

		Composite resourceFilesComposite = new Composite(sash, SWT.NONE);

		GridData gd = new GridData(SWT.BEGINNING, SWT.FILL, false, true, 1, 1);

		resourceFilesComposite.setLayoutData(gd);

		resourceFilesComposite.setLayout(new GridLayout());

		Label label = new Label(resourceFilesComposite, SWT.NONE);

		gd = new GridData(SWT.BEGINNING, SWT.BEGINNING, false, false, 1, 1);

		label.setLayoutData(gd);

		label.setText("Resource Files");

		// The Table that contains all assigned resource files for the selected

		// resource type

		final Table table = new Table(resourceFilesComposite, SWT.BORDER

				| SWT.H_SCROLL | SWT.V_SCROLL | SWT.MULTI | SWT.CHECK

				| SWT.FULL_SELECTION);

		gd = new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1);

		table.setLayoutData(gd);

		// The resource type viewer associated with the list

		resourceFilesViewer = new CheckboxTableViewer(table);

		resourceFilesViewer

				.setContentProvider(new ResourceFilesContentProvider());

		resourceFilesViewer.setLabelProvider(new ResourceFilesLabelProvider());

		resourceFilesViewer.addCheckStateListener(new ICheckStateListener() {

			// When the user changed the checked state of the checkbox in the

			// table, set

			// or unset the isChecked attribute in the corresponding

			// CheckableResourceFilename object

			public void checkStateChanged(CheckStateChangedEvent event) {

				CheckableResourceFilename checkableFilename = (CheckableResourceFilename) event

						.getElement();

				boolean isSelected = event.getChecked();

				if (isSelected) {

					handleMultipleCheckRules(checkableFilename);

				} else {

					handleNoCheckRules(checkableFilename);

				}

			}

		});

	}

	private void createResourceTypesComposite(SashForm sash) {

		// The Composite that contains the resource types list, along with a

		// label

		Composite resourceTypesComposite = new Composite(sash, SWT.NONE);

		GridData gd = new GridData(SWT.BEGINNING, SWT.FILL, false, true, 1, 1);

		resourceTypesComposite.setLayoutData(gd);

		resourceTypesComposite.setLayout(new GridLayout());

		Label l = new Label(resourceTypesComposite, SWT.NONE);

		gd = new GridData(SWT.BEGINNING, SWT.BEGINNING, false, false, 1, 1);

		l.setLayoutData(gd);

		l.setText("Resource Types");

		// The List that contains all possible resource types

		final List list = new List(resourceTypesComposite, SWT.BORDER

				| SWT.H_SCROLL | SWT.V_SCROLL | SWT.SINGLE);

		gd = new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1);

		list.setLayoutData(gd);

		// The resource type viewer associated with the list

		resourceTypesViewer = new ListViewer(list);

		resourceTypesViewer

				.setContentProvider(new ResourceTypesContentProvider());

		resourceTypesViewer.setLabelProvider(new ResourceTypesLabelProvider());

		resourceTypesViewer.setInput(ResourcesEnums.values());

		resourceTypesViewer

				.addSelectionChangedListener(new ISelectionChangedListener() {

					public void selectionChanged(SelectionChangedEvent event) {

						IStructuredSelection ssel = (IStructuredSelection) event

								.getSelection();

						if (ssel.isEmpty()) {

							return;

						}

						ResourcesEnums selectedType = (ResourcesEnums) ssel.getFirstElement();

						resourceFilesViewer.setInput(ResourcesWidgetHelper

								.getCheckableResourceFilenames(selectedType,

										resourceFilesMap));

						resourceFilesViewer

								.setCheckedElements(ResourcesWidgetHelper

										.getCheckedResourceFilenames(

												selectedType, resourceFilesMap));

					}

				});

	}

	@Override

	public void dispose() {

		resourceFilesMap.clear();

		super.dispose();

	}

	/**

	 * Returns the shapes file or an empty string if no shapes file has been

	 * specified

	 * 

	 * @return String

	 */

	public String[] getBorderShapesFiles() {