Class AbstractPrintFeature
- java.lang.Object
-
- org.eclipse.graphiti.features.impl.AbstractFeature
-
- org.eclipse.graphiti.features.impl.AbstractPrintFeature
-
- All Implemented Interfaces:
IFeature
,IFeatureProviderHolder
,IPrintFeature
,IDescription
,IName
- Direct Known Subclasses:
DefaultPrintFeature
public abstract class AbstractPrintFeature extends AbstractFeature implements IPrintFeature
Abstract base implementation of a save as image feature.- Since:
- 0.10
-
-
Constructor Summary
Constructors Constructor Description AbstractPrintFeature(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 methodcanPrint(IPrintContext)
.boolean
canPrint(IPrintContext context)
Checks if this feature can execute.void
execute(IContext context)
Executes this print feature by sequentially callingprePrint(IPrintContext)
,IPrintFeature.print(IPrintContext)
andpostPrint(IPrintContext)
.java.lang.String
getName()
Returns the name of the print feature, by default "Print"boolean
hasDoneChanges()
Hook method that reports if changes have been done while executing this feature.void
postPrint(IPrintContext context)
Hook method for executing stuff that needs to be done after actually printing a diagram.void
prePrint(IPrintContext context)
Hook method for executing stuff that needs to be done before actually printing a diagram.-
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.IPrintFeature
print
-
-
-
-
Constructor Detail
-
AbstractPrintFeature
public AbstractPrintFeature(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 print feature, by default "Print"- Specified by:
getName
in interfaceIName
- Overrides:
getName
in classAbstractFeature
- Returns:
- the name
-
canExecute
public final boolean canExecute(IContext context)
Checks if this feature can be executed by delegating to the methodcanPrint(IPrintContext)
.- Specified by:
canExecute
in interfaceIFeature
- Parameters:
context
- Context information for printing.- Returns:
true
in case this print feature can be executed,false
otherwise.- See Also:
IContext
-
canPrint
public boolean canPrint(IPrintContext context)
Checks if this feature can execute. The default implementation simply returnstrue
. Note that the Graphiti framework already checks the availability of printer in the print action that triggers this feature.- Specified by:
canPrint
in interfaceIPrintFeature
- Parameters:
context
- Context information for printing.- Returns:
true
in case this print feature can be executed,false
otherwise.
-
prePrint
public void prePrint(IPrintContext context)
Hook method for executing stuff that needs to be done before actually printing a diagram. The default implementation does nothing.- Specified by:
prePrint
in interfaceIPrintFeature
- Parameters:
context
- Context information for printing.
-
execute
public final void execute(IContext context)
Executes this print feature by sequentially callingprePrint(IPrintContext)
,IPrintFeature.print(IPrintContext)
andpostPrint(IPrintContext)
. This method will fail in case the passed context is noIPrintContext
.
-
postPrint
public void postPrint(IPrintContext context)
Hook method for executing stuff that needs to be done after actually printing a diagram. The default implementation does nothing.- Specified by:
postPrint
in interfaceIPrintFeature
- Parameters:
context
- Context information for printing.
-
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.
-
-