public interface IDomain extends IAdaptable, IActivatable, IDisposable
IViewer
s and related IGesture
s to interact
with these. It also holds a reference to the IOperationHistory
and
UndoContext
used by all IGesture
as well as IPolicy
s
(in the IViewer
s) to execute IUndoableOperation
s.adapters
active
IAdaptable.Bound<A extends IAdaptable>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CONTENT_VIEWER_ROLE
The adapter role for the content viewer.
|
ADAPTERS_PROPERTY
ACTIVE_PROPERTY
Modifier and Type | Method and Description |
---|---|
void |
closeExecutionTransaction(org.eclipse.gef.mvc.fx.gestures.IGesture gesture)
Closes the active execution transaction, removes the given
IGesture from the transaction context, and opens a new execution
transaction if there are any gestures remaining in the context. |
void |
execute(ITransactionalOperation operation,
org.eclipse.core.runtime.IProgressMonitor monitor)
Executes the given
IUndoableOperation . |
java.util.Map<AdapterKey<? extends org.eclipse.gef.mvc.fx.gestures.IGesture>,org.eclipse.gef.mvc.fx.gestures.IGesture> |
getGestures()
Returns the
IGesture s registered at this IDomain (via
IAdaptable.setAdapter(TypeToken, Object) ) with the AdapterKey s used
for registration. |
java.util.Map<AdapterKey<? extends org.eclipse.gef.mvc.fx.gestures.IGesture>,org.eclipse.gef.mvc.fx.gestures.IGesture> |
getTools()
Deprecated.
Will be removed in 6.0.0. Please use
getGestures()
instead. |
java.util.Map<AdapterKey<? extends IViewer>,IViewer> |
getViewers()
Returns the
IViewer s registered at this IDomain (via
IAdaptable.setAdapter(TypeToken, Object) ) with the AdapterKey s used
for registration. |
boolean |
isExecutionTransactionOpen(org.eclipse.gef.mvc.fx.gestures.IGesture gesture)
Returns
true if the given IGesture is taking part in
the currently open execution transaction. |
void |
openExecutionTransaction(org.eclipse.gef.mvc.fx.gestures.IGesture gesture)
Opens a new transaction or adds the given
IGesture to the
currently opened transaction for executing operations (via
execute(ITransactionalOperation, IProgressMonitor) ) on the
IOperationHistory used by this IDomain . |
adaptersProperty, getAdapter, getAdapter, getAdapter, getAdapterKey, getAdapters, getAdapters, getAdapters, setAdapter, setAdapter, setAdapter, setAdapter, unsetAdapter
activate, activeProperty, deactivate, isActive
dispose
static final java.lang.String CONTENT_VIEWER_ROLE
void closeExecutionTransaction(org.eclipse.gef.mvc.fx.gestures.IGesture gesture)
IGesture
from the transaction context, and opens a new execution
transaction if there are any gestures remaining in the context.gesture
- The IGesture
that should be removed from the
transaction context.openExecutionTransaction(IGesture)
void execute(ITransactionalOperation operation, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.commands.ExecutionException
IUndoableOperation
.operation
- The IUndoableOperation
to be executed on the
IOperationHistory
of this IDomain
.monitor
- An IProgressMonitor
used to indicate progress. May be
null
.org.eclipse.core.commands.ExecutionException
- In case an exception occurred during the execution of the
operation.java.util.Map<AdapterKey<? extends org.eclipse.gef.mvc.fx.gestures.IGesture>,org.eclipse.gef.mvc.fx.gestures.IGesture> getGestures()
IGesture
s registered at this IDomain
(via
IAdaptable.setAdapter(TypeToken, Object)
) with the AdapterKey
s used
for registration.Map
containing the registered IGesture
s mapped
to their respective AdapterKey
s.IAdaptable.setAdapter(TypeToken, Object)
@Deprecated java.util.Map<AdapterKey<? extends org.eclipse.gef.mvc.fx.gestures.IGesture>,org.eclipse.gef.mvc.fx.gestures.IGesture> getTools()
getGestures()
instead.IGesture
s registered at this IDomain
(via
IAdaptable.setAdapter(TypeToken, Object)
) with the AdapterKey
s used
for registration.Map
containing the registered IGesture
s mapped
to their respective AdapterKey
s.IAdaptable.setAdapter(TypeToken, Object)
java.util.Map<AdapterKey<? extends IViewer>,IViewer> getViewers()
IViewer
s registered at this IDomain
(via
IAdaptable.setAdapter(TypeToken, Object)
) with the AdapterKey
s used
for registration.Map
containing the registered IViewer
s mapped
to their respective AdapterKey
s.IAdaptable.setAdapter(TypeToken, Object)
boolean isExecutionTransactionOpen(org.eclipse.gef.mvc.fx.gestures.IGesture gesture)
true
if the given IGesture
is taking part in
the currently open execution transaction. Otherwise returns
false
.gesture
- The IGesture
that is checked.true
if the given IGesture
is taking part in
the currently open execution transaction, otherwise
false
.void openExecutionTransaction(org.eclipse.gef.mvc.fx.gestures.IGesture gesture)
IGesture
to the
currently opened transaction for executing operations (via
execute(ITransactionalOperation, IProgressMonitor)
) on the
IOperationHistory
used by this IDomain
.gesture
- The IGesture
starting/joining the transaction.Copyright (c) 2014, 2016 itemis AG and others. All rights reserved.