/******************************************************************************
* Copyright (c) 2016 Oracle
* 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:
* Konstantin Komissarchik - initial implementation and ongoing maintenance
******************************************************************************/
package org.eclipse.sapphire.ui.forms.swt;
import static org.eclipse.sapphire.ui.forms.swt.SwtUtil.toImageDescriptor;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.wizard.IWizard;
import org.eclipse.jface.wizard.IWizardContainer;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.sapphire.Disposable;
import org.eclipse.sapphire.Element;
import org.eclipse.sapphire.ElementType;
import org.eclipse.sapphire.Event;
import org.eclipse.sapphire.ExecutableElement;
import org.eclipse.sapphire.FilteredListener;
import org.eclipse.sapphire.Listener;
import org.eclipse.sapphire.LoggingService;
import org.eclipse.sapphire.Sapphire;
import org.eclipse.sapphire.modeling.ProgressMonitor;
import org.eclipse.sapphire.modeling.Status;
import org.eclipse.sapphire.ui.DelayedTasksExecutor;
import org.eclipse.sapphire.ui.PartVisibilityEvent;
import org.eclipse.sapphire.ui.SapphirePart.ImageChangedEvent;
import org.eclipse.sapphire.ui.SapphirePart.LabelChangedEvent;
import org.eclipse.sapphire.ui.def.DefinitionLoader;
import org.eclipse.sapphire.ui.forms.WizardDef;
import org.eclipse.sapphire.ui.forms.WizardPagePart;
import org.eclipse.sapphire.ui.forms.WizardPart;
import org.eclipse.sapphire.ui.forms.swt.internal.ProgressMonitorBridge;
import org.eclipse.sapphire.ui.forms.swt.internal.StatusDialog;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.ide.IDE;
/**
* @author <a href="mailto:konstantin.komissarchik@oracle.com">Konstantin Komissarchik</a>
*/
public class SapphireWizard<M extends Element> implements IWizard, Disposable
{
private Element element;
private boolean elementInstantiatedLocally;
private DefinitionLoader.Reference<WizardDef> definition;
private WizardPart part;
private Map<WizardPagePart,SapphireWizardPage> pages;
private IWizardContainer container;
private ImageDescriptor defaultPageImageDescriptor;
private Image defaultPageImage;
/**
* Constructs a new SapphireWizard instance. Use WizardDialog actually open the wizard.
*
* <p>The model will be instantiated when the wizard is constructed and disposed when the wizard is disposed. To avoid
* resource leaks, the wizard's dispose method must be called if this constructor is used.</p>
*
* @param shell the shell
* @param type the root model element type
* @param definition the wizard definition
*/
public SapphireWizard( final ElementType type, final DefinitionLoader.Reference<WizardDef> definition )
{
init( type, definition );
}
/**
* Constructs a new SapphireWizard instance. Use WizardDialog actually open the wizard.
*
* @param shell the shell
* @param element the root model element
* @param definition the wizard definition
*/
public SapphireWizard( final M element, final DefinitionLoader.Reference<WizardDef> definition )
{
init( element, definition );
}
protected SapphireWizard()
{
}
/**
* Initializes the wizard. This method is called from the constructors. It can be overridden by extenders.
*
* @param type the root model element type
* @param definition the wizard definition
*/
protected void init( final ElementType type, final DefinitionLoader.Reference<WizardDef> definition )
{
if( type == null )
{
throw new IllegalArgumentException();
}
this.elementInstantiatedLocally = true;
init( (Element) type.instantiate(), definition );
}
/**
* Initializes the wizard. This method is called from the constructors. It can be overridden by extenders.
*
* @param element the root model element
* @param definition the wizard definition
*/
protected void init( final Element element, final DefinitionLoader.Reference<WizardDef> definition )
{
if( element == null )
{
throw new IllegalArgumentException();
}
if( definition == null )
{
throw new IllegalArgumentException();
}
this.element = element;
this.definition = definition;
this.part = new WizardPart();
this.part.init( null, this.element, this.definition.resolve(), Collections.<String,String>emptyMap() );
this.part.initialize();
this.part.attach
(
new Listener()
{
@Override
public void handle( final Event event )
{
if( event instanceof ImageChangedEvent )
{
refreshImage();
}
else if( event instanceof LabelChangedEvent )
{
refreshTitle();
}
}
}
);
this.pages = new LinkedHashMap<WizardPagePart,SapphireWizardPage>();
final Listener pageVisibilityListener = new FilteredListener<PartVisibilityEvent>()
{
@Override
protected void handleTypedEvent( final PartVisibilityEvent event )
{
getContainer().updateButtons();
}
};
for( final WizardPagePart page : this.part.getPages() )
{
page.attach( pageVisibilityListener );
this.pages.put( page, null );
}
refreshImage();
}
@SuppressWarnings( "unchecked" )
public final M element()
{
return (M) this.element;
}
public final WizardDef definition()
{
return ( this.definition == null ? null : this.definition.resolve() );
}
/**
* Returns the corresponding part.
*
* @return the corresponding part
*/
public final WizardPart part()
{
return this.part;
}
/**
* Returns the wizard pages. Can be overridden to add custom pages.
*
* @return the wizard pages
*/
@Override
public IWizardPage[] getPages()
{
final List<IWizardPage> result = new ArrayList<IWizardPage>();
for( final WizardPagePart wizardPagePart : this.pages.keySet() )
{
if( wizardPagePart.visible() )
{
SapphireWizardPage wizardPagePresentation = this.pages.get( wizardPagePart );
if( wizardPagePresentation == null )
{
wizardPagePresentation = new SapphireWizardPage( wizardPagePart );
wizardPagePresentation.setWizard( this );
this.pages.put( wizardPagePart, wizardPagePresentation );
}
result.add( wizardPagePresentation );
}
}
return result.toArray( new IWizardPage[ result.size() ] );
}
@Override
public final int getPageCount()
{
return getPages().length;
}
@Override
public final IWizardPage getPage( final String name )
{
if( name == null )
{
throw new IllegalArgumentException();
}
for( final IWizardPage page : getPages() )
{
if( name.equals( page.getName() ) )
{
return page;
}
}
return null;
}
@Override
public final IWizardPage getStartingPage()
{
final IWizardPage[] pages = getPages();
if( pages.length > 0 )
{
return pages[ 0 ];
}
return null;
}
@Override
public final IWizardPage getNextPage( final IWizardPage page )
{
boolean captureNextPage = false;
for( final IWizardPage p : getPages() )
{
if( captureNextPage )
{
return p;
}
else if( p == page )
{
captureNextPage = true;
}
}
return null;
}
@Override
public final IWizardPage getPreviousPage( final IWizardPage page )
{
IWizardPage previous = null;
for( final IWizardPage p : getPages() )
{
if( p == page )
{
break;
}
else
{
previous = p;
}
}
return previous;
}
@Override
public final void addPages()
{
}
@Override
public final boolean canFinish()
{
for( final IWizardPage p : getPages() )
{
if( ! p.isPageComplete() )
{
return false;
}
}
return true;
}
@Override
public final boolean performFinish()
{
DelayedTasksExecutor.sweep();
if( ! canFinish() )
{
return false;
}
final Status[] result = new Status[ 1 ];
final IRunnableWithProgress runnable = new IRunnableWithProgress()
{
public void run( final IProgressMonitor monitor ) throws InvocationTargetException
{
result[ 0 ] = performFinish( ProgressMonitorBridge.create( monitor ) );
}
};
try
{
getContainer().run( true, true, runnable );
}
catch( InvocationTargetException e )
{
Sapphire.service( LoggingService.class ).log( e.getTargetException() );
return false;
}
catch( InterruptedException e )
{
return false;
}
final Status st = result[ 0 ];
if( st.severity() == Status.Severity.ERROR )
{
return handleFinishFailure( st );
}
else
{
performPostFinish();
return true;
}
}
protected Status performFinish( final ProgressMonitor monitor )
{
if( this.element instanceof ExecutableElement )
{
return ( (ExecutableElement) this.element ).execute( monitor );
}
return Status.createOkStatus();
}
protected void performPostFinish()
{
// The default implementation doesn't do anything.
}
/**
* Called when the finish operation fails with an error status. The default implementation opens a dialog showing
* the failure message and leaves the wizard open.
*
* @param status the failure status
* @return true, if the wizard should be closed; false, otherwise
*/
protected boolean handleFinishFailure( final Status status )
{
StatusDialog.open( getContainer().getShell(), status );
return false;
}
@Override
public boolean performCancel()
{
return true;
}
@Override
public final IWizardContainer getContainer()
{
return this.container;
}
@Override
public final void setContainer( final IWizardContainer container )
{
this.container = container;
}
@Override
public final Image getDefaultPageImage()
{
if( this.defaultPageImage == null )
{
this.defaultPageImage = JFaceResources.getResources().createImageWithDefault( this.defaultPageImageDescriptor );
}
return this.defaultPageImage;
}
@Override
public final RGB getTitleBarColor()
{
return null;
}
@Override
public final String getWindowTitle()
{
return this.part.getLabel();
}
@Override
public final IDialogSettings getDialogSettings()
{
return null;
}
@Override
public final boolean isHelpAvailable()
{
return false;
}
@Override
public final boolean needsPreviousAndNextButtons()
{
return true;
}
@Override
public final boolean needsProgressMonitor()
{
return true;
}
@Override
public final void createPageControls( final Composite pageContainer )
{
}
protected final void openFileEditors( final IFile... files )
{
final IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
if( window != null )
{
final IWorkbenchPage page = window.getActivePage();
for( IFile file : files )
{
if( file != null && file.isAccessible() )
{
try
{
IDE.openEditor( page, file );
}
catch( PartInitException e )
{
Sapphire.service( LoggingService.class ).log( e );
}
}
}
}
}
protected final void openFileEditor( final IFile file )
{
openFileEditor( file, null );
}
protected final void openFileEditor( final IFile file, final String editor )
{
final IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
if( window != null )
{
final IWorkbenchPage page = window.getActivePage();
try
{
if( editor == null )
{
IDE.openEditor( page, file );
}
else
{
IDE.openEditor( page, file, editor );
IDE.setDefaultEditor( file, editor );
}
}
catch( PartInitException e )
{
Sapphire.service( LoggingService.class ).log( e );
}
}
}
private final void refreshImage()
{
if( this.defaultPageImage != null )
{
JFaceResources.getResources().destroyImage( this.defaultPageImageDescriptor );
this.defaultPageImage = null;
}
this.defaultPageImageDescriptor = toImageDescriptor( this.part.getImage() );
if( this.defaultPageImageDescriptor == null )
{
this.defaultPageImageDescriptor = JFaceResources.getImageRegistry().getDescriptor( Wizard.DEFAULT_IMAGE );
}
}
private final void refreshTitle()
{
final IWizardContainer container = getContainer();
if( container != null )
{
container.updateWindowTitle();
}
}
@Override
public void dispose()
{
if( this.element != null )
{
if( this.elementInstantiatedLocally )
{
this.element.dispose();
}
this.element = null;
}
if( this.part != null )
{
this.part.dispose();
this.part = null;
}
if( this.definition != null )
{
this.definition.dispose();
this.definition = null;
}
if( this.defaultPageImage != null )
{
JFaceResources.getResources().destroyImage( this.defaultPageImageDescriptor );
this.defaultPageImage = null;
}
this.defaultPageImageDescriptor = null;
this.container = null;
this.pages = null;
}
}