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
Abstract base implementation of a save as image feature.
- Since:
- 0.10
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor that is to be called by any subclass. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleancanExecute(IContext context) Checks if this feature can be executed by delegating to the methodcanPrint(IPrintContext).booleancanPrint(IPrintContext context) Checks if this feature can execute.final voidExecutes this print feature by sequentially callingprePrint(IPrintContext),IPrintFeature.print(IPrintContext)andpostPrint(IPrintContext).getName()Returns the name of the print feature, by default "Print"booleanHook method that reports if changes have been done while executing this feature.voidpostPrint(IPrintContext context) Hook method for executing stuff that needs to be done after actually printing a diagram.voidprePrint(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, updatePictogramElementMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.eclipse.graphiti.IDescription
getDescriptionMethods inherited from interface org.eclipse.graphiti.features.IFeature
canUndo, isAvailableMethods inherited from interface org.eclipse.graphiti.features.IFeatureProviderHolder
getFeatureProviderMethods inherited from interface org.eclipse.graphiti.features.IPrintFeature
print
-
Constructor Details
-
AbstractPrintFeature
Constructor that is to be called by any subclass.- Parameters:
fp- The feature provider that created the feature
-
-
Method Details
-
getName
Returns the name of the print feature, by default "Print"- Specified by:
getNamein interfaceIName- Overrides:
getNamein classAbstractFeature- Returns:
- the name
-
canExecute
Checks if this feature can be executed by delegating to the methodcanPrint(IPrintContext).- Specified by:
canExecutein interfaceIFeature- Parameters:
context- Context information for printing.- Returns:
truein case this print feature can be executed,falseotherwise.- See Also:
-
canPrint
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:
canPrintin interfaceIPrintFeature- Parameters:
context- Context information for printing.- Returns:
truein case this print feature can be executed,falseotherwise.
-
prePrint
Hook method for executing stuff that needs to be done before actually printing a diagram. The default implementation does nothing.- Specified by:
prePrintin interfaceIPrintFeature- Parameters:
context- Context information for printing.
-
execute
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
Hook method for executing stuff that needs to be done after actually printing a diagram. The default implementation does nothing.- Specified by:
postPrintin 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 casefalseis returned the feature will not appear in the undo stack. The default implementation simply returnsfalse.- Specified by:
hasDoneChangesin interfaceIFeature- Overrides:
hasDoneChangesin classAbstractFeature- Returns:
truein case changes have been made,falseotherwise.
-