/*******************************************************************************
 * Copyright (c) 2004, 2005 Actuate Corporation.
 * 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:
 *  Actuate Corporation  - initial API and implementation
 *******************************************************************************/

package org.eclipse.birt.report.designer.data.ui.dataset;

import org.eclipse.birt.report.designer.data.ui.util.IHelpConstants;
import org.eclipse.birt.report.designer.data.ui.util.Utility;
import org.eclipse.birt.report.designer.nls.Messages;
import org.eclipse.birt.report.model.core.Structure;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.dialogs.StatusDialog;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.KeyListener;
import org.eclipse.swt.events.ShellEvent;
import org.eclipse.swt.events.ShellListener;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.ui.PlatformUI;

/**
 * 
 */

abstract class PropertyHandleInputDialog extends StatusDialog
{

	private Object structureOrHandle = null;

	private static final String NEW_ACTION = Messages.getString( "PropertyHandleInputDialog.Action.New" );//$NON-NLS-1$
	private static final String EDIT_ACTION = Messages.getString( "PropertyHandleInputDialog.Action.Edit" );//$NON-NLS-1$

	protected PropertyHandleInputDialog( Object structureOrHandle )
	{
		super( PlatformUI.getWorkbench( ).getDisplay( ).getActiveShell( ) );

		this.structureOrHandle = structureOrHandle;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.window.Window#create()
	 */
	public void create( )
	{
		super.create( );

		Point pt = getShell( ).computeSize( -1, -1 );
		pt.x = Math.max( pt.x, 400 );
		pt.y = Math.max( pt.y, 200 );
		getShell( ).setSize( pt );
		getShell( ).setText( getTitle( ) );
	}

	protected String getTitle( )
	{
		return structureOrHandle instanceof Structure ? NEW_ACTION
				: EDIT_ACTION;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.dialogs.Dialog#createDialogArea(org.eclipse.swt.widgets.Composite)
	 */
	protected Control createDialogArea( Composite parent )
	{
		Composite composite = (Composite) super.createDialogArea( parent );
		GridLayout layout = new GridLayout( 3, false );
		layout.marginHeight = 10;
		layout.marginWidth = 10;
		composite.setLayout( layout );

		createCustomControls( composite );
		validateSyntax( );

		addListeners(  );
		Utility.setSystemHelp( composite,
				IHelpConstants.CONEXT_ID_PROPERTYHANDLE_DIALOG );

		return composite;
	}

	/**
	 * Create customized controls
	 * 
	 * @param parent
	 */
	protected abstract void createCustomControls( Composite parent );

	protected void validateSyntax( )
	{
		IStatus status = validateSyntax( structureOrHandle );

		if ( status != null )
			updateStatus( status );
	}

	/**
	 * Syntax check which determines whether to enable the Ok button
	 * 
	 * @param structureOrHandle
	 * @return
	 */
	protected abstract IStatus validateSyntax( Object structureOrHandle );
	
	private void addListeners( )
	{
		getShell( ).addListener( SWT.Close, new Listener( ) {

			public void handleEvent( Event event )
			{
				rollback( );
			}
		} );
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.dialogs.Dialog#okPressed()
	 */
	protected void okPressed( )
	{
		if ( validateSemantics( ) )
			super.okPressed( );
	}

	protected boolean validateSemantics( )
	{
		IStatus status = validateSemantics( structureOrHandle );

		if ( status == null )
			return true;

		updateStatus( status );

		return status.getSeverity( ) == IStatus.OK;
	}

	/**
	 * Semantics check which determines whether to close the window
	 * 
	 * @param structureOrHandle
	 * @return
	 */
	protected abstract IStatus validateSemantics( Object structureOrHandle );

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.dialogs.Dialog#cancelPressed()
	 */
	protected void cancelPressed( )
	{
		rollback( );

		super.cancelPressed( );
	}

	/**
	 * Roll back to the original status when necessary.
	 * 
	 */
	protected abstract void rollback( );

	protected Object getStructureOrHandle( )
	{
		return structureOrHandle;
	}

	protected Status getBlankPropertyStatus( String cellLabel )
	{
		return new Status( IStatus.ERROR,
				PlatformUI.PLUGIN_ID,
				IStatus.OK,
				Messages.getFormattedString( "PropertyHandleInputDialog.messages.error.blankProperty",//$NON-NLS-1$
						new String[]{
							cellLabel
						} ),
				null );
	}

}
