org.eclipse.graphiti.pattern
Class UpdateFeatureForPattern

java.lang.Object
  extended by org.eclipse.graphiti.features.impl.AbstractFeature
      extended by org.eclipse.graphiti.features.impl.AbstractUpdateFeature
          extended by org.eclipse.graphiti.pattern.UpdateFeatureForPattern
All Implemented Interfaces:
ICustomUndoableFeature, IFeature, IFeatureProviderHolder, IUpdateFeature, IUpdate, IDescription, IName

public class UpdateFeatureForPattern
extends AbstractUpdateFeature
implements ICustomUndoableFeature

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


Field Summary
private  IUpdate pattern
           
 
Constructor Summary
UpdateFeatureForPattern(IFeatureProvider featureProvider, IUpdate pattern)
          Creates a new UpdateFeatureForPattern.
 
Method Summary
 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 canUpdate(IUpdateContext context)
          Checks whether the values of the current pictogram element of the given context can be updated.
 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.
 boolean update(IUpdateContext context)
          Updates the pictogram element.
 IReason updateNeeded(IUpdateContext context)
          Check whether the values in the pictogram element are up to date, that means whether the graphics algorithm of this pictogram element contain the latest values from the business objects.
 
Methods inherited from class org.eclipse.graphiti.features.impl.AbstractUpdateFeature
canExecute, canUpdatePictogramElement, execute, getDescription, getName, resizeShape, updatePictogramElement, updatePictogramElementNeeded
 
Methods inherited from class org.eclipse.graphiti.features.impl.AbstractFeature
addGraphicalRepresentation, getAllBusinessObjectsForPictogramElement, getBusinessObjectForPictogramElement, getDiagram, getDiagramBehavior, getDiagramEditor, getFeatureProvider, getProgressCallback, getUserDecision, hasDoneChanges, isAvailable, layoutPictogramElement, link, link, manageColor, manageColor, manageDefaultFont, manageFont, manageFont, setProgressCallback, toString
 
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.features.IFeatureProviderHolder
getFeatureProvider
 

Field Detail

pattern

private IUpdate pattern
Constructor Detail

UpdateFeatureForPattern

public UpdateFeatureForPattern(IFeatureProvider featureProvider,
                               IUpdate pattern)
Creates a new UpdateFeatureForPattern.

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

canUpdate

public boolean canUpdate(IUpdateContext context)
Description copied from interface: IUpdate
Checks whether the values of the current pictogram element of the given context can be updated.

Specified by:
canUpdate in interface IUpdate
Parameters:
context - the context
Returns:
true if update is possible

updateNeeded

public IReason updateNeeded(IUpdateContext context)
Description copied from interface: IUpdate
Check whether the values in the pictogram element are up to date, that means whether the graphics algorithm of this pictogram element contain the latest values from the business objects.

Specified by:
updateNeeded in interface IUpdate
Parameters:
context - the context
Returns:
true if parts of the pictogram model needs to be updated with the latest values from the business model

update

public boolean update(IUpdateContext context)
Description copied from interface: IUpdate
Updates the pictogram element. It copies the latest values from the business model to the graphics algorithm of this pictogram elements.

Specified by:
update in interface IUpdate
Parameters:
context - the context
Returns:
true, if update process was successfull

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.