org.eclipse.eef.core.api

Interface EditingContextAdapter

public interface EditingContextAdapter

Connects EEF views with the external context (e.g. an editor) on behalf of which the views display and edit model elements. Clients which use the EEF runtime must supply an implementation of this interface so that the EEF views can be correctly integrated into the source context.

Method Summary

Modifier and Type	Method and Description
void	addLockStatusChangedListener(IConsumer<java.util.Collection<LockStatusChangeEvent>> listener) Adds a new lock status changed listener to the collection of lock status changed listeners to be notified when model elements are locked or unlocked.
LockStatusChangeEvent.LockStatus	geLockStatus(org.eclipse.emf.ecore.EObject obj) Returns the current locking status of an element.
org.eclipse.emf.edit.domain.EditingDomain	getEditingDomain() Returns the editing domain.
void	lock(java.util.Collection<org.eclipse.emf.ecore.EObject> elements) Attempts to take an exclusive lock on the specified elements.
org.eclipse.core.runtime.IStatus	performModelChange(java.lang.Runnable operation) Executes an operation which which potentially makes changes to the model.
void	registerModelChangeListener(IConsumer<java.util.List<org.eclipse.emf.common.notify.Notification>> listener) Registers the sole unique model change listener listener to be notified when the model is modified.
void	removeLockStatusChangedListener(IConsumer<java.util.Collection<LockStatusChangeEvent>> listener) Removes the given lock status changed listener from the list of all lock status changed listeners..
void	unlock(java.util.Collection<org.eclipse.emf.ecore.EObject> elements) Attempts to release the locks on the specified elements.
void	unregisterModelChangeListener() Unregisters the currently set model change listener.

Method Detail

performModelChange

org.eclipse.core.runtime.IStatus performModelChange(java.lang.Runnable operation)

Executes an operation which which potentially makes changes to the model.

Parameters:

operation - the operation.

Returns:

the status of the operation execution.

registerModelChangeListener

void registerModelChangeListener(IConsumer<java.util.List<org.eclipse.emf.common.notify.Notification>> listener)

Registers the sole unique model change listener listener to be notified when the model is modified. The listener will be called in a context in which it may not be possible to perform additional changes to the model itself. The list of changes supplied to the listener should be considered only as a hint and may be null.

Parameters:

listener - the listener to invoke when the model is modified.

unregisterModelChangeListener

void unregisterModelChangeListener()

Unregisters the currently set model change listener. Does nothing if none is currently registered.

getEditingDomain

org.eclipse.emf.edit.domain.EditingDomain getEditingDomain()

Returns the editing domain.

Returns:

The editing domain

Since:

1.7.0

addLockStatusChangedListener

void addLockStatusChangedListener(IConsumer<java.util.Collection<LockStatusChangeEvent>> listener)

Adds a new lock status changed listener to the collection of lock status changed listeners to be notified when model elements are locked or unlocked.

Parameters:

listener - the listener to invoke when elements are locked or unlocked.

removeLockStatusChangedListener

void removeLockStatusChangedListener(IConsumer<java.util.Collection<LockStatusChangeEvent>> listener)

Removes the given lock status changed listener from the list of all lock status changed listeners..

Parameters:

listener - The listener to unregister

geLockStatus

LockStatusChangeEvent.LockStatus geLockStatus(org.eclipse.emf.ecore.EObject obj)

Returns the current locking status of an element.

Parameters:

obj - the element.

Returns:

the current lock status of the element.

lock

void lock(java.util.Collection<org.eclipse.emf.ecore.EObject> elements)

Attempts to take an exclusive lock on the specified elements. Callers should not assume the elements are actually locked until they receive the corresponding LockStatusChangeEvent notification through the #onLockStatusChanged(IConsumer) callback. There is no guarantee such a notification will be sent, if for example an element was already locked by some other context.

Parameters:

elements - the elements to lock.

unlock

void unlock(java.util.Collection<org.eclipse.emf.ecore.EObject> elements)

Attempts to release the locks on the specified elements. Callers should not assume the elements are actually locked until they receive the corresponding LockStatusChangeEvent notification through the #onLockStatusChanged(IConsumer) callback. There is no guarantee such a notification will be sent, if for example this editing context did not have a lock on a given element.

Parameters:

elements - the elements to unlock.