Class AbstractSaveImageFeature
- java.lang.Object
-
- org.eclipse.graphiti.features.impl.AbstractFeature
-
- org.eclipse.graphiti.features.impl.AbstractSaveImageFeature
-
- All Implemented Interfaces:
IFeature
,IFeatureProviderHolder
,ISaveImageFeature
,IDescription
,IName
- Direct Known Subclasses:
DefaultSaveImageFeature
public abstract class AbstractSaveImageFeature extends AbstractFeature implements ISaveImageFeature
Abstract base implementation of a save as image feature.- Since:
- 0.10
-
-
Constructor Summary
Constructors Constructor Description AbstractSaveImageFeature(IFeatureProvider fp)
Constructor that is to be called by any subclass.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canExecute(IContext context)
Checks if this feature can be executed by delegating to the methodcanSave(ISaveImageContext)
.boolean
canSave(ISaveImageContext context)
Checks if this feature can execute.void
execute(IContext context)
Executes this save image feature by sequentially callingpreSave(ISaveImageContext)
,ISaveImageFeature.save(ISaveImageContext)
andpostSave(ISaveImageContext)
.java.lang.String
getName()
Returns the name of the save as image feature, by default "Save As Image"boolean
hasDoneChanges()
Hook method that reports if changes have been done while executing this feature.void
postSave(ISaveImageContext context)
Hook method for executing stuff that needs to be done after actually saving a diagram as an image.void
preSave(ISaveImageContext context)
Hook method for executing stuff that needs to be done before actually saving a diagram as an image.-
Methods inherited from class org.eclipse.graphiti.features.impl.AbstractFeature
addGraphicalRepresentation, canUndo, getAllBusinessObjectsForPictogramElement, getBusinessObjectForPictogramElement, getDescription, getDiagram, getDiagramBehavior, getFeatureProvider, getProgressCallback, getUserDecision, 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
canUndo, isAvailable
-
Methods inherited from interface org.eclipse.graphiti.features.IFeatureProviderHolder
getFeatureProvider
-
Methods inherited from interface org.eclipse.graphiti.features.ISaveImageFeature
save
-
-
-
-
Constructor Detail
-
AbstractSaveImageFeature
public AbstractSaveImageFeature(IFeatureProvider fp)
Constructor that is to be called by any subclass.- Parameters:
fp
- The feature provider that created the feature
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns the name of the save as image feature, by default "Save As Image"- Specified by:
getName
in interfaceIName
- Overrides:
getName
in classAbstractFeature
- Returns:
- the name
-
canExecute
public boolean canExecute(IContext context)
Checks if this feature can be executed by delegating to the methodcanSave(ISaveImageContext)
.- Specified by:
canExecute
in interfaceIFeature
- Parameters:
context
- Context information for printing.- Returns:
true
in case this save image feature can be executed,false
otherwise.- See Also:
IContext
-
canSave
public boolean canSave(ISaveImageContext context)
Checks if this feature can execute. The default implementation simply returnstrue
.- Specified by:
canSave
in interfaceISaveImageFeature
- Parameters:
context
- Context information for saving an image.- Returns:
true
in case this save image feature can be executed,false
otherwise.
-
preSave
public void preSave(ISaveImageContext context)
Hook method for executing stuff that needs to be done before actually saving a diagram as an image. The default implementation does nothing.- Specified by:
preSave
in interfaceISaveImageFeature
- Parameters:
context
- Context information for saving.
-
execute
public final void execute(IContext context)
Executes this save image feature by sequentially callingpreSave(ISaveImageContext)
,ISaveImageFeature.save(ISaveImageContext)
andpostSave(ISaveImageContext)
. This method will fail in case the passed context is noISaveImageContext
.
-
postSave
public void postSave(ISaveImageContext context)
Hook method for executing stuff that needs to be done after actually saving a diagram as an image. The default implementation does nothing.- Specified by:
postSave
in interfaceISaveImageFeature
- Parameters:
context
- Context information for saving.
-
hasDoneChanges
public boolean hasDoneChanges()
Hook method that reports if changes have been done while executing this feature. In casefalse
is returned the feature will not appear in the undo stack. The default implementation simply returnsfalse
.- Specified by:
hasDoneChanges
in interfaceIFeature
- Overrides:
hasDoneChanges
in classAbstractFeature
- Returns:
true
in case changes have been made,false
otherwise.
-
-