org.eclipse.gef4.mvc.domain

Class AbstractDomain<VR>

java.lang.Object

org.eclipse.gef4.mvc.domain.AbstractDomain<VR>

Type Parameters:

VR - The visual root node of the UI toolkit used, e.g. javafx.scene.Node in case of JavaFX.

All Implemented Interfaces:

IActivatable, IAdaptable, IDisposable, IPropertyChangeNotifier, IDomain<VR>

Direct Known Subclasses:

FXDomain

public abstract class AbstractDomain<VR>
extends java.lang.Object
implements IDomain<VR>

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

IAdaptable.Bound<A extends IAdaptable>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.beans.PropertyChangeSupport	pcs A PropertyChangeSupport that is used as a delegate to notify listeners about changes to this object.

Fields inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

ADAPTERS_PROPERTY

Fields inherited from interface org.eclipse.gef4.common.activate.IActivatable

ACTIVE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AbstractDomain() Creates a new AbstractDomain instance, setting the AdaptableScope for each of its IAdaptable-compliant types (super classes implementing IAdaptable and super-interfaces extending IAdaptable) to the newly created instance (see AdaptableScopes#scopeTo(IAdaptable)).

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	closeExecutionTransaction(ITool<VR> tool) Closes the active execution transaction, removes the given ITool from the transaction context, and opens a new execution transaction if there are any tools remaining in the context.
protected ForwardUndoCompositeOperation	createExecutionTransaction()
void	deactivate()
void	dispose()
void	execute(IUndoableOperation operation) Will execute the given IUndoableOperation on the IOperationHistory used by this IDomain (see IDomain.getOperationHistory()), using the IUndoContext of this IDomain.
<T> T	getAdapter(AdapterKey<? super T> key)
<T> T	getAdapter(java.lang.Class<? super T> classKey)
<T> T	getAdapter(com.google.common.reflect.TypeToken<? super T> key)
<T> java.util.Map<AdapterKey<? extends T>,T>	getAdapters(java.lang.Class<? super T> classKey)
<T> java.util.Map<AdapterKey<? extends T>,T>	getAdapters(com.google.common.reflect.TypeToken<? super T> key)
IOperationHistory	getOperationHistory() Returns the IOperationHistory that is used by this domain.
java.util.Map<AdapterKey<? extends ITool<VR>>,ITool<VR>>	getTools() Returns the ITools registered at this IDomain (via IAdaptable.setAdapter(AdapterKey, Object)) with the AdapterKeys used for registration.
IUndoContext	getUndoContext() Returns the UndoContext that is used by this domain.
java.util.Map<AdapterKey<? extends IViewer<VR>>,IViewer<VR>>	getViewers() Returns the IViewers registered at this IDomain (via IAdaptable.setAdapter(AdapterKey, Object)) with the AdapterKeys used for registration.
boolean	isActive()
protected boolean	isExecutionTransactionOpen()
boolean	isExecutionTransactionOpen(ITool<VR> tool) Returns true if the given ITool is taking part in the currently open execution transaction.
void	openExecutionTransaction(ITool<VR> tool) Opens a new transaction or adds the given ITool to the currently opened transaction for executing operations (via IDomain.execute(IUndoableOperation)) on the IOperationHistory used by this IDomain (see IDomain.getOperationHistory()), using the IUndoContext of this IDomain.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
<T> void	setAdapter(AdapterKey<? super T> key, T adapter)
<T> void	setAdapter(java.lang.Class<? super T> key, T adapter)
<T> void	setAdapter(com.google.common.reflect.TypeToken<? super T> key, T adapter)
void	setAdapters(java.util.Map<AdapterKey<?>,java.lang.Object> adaptersWithKeys) Adds the set of adapters to this IAdaptable.
void	setOperationHistory(IOperationHistory stack)
void	setUndoContext(IUndoContext undoContext)
<T> T	unsetAdapter(AdapterKey<? super T> key)

Methods inherited from class java.lang.Object

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

Field Detail

pcs

protected java.beans.PropertyChangeSupport pcs

A PropertyChangeSupport that is used as a delegate to notify listeners about changes to this object. May be used by subclasses to trigger the notification of listeners.

Constructor Detail

AbstractDomain

public AbstractDomain()

Creates a new AbstractDomain instance, setting the AdaptableScope for each of its IAdaptable-compliant types (super classes implementing IAdaptable and super-interfaces extending IAdaptable) to the newly created instance (see AdaptableScopes#scopeTo(IAdaptable)).

Method Detail

activate

public void activate()

Specified by:

activate in interface IActivatable

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface IPropertyChangeNotifier

closeExecutionTransaction

public void closeExecutionTransaction(ITool<VR> tool)

Description copied from interface: IDomain

Closes the active execution transaction, removes the given ITool from the transaction context, and opens a new execution transaction if there are any tools remaining in the context.

Specified by:

closeExecutionTransaction in interface IDomain<VR>

Parameters:

tool - The ITool that should be removed from the transaction context.

See Also:

IDomain.openExecutionTransaction(ITool)

createExecutionTransaction

protected ForwardUndoCompositeOperation createExecutionTransaction()

deactivate

public void deactivate()

Specified by:

deactivate in interface IActivatable

dispose

public void dispose()

Specified by:

dispose in interface IDisposable

execute

public void execute(IUndoableOperation operation)

Description copied from interface: IDomain

Will execute the given IUndoableOperation on the IOperationHistory used by this IDomain (see IDomain.getOperationHistory()), using the IUndoContext of this IDomain. In case an execution transaction is currently open (see IDomain.openExecutionTransaction(ITool), IDomain.closeExecutionTransaction(ITool)) the enclosing transaction will refer to the IUndoContext used by this IDomain) (so that no specific IUndoContext is set on the passed in IUndoableOperation). If no transaction is currently open, the IUndoContext of this IDomain will be set on the passed in IUndoableOperation.

Specified by:

execute in interface IDomain<VR>

Parameters:

operation - The IUndoableOperation to be executed on the IOperationHistory of this IDomain.

getAdapter

public <T> T getAdapter(AdapterKey<? super T> key)

Specified by:

getAdapter in interface IAdaptable

getAdapter

public <T> T getAdapter(java.lang.Class<? super T> classKey)

Specified by:

getAdapter in interface IAdaptable

getAdapter

public <T> T getAdapter(com.google.common.reflect.TypeToken<? super T> key)

Specified by:

getAdapter in interface IAdaptable

getAdapters

public <T> java.util.Map<AdapterKey<? extends T>,T> getAdapters(java.lang.Class<? super T> classKey)

Specified by:

getAdapters in interface IAdaptable

getAdapters

public <T> java.util.Map<AdapterKey<? extends T>,T> getAdapters(com.google.common.reflect.TypeToken<? super T> key)

Specified by:

getAdapters in interface IAdaptable

getOperationHistory

public IOperationHistory getOperationHistory()

Description copied from interface: IDomain

Returns the IOperationHistory that is used by this domain.

Specified by:

getOperationHistory in interface IDomain<VR>

Returns:

The IOperationHistory.

getTools

public java.util.Map<AdapterKey<? extends ITool<VR>>,ITool<VR>> getTools()

Description copied from interface: IDomain

Returns the ITools registered at this IDomain (via IAdaptable.setAdapter(AdapterKey, Object)) with the AdapterKeys used for registration.

Specified by:

getTools in interface IDomain<VR>

Returns:

A Map containing the registered ITools mapped to their respective AdapterKeys.

See Also:

IAdaptable.setAdapter(AdapterKey, Object)

getUndoContext

public IUndoContext getUndoContext()

Description copied from interface: IDomain

Returns the UndoContext that is used by this domain.

Specified by:

getUndoContext in interface IDomain<VR>

Returns:

The UndoContext.

getViewers

public java.util.Map<AdapterKey<? extends IViewer<VR>>,IViewer<VR>> getViewers()

Description copied from interface: IDomain

Returns the IViewers registered at this IDomain (via IAdaptable.setAdapter(AdapterKey, Object)) with the AdapterKeys used for registration.

Specified by:

getViewers in interface IDomain<VR>

Returns:

A Map containing the registered IViewers mapped to their respective AdapterKeys.

See Also:

IAdaptable.setAdapter(AdapterKey, Object)

isActive

public boolean isActive()

Specified by:

isActive in interface IActivatable

isExecutionTransactionOpen

protected boolean isExecutionTransactionOpen()

isExecutionTransactionOpen

public boolean isExecutionTransactionOpen(ITool<VR> tool)

Description copied from interface: IDomain

Returns true if the given ITool is taking part in the currently open execution transaction. Otherwise returns false.

Specified by:

isExecutionTransactionOpen in interface IDomain<VR>

Parameters:

tool - The ITool that is checked.

Returns:

true if the given ITool is taking part in the currently open execution transaction, otherwise false.

openExecutionTransaction

public void openExecutionTransaction(ITool<VR> tool)

Description copied from interface: IDomain

Opens a new transaction or adds the given ITool to the currently opened transaction for executing operations (via IDomain.execute(IUndoableOperation)) on the IOperationHistory used by this IDomain (see IDomain.getOperationHistory()), using the IUndoContext of this IDomain.

Specified by:

openExecutionTransaction in interface IDomain<VR>

Parameters:

tool - The ITool starting/joining the transaction.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface IPropertyChangeNotifier

setAdapter

public <T> void setAdapter(AdapterKey<? super T> key,
                           T adapter)

Specified by:

setAdapter in interface IAdaptable

setAdapter

public <T> void setAdapter(java.lang.Class<? super T> key,
                           T adapter)

Specified by:

setAdapter in interface IAdaptable

setAdapter

public <T> void setAdapter(com.google.common.reflect.TypeToken<? super T> key,
                           T adapter)

Specified by:

setAdapter in interface IAdaptable

setAdapters

@Inject(optional=true)
public void setAdapters(@AdapterMap
                                               java.util.Map<AdapterKey<?>,java.lang.Object> adaptersWithKeys)

Adds the set of adapters to this IAdaptable. This method should not be used by clients but is intended for injection of adapters by means of an AdapterMapInjector.

IMPORTANT: If sub-classes override this method, they will have to transfer the inject annotation to the overwritten method to ensure that adapter map injection is still functional.

Parameters:

adaptersWithKeys - The adapters to add to this IAdaptable (by means of injection)

See Also:

AdapterMap

setOperationHistory

@Inject
public void setOperationHistory(IOperationHistory stack)

setUndoContext

@Inject
public void setUndoContext(IUndoContext undoContext)

unsetAdapter

public <T> T unsetAdapter(AdapterKey<? super T> key)

Specified by:

unsetAdapter in interface IAdaptable