org.eclipse.xtext.ui.editor

Class DirtyStateEditorSupport

java.lang.Object

org.eclipse.xtext.ui.editor.DirtyStateEditorSupport

All Implemented Interfaces:

EventListener, org.eclipse.swt.events.VerifyListener, org.eclipse.swt.internal.SWTEventListener, IResourceDescription.Event.Listener

public class DirtyStateEditorSupport
extends Object
implements IResourceDescription.Event.Listener, org.eclipse.swt.events.VerifyListener

Author:

Sebastian Zarnekow - Initial contribution and API, Jan Koehnlein

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DirtyStateEditorSupport.IConcurrentEditingCallback Allows to mock the user decision in unit tests.
static interface	DirtyStateEditorSupport.IDirtyStateEditorSupportClient Minimal required interface for clients.
static interface	DirtyStateEditorSupport.IDirtyStateEditorSupportClientExtension
static class	DirtyStateEditorSupport.InteractiveConcurrentEditingQuestion
protected class	DirtyStateEditorSupport.UpdateEditorStateJob

Constructor Summary

Constructors

Constructor and Description
DirtyStateEditorSupport()

Method Summary

Methods

Modifier and Type	Method and Description
void	announceDirtyState(XtextResource resource)
protected Collection<org.eclipse.emf.ecore.resource.Resource>	collectAffectedResources(XtextResource resource, IResourceDescription.Event event)
protected ChangedResourceDescriptionDelta	createDelta(IResourceDescription.Delta delta, IResourceDescription.Delta prev)
protected DirtyStateEditorSupport.UpdateEditorStateJob	createUpdateEditorJob()
void	descriptionsChanged(IResourceDescription.Event event)
boolean	doVerify()
DirtyStateEditorSupport.IConcurrentEditingCallback	getConcurrentEditingWarningDialog()
DocumentBasedDirtyResource	getDirtyResource()
IDirtyStateManager	getDirtyStateManager()
protected IResourceDescription.Manager	getResourceDescriptionManager(org.eclipse.emf.common.util.URI resourceURI)
protected IResourceDescription.Manager	getResourceDescriptionManagerIfOwnLanguage(XtextResource resource)
IStateChangeEventBroker	getStateChangeEventBroker()
DirtyStateEditorSupport.UpdateEditorStateJob	getUpdateEditorStateJob()
boolean	haveEObjectDescriptionsChanged(IResourceDescription newDescription) Deprecated. Use haveEObjectDescriptionsChanged(IResourceDescription, org.eclipse.xtext.resource.IResourceDescription.Manager).
boolean	haveEObjectDescriptionsChanged(IResourceDescription newDescription, IResourceDescription.Manager resourceDescriptionManager)
protected void	initDirtyResource(IXtextDocument document)
void	initializeDirtyStateSupport(DirtyStateEditorSupport.IDirtyStateEditorSupportClient client)
protected boolean	isConcurrentEditingIgnored()
protected boolean	isDirty()
boolean	isEditingPossible(DirtyStateEditorSupport.IDirtyStateEditorSupportClient client)
protected boolean	isReparseRequired(XtextResource resource, IResourceDescription.Event event)
void	markEditorClean(DirtyStateEditorSupport.IDirtyStateEditorSupportClient client)
void	modelChanged(XtextResource resource)
protected void	processDelta(IResourceDescription.Delta delta, org.eclipse.emf.ecore.resource.Resource context, List<org.eclipse.emf.ecore.resource.Resource> result)
void	removeDirtyStateSupport(DirtyStateEditorSupport.IDirtyStateEditorSupportClient client)
void	scheduleUpdateEditorJob(IResourceDescription.Event event)
void	setConcurrentEditingWarningDialog(DirtyStateEditorSupport.IConcurrentEditingCallback concurrentEditingWarningDialog)
void	setDirtyResource(DocumentBasedDirtyResource dirtyResource)
void	setDirtyStateManager(IDirtyStateManager dirtyStateManager)
void	setResourceDescriptions(IResourceDescriptions resourceDescriptions)
void	setResourceServiceProviderRegistry(IResourceServiceProvider.Registry resourceServiceProviderRegistry) Only for testing
void	setStateChangeEventBroker(IStateChangeEventBroker stateChangeEventBroker)
void	verifyText(org.eclipse.swt.events.VerifyEvent e)
void	waitForUpdateEditorJob()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirtyStateEditorSupport

public DirtyStateEditorSupport()

Method Detail

initializeDirtyStateSupport

public void initializeDirtyStateSupport(DirtyStateEditorSupport.IDirtyStateEditorSupportClient client)

verifyText

public void verifyText(org.eclipse.swt.events.VerifyEvent e)

Specified by:

verifyText in interface org.eclipse.swt.events.VerifyListener

doVerify

public boolean doVerify()

isEditingPossible

public boolean isEditingPossible(DirtyStateEditorSupport.IDirtyStateEditorSupportClient client)

isConcurrentEditingIgnored

protected boolean isConcurrentEditingIgnored()

initDirtyResource

protected void initDirtyResource(IXtextDocument document)

removeDirtyStateSupport

public void removeDirtyStateSupport(DirtyStateEditorSupport.IDirtyStateEditorSupportClient client)

markEditorClean

public void markEditorClean(DirtyStateEditorSupport.IDirtyStateEditorSupportClient client)

descriptionsChanged

public void descriptionsChanged(IResourceDescription.Event event)

Specified by:

descriptionsChanged in interface IResourceDescription.Event.Listener

scheduleUpdateEditorJob

public void scheduleUpdateEditorJob(IResourceDescription.Event event)

waitForUpdateEditorJob

public void waitForUpdateEditorJob()
                            throws InterruptedException

Throws:

InterruptedException

Since:

2.7

getUpdateEditorStateJob

public DirtyStateEditorSupport.UpdateEditorStateJob getUpdateEditorStateJob()

Since:

2.9

createUpdateEditorJob

protected DirtyStateEditorSupport.UpdateEditorStateJob createUpdateEditorJob()

announceDirtyState

public void announceDirtyState(XtextResource resource)

Since:

2.7

modelChanged

public void modelChanged(XtextResource resource)

Since:

2.7 this should no longer be called.

setResourceServiceProviderRegistry

public void setResourceServiceProviderRegistry(IResourceServiceProvider.Registry resourceServiceProviderRegistry)

Only for testing

Since:

2.7

getResourceDescriptionManager

protected IResourceDescription.Manager getResourceDescriptionManager(org.eclipse.emf.common.util.URI resourceURI)

Since:

2.7

getResourceDescriptionManagerIfOwnLanguage

protected IResourceDescription.Manager getResourceDescriptionManagerIfOwnLanguage(XtextResource resource)

Since:

2.8

haveEObjectDescriptionsChanged

@Deprecated
public boolean haveEObjectDescriptionsChanged(IResourceDescription newDescription)

Deprecated. Use haveEObjectDescriptionsChanged(IResourceDescription, org.eclipse.xtext.resource.IResourceDescription.Manager).

haveEObjectDescriptionsChanged

public boolean haveEObjectDescriptionsChanged(IResourceDescription newDescription,
                                     IResourceDescription.Manager resourceDescriptionManager)

Since:

2.3

collectAffectedResources

protected Collection<org.eclipse.emf.ecore.resource.Resource> collectAffectedResources(XtextResource resource,
                                                                           IResourceDescription.Event event)

processDelta

protected void processDelta(IResourceDescription.Delta delta,
                org.eclipse.emf.ecore.resource.Resource context,
                List<org.eclipse.emf.ecore.resource.Resource> result)

Since:

2.8

isReparseRequired

protected boolean isReparseRequired(XtextResource resource,
                        IResourceDescription.Event event)

isDirty

protected boolean isDirty()

createDelta

protected ChangedResourceDescriptionDelta createDelta(IResourceDescription.Delta delta,
                                          IResourceDescription.Delta prev)

getDirtyStateManager

public IDirtyStateManager getDirtyStateManager()

setDirtyStateManager

public void setDirtyStateManager(IDirtyStateManager dirtyStateManager)

getStateChangeEventBroker

public IStateChangeEventBroker getStateChangeEventBroker()

setStateChangeEventBroker

public void setStateChangeEventBroker(IStateChangeEventBroker stateChangeEventBroker)

setConcurrentEditingWarningDialog

public void setConcurrentEditingWarningDialog(DirtyStateEditorSupport.IConcurrentEditingCallback concurrentEditingWarningDialog)

getConcurrentEditingWarningDialog

public DirtyStateEditorSupport.IConcurrentEditingCallback getConcurrentEditingWarningDialog()

setDirtyResource

public void setDirtyResource(DocumentBasedDirtyResource dirtyResource)

getDirtyResource

public DocumentBasedDirtyResource getDirtyResource()

setResourceDescriptions

public void setResourceDescriptions(IResourceDescriptions resourceDescriptions)

Since:

2.1