{"id":69,"date":"2008-07-27T13:22:29","date_gmt":"2008-07-27T13:22:29","guid":{"rendered":"http:\/\/cyberpen.wordpress.com\/?p=69"},"modified":"2022-10-31T17:53:35","modified_gmt":"2022-10-31T17:53:35","slug":"print-all-gmf-diagrams-with-a-single-click","status":"publish","type":"post","link":"https:\/\/www.confianzit.com\/cit-blog\/print-all-gmf-diagrams-with-a-single-click\/","title":{"rendered":"Print all GMF diagrams with a single click"},"content":{"rendered":"

[et_pb_section fb_built=”1″ _builder_version=”3.22″][et_pb_row _builder_version=”4.9.4″ background_size=”initial” background_position=”top_left” background_repeat=”repeat” hover_enabled=”0″ column_structure=”3_5,2_5″ sticky_enabled=”0″][et_pb_column type=”3_5″ _builder_version=”3.25″ custom_padding=”|||” custom_padding__hover=”|||”][et_pb_text _builder_version=”4.9.4″ background_size=”initial” background_position=”top_left” background_repeat=”repeat” hover_enabled=”0″ module_class=”blog-left-content” sticky_enabled=”0″]<\/p>\n

<\/p>\n

Print all GMF diagrams with a single click<\/strong><\/span><\/p>\n

We know that GMF gives only three types of Print Options for the Print Range.<\/p>\n

a. Current Diagram<\/p>\n

b. All diagrams from open models<\/p>\n

c. Selected diagrams.<\/p>\n

Suppose consider your projects contain a large number of diagrams and you wish to Print all the diagrams. What are the options left? You need to open up each of the diagram and click print. This is a hard task when you have a large number of diagrams. I have found a better way by automating it.<\/p>\n

Please note that there will be a lot of methods to accomplish this. This is one method I am going to detail. Since GMF doesn’t allow us to do this directly I am customizing four GMF internal classes. The classes we need to customize are<\/p>\n

DiagramWithPrintGlobalActionHandlerProvider<\/strong> class<\/p>\n

DiagramWithPrintGlobalActionHandler<\/strong> class<\/p>\n

EnhancedPrintActionHelper<\/strong> class<\/p>\n

DiagramPrinterUtil<\/strong> class<\/p>\n

DiagramWithPrintGlobalActionHandlerProvider<\/strong> is the class that provides GlobalActionHandlerProvider for print functionality. This will be defined in our plugin’s plugin.xml<\/p>\n

Before we start we need to make these four classes as custom ones. I am doing this because we cannot edit the source code of dependent plugins. If we have attached source for these classes in out target platform definition we can view the code while debugging but We cannot the edit the code for our own customization.<\/p>\n

As the first step create four new classes in a package of your choice with names<\/p>\n

CustomDiagramWithPrintGlobalActionHandlerProvider.java <\/strong><\/p>\n

CustomDiagramWithPrintGlobalActionHandler.java <\/strong><\/p>\n

CustomEnhancedPrintActionHelper.java <\/strong><\/p>\n

CustomDiagramPrinterUtil.java<\/strong><\/p>\n

Copy the original code itself in to these classes from its respective original counterparts. Once done that open up your plugin’s plugin.xml and change the GlobalActionHandlerProvider<\/strong> definition to as shown below.<\/p>\n

<extension point=”org.eclipse.gmf.runtime.common.ui.services.action.globalActionHandlerProviders”><\/p>\n

<GlobalActionHandlerProvider<\/p>\n

class=”mypackage.printing.CustomDiagramWithPrintGlobalActionHandlerProvider<\/strong>“<\/p>\n

id=”mydomainPresentationPrint”><\/p>\n

<Priority name=”High”\/><\/p>\n

<ViewId id=”mypackage.CustomDiagramEditorID”><\/p>\n

<ElementType class=”org.eclipse.gmf.runtime.diagram.ui.editparts.IGraphicalEditPart”><\/p>\n

<GlobalActionId actionId=”print”\/><\/p>\n

<\/ElementType><\/p>\n

<\/ViewId><\/p>\n

<\/GlobalActionHandlerProvider><\/p>\n

<\/extension><\/p>\n

Once you are done with this, start your application using the Run configuration. Yep, We haven’t changed anything in our custom classes, but We want to make sure it works in the default way. If this works fine we can make sure that the print mechanism is actually referencing our custom classes instead of the GMF internal classes. Still having doubts? put some break points in the code and see whether our class is called while running in eclipse DEBUG mode.<\/p>\n

Make sure this works fine. ie. The print options given above should work the same way as it existed because we have copied the original code itself to our custom classes.<\/p>\n

So whats our ultimate AIM? We want to automate the printing of all diagrams with a single click. For that we need to make a lot of changes in code for these 4 classes that we have just made.<\/p>\n

Step 1: Open up CustomDiagramWithPrintGlobalActionHandlerProvider.java<\/strong> and make changes shown below.<\/p>\n

………………………<\/p>\n

if<\/strong> (!getHandlerList().containsKey(context.getActivePart())) {<\/p>\n

getHandlerList().put(context.getActivePart(),<\/p>\n

new<\/strong> CustomDiagramWithPrintGlobalActionHandler()<\/strong>);<\/p>\n

………………………<\/p>\n

return<\/strong> (CustomDiagramWithPrintGlobalActionHandler<\/strong>) getHandlerList().get(context.getActivePart());<\/p>\n

………………………<\/p>\n

Step 2:Open up CustomDiagramWithPrintGlobalActionHandler <\/strong>and make changes as shown below.<\/p>\n

protected<\/strong> void<\/strong> doPrint(IGlobalActionContext cntxt) {<\/p>\n

IPrintActionHelper helper = new <\/strong>CustomEnhancedPrintActionHelper()<\/strong>;<\/p>\n

helper.doPrint(cntxt.getActivePart());<\/p>\n

}<\/p>\n

…………………………<\/p>\n

Step 3:open up CustomDiagramPrinterUtil.java<\/strong><\/p>\n

This is the class we are going to do a lot of coding to attain our goal.<\/p>\n

What we are going to do is<\/p>\n

#1.Get all the diagram files from the Workspace using our diagram file’s extension as an Array list.<\/p>\n

#2.Ina loop we Will Open a diagram,Print the Diagram and Close the diagram. This loop will iterate for n times where, n is the size of the array list described in #1.<\/p>\n

#1.I find all the diagram files present in my workspace using my diagram’s extension.<\/strong><\/span><\/p>\n

private<\/strong> static<\/strong> Collection getWorkspaceFiles(String extension)<\/p>\n

{<\/p>\n

ArrayList files = new<\/strong> ArrayList();<\/p>\n

IWorkspaceRoot root = ResourcesPlugin.getWorkspace<\/em>().getRoot();<\/p>\n

IProject[] projects = root.getProjects();<\/p>\n

for<\/strong> (int<\/strong> i=0;i<projects.length;i++)<\/p>\n

{<\/p>\n

try<\/strong> {<\/p>\n

IResource[] resources = projects[i].members();<\/p>\n

for<\/strong> (int<\/strong> j=0;j<resources.length;j++)<\/p>\n

{<\/p>\n

getChildren<\/em>(resources[j], files, extension);<\/p>\n

}<\/p>\n

}<\/p>\n

catch<\/strong> (CoreException ex)<\/p>\n

{\/*ignore*\/}<\/p>\n

}<\/p>\n

return<\/strong> files;<\/p>\n

}<\/p>\n

private<\/strong> static<\/strong> void<\/strong> getChildren(IResource res, ArrayList files, String extension)<\/p>\n

{<\/p>\n

if<\/strong> (res instanceof<\/strong> IFile)<\/p>\n

{<\/p>\n

if<\/strong> (extension == null<\/strong> ||( res.getFileExtension()!=null<\/strong> && res.getFileExtension().endsWith(extension) ))<\/p>\n

files.add(res.getFullPath().toString());<\/p>\n

}<\/p>\n

if<\/strong> (res instanceof<\/strong> IFolder)<\/p>\n

{<\/p>\n

try<\/strong> {<\/p>\n

IResource[] resources = ((IFolder)res).members();<\/p>\n

for<\/strong> (int<\/strong> j=0;j<resources.length;j++)<\/p>\n

{<\/p>\n

getChildren<\/em>(resources[j], files, extension);<\/p>\n

}<\/p>\n

}<\/p>\n

catch<\/strong> (CoreException ex)<\/p>\n

{}<\/p>\n

}<\/p>\n

}<\/p>\n

#2.Ina loop we Will Open a diagram,Print the Diagram and Close the diagram.<\/strong><\/span><\/p>\n

For anyone there will be a doubt where to put this loop and call the function calls. In my case I put this inside the code block that gets called when we select “All diagrams from open models” in the print dialog.<\/p>\n

…………….<\/p>\n

else<\/strong> if<\/strong> (helper.getDlgDiagramPrintRangeAll()) {<\/p>\n

flag=1;<\/p>\n

ArrayList files = (ArrayList)getWorkspaceFiles<\/em>(“mydomain_diagram”);<\/p>\n

System.out<\/em>.println(“Number of diagrams to be printed is”+files.size());<\/p>\n

for<\/strong>(int<\/strong> i=0;i<files.size();i++){<\/p>\n

System.out<\/em>.println(“Diagram opened is”+files.get(i));<\/p>\n

openDiagram<\/em>(files.get(i).toString());<\/p>\n

PrintDiagram<\/em>(diagramPrinter,helper);<\/p>\n

closeDiagram<\/em>();<\/p>\n

}<\/p>\n

…………<\/p>\n

And the Functions for Opening and Printing and Closing are as follows:<\/p>\n

\/\/Method for Opening the Diagram<\/p>\n

private<\/strong> static<\/strong> void<\/strong> openDiagram(String DiagramName){<\/p>\n

URI diagramModelFilename = URI.createURI<\/em>(DiagramName);<\/p>\n

GMFResource myGMFDiagram = new<\/strong> GMFResource(diagramModelFilename);<\/p>\n

try<\/strong> {<\/p>\n

myGMFDiagram.load(Collections.EMPTY_MAP<\/em>);<\/p>\n

myDomainDiagramEditorUtil<\/strong>.openDiagram<\/em>(myGMFDiagram);<\/p>\n

} catch<\/strong> (IOException e1) {<\/p>\n

e1.printStackTrace();<\/p>\n

} catch<\/strong> (PartInitException e) {<\/p>\n

System.out<\/em>.println(“Error opening diagram editor”+e.getStatus());<\/p>\n

}<\/p>\n

}<\/p>\n

……..<\/p>\n

\/\/Method for Printing the Diagram<\/p>\n

……..<\/p>\n

private<\/strong> static<\/strong> void<\/strong> PrintDiagram(DiagramPrinter diagramPrinter,IPrintHelper helper){<\/p>\n

DiagramEditor dEditor = null<\/strong>;<\/p>\n

List diagramEditors = EditorService.getInstance<\/em>().getRegisteredEditorParts();<\/p>\n

Iterator it = diagramEditors.iterator();<\/p>\n

while<\/strong> (it.hasNext()) {<\/p>\n

Object obje = it.next();<\/p>\n

if<\/strong> (obje instanceof<\/strong> DiagramEditor) { \/\/DiagramDocumentEditor<\/p>\n

dEditor = (DiagramEditor) obje;<\/p>\n

}<\/p>\n

}<\/p>\n

diagramPrinter.setDiagrams(Collections.singletonList<\/em>(dEditor.getDiagram()));<\/p>\n

printDiagrams<\/em>(diagramPrinter, helper);<\/p>\n

System.out<\/em>.println(“File Printed”);<\/p>\n

}<\/p>\n

……..<\/p>\n

\/\/Method for Closing the Diagram<\/p>\n

……..<\/p>\n

private<\/strong> static<\/strong> void<\/strong> closeDiagram(){<\/p>\n

IWorkbench workbench = PlatformUI.getWorkbench<\/em>();<\/p>\n

if<\/strong> (workbench != null<\/strong>) {<\/p>\n

if<\/strong> (workbench.getWorkbenchWindows() != null<\/strong><\/p>\n

&&workbench.getWorkbenchWindows()[0].getActivePage() != null<\/strong>) {<\/p>\n

IWorkbenchPage page = workbench.getWorkbenchWindows()[0].getActivePage();<\/p>\n

if<\/strong> (page != null<\/strong>&& page.getEditorReferences().length > 0) {<\/p>\n

ArrayList<Resource> resource = new<\/strong> ArrayList<Resource>();<\/p>\n

for<\/strong> (IEditorReference editorReference : page.getEditorReferences()) {<\/p>\n

TransactionalEditingDomain editingDomain = ((SgmoduleDiagramEditor) editorReference<\/p>\n

.getPart(false<\/strong>))<\/p>\n

.getEditingDomain();<\/p>\n

if<\/strong> (editingDomain != null<\/strong>) {<\/p>\n

ResourceSet resourceSet = editingDomain<\/p>\n

.getResourceSet();<\/p>\n

for<\/strong> (Resource element : resourceSet<\/p>\n

.getResources()) {<\/p>\n

resource.add(element);<\/p>\n

}<\/p>\n

for<\/strong> (Resource element : resource) {<\/p>\n

resourceSet.getResources()<\/p>\n

.remove(element);<\/p>\n

}<\/p>\n

}<\/p>\n

((SgmoduleDiagramEditor) editorReference<\/p>\n

.getPart(false<\/strong>)).close(false<\/strong>);<\/p>\n

}<\/p>\n

}<\/p>\n

}<\/p>\n

}<\/p>\n

System.out<\/em>.println(“Diagram closed”);<\/p>\n

}<\/p>\n

This works perfectly for me. But When you have lots of diagrams to be printed in a single stretch, make sure You allot more memory for your application else it may throw a java heap memory exception.<\/p>\n

Hope this helps some one. Queries\/Suggestions Welcome<\/p>\n

Anoop Menon<\/p>\n

Confianz Global Inc.\u00a0develop custom software application<\/a>\u00a0according to your business requirement. We help organizations with their web &\u00a0mobile application development<\/a>\u00a0needs.<\/em><\/p>\n

[\/et_pb_text][\/et_pb_column][et_pb_column type=”2_5″ _builder_version=”3.25″ custom_padding=”|||” custom_padding__hover=”|||”][et_pb_code _builder_version=”4.9.4″ _module_preset=”default” locked=”off” global_module=”2151″]<\/p>\n

<\/p>\n
\n
\n

Table of Contents<\/p>\nToggle<\/span><\/path><\/svg><\/svg><\/span><\/span><\/span><\/a><\/span><\/div>\n