|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.graphiti.features.impl.AbstractFeature
org.eclipse.graphiti.features.impl.AbstractCreateConnectionFeature
org.eclipse.graphiti.pattern.CreateConnectionFeatureForPattern
public class CreateConnectionFeatureForPattern
This feature wraps the create functionality of a pattern for calls of the Graphiti framework. Clients should not need to use this class directly.
Field Summary | |
---|---|
private IConnectionPattern |
delegate
|
Constructor Summary | |
---|---|
CreateConnectionFeatureForPattern(IFeatureProvider featureProvider,
IConnectionPattern pattern)
Creates a new CreateConnectionFeatureForPattern . |
Method Summary | |
---|---|
void |
attachedToSource(ICreateConnectionContext context)
Will called after a connection was successfully attached to an anchor of a source object. Note: In contrast to the standard feature methods like ICreateConnection.canCreate(ICreateConnectionContext) and
ICreateConnection.create(ICreateConnectionContext) this method will not be called
in the scope of an EMF transaction. |
void |
canceledAttaching(ICreateConnectionContext context)
Will called if the connection creation process was canceled after the successful attachment of the connection to an anchor of a source object. |
boolean |
canCreate(ICreateConnectionContext context)
Can create. |
boolean |
canRedo(IContext context)
Decides if the processed feature can be re-done. |
boolean |
canStartConnection(ICreateConnectionContext context)
Can start connection. |
boolean |
canUndo(IContext context)
Decides if the current feature can be undone - this is the undo of the execute operation. |
Connection |
create(ICreateConnectionContext context)
Creates the connection. |
void |
endConnecting()
Will called after a connection creation tool from the palette was deselected. Note: In contrast to the standard feature methods like ICreateConnection.canCreate(ICreateConnectionContext) and
ICreateConnection.create(ICreateConnectionContext) this method will not be called
in the scope of an EMF transaction. |
String |
getCreateImageId()
Gets the create image id. |
String |
getCreateLargeImageId()
Gets the create large image id. |
IConnectionPattern |
getPattern()
Gets the pattern. |
boolean |
isAbort()
The Graphiti framework will call this method after ICustomUndoRedoFeature.preUndo(org.eclipse.graphiti.features.context.IContext) /
ICustomUndoRedoFeature.preRedo(org.eclipse.graphiti.features.context.IContext) have
been called and before the actual undo/redo operation is triggered. |
void |
postRedo(IContext context)
This method will be called by the Graphiti framework after the EMF undo has finished. |
void |
postUndo(IContext context)
This method will be called by the Graphiti framework after the EMF undo is finished. |
void |
preRedo(IContext context)
This method will be called by the Graphiti framework before the EMF undo has triggered. |
void |
preUndo(IContext context)
This method will be called by the Graphiti framework before the EMF undo is triggered. |
void |
redo(IContext context)
Deprecated. use postRedo(IContext) instead |
void |
startConnecting()
Will called after a connection creation tool from the palette was selected. Note: In contrast to the standard feature methods like ICreateConnection.canCreate(ICreateConnectionContext) and
ICreateConnection.create(ICreateConnectionContext) this method will not be called
in the scope of an EMF transaction. |
void |
undo(IContext context)
Deprecated. use postUndo(IContext) instead |
Methods inherited from class org.eclipse.graphiti.features.impl.AbstractCreateConnectionFeature |
---|
canExecute, execute, getCreateDescription, getCreateName, getName |
Methods inherited from class org.eclipse.graphiti.features.impl.AbstractFeature |
---|
addGraphicalRepresentation, getAllBusinessObjectsForPictogramElement, getBusinessObjectForPictogramElement, getDescription, getDiagram, getDiagramBehavior, getFeatureProvider, getProgressCallback, getUserDecision, hasDoneChanges, isAvailable, layoutPictogramElement, link, link, manageColor, manageColor, manageDefaultFont, manageFont, manageFont, setProgressCallback, toString, updatePictogramElement |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.graphiti.features.IFeature |
---|
hasDoneChanges, isAvailable |
Methods inherited from interface org.eclipse.graphiti.IDescription |
---|
getDescription |
Methods inherited from interface org.eclipse.graphiti.features.IFeatureProviderHolder |
---|
getFeatureProvider |
Field Detail |
---|
private IConnectionPattern delegate
Constructor Detail |
---|
public CreateConnectionFeatureForPattern(IFeatureProvider featureProvider, IConnectionPattern pattern)
CreateConnectionFeatureForPattern
.
featureProvider
- the feature providerpattern
- the connection patternMethod Detail |
---|
public boolean canCreate(ICreateConnectionContext context)
ICreateConnection
canCreate
in interface ICreateConnection
context
- the context
public boolean canStartConnection(ICreateConnectionContext context)
ICreateConnection
canStartConnection
in interface ICreateConnection
context
- the context
public Connection create(ICreateConnectionContext context)
ICreateConnection
create
in interface ICreateConnection
context
- the context
null
in case
no valid connection can be returned. Currently this return value
is not evaluated by the Graphiti framework but it might be used
in future versions but only for performance optimizations.public String getCreateImageId()
ICreateInfo
getCreateImageId
in interface ICreateInfo
getCreateImageId
in class AbstractCreateConnectionFeature
public String getCreateLargeImageId()
ICreateInfo
getCreateLargeImageId
in interface ICreateInfo
getCreateLargeImageId
in class AbstractCreateConnectionFeature
public boolean isAbort()
ICustomAbortableUndoRedoFeature
ICustomUndoRedoFeature.preUndo(org.eclipse.graphiti.features.context.IContext)
/
ICustomUndoRedoFeature.preRedo(org.eclipse.graphiti.features.context.IContext)
have
been called and before the actual undo/redo operation is triggered. In
case this method returns true
, the operation will be
cancelled by the Graphiti framework by throwing an
OperationCanceledException
that causes am EMF revert of the
operation.
Implementing classes might e.g. set a flag in
ICustomUndoRedoFeature.preUndo(org.eclipse.graphiti.features.context.IContext)
/
ICustomUndoRedoFeature.preRedo(org.eclipse.graphiti.features.context.IContext)
as
cancellation indication and check that that flag here.
isAbort
in interface ICustomAbortableUndoRedoFeature
true
in case you want to cancel the current
operation, false
otherwise.public boolean canUndo(IContext context)
IFeature
canUndo
in interface ICustomUndoableFeature
canUndo
in interface ICustomUndoRedoFeature
canUndo
in interface IFeature
canUndo
in class AbstractFeature
context
- this is the general input for this method
IContext
public void preUndo(IContext context)
ICustomUndoRedoFeature
ICustomUndoRedoFeature.postUndo(IContext)
.
preUndo
in interface ICustomUndoRedoFeature
context
- this is the instance of the IContext
object that was
in use when executing the featurepublic void postUndo(IContext context)
ICustomUndoRedoFeature
ICustomUndoRedoFeature.preUndo(IContext)
.
postUndo
in interface ICustomUndoRedoFeature
context
- this is the instance of the IContext
object that was
in use when executing the featurepublic void undo(IContext context)
postUndo(IContext)
instead
ICustomUndoableFeature
undo
in interface ICustomUndoableFeature
context
- this is the instance of the IContext
object that was
in use when executing the featurepublic boolean canRedo(IContext context)
ICustomUndoableFeature
Note that as soon as any feature reports false
here, also
all consecutive entries in the command stack are no longer reachable for
redo.
canRedo
in interface ICustomUndoableFeature
canRedo
in interface ICustomUndoRedoFeature
context
- this is the instance of the IContext
object that was
in use when executing the feature
public void preRedo(IContext context)
ICustomUndoRedoFeature
ICustomUndoRedoFeature.postRedo(IContext)
. (Usually it might be
sufficient to delegate to the execution method of the feature.)
preRedo
in interface ICustomUndoRedoFeature
context
- this is the instance of the IContext
object that was
in use when executing the featurepublic void postRedo(IContext context)
ICustomUndoRedoFeature
ICustomUndoRedoFeature.preRedo(IContext)
. (Usually it might be
sufficient to delegate to the execution method of the feature.)
postRedo
in interface ICustomUndoRedoFeature
context
- this is the instance of the IContext
object that was
in use when executing the featurepublic void redo(IContext context)
postRedo(IContext)
instead
ICustomUndoableFeature
redo
in interface ICustomUndoableFeature
context
- this is the instance of the IContext
object that was
in use when executing the featurepublic void startConnecting()
ICreateConnection
ICreateConnection.canCreate(ICreateConnectionContext)
and
ICreateConnection.create(ICreateConnectionContext)
this method will not be called
in the scope of an EMF transaction. In case you want to modify the model
(EMF domain objects or Graphiti pictogram objects) you need to do that
within a command executed on the editor's command stack to make sure that
the modification happens inside an EMF write transaction. Keep in mind
that any changes you do within such a command will be create a seperate
entry in the undo/redo stack for the editor, which might not be the
desired effect.
startConnecting
in interface ICreateConnection
startConnecting
in class AbstractCreateConnectionFeature
public void endConnecting()
ICreateConnection
ICreateConnection.canCreate(ICreateConnectionContext)
and
ICreateConnection.create(ICreateConnectionContext)
this method will not be called
in the scope of an EMF transaction. In case you want to modify the model
(EMF domain objects or Graphiti pictogram objects) you need to do that
within a command executed on the editor's command stack to make sure that
the modification happens inside an EMF write transaction. Keep in mind
that any changes you do within such a command will be create a seperate
entry in the undo/redo stack for the editor, which might not be the
desired effect.
endConnecting
in interface ICreateConnection
endConnecting
in class AbstractCreateConnectionFeature
public void attachedToSource(ICreateConnectionContext context)
ICreateConnection
ICreateConnection.canCreate(ICreateConnectionContext)
and
ICreateConnection.create(ICreateConnectionContext)
this method will not be called
in the scope of an EMF transaction. In case you want to modify the model
(EMF domain objects or Graphiti pictogram objects) you need to do that
within a command executed on the editor's command stack to make sure that
the modification happens inside an EMF write transaction. Keep in mind
that any changes you do within such a command will be create a seperate
entry in the undo/redo stack for the editor, which might not be the
desired effect.
attachedToSource
in interface ICreateConnection
attachedToSource
in class AbstractCreateConnectionFeature
context
- the contextpublic void canceledAttaching(ICreateConnectionContext context)
ICreateConnection
ICreateConnection.canCreate(ICreateConnectionContext)
and
ICreateConnection.create(ICreateConnectionContext)
this method will not be called
in the scope of an EMF transaction. In case you want to modify the model
(EMF domain objects or Graphiti pictogram objects) you need to do that
within a command executed on the editor's command stack to make sure that
the modification happens inside an EMF write transaction. Keep in mind
that any changes you do within such a command will be create a seperate
entry in the undo/redo stack for the editor, which might not be the
desired effect.
canceledAttaching
in interface ICreateConnection
canceledAttaching
in class AbstractCreateConnectionFeature
context
- the contextpublic IConnectionPattern getPattern()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |