/**************************************************************************
* ERA - Eclipse Requirements Analysis
* ==============================================
* Copyright (C) 2009-2013 by Georg Blaschke, Christoph P. Neumann
* and Bernd Haberstumpf (http://era.origo.ethz.ch)
**************************************************************************
* Licensed under the Eclipse Public License - v 1.0 (the "License");
* you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.eclipse.org/org/documents/epl-v10.html
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**************************************************************************
*/
package era.foss.objecteditor;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.EventObject;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceChangeEvent;
import org.eclipse.core.resources.IResourceChangeListener;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.IResourceDeltaVisitor;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.emf.common.command.BasicCommandStack;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.common.command.CommandStack;
import org.eclipse.emf.common.command.CommandStackListener;
import org.eclipse.emf.common.notify.AdapterFactory;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.common.ui.MarkerHelper;
import org.eclipse.emf.common.ui.ViewerPane;
import org.eclipse.emf.common.ui.editor.ProblemEditorPart;
import org.eclipse.emf.common.ui.viewer.IViewerProvider;
import org.eclipse.emf.common.util.BasicDiagnostic;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EValidator;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.util.EContentAdapter;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.emf.edit.domain.AdapterFactoryEditingDomain;
import org.eclipse.emf.edit.domain.EditingDomain;
import org.eclipse.emf.edit.domain.IEditingDomainProvider;
import org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator;
import org.eclipse.emf.edit.provider.ComposedAdapterFactory;
import org.eclipse.emf.edit.provider.ReflectiveItemProviderAdapterFactory;
import org.eclipse.emf.edit.provider.resource.ResourceItemProviderAdapterFactory;
import org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor;
import org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider;
import org.eclipse.emf.edit.ui.provider.AdapterFactoryLabelProvider;
import org.eclipse.emf.edit.ui.util.EditUIMarkerHelper;
import org.eclipse.emf.edit.ui.util.EditUIUtil;
import org.eclipse.emf.edit.ui.view.ExtendedPropertySheetPage;
import org.eclipse.jface.action.IMenuListener;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.IStatusLineManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.dialogs.ProgressMonitorDialog;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.ISelectionProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.events.ControlAdapter;
import org.eclipse.swt.events.ControlEvent;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IEditorSite;
import org.eclipse.ui.IPartListener;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.actions.WorkspaceModifyOperation;
import org.eclipse.ui.dialogs.SaveAsDialog;
import org.eclipse.ui.ide.IGotoMarker;
import org.eclipse.ui.part.FileEditorInput;
import org.eclipse.ui.part.MultiPageEditorPart;
import org.eclipse.ui.part.WorkbenchPart;
import org.eclipse.ui.views.contentoutline.ContentOutline;
import org.eclipse.ui.views.contentoutline.ContentOutlinePage;
import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
import org.eclipse.ui.views.properties.IPropertySheetPage;
import org.eclipse.ui.views.properties.PropertySheet;
import org.eclipse.ui.views.properties.PropertySheetPage;
import era.foss.erf.ERF;
import era.foss.erf.SpecObject;
import era.foss.erf.provider.ErfItemProviderAdapterFactory;
import era.foss.objecteditor.contrib.IAdapterFactoryProvider;
import era.foss.objecteditor.specobject.SpecObjectCompositeViewer;
/**
* This is an example of a Erf model editor.
*/
public class ErfObjectEditor extends MultiPageEditorPart implements IEditingDomainProvider, ISelectionProvider,
IMenuListener, IViewerProvider, IGotoMarker, IAdapterFactoryProvider {
/**
* This keeps track of the editing domain that is used to track all changes to the model.
*/
protected AdapterFactoryEditingDomain editingDomain;
/**
* This is the one adapter factory used for providing views of the model.
*/
protected ComposedAdapterFactory adapterFactory;
/**
* This is the content outline page.
*/
protected IContentOutlinePage contentOutlinePage;
/**
* This is a kludge...
*/
protected IStatusLineManager contentOutlineStatusLineManager;
/**
* This is the content outline page's viewer.
*/
protected TreeViewer contentOutlineViewer;
/**
* This is the property sheet page.
*/
protected PropertySheetPage propertySheetPage;
/**
* This keeps track of the active viewer pane, in the book. <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @generated
*/
protected ViewerPane currentViewerPane;
/**
* This keeps track of the active content viewer, which may be either one of the viewers in the pages or the content
* outline viewer.
*/
protected Viewer currentViewer;
/**
* This listens to which ever viewer is active.
*/
protected ISelectionChangedListener selectionChangedListener;
/**
* This keeps track of all the {@link org.eclipse.jface.viewers.ISelectionChangedListener}s that are listening to
* this editor.
*/
protected Collection<ISelectionChangedListener> selectionChangedListeners = new ArrayList<ISelectionChangedListener>();
/**
* This keeps track of the selection of the editor as a whole.
*/
protected ISelection editorSelection = StructuredSelection.EMPTY;
/**
* The MarkerHelper is responsible for creating workspace resource markers presented in Eclipse's Problems View.
*/
protected MarkerHelper markerHelper = new EditUIMarkerHelper();
/** Job for validation of spec objects. */
protected ErfValidateJob validateJob;
/** This listens for when the outline becomes active <!-- begin-user-doc --> <!-- end-user-doc -->. @generated */
protected IPartListener partListener = new IPartListener() {
public void partActivated( IWorkbenchPart p ) {
if( p instanceof ContentOutline ) {
if( ((ContentOutline)p).getCurrentPage() == contentOutlinePage ) {
getActionBarContributor().setActiveEditor( ErfObjectEditor.this );
setCurrentViewer( contentOutlineViewer );
}
} else if( p instanceof PropertySheet ) {
if( ((PropertySheet)p).getCurrentPage() == propertySheetPage ) {
getActionBarContributor().setActiveEditor( ErfObjectEditor.this );
handleActivate();
}
} else if( p == ErfObjectEditor.this ) {
handleActivate();
}
}
public void partBroughtToTop( IWorkbenchPart p ) {
// Ignore.
}
public void partClosed( IWorkbenchPart p ) {
// Ignore.
}
public void partDeactivated( IWorkbenchPart p ) {
// Ignore.
}
public void partOpened( IWorkbenchPart p ) {
// Ignore.
}
};
/**
* Resources that have been removed since last activation.
*/
protected Collection<Resource> removedResources = new ArrayList<Resource>();
/**
* Resources that have been changed since last activation.
*/
protected Collection<Resource> changedResources = new ArrayList<Resource>();
/**
* Resources that have been saved.
*/
protected Collection<Resource> savedResources = new ArrayList<Resource>();
/**
* Map to store the diagnostic associated with a resource.
*/
protected Map<Resource, Diagnostic> resourceToDiagnosticMap = new LinkedHashMap<Resource, Diagnostic>();
/**
* Controls whether the problem indication should be updated.
*/
protected boolean updateProblemIndication = true;
/** The resource of the ERF file (initialized in {@link #createModel()}). */
protected Resource erfResource;
/** The ERF model (initialized in {@link #createModel()}). */
protected ERF erfModel;
/**
* Adapter used to update the problem indication when resources are demanded loaded.
*/
protected EContentAdapter problemIndicationAdapter = new EContentAdapter() {
@Override
public void notifyChanged( Notification notification ) {
if( notification.getNotifier() instanceof Resource ) {
switch (notification.getFeatureID( Resource.class )) {
case Resource.RESOURCE__IS_LOADED:
case Resource.RESOURCE__ERRORS:
case Resource.RESOURCE__WARNINGS: {
Resource resource = (Resource)notification.getNotifier();
Diagnostic diagnostic = analyzeResourceProblems( resource, null );
if( diagnostic.getSeverity() != Diagnostic.OK ) {
resourceToDiagnosticMap.put( resource, diagnostic );
} else {
resourceToDiagnosticMap.remove( resource );
}
if( updateProblemIndication ) {
getSite().getShell().getDisplay().asyncExec( new Runnable() {
public void run() {
updateProblemIndication();
}
} );
}
break;
}
}
} else {
super.notifyChanged( notification );
}
}
@Override
protected void setTarget( Resource target ) {
basicSetTarget( target );
}
@Override
protected void unsetTarget( Resource target ) {
basicUnsetTarget( target );
}
};
/**
* This listens for workspace changes.
*/
protected IResourceChangeListener resourceChangeListener = new IResourceChangeListener() {
public void resourceChanged( IResourceChangeEvent event ) {
IResourceDelta delta = event.getDelta();
try {
class ResourceDeltaVisitor implements IResourceDeltaVisitor {
protected ResourceSet resourceSet = editingDomain.getResourceSet();
protected Collection<Resource> changedResources = new ArrayList<Resource>();
protected Collection<Resource> removedResources = new ArrayList<Resource>();
public boolean visit( IResourceDelta delta ) {
if( delta.getResource().getType() == IResource.FILE ) {
if( delta.getKind() == IResourceDelta.REMOVED
|| delta.getKind() == IResourceDelta.CHANGED
&& delta.getFlags() != IResourceDelta.MARKERS ) {
Resource resource = resourceSet.getResource( URI.createPlatformResourceURI( delta.getFullPath()
.toString(),
true ),
false );
if( resource != null ) {
if( delta.getKind() == IResourceDelta.REMOVED ) {
removedResources.add( resource );
} else if( !savedResources.remove( resource ) ) {
changedResources.add( resource );
}
}
}
}
return true;
}
public Collection<Resource> getChangedResources() {
return changedResources;
}
public Collection<Resource> getRemovedResources() {
return removedResources;
}
}
final ResourceDeltaVisitor visitor = new ResourceDeltaVisitor();
delta.accept( visitor );
if( !visitor.getRemovedResources().isEmpty() ) {
getSite().getShell().getDisplay().asyncExec( new Runnable() {
public void run() {
removedResources.addAll( visitor.getRemovedResources() );
if( !isDirty() ) {
getSite().getPage().closeEditor( ErfObjectEditor.this, false );
}
}
} );
}
if( !visitor.getChangedResources().isEmpty() ) {
getSite().getShell().getDisplay().asyncExec( new Runnable() {
public void run() {
changedResources.addAll( visitor.getChangedResources() );
if( getSite().getPage().getActiveEditor() == ErfObjectEditor.this ) {
handleActivate();
}
}
} );
}
} catch( CoreException exception ) {
ErfObjectsEditorPlugin.INSTANCE.log( exception );
}
}
};
/**
* Handles activation of the editor or it's associated views.
*/
protected void handleActivate() {
// Recompute the read only state.
//
if( editingDomain.getResourceToReadOnlyMap() != null ) {
editingDomain.getResourceToReadOnlyMap().clear();
// Refresh any actions that may become enabled or disabled.
//
setSelection( getSelection() );
}
if( !removedResources.isEmpty() ) {
if( handleDirtyConflict() ) {
getSite().getPage().closeEditor( ErfObjectEditor.this, false );
} else {
removedResources.clear();
changedResources.clear();
savedResources.clear();
}
} else if( !changedResources.isEmpty() ) {
changedResources.removeAll( savedResources );
handleChangedResources();
changedResources.clear();
savedResources.clear();
}
}
/**
* Handles what to do with changed resources on activation.
*/
protected void handleChangedResources() {
if( !changedResources.isEmpty() && (!isDirty() || handleDirtyConflict()) ) {
if( isDirty() ) {
changedResources.addAll( editingDomain.getResourceSet().getResources() );
}
editingDomain.getCommandStack().flush();
updateProblemIndication = false;
for( Resource resource : changedResources ) {
if( resource.isLoaded() ) {
resource.unload();
try {
resource.load( Collections.EMPTY_MAP );
} catch( IOException exception ) {
if( !resourceToDiagnosticMap.containsKey( resource ) ) {
resourceToDiagnosticMap.put( resource, analyzeResourceProblems( resource, exception ) );
}
}
}
}
if( AdapterFactoryEditingDomain.isStale( editorSelection ) ) {
setSelection( StructuredSelection.EMPTY );
}
updateProblemIndication = true;
updateProblemIndication();
}
}
/**
* Updates the problems indication with the information described in the specified diagnostic.
*/
protected void updateProblemIndication() {
if( updateProblemIndication ) {
BasicDiagnostic diagnostic = new BasicDiagnostic(
Diagnostic.OK,
"era.foss.objecteditor",
0,
null,
new Object[]{editingDomain.getResourceSet()} );
for( Diagnostic childDiagnostic : resourceToDiagnosticMap.values() ) {
if( childDiagnostic.getSeverity() != Diagnostic.OK ) {
diagnostic.add( childDiagnostic );
}
}
int lastEditorPage = getPageCount() - 1;
if( lastEditorPage >= 0 && getEditor( lastEditorPage ) instanceof ProblemEditorPart ) {
((ProblemEditorPart)getEditor( lastEditorPage )).setDiagnostic( diagnostic );
if( diagnostic.getSeverity() != Diagnostic.OK ) {
setActivePage( lastEditorPage );
}
} else if( diagnostic.getSeverity() != Diagnostic.OK ) {
ProblemEditorPart problemEditorPart = new ProblemEditorPart();
problemEditorPart.setDiagnostic( diagnostic );
problemEditorPart.setMarkerHelper( markerHelper );
try {
addPage( ++lastEditorPage, problemEditorPart, getEditorInput() );
setPageText( lastEditorPage, problemEditorPart.getPartName() );
setActivePage( lastEditorPage );
showTabs();
} catch( PartInitException exception ) {
ErfObjectsEditorPlugin.INSTANCE.log( exception );
}
}
if( markerHelper.hasMarkers( editingDomain.getResourceSet() ) ) {
markerHelper.deleteMarkers( editingDomain.getResourceSet() );
if( diagnostic.getSeverity() != Diagnostic.OK ) {
try {
markerHelper.createMarkers( diagnostic );
} catch( CoreException exception ) {
ErfObjectsEditorPlugin.INSTANCE.log( exception );
}
}
}
}
}
/**
* Shows a dialog that asks if conflicting changes should be discarded.
*
* @return true, if successful
*/
protected boolean handleDirtyConflict() {
return MessageDialog.openQuestion( getSite().getShell(),
getString( "_UI_FileConflict_label" ),
getString( "_WARN_FileConflict" ) );
}
/**
* This creates a model editor.
*/
public ErfObjectEditor() {
super();
initializeEditingDomain();
}
/**
* This sets up the editing domain for the model editor.
*/
protected void initializeEditingDomain() {
// Create an adapter factory that yields item providers.
adapterFactory = new ComposedAdapterFactory( ComposedAdapterFactory.Descriptor.Registry.INSTANCE );
adapterFactory.addAdapterFactory( new ResourceItemProviderAdapterFactory() );
adapterFactory.addAdapterFactory( new ErfItemProviderAdapterFactory() );
adapterFactory.addAdapterFactory( new ReflectiveItemProviderAdapterFactory() );
// Create the command stack that will notify this editor as commands are executed.
BasicCommandStack commandStack = new EraCommandStack();
// Add a listener to set the most recent command's affected objects to be the selection of the viewer with
// focus.
commandStack.addCommandStackListener( new CommandStackListener() {
/**
* create a validate job if none is existing yet The validate job asynchronously checks if the erfModel is
* valid
*
* @return the validate job
*/
public void commandStackChanged( final EventObject event ) {
getContainer().getDisplay().asyncExec( new Runnable() {
public void run() {
firePropertyChange( IEditorPart.PROP_DIRTY );
// Try to select the affected objects. (e.g. skip to respective objects when performing an UNDO
// operation)
Command mostRecentCommand = ((CommandStack)event.getSource()).getMostRecentCommand();
if( mostRecentCommand != null ) {
setSelectionToViewer( mostRecentCommand.getAffectedObjects() );
}
// refresh property page
if( propertySheetPage != null && !propertySheetPage.getControl().isDisposed() ) {
propertySheetPage.refresh();
}
// start model validation:
// * Try to cancel the job.
// * It does not matter if the cancellation fails as we schedule the Job again in any case.
ErfObjectEditor.this.validateJob.cancel();
ErfObjectEditor.this.validateJob.schedule();
}
} );
}
} );
// Create the editing domain with a special command stack.
//
editingDomain = new AdapterFactoryEditingDomain(
adapterFactory,
commandStack,
new HashMap<Resource, Boolean>() );
}
/**
* This is here for the listener to be able to call it.
*
* @param action the action
*/
@Override
protected void firePropertyChange( int action ) {
super.firePropertyChange( action );
}
/**
* This sets the selection of current viewer.
*
* @param collection the new selection to viewer
*/
public void setSelectionToViewer( Collection<?> collection ) {
final Collection<?> theSelection = collection;
if( theSelection != null && !theSelection.isEmpty() ) {
Runnable runnable = new Runnable() {
public void run() {
ArrayList<SpecObject> specObjectList = new ArrayList<SpecObject>();
// Check all elements in selection and set to the spec object
for( Object element : theSelection ) {
if( element instanceof EObject ) {
EObject eObject = (EObject)element;
if( eObject instanceof SpecObject ) {
specObjectList.add( (SpecObject)eObject );
} else if( eObject.eContainer() instanceof SpecObject ) {
specObjectList.add( (SpecObject)eObject.eContainer() );
}
}
}
if( currentViewer != null && !specObjectList.isEmpty() ) {
currentViewer.setSelection( new StructuredSelection( specObjectList.toArray() ), true );
}
}
};
getSite().getShell().getDisplay().asyncExec( runnable );
}
}
/**
* This returns the editing domain as required by the {@link IEditingDomainProvider} interface. This is important
* for implementing the static methods of {@link AdapterFactoryEditingDomain} and for supporting
*
* @return the editing domain {@link org.eclipse.emf.edit.ui.action.CommandAction}.
*/
public EditingDomain getEditingDomain() {
return editingDomain;
}
/**
* <!-- begin-user-doc --> <!-- end-user-doc -->.
*
* @param viewerPane the new current viewer pane
* @generated
*/
public void setCurrentViewerPane( ViewerPane viewerPane ) {
if( currentViewerPane != viewerPane ) {
if( currentViewerPane != null ) {
currentViewerPane.showFocus( false );
}
currentViewerPane = viewerPane;
}
setCurrentViewer( currentViewerPane.getViewer() );
}
/**
* This makes sure that one content viewer, either for the current page or the outline view, if it has focus, is the
* current one.
*
* @param viewer the new current viewer
*/
public void setCurrentViewer( Viewer viewer ) {
// If it is changing...
//
if( currentViewer != viewer ) {
if( selectionChangedListener == null ) {
// Create the listener on demand.
//
selectionChangedListener = new ISelectionChangedListener() {
// This just notifies those things that are affected by the section.
//
public void selectionChanged( SelectionChangedEvent selectionChangedEvent ) {
setSelection( selectionChangedEvent.getSelection() );
}
};
}
// Stop listening to the old one.
//
if( currentViewer != null ) {
currentViewer.removeSelectionChangedListener( selectionChangedListener );
}
// Start listening to the new one.
//
if( viewer != null ) {
viewer.addSelectionChangedListener( selectionChangedListener );
}
// Remember it.
//
currentViewer = viewer;
// Set the editors selection based on the current viewer's selection.
//
setSelection( currentViewer == null ? StructuredSelection.EMPTY : currentViewer.getSelection() );
}
}
/**
* This returns the viewer as required by the {@link IViewerProvider} interface.
*
* @return the viewer
* @generated
*/
public Viewer getViewer() {
return currentViewer;
}
/**
* This creates a context menu for the viewer and adds a listener as well registering the menu for extension.
*
* @generated
*
* protected void createContextMenuFor( StructuredViewer viewer ) { MenuManager contextMenu = new
* MenuManager( "#PopUp" ); contextMenu.add( new Separator( "additions" ) );
* contextMenu.setRemoveAllWhenShown( true ); contextMenu.addMenuListener( this ); Menu menu =
* contextMenu.createContextMenu( viewer.getControl() ); viewer.getControl().setMenu( menu );
* getSite().registerContextMenu( contextMenu, new UnwrappingSelectionProvider( viewer ) );
*
* int dndOperations = DND.DROP_COPY | DND.DROP_MOVE | DND.DROP_LINK; Transfer[] transfers = new
* Transfer[]{LocalTransfer.getInstance()}; viewer.addDragSupport( dndOperations, transfers, new
* ViewerDragAdapter( viewer ) ); viewer.addDropSupport( dndOperations, transfers, new
* EditingDomainViewerDropAdapter( editingDomain, viewer ) ); }
*/
/**
* This is the method called to load a resource into the editing domain's resource set based on the editor's input.
*/
public void createModel() {
URI resourceURI = EditUIUtil.getURI( getEditorInput() );
Exception exception = null;
erfResource = null;
try {
// Load the resource through the editing domain.
//
erfResource = editingDomain.getResourceSet().getResource( resourceURI, true );
} catch( Exception e ) {
exception = e;
erfResource = editingDomain.getResourceSet().getResource( resourceURI, false );
}
Diagnostic diagnostic = analyzeResourceProblems( erfResource, exception );
if( diagnostic.getSeverity() != Diagnostic.OK ) {
resourceToDiagnosticMap.put( erfResource, analyzeResourceProblems( erfResource, exception ) );
}
editingDomain.getResourceSet().eAdapters().add( problemIndicationAdapter );
erfModel = (ERF)erfResource.getContents().get( 0 );
// create validation job and start validation of the model
validateJob = new ErfValidateJob( erfModel );
validateJob.schedule();
}
/**
* Returns a diagnostic describing the errors and warnings listed in the resource and the specified exception (if
* any).
*
* @param resource the resource
* @param exception the exception
* @return the diagnostic
*/
public Diagnostic analyzeResourceProblems( Resource resource, Exception exception ) {
if( !resource.getErrors().isEmpty() || !resource.getWarnings().isEmpty() ) {
BasicDiagnostic basicDiagnostic = new BasicDiagnostic(
Diagnostic.ERROR,
"era.foss.objecteditor",
0,
getString( "_UI_CreateModelError_message", resource.getURI() ),
new Object[]{exception == null ? (Object)resource : exception} );
basicDiagnostic.merge( EcoreUtil.computeDiagnostic( resource, true ) );
return basicDiagnostic;
} else if( exception != null ) {
return new BasicDiagnostic(
Diagnostic.ERROR,
"era.foss.objecteditor",
0,
getString( "_UI_CreateModelError_message", resource.getURI() ),
new Object[]{exception} );
} else {
return Diagnostic.OK_INSTANCE;
}
}
/**
* This is the method used by the framework to install your own controls. <!-- begin-user-doc --> <!-- end-user-doc
* -->
*
* @not generated
*/
@Override
public void createPages() {
// Creates the model from the editor input
createModel();
// Only creates the other pages if there is something that can be edited
if( !getEditingDomain().getResourceSet().getResources().isEmpty() ) {
// Create a page for the selection tree view.
//
{
ViewerPane viewerPane = new ViewerPane( getSite().getPage(), ErfObjectEditor.this ) {
@Override
public Viewer createViewer( Composite composite ) {
return new SpecObjectCompositeViewer( composite, editingDomain, erfModel );
}
@Override
public void requestActivation() {
super.requestActivation();
setCurrentViewerPane( this );
}
};
viewerPane.createControl( getContainer() );
int pageIndex = addPage( viewerPane.getControl() );
setPageText( pageIndex, "ERA SpecObj Viewer" );
this.setCurrentViewerPane( viewerPane );
}
getSite().getShell().getDisplay().asyncExec( new Runnable() {
public void run() {
setActivePage( 0 );
}
} );
}
// Ensures that this editor will only display the page's tab
// area if there are more than one page
getContainer().addControlListener( new ControlAdapter() {
boolean guard = false;
@Override
public void controlResized( ControlEvent event ) {
if( !guard ) {
guard = true;
hideTabs();
guard = false;
}
}
} );
getSite().getShell().getDisplay().asyncExec( new Runnable() {
public void run() {
updateProblemIndication();
}
} );
}
/**
* If there is just one page in the multi-page editor part, this hides the single tab at the bottom. <!--
* begin-user-doc --> <!-- end-user-doc -->
*
* @generated
*/
protected void hideTabs() {
if( getPageCount() <= 1 ) {
setPageText( 0, "" );
if( getContainer() instanceof CTabFolder ) {
((CTabFolder)getContainer()).setTabHeight( 1 );
Point point = getContainer().getSize();
getContainer().setSize( point.x, point.y + 6 );
}
}
}
/**
* If there is more than one page in the multi-page editor part, this shows the tabs at the bottom. <!--
* begin-user-doc --> <!-- end-user-doc -->
*
* @generated
*/
protected void showTabs() {
if( getPageCount() > 1 ) {
setPageText( 0, getString( "_UI_SelectionPage_label" ) );
if( getContainer() instanceof CTabFolder ) {
((CTabFolder)getContainer()).setTabHeight( SWT.DEFAULT );
Point point = getContainer().getSize();
getContainer().setSize( point.x, point.y - 6 );
}
}
}
/**
* This is used to track the active viewer. <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @generated
*/
@Override
protected void pageChange( int pageIndex ) {
super.pageChange( pageIndex );
if( contentOutlinePage != null ) {
handleContentOutlineSelection( contentOutlinePage.getSelection() );
}
}
/**
* This is how the framework determines which interfaces we implement.
*
* @param key the key
* @return the adapter
*/
@Override
public Object getAdapter( @SuppressWarnings({"rawtypes"}) Class key ) {
if( key.equals( IContentOutlinePage.class ) ) {
return showOutlineView() ? getContentOutlinePage() : null;
} else if( key.equals( IPropertySheetPage.class ) ) {
return getPropertySheetPage();
} else if( key.equals( IGotoMarker.class ) ) {
return this;
} else {
return super.getAdapter( key );
}
}
/**
* This accesses a cached version of the content outliner.
*
* @return the content outline page
*/
public IContentOutlinePage getContentOutlinePage() {
if( contentOutlinePage == null ) {
// The content outline is just a tree.
//
class MyContentOutlinePage extends ContentOutlinePage {
@Override
public void createControl( Composite parent ) {
super.createControl( parent );
contentOutlineViewer = getTreeViewer();
contentOutlineViewer.addSelectionChangedListener( this );
// Set up the tree viewer.
//
contentOutlineViewer.setContentProvider( new AdapterFactoryContentProvider( adapterFactory ) );
contentOutlineViewer.setLabelProvider( new AdapterFactoryLabelProvider( adapterFactory ) );
contentOutlineViewer.setInput( editingDomain.getResourceSet() );
// Make sure our popups work.
//
// createContextMenuFor( contentOutlineViewer );
if( !editingDomain.getResourceSet().getResources().isEmpty() ) {
// Select the root object in the view.
//
contentOutlineViewer.setSelection( new StructuredSelection( editingDomain.getResourceSet()
.getResources()
.get( 0 ) ), true );
}
}
@Override
public void makeContributions( IMenuManager menuManager,
IToolBarManager toolBarManager,
IStatusLineManager statusLineManager ) {
super.makeContributions( menuManager, toolBarManager, statusLineManager );
contentOutlineStatusLineManager = statusLineManager;
}
@Override
public void setActionBars( IActionBars actionBars ) {
super.setActionBars( actionBars );
getActionBarContributor().shareGlobalActions( this, actionBars );
}
}
contentOutlinePage = new MyContentOutlinePage();
// Listen to selection so that we can handle it is a special way.
//
contentOutlinePage.addSelectionChangedListener( new ISelectionChangedListener() {
// This ensures that we handle selections correctly.
//
public void selectionChanged( SelectionChangedEvent event ) {
handleContentOutlineSelection( event.getSelection() );
}
} );
}
return contentOutlinePage;
}
/**
* This accesses a cached version of the property sheet.
*
* @return the property sheet page
*/
public IPropertySheetPage getPropertySheetPage() {
if( propertySheetPage == null ) {
propertySheetPage = new ExtendedPropertySheetPage( editingDomain ) {
@Override
public void setSelectionToViewer( List<?> selection ) {
ErfObjectEditor.this.setSelectionToViewer( selection );
ErfObjectEditor.this.setFocus();
}
@Override
public void setActionBars( IActionBars actionBars ) {
super.setActionBars( actionBars );
getActionBarContributor().shareGlobalActions( this, actionBars );
}
};
propertySheetPage.setPropertySourceProvider( new SpecObjectPropertySourceProvider() );
}
return propertySheetPage;
}
/**
* This deals with how we want selection in the outliner to affect the other views. <!-- begin-user-doc --> <!--
* end-user-doc -->
*
* @generated
*/
public void handleContentOutlineSelection( ISelection selection ) {
if( currentViewerPane != null && !selection.isEmpty() && selection instanceof IStructuredSelection ) {
Iterator<?> selectedElements = ((IStructuredSelection)selection).iterator();
if( selectedElements.hasNext() ) {
// Get the first selected element.
//
Object selectedElement = selectedElements.next();
// If it's the selection viewer, then we want it to select the same selection as this selection.
//
// Set the input to the widget.
//
if( currentViewerPane.getViewer().getInput() != selectedElement ) {
currentViewerPane.getViewer().setInput( selectedElement );
currentViewerPane.setTitle( selectedElement );
}
}
}
}
/**
* This is for implementing {@link IEditorPart} and simply tests the command stack.
*
* @return true, if is dirty
*/
@Override
public boolean isDirty() {
return ((BasicCommandStack)editingDomain.getCommandStack()).isSaveNeeded();
}
/**
* This is for implementing {@link IEditorPart} and simply saves the model file.
*
* @param progressMonitor the progress monitor
*/
@Override
public void doSave( IProgressMonitor progressMonitor ) {
// Save only resources that have actually changed.
//
final Map<Object, Object> saveOptions = new HashMap<Object, Object>();
saveOptions.put( Resource.OPTION_SAVE_ONLY_IF_CHANGED, Resource.OPTION_SAVE_ONLY_IF_CHANGED_MEMORY_BUFFER );
// Do the work within an operation because this is a long running activity that modifies the workbench.
//
WorkspaceModifyOperation operation = new WorkspaceModifyOperation() {
// This is the method that gets invoked when the operation runs.
//
@Override
public void execute( IProgressMonitor monitor ) {
// Save the resources to the file system.
//
boolean first = true;
for( Resource resource : editingDomain.getResourceSet().getResources() ) {
if( (first || !resource.getContents().isEmpty() || isPersisted( resource ))
&& !editingDomain.isReadOnly( resource ) ) {
try {
long timeStamp = resource.getTimeStamp();
resource.save( saveOptions );
if( resource.getTimeStamp() != timeStamp ) {
savedResources.add( resource );
}
} catch( Exception exception ) {
resourceToDiagnosticMap.put( resource, analyzeResourceProblems( resource, exception ) );
}
first = false;
}
}
}
};
updateProblemIndication = false;
try {
// This runs the options, and shows progress.
//
new ProgressMonitorDialog( getSite().getShell() ).run( true, false, operation );
// Refresh the necessary state.
//
((BasicCommandStack)editingDomain.getCommandStack()).saveIsDone();
firePropertyChange( IEditorPart.PROP_DIRTY );
} catch( Exception exception ) {
// Something went wrong that shouldn't.
//
ErfObjectsEditorPlugin.INSTANCE.log( exception );
}
updateProblemIndication = true;
updateProblemIndication();
}
/**
* This returns whether something has been persisted to the URI of the specified resource. The implementation uses
* the URI converter from the editor's resource set to try to open an input stream.
*
* @param resource the resource
* @return true, if is persisted
*/
protected boolean isPersisted( Resource resource ) {
boolean result = false;
try {
InputStream stream = editingDomain.getResourceSet()
.getURIConverter()
.createInputStream( resource.getURI() );
if( stream != null ) {
result = true;
stream.close();
}
} catch( IOException e ) {
// Ignore
}
return result;
}
/**
* This always returns true because it is not currently supported.
*
* @return true, if is save as allowed
*/
@Override
public boolean isSaveAsAllowed() {
return true;
}
/**
* This also changes the editor's input.
*/
@Override
public void doSaveAs() {
SaveAsDialog saveAsDialog = new SaveAsDialog( getSite().getShell() );
saveAsDialog.open();
IPath path = saveAsDialog.getResult();
if( path != null ) {
IFile file = ResourcesPlugin.getWorkspace().getRoot().getFile( path );
if( file != null ) {
doSaveAs( URI.createPlatformResourceURI( file.getFullPath().toString(), true ), new FileEditorInput(
file ) );
}
}
}
/**
* Handle save operation (Save As).
*
* @param uri the uri
* @param editorInput the editor input
*/
protected void doSaveAs( URI uri, IEditorInput editorInput ) {
(editingDomain.getResourceSet().getResources().get( 0 )).setURI( uri );
setInputWithNotify( editorInput );
setPartName( editorInput.getName() );
IProgressMonitor progressMonitor = getActionBars().getStatusLineManager() != null
? getActionBars().getStatusLineManager().getProgressMonitor()
: new NullProgressMonitor();
doSave( progressMonitor );
}
/**
* See {@link org.eclipse.ui.ide.IGotoMarker}
*
* @param marker the marker
*/
public void gotoMarker( IMarker marker ) {
try {
if( marker.getType().equals( EValidator.MARKER ) ) {
String uriAttribute = marker.getAttribute( EValidator.URI_ATTRIBUTE, null );
if( uriAttribute != null ) {
URI uri = URI.createURI( uriAttribute );
EObject eObject = editingDomain.getResourceSet().getEObject( uri, true );
if( eObject != null ) {
setSelectionToViewer( Collections.singleton( editingDomain.getWrapper( eObject ) ) );
}
}
}
} catch( CoreException exception ) {
ErfObjectsEditorPlugin.INSTANCE.log( exception );
}
}
/**
* Initializes the editor part
*
* This is called during startup.
*
* @param site the site
* @param editorInput the editor input
*/
@Override
public void init( IEditorSite site, IEditorInput editorInput ) {
setSite( site );
setInputWithNotify( editorInput );
setPartName( editorInput.getName() );
site.setSelectionProvider( this );
site.getPage().addPartListener( partListener );
ResourcesPlugin.getWorkspace().addResourceChangeListener( resourceChangeListener,
IResourceChangeEvent.POST_CHANGE );
}
/**
* See {@link WorkbenchPart#setFocus()}.
*/
@Override
public void setFocus() {
if( currentViewerPane != null ) {
currentViewerPane.setFocus();
} else {
getControl( getActivePage() ).setFocus();
}
}
/**
* This implements {@link org.eclipse.jface.viewers.ISelectionProvider}.
*
* Also see
*
* @param listener the listener
* {@link org.eclipse.jface.viewers.ISelectionProvider#addSelectionChangedListener(ISelectionChangedListener)}
*/
public void addSelectionChangedListener( ISelectionChangedListener listener ) {
selectionChangedListeners.add( listener );
}
/**
* This implements {@link org.eclipse.jface.viewers.ISelectionProvider}.
*
* @param listener the listener
*/
public void removeSelectionChangedListener( ISelectionChangedListener listener ) {
selectionChangedListeners.remove( listener );
}
/**
* This implements {@link org.eclipse.jface.viewers.ISelectionProvider} to return this editor's overall selection.
*
* @return the selection
*/
public ISelection getSelection() {
return editorSelection;
}
/**
* This implements {@link org.eclipse.jface.viewers.ISelectionProvider} to set this editor's overall selection.
* Calling this result will notify the listeners.
*
* @param selection the new selection
*/
public void setSelection( ISelection selection ) {
editorSelection = selection;
for( ISelectionChangedListener listener : selectionChangedListeners ) {
listener.selectionChanged( new SelectionChangedEvent( this, selection ) );
}
setStatusLineManager( selection );
}
/**
* Set text displayed in status line according to the element selcted in the viewer.
*
* @param selection the new status line manager
*/
public void setStatusLineManager( ISelection selection ) {
/*
* TODO: discuss if it make sense to show anything here. it would make sense to show the object ID as soon we
* are able to define an attribute definition as ID for an spec object. Then again, do we need to specify a
* certain attribute defintion as ID ? We certainly need some kind of unique attribute... Check if ReqIf does
* specify a 'unique' attribute for Attribute definitions.
*/
IStatusLineManager statusLineManager = currentViewer != null && currentViewer == contentOutlineViewer
? contentOutlineStatusLineManager
: getActionBars().getStatusLineManager();
if( statusLineManager != null ) {
if( selection instanceof IStructuredSelection ) {
Collection<?> collection = ((IStructuredSelection)selection).toList();
switch (collection.size()) {
case 0: {
statusLineManager.setMessage( getString( "_UI_NoObjectSelected" ) );
break;
}
case 1: {
String text = new AdapterFactoryItemDelegator( adapterFactory ).getText( collection.iterator()
.next() );
statusLineManager.setMessage( getString( "_UI_SingleObjectSelected", text ) );
break;
}
default: {
statusLineManager.setMessage( getString( "_UI_MultiObjectSelected",
Integer.toString( collection.size() ) ) );
break;
}
}
} else {
statusLineManager.setMessage( "" );
}
}
}
/**
* This looks up a string in the plugin's plugin.properties file.
*
* @generated
*/
private static String getString( String key ) {
return ErfObjectsEditorPlugin.INSTANCE.getString( key );
}
/**
* This looks up a string in plugin.properties, making a substitution. <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @generated
*/
private static String getString( String key, Object s1 ) {
return ErfObjectsEditorPlugin.INSTANCE.getString( key, new Object[]{s1} );
}
/**
* This implements {@link org.eclipse.jface.action.IMenuListener} to help fill the context menus with contributions
* from the Edit menu. <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @generated
*/
public void menuAboutToShow( IMenuManager menuManager ) {
((IMenuListener)getEditorSite().getActionBarContributor()).menuAboutToShow( menuManager );
}
/**
* <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @generated
*/
public EditingDomainActionBarContributor getActionBarContributor() {
return (EditingDomainActionBarContributor)getEditorSite().getActionBarContributor();
}
/**
*
*
* @generated
*/
public IActionBars getActionBars() {
return getActionBarContributor().getActionBars();
}
/**
* @return the adapter factory
* @generated
*/
public AdapterFactory getAdapterFactory() {
return adapterFactory;
}
/**
*
*/
@Override
public void dispose() {
updateProblemIndication = false;
ResourcesPlugin.getWorkspace().removeResourceChangeListener( resourceChangeListener );
getSite().getPage().removePartListener( partListener );
adapterFactory.dispose();
if( getActionBarContributor().getActiveEditor() == this ) {
getActionBarContributor().setActiveEditor( null );
}
if( propertySheetPage != null ) {
propertySheetPage.dispose();
}
if( contentOutlinePage != null ) {
contentOutlinePage.dispose();
}
super.dispose();
}
/**
* Returns whether the outline view should be presented to the user. <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @return true, if successful
* @generated
*/
protected boolean showOutlineView() {
return true;
}
}