/*****************************************************************************
 * Copyright (c) 2011 CEA LIST.
 *    
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *  Camille Letavernier (CEA LIST) camille.letavernier@cea.fr - Initial API and implementation
 *****************************************************************************/
package org.eclipse.papyrus.infra.widgets.creation;

import java.util.Collection;

import org.eclipse.jface.dialogs.IInputValidator;
import org.eclipse.jface.window.Window;
import org.eclipse.papyrus.infra.widgets.editors.InputDialog;
import org.eclipse.papyrus.infra.widgets.messages.Messages;
import org.eclipse.papyrus.infra.widgets.providers.IStaticContentProvider;
import org.eclipse.swt.widgets.Control;

/**
 * A ValueFactory for editing Strings
 * 
 * @author Camille Letavernier
 * 
 */
public class StringEditionFactory implements ReferenceValueFactory {

	private String title = Messages.StringEditionFactory_EnterANewValue;

	private String label = Messages.StringEditionFactory_EnterANewValue;

	private IInputValidator validator;

	private IStaticContentProvider contentProvider;

	/**
	 * 
	 * Constructor.
	 * 
	 */
	public StringEditionFactory() {
	}

	/**
	 * 
	 * Constructor.
	 * 
	 * @param title
	 *        The title of the dialog opened by this factory when editing a String
	 * @param label
	 *        The Label used to describe the kind of value being edited
	 */
	public StringEditionFactory(String title, String label) {
		this.title = title;
		this.label = label;
	}

	/**
	 * 
	 * Constructor.
	 * 
	 * @param validator
	 *        The InputValidator used to check the entered String
	 */
	public StringEditionFactory(IInputValidator validator) {
		this.validator = validator;
	}

	/**
	 * 
	 * Constructor.
	 * 
	 * @param title
	 *        The title of the dialog opened by this factory when editing a String
	 * @param label
	 *        The Label used to describe the kind of value being edited
	 * @param validator
	 *        The validator used to check the Strings being edited
	 */
	public StringEditionFactory(String title, String label, IInputValidator validator) {
		this.title = title;
		this.label = label;
		this.validator = validator;
	}

	public boolean canCreateObject() {
		return true;
	}

	public Object createObject(Control widget) {
		InputDialog dialog = new InputDialog(widget.getShell(), title, label, "", validator); //$NON-NLS-1$
		if(contentProvider != null) {
			dialog.setContentProvider(contentProvider);
		}

		int result = dialog.open();
		if(result == Window.OK) {
			String newValue = dialog.getText();
			return newValue;
		}

		return null;
	}

	public Collection<Object> validateObjects(Collection<Object> objectsToValidate) {
		return objectsToValidate;
	}

	public boolean canEdit() {
		return true;
	}

	public Object edit(Control widget, Object object) {
		if(!(object instanceof String)) {
			return object;
		}

		InputDialog dialog = new InputDialog(widget.getShell(), title, label, (String)object, validator);
		if(contentProvider != null) {
			dialog.setContentProvider(contentProvider);
		}

		int result = dialog.open();
		if(result == Window.OK) {
			String newValue = dialog.getText();
			return newValue;
		}

		return object;
	}

	/**
	 * Sets the Validator for this factory
	 * 
	 * @param validator
	 *        The InputValidator to be used to check the input String
	 */
	public void setValidator(IInputValidator validator) {
		this.validator = validator;
	}

	/**
	 * Sets the content provider for this edition factory. The ContentProvider is used
	 * to suggest values to the user.
	 * 
	 * @param provider
	 *        The provider which will make suggestions to the user
	 */
	public void setContentProvider(IStaticContentProvider provider) {
		this.contentProvider = provider;
	}
}