org.eclipse.graphiti.pattern
Class AddFeatureForPattern

java.lang.Object
  extended by org.eclipse.graphiti.features.impl.AbstractFeature
      extended by org.eclipse.graphiti.features.impl.AbstractAddFeature
          extended by org.eclipse.graphiti.pattern.AddFeatureForPattern
All Implemented Interfaces:
IAddFeature, ICustomUndoableFeature, IFeature, IFeatureProviderHolder, IAdd, IDescription, IName

public class AddFeatureForPattern
extends AbstractAddFeature
implements ICustomUndoableFeature

This feature wraps the add functionality of a pattern for calls of the Graphiti framework. Clients should not need to use this class directly.


Field Summary
private  IAdd pattern
           
 
Fields inherited from class org.eclipse.graphiti.features.impl.AbstractAddFeature
EMPTY
 
Constructor Summary
AddFeatureForPattern(IFeatureProvider featureProvider, IAdd pattern)
          Creates a new AddFeatureForPattern.
 
Method Summary
 PictogramElement add(IAddContext context)
          Executes the add.
 boolean canAdd(IAddContext context)
          Checks, if the add can be executed.
 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.
 void redo(IContext context)
          This method will be called to actually do the work needed for redo.
 void undo(IContext context)
          This method will be called to actually do the work needed for undo.
 
Methods inherited from class org.eclipse.graphiti.features.impl.AbstractAddFeature
canExecute, execute, getName
 
Methods inherited from class org.eclipse.graphiti.features.impl.AbstractFeature
addGraphicalRepresentation, getAllBusinessObjectsForPictogramElement, getBusinessObjectForPictogramElement, getDescription, getDiagram, getDiagramEditor, getFeatureProvider, getProgressCallback, getUserDecision, hasDoneChanges, isAvailable, layoutPictogramElement, link, link, manageColor, manageColor, 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

pattern

private IAdd pattern
Constructor Detail

AddFeatureForPattern

public AddFeatureForPattern(IFeatureProvider featureProvider,
                            IAdd pattern)
Creates a new AddFeatureForPattern.

Parameters:
featureProvider - the feature provider
pattern - the pattern
Method Detail

canAdd

public boolean canAdd(IAddContext context)
Description copied from interface: IAdd
Checks, if the add can be executed.

Specified by:
canAdd in interface IAdd
Parameters:
context - the context needed to execute the add
Returns:
true, if the add can be executed

add

public PictogramElement add(IAddContext context)
Description copied from interface: IAdd
Executes the add.

Specified by:
add in interface IAdd
Parameters:
context - the context needed to execute the add
Returns:
the added pictogram element

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 interface ICustomUndoableFeature
Specified by:
canUndo in interface IFeature
Overrides:
canUndo in class AbstractFeature
Parameters:
context - this is the general input for this method
Returns:
true if the feature can be undone, false if not
See Also:
IContext

undo

public void undo(IContext context)
Description copied from interface: ICustomUndoableFeature
This method will be called to actually do the work needed for undo. Customers may revert their non-EMF changes done by the feature here.

Specified by:
undo in interface ICustomUndoableFeature
Parameters:
context - this is the instance of the IContext object that was in use when executing the feature
Since:
0.8

canRedo

public boolean canRedo(IContext context)
Description copied from interface: ICustomUndoableFeature
Decides if the processed feature can be re-done.

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 interface ICustomUndoableFeature
Parameters:
context - this is the instance of the IContext object that was in use when executing the feature
Returns:
true if the feature can be re-done, false if not
Since:
0.8

redo

public void redo(IContext context)
Description copied from interface: ICustomUndoableFeature
This method will be called to actually do the work needed for redo. Customers may re-apply their non-EMF changes done by the feature here. (Usually it might be sufficient to delegate to the execution method of the feature.)

Specified by:
redo in interface ICustomUndoableFeature
Parameters:
context - this is the instance of the IContext object that was in use when executing the feature
Since:
0.8


Copyright (c) SAP AG 2005, 2012.