OpenOf fice - NetBeans

More documents

Recommendations

Info

OpenOffice.org NetBeans Integrationskeleton. The AddOns.xcu configurationfile includes the add-on parameters, andProtocolHandler.xcu defines the protocolhandler configuration. Protocol handlersare part of OpenOffice.org dispatchframework; they bind user-interface controls,such as menu or toolbar items, tothe functionality of OpenOffice.org. Everythingreachable through the user interfaceis described by a command URL and correspondingparameters.The structure of the ProtocolHandler.xcu file defines a namespacefor the add-on (org.openoffice.myaddon,for ourexample). All commandsdefined by the same addonuse this namespace.See Listing 1.The Java code skeletonlooks more complicatedthan it really is. Most ofthe methods are necessaryonly for OpenOffice.org internal implementationreasons and don’tneed to be changed at all.OpenOffice.org calls thedispatch() method each time theprotocol handler routes commands.The fully implementeddispatch() method, which addsthe “Hello World” message tothe current document is shownin Listing 2. Note that only thelines in bold are new; the restwere part of the skeleton. Thecode basically determines thecurrent document and thenadds text to it. Notice also thatthe aURL parameter uses theOpenOffice.org specific com.sun.star.util.URL class instead of thejava.net.URL class.A 2Since all commands fired by the user interface are passedthrough the dispatch() method, it’s necessary to filter explicitly forthe namespace org.openoffice.myaddon, which represents thecommands of our add-on. Finally, myAddOn is the command that’sfired when the user calls the add-on via the toolbar or menu.Our add-on is now ready to deploy. Right click the project nameand choose Deploy Office Extension from the context menu. Net-Beans compiles all necessary files, creates an OpenOffice.org extensionpackage file, and deploys it. Depending on the setup ofthe add-on, a new top-level menu and/or a toolbar are displayed inBListing 1. Excerpt from the ProtocolHandler.xcu configuration file.org.openoffice.myaddon:*BListing 2. dispatch() method example.public void dispatch( URL aURL, PropertyValue[] aArguments ){if ( aURL.Protocol.compareTo(“org.openoffice.myaddon:”) == 0 ) {if ( aURL.Path.compareTo(“myAddOn”) == 0 ) {XTextDocument xDoc = (XTextDocument) UnoRuntime.queryInterface(XTextDocument.class, m_xFrame.getController().getModel());xDoc.getText().setString(“Hello World”);return;}}}AFigure 2Defining thetoolbar for theadd-on.Issue Three N 55
Plugin ModulesAFigure 3The new addonmenu.AFigure 4Remotedebuggingcontextmenu item.AFigure 5Defining a functionand its parametersin the Calc Add-Inwizard.OpenOffice.org. For our example both should show up (see the newmenu in Figure 3).Developing more complex add-ons will probably require an extensivedebugging session. However, as the add-ons run in OpenOffice.org’s JVM, NetBeans’ built-in debugger won’t work. We need remotedebugging.The OOo plugin module adds a command to the project’s contextmenu for starting a remote debugging session, which means thata manual setup of the client JVM or the remote debugger is notrequired. To use this feature, set a breakpoint within the dispatch()method, then call Debug Extension in Target Office as displayedin Figure 4. An OpenOffice.org instance will start automatically.Choose My Command from the add-on’s menu and the debuggerwill stop at the breakpoint.Calc Add-InsLet’s now see how to create a Calc Add-In extension, which implementsOpenOffice.org Calc functions. These functions are tightlyintegrated with the Calc application, so users will not recognize thedifferences between a standard function and one provided by anadd-in; there are no new menus, toolbars or other evidences of anextension.The Calc Add-In wizard is also located in the StarOffice/OpenOffice.org category of the File>New Project dialog. Start thewizard and enter a name and location for the NetBeans project.We’ll use “myAddIn” for both names and “org.openoffice” again asthe package name; also make sure Create backward compatibleCalc Add-In is unchecked.Click Next to enter the A 5name and parameters ofthe Calc functions.The definition of a CalcAdd-In function requiresspecifying the followingparameters:• The name of the Javamethod which implementsthe Calc function.• The data type of the resultof the new function.• The exception the Javaimplementation throws in case of errors.An additional dialog provides access to allavailable exceptions. (This property is optional.)• The Category where the function islisted within Calc's Function Wizard.• The function’s display name. This canbe different from the name of the correspondingJava method.Figure 5 shows how the wizard presentsthese parameters.There are some additional parameters,which are all localizable. Calc functions areusually localized, having different namesfor each language; for example, the functionSum() in the English-language Calc isA 3A 456 N NetBeans Magazine
Page 1: OpenOfUsing a new OpenOffice.org pl
Page 7 and 8: Plugin ModulesDownloadpage ofthe la

OpenOf fice - NetBeans

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?