Package org.eclipse.graphiti.pattern
Class LayoutFeatureForPattern
- java.lang.Object
-
- org.eclipse.graphiti.features.impl.AbstractFeature
-
- org.eclipse.graphiti.features.impl.AbstractLayoutFeature
-
- org.eclipse.graphiti.pattern.LayoutFeatureForPattern
-
- All Implemented Interfaces:
ICustomAbortableUndoRedoFeature
,ICustomUndoRedoFeature
,IFeature
,IFeatureProviderHolder
,ILayoutFeature
,ILayout
,IDescription
,IName
public class LayoutFeatureForPattern extends AbstractLayoutFeature implements ICustomAbortableUndoRedoFeature
This feature wraps the layout functionality of a pattern for calls of the Graphiti framework. Clients should not need to use this class directly.
-
-
Constructor Summary
Constructors Constructor Description LayoutFeatureForPattern(IFeatureProvider featureProvider, IPattern pattern)
Creates a newLayoutFeatureForPattern
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canLayout(ILayoutContext context)
Checks whether the current pictogram element of the given context can be layouted.boolean
canRedo(IContext context)
Decides if the processed feature can be re-done.boolean
canUndo(IContext context)
Decides if the current feature can be undone - this is the undo of the execute operation.boolean
isAbort()
The Graphiti framework will call this method afterICustomUndoRedoFeature.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.boolean
layout(ILayoutContext context)
Layoutes the pictogram element.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.-
Methods inherited from class org.eclipse.graphiti.features.impl.AbstractLayoutFeature
canExecute, canLayoutPictogramElement, execute, getName, resizeShape
-
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.IDescription
getDescription
-
Methods inherited from interface org.eclipse.graphiti.features.IFeature
hasDoneChanges, isAvailable
-
Methods inherited from interface org.eclipse.graphiti.features.IFeatureProviderHolder
getFeatureProvider
-
-
-
-
Constructor Detail
-
LayoutFeatureForPattern
public LayoutFeatureForPattern(IFeatureProvider featureProvider, IPattern pattern)
Creates a newLayoutFeatureForPattern
.- Parameters:
featureProvider
- the feature providerpattern
- the pattern
-
-
Method Detail
-
canLayout
public boolean canLayout(ILayoutContext context)
Description copied from interface:ILayout
Checks whether the current pictogram element of the given context can be layouted.
-
layout
public boolean layout(ILayoutContext context)
Description copied from interface:ILayout
Layoutes the pictogram element.
-
isAbort
public boolean isAbort()
Description copied from interface:ICustomAbortableUndoRedoFeature
The Graphiti framework will call this method afterICustomUndoRedoFeature.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 returnstrue
, the operation will be cancelled by the Graphiti framework by throwing anOperationCanceledException
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.- Specified by:
isAbort
in interfaceICustomAbortableUndoRedoFeature
- Returns:
true
in case you want to cancel the current operation,false
otherwise.- Since:
- 0.12
-
canUndo
public boolean canUndo(IContext context)
Description copied from interface:IFeature
Decides if the current feature can be undone - this is the undo of the execute operation.- Specified by:
canUndo
in interfaceICustomUndoRedoFeature
- Specified by:
canUndo
in interfaceIFeature
- Overrides:
canUndo
in classAbstractFeature
- Parameters:
context
- this is the general input for this method- Returns:
- true if the feature can be undone, false if not
- See Also:
IContext
-
preUndo
public void preUndo(IContext context)
Description copied from interface:ICustomUndoRedoFeature
This method will be called by the Graphiti framework before the EMF undo is triggered. Customers may revert their non-EMF changes done by the feature here or inICustomUndoRedoFeature.postUndo(IContext)
.- Specified by:
preUndo
in interfaceICustomUndoRedoFeature
- Parameters:
context
- this is the instance of theIContext
object that was in use when executing the feature- Since:
- 0.12
-
postUndo
public void postUndo(IContext context)
Description copied from interface:ICustomUndoRedoFeature
This method will be called by the Graphiti framework after the EMF undo is finished. Customers may revert their non-EMF changes done by the feature here or inICustomUndoRedoFeature.preUndo(IContext)
.- Specified by:
postUndo
in interfaceICustomUndoRedoFeature
- Parameters:
context
- this is the instance of theIContext
object that was in use when executing the feature- Since:
- 0.12
-
canRedo
public boolean canRedo(IContext context)
Description copied from interface:ICustomUndoRedoFeature
Decides if the processed feature can be re-done. This method is called once by the Graphiti framework just before any redo work is started, e.g. beforeICustomUndoRedoFeature.preRedo(IContext)
.Note that as soon as any feature reports
false
here, also all consecutive entries in the command stack are no longer reachable for redo.- Specified by:
canRedo
in interfaceICustomUndoRedoFeature
- Parameters:
context
- this is the instance of theIContext
object that was in use when executing the feature- Returns:
- true if the feature can be re-done, false if not
- Since:
- 0.8
-
preRedo
public void preRedo(IContext context)
Description copied from interface:ICustomUndoRedoFeature
This method will be called by the Graphiti framework before the EMF undo has triggered. Customers may re-apply their non-EMF changes done by the feature here or inICustomUndoRedoFeature.postRedo(IContext)
. (Usually it might be sufficient to delegate to the execution method of the feature.)- Specified by:
preRedo
in interfaceICustomUndoRedoFeature
- Parameters:
context
- this is the instance of theIContext
object that was in use when executing the feature- Since:
- 0.12
-
postRedo
public void postRedo(IContext context)
Description copied from interface:ICustomUndoRedoFeature
This method will be called by the Graphiti framework after the EMF undo has finished. Customers may re-apply their non-EMF changes done by the feature here or inICustomUndoRedoFeature.preRedo(IContext)
. (Usually it might be sufficient to delegate to the execution method of the feature.)- Specified by:
postRedo
in interfaceICustomUndoRedoFeature
- Parameters:
context
- this is the instance of theIContext
object that was in use when executing the feature- Since:
- 0.12
-
-