| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml"> | |
| <head> | |
| <!-- -*- xhtml -*- --> | |
| <title>NetBeans Platform Quick Start for NetBeans Platform 6.1</title> | |
| <link rel="stylesheet" type="text/css" href="https://netbeans.org/netbeans.css"> | |
| <meta name="AUDIENCE" content="NBUSER"> | |
| <met a name="TYPE" content="ARTICLE"> | |
| <meta name="EXPIRES" content="N"> | |
| <meta name="developer" content="jtulach@netbeans.org"> | |
| <meta name="indexed" content="y"> | |
| <meta name="description" | |
| content="A short guide to using the Nodes API."> | |
| <!-- Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved. --> | |
| <!-- Use is subject to license terms.--> | |
| </head> | |
| <body> | |
| <h1>NetBeans Platform Quick Start</h1> | |
| <p>Welcome to the NetBeans Platform! | |
| <p>This tutorial provides a very simple and quick introduction to | |
| the NetBeans Platform workflow by walking you through the creation | |
| of a simple HTML Editor. Though simple, the HTML Editor you create | |
| will be very mature because it will reuse the infrastructure provided | |
| by the NetBeans Platform. For example, without any coding, your | |
| HTML Editor will have a mature window system. | |
| Once you are done with this tutorial, you | |
| will have a general understanding of how to create, build, and run | |
| applications on top of the NetBeans Platform. | |
| <p><b class="notes">Note:</b> If, instead of learning how to create a NetBeans Platform | |
| application, you would like to learn how to create a NetBeans plugin, | |
| see the <a href="../60/nbm-google.html">NetBeans Plugin Quick Start</a>. | |
| This is not the latest version of this | |
| document. It applies to NetBeans IDE 6.1 only. | |
| <a href="../nbm-htmleditor.html">Click here</a> to | |
| see the most up to date version. | |
| <p>After you finish this tutorial, you can move on to the | |
| <a href="https://netbeans.org/kb/trails/platform.html">NetBeans Platform learning trail</a>. | |
| The learning trail provides comprehensive tutorials | |
| that highlight a wide range of NetBeans APIs for a variety of application types. | |
| If you do not want to do a "Hello World" application, you can skip this | |
| tutorial and jump straight to the learning trail. | |
| <p><b>Contents</b></p> | |
| <img src="../../images/articles/61/netbeans-stamp.gif" class="stamp" width="114" height="114" alt="Content on this page applies to NetBeans IDE 6.1" title="Content on this page applies to NetBeans IDE 6.1"> </p> | |
| <ul class="toc"> | |
| <li><a href="#generating">Generating the Skeleton Application</a></li> | |
| <li><a href="#tweakingthemenuitems">Tweaking the User Interface</a> | |
| <li><a href="#tweakingthewindowlayout">Tweaking the Window Layout</a></li> | |
| <li><a href="#tweakingthefavorites">Tweaking the Favorites Window</a></li> | |
| <li><a href="#runningtheapplication">Running the Application</a></li> | |
| <li><a href="#distributingtheapplication">Distributing the Application</a> | |
| <ul> | |
| <li><a href="#zip">Distributing the HTML Editor via a ZIP File</a></li> | |
| <li><a href="#webstart">Distributing the HTML Editor via the Shared NetBeans Web Start Repository</a></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <p><b>To follow this tutorial, you need the software and resources listed in the following | |
| table.</b></p> | |
| <table> | |
| <tbody> | |
| <tr> | |
| <th class="tblheader" scope="col">Software or Resource</th> | |
| <th class="tblheader" scope="col">Version Required</th> | |
| </tr> | |
| <tr> | |
| <td class="tbltd1">NetBeans IDE</td> | |
| <td class="tbltd1">version | |
| <a href="http://download.netbeans.org/netbeans/6.1/final/">version 6.1</a></td> | |
| </tr> | |
| <tr> | |
| <td class="tbltd1">Java Developer Kit (JDK)</td> | |
| <td class="tbltd1"><a href="http://java.sun.com/javase/downloads/index.jsp">version 6</a> or<br> | |
| version 5</td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| <p class="tips">Optionally, for troubleshooting purposes, you can <a href="http://plugins.netbeans.org/PluginPortal/faces/PluginDetailPage.jsp?pluginid=6635">download the | |
| completed sample</a> and inspect the sources. | |
| <p>At the end of this tutorial, you will have an | |
| HTML Editor that looks like this:</p> | |
| <img src="../../images/tutorials/htmleditor/html_editor_final-61.png" border="1" alt="Final HTML Editor"> | |
| <p><b class="notes">Note:</b> Although this a very simple demo application, it is not a toy! It is a <i>real</i> | |
| program that supports easy editing of HTML pages, with features such as code completion, | |
| validation, and predefined HTML snippets. | |
| <p>The HTML Editor that you create in this tutorial is a rich-client application built "on top of the NetBeans Platform". What this | |
| means is that the core of the IDE, which is what the NetBeans Platform <i><u>is</u></i>, will be the base | |
| of your application. On top of the NetBeans Platform, you add the modules that you need | |
| and exclude the ones that the IDE needs but that your application doesn't. | |
| Here you see some of the IDE's modules, added to the NetBeans Platform, which is its base:</p> | |
| <img src="../../images/tutorials/htmleditor/diagram.png" alt="Structure of NetBeans Platform applications"> | |
| <p>Creating this HTML Editor means generating an application skeleton, excluding the modules | |
| and user interface items that you do not need, and then setting the Favorites window | |
| as the window that will open by default when the IDE starts. All of these activities | |
| are supported by user interface elements in the IDE. </p> | |
| <p>You will see for yourself how simple | |
| and easy it is to build, or to be more precise, to <em>assemble</em> a | |
| full-featured application on top of the NetBeans Platform. At the end, you are shown how | |
| to make the final product easily downloadable and launchable using WebStart. | |
| </p> | |
| <p><b class="notes">Note:</b> Even though it is a separate product, there is no need to download the NetBeans Platform separately | |
| for purposes of this tutorial. You will develop the rich-client application in the IDE and then exclude the modules | |
| that are specific to the IDE but that are superfluous to you application. | |
| <!-- ===================================================================================== --> | |
| <h2 class="tutorial"><a name="generating"></a>Generating the Skeleton Application</h2> | |
| <p>When creating an application on the NetBeans Platform, | |
| the very first step is to create a NetBeans Platform Application project. | |
| The default NetBeans Platform Application project includes <i>all</i> the modules | |
| included in the NetBeans Platform as well as <i>all</i> the | |
| modules included in NetBeans IDE. Since we do not need all | |
| these modules, we will exclude those that we do not need. | |
| <ol><li>Using the New Project wizard (Ctrl-Shift-N), create a NetBeans Platform Application Project from the template | |
| in | |
| the NetBeans modules category, as shown below:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/netbeans-platform-app-1.png" border="1" alt="New Project wizard"> | |
| <p>Click Next and name the NetBeans Platform Application project "NetBeansHTMLEditor". | |
| Click Finish.</p> | |
| <li>Right-click the project node, choose Properties, | |
| and then make a few changes in the NetBeans Platform Application's Project Properties | |
| dialog box: | |
| <ul><p><li>In the Build panel, click | |
| "Create Standalone Application", to specify that this | |
| is going to be a rich-client application | |
| on top of the NetBeans Platform. </p> | |
| <p>Make sure | |
| that you like the branding name for the executable | |
| and tweak the application title for the titlebar, | |
| as shown below:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/application_panel-61.png" border="1" alt="Application panel"> | |
| <li>In the Splash Screen panel, notice that | |
| you can provide the application's splash screen, and progress | |
| bar brandings, as shown below: | |
| </p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/splash_screen_panel-61.png" border="1" alt="Splash Screen panel"> | |
| <p><b class="notes">Note:</b> If you do not have a splash screen, use <a href="../../images/tutorials/htmleditor/splash.gif">this one</a>. | |
| </ul> | |
| <li><p>In the Libraries panel of the Project Properties | |
| dialog box, you see a list of "clusters". A cluster is | |
| a collection of related modules. The only clusters that need to be | |
| selected are <tt>gsf1</tt>, <tt>ide9</tt> and <tt>platform8</tt>. Deselect | |
| all the other clusters. Now you need to enable and disable a number of modules, | |
| because only those specifically relevant to our HTML Editor should be selected. | |
| Whenever you select or deselect a module in the Libraries panel, an entry is | |
| added to the application's NetBeans Platform Config file. To speed up this process, | |
| we will simply paste the entries into that file. Close the Project Properties dialog | |
| box.</p> | |
| <p><p>Expand the Important Files node and then | |
| open the NetBeans Platform Config file. Paste | |
| in the following entries: | |
| <p><pre>disabled.clusters=\ | |
| apisupport1,\ | |
| harness,\ | |
| java2,\ | |
| nb6.1,\ | |
| profiler3 | |
| disabled.modules=\ | |
| org.mozilla.rhino.patched,\ | |
| org.netbeans.api.debugger,\ | |
| org.netbeans.api.visual,\ | |
| org.netbeans.core.ide,\ | |
| org.netbeans.core.multiview,\ | |
| org.netbeans.core.nativeaccess,\ | |
| org.netbeans.insane,\ | |
| org.netbeans.lib.cvsclient,\ | |
| org.netbeans.libs.commons_logging,\ | |
| org.netbeans.libs.ini4j,\ | |
| org.netbeans.libs.jna,\ | |
| org.netbeans.libs.svnClientAdapter,\ | |
| org.netbeans.libs.xerces,\ | |
| org.netbeans.modules.autoupdate.services,\ | |
| org.netbeans.modules.autoupdate.ui,\ | |
| org.netbeans.modules.classfile,\ | |
| org.netbeans.modules.core.kit,\ | |
| org.netbeans.modules.css.editor,\ | |
| org.netbeans.modules.css.visual,\ | |
| org.netbeans.modules.db,\ | |
| org.netbeans.modules.db.core,\ | |
| org.netbeans.modules.db.drivers,\ | |
| org.netbeans.modules.db.kit,\ | |
| org.netbeans.modules.db.mysql,\ | |
| org.netbeans.modules.db.sql.editor,\ | |
| org.netbeans.modules.db.sql.visualeditor,\ | |
| org.netbeans.modules.dbapi,\ | |
| org.netbeans.modules.editor.bookmarks,\ | |
| org.netbeans.modules.editor.kit,\ | |
| org.netbeans.modules.extbrowser,\ | |
| org.netbeans.modules.gototest,\ | |
| org.netbeans.modules.httpserver,\ | |
| org.netbeans.modules.ide.kit,\ | |
| org.netbeans.modules.javascript.editing,\ | |
| org.netbeans.modules.javascript.hints,\ | |
| org.netbeans.modules.javascript.kit,\ | |
| org.netbeans.modules.javascript.refactoring,\ | |
| org.netbeans.modules.languages,\ | |
| org.netbeans.modules.languages.bat,\ | |
| org.netbeans.modules.languages.diff,\ | |
| org.netbeans.modules.languages.manifest,\ | |
| org.netbeans.modules.languages.sh,\ | |
| org.netbeans.modules.localhistory,\ | |
| org.netbeans.modules.mercurial,\ | |
| org.netbeans.modules.project.ant,\ | |
| org.netbeans.modules.project.libraries,\ | |
| org.netbeans.modules.properties,\ | |
| org.netbeans.modules.properties.syntax,\ | |
| org.netbeans.modules.schema2beans,\ | |
| org.netbeans.modules.sendopts,\ | |
| org.netbeans.modules.server,\ | |
| org.netbeans.modules.servletapi,\ | |
| org.netbeans.modules.subversion,\ | |
| org.netbeans.modules.tasklist.kit,\ | |
| org.netbeans.modules.tasklist.projectint,\ | |
| org.netbeans.modules.tasklist.todo,\ | |
| org.netbeans.modules.tasklist.ui,\ | |
| org.netbeans.modules.timers,\ | |
| org.netbeans.modules.usersguide,\ | |
| org.netbeans.modules.utilities,\ | |
| org.netbeans.modules.utilities.project,\ | |
| org.netbeans.modules.versioning,\ | |
| org.netbeans.modules.versioning.system.cvss,\ | |
| org.netbeans.modules.versioning.util,\ | |
| org.netbeans.modules.web.flyingsaucer,\ | |
| org.netbeans.modules.xml,\ | |
| org.netbeans.modules.xml.axi,\ | |
| org.netbeans.modules.xml.core,\ | |
| org.netbeans.modules.xml.lexer,\ | |
| org.netbeans.modules.xml.multiview,\ | |
| org.netbeans.modules.xml.retriever,\ | |
| org.netbeans.modules.xml.schema.completion,\ | |
| org.netbeans.modules.xml.schema.model,\ | |
| org.netbeans.modules.xml.tax,\ | |
| org.netbeans.modules.xml.text,\ | |
| org.netbeans.modules.xml.tools,\ | |
| org.netbeans.modules.xml.wsdl.model,\ | |
| org.netbeans.modules.xml.xam,\ | |
| org.netbeans.modules.xml.xdm,\ | |
| org.netbeans.modules.xsl,\ | |
| org.netbeans.spi.debugger.ui,\ | |
| org.netbeans.spi.viewmodel,\ | |
| org.netbeans.swing.dirchooser,\ | |
| org.openide.compat,\ | |
| org.openide.util.enumerations | |
| enabled.clusters=\ | |
| gsf1,\ | |
| ide9,\ | |
| platform8 | |
| nbplatform.active=default</pre> | |
| </ol> | |
| <p>Now you have the subset of NetBeans modules that are relevant to your HTML Editor. | |
| However, even though you need the modules that you now have, you probably do not | |
| need all of the user interface elements that these modules give you. In the next sections, | |
| you tweak the user interface and customize the window layout specifically for the HTML Editor | |
| that you are creating. | |
| <!-- ===================================================================================== --> | |
| <h2 class="tutorial"><a name="tweakingthemenuitems"></a>Tweaking the User Interface</h2> | |
| <p>You can keep or reject as much of the user interface that your selected modules give you. For example, your HTML Editor probably | |
| does not need any or all of the items under the Tools menu. Similarly, maybe there are toolbars | |
| or toolbar buttons that you can do without. In this section, you prune the IDE's user interface | |
| until you are left with a subset that is useful to your specific rich-client application. | |
| <ol><li>Expand the NetBeans Platform Application project, right-click the Modules node | |
| and choose Add New, as shown below:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/add-module-61.png" alt="This layer in context"> | |
| <p>The New Project wizard (Ctrl-Shift-N) appears. | |
| Name the project <tt>BrandingModule</tt>, click Next. | |
| <li>In the Code Name Base field, type <tt>org.netbeans.brandingmodule</tt>. | |
| <li>In the XML Layer field, type the name of your package, appended | |
| with "layer.xml", such as "org/netbeans/brandingmodule/layer.xml" and then | |
| click Finish. | |
| <p> | |
| <p><b class="notes">Note:</b> If you did not type the location of the layer.xml | |
| file in this field, the file will not have been created. In this | |
| case, create a file manually, called "layer.xml", in the main package. Replace | |
| all the default content with the following tags: | |
| <pre class="examplecode"><?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.1//EN" "https://netbeans.org/dtds/filesystem-1_1.dtd"> | |
| <filesystem> | |
| </filesystem></pre> | |
| <p>Then manually register the file in the Module Manifest file as follows: | |
| <p><pre>OpenIDE-Module-Layer: org/netbeans/brandingmodule/layer.xml</pre> | |
| <p>Make sure the path specified above points to the "layer.xml" file that | |
| you created. Now close and then open the project again. | |
| Now you will be able to expand the | |
| "layer.xml" file, which is what you need to do in the next steps. | |
| However, you will not be able to expand the "layer.xml" file that is | |
| in the main package. Instead, expand the Important Files node first | |
| and then you will be able to expand the "XML Layer" file that you find there. | |
| That file is the same as the one in the main package, just represented | |
| in a different way. | |
| <li>In the branding module, expand the <tt>layer.xml</tt> node. | |
| Two subnodes are exposed:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/expanded-xml-layer-61.png" alt="Expanded XML layer file"> | |
| <p><b class="notes">Note:</b> In the case where you have manually | |
| added the layer.xml file, you will need to expand the Important Files node | |
| in order to be able to expand the XML Layer node that you find there. | |
| <li>In the <tt><this layer in context></tt> node, | |
| the IDE shows you a merged view of all folders and files that all modules register in their | |
| layers. To exclude items, you can right-click them and choose 'Delete', as shown below:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/this-layer-in-context-61.png" alt="This layer in context"> | |
| <p>The IDE then adds | |
| tags to the module's <tt>layer.xml</tt> file which, when the module is installed, | |
| hides the items that you have deleted. For example, by right-clicking within <tt>Menu Bar/Edit</tt>, you can remove | |
| menu items from the Edit menu that are not necessary for the HTML Editor. | |
| By doing this, you generate snippets such as the following in the <tt>layer.xml</tt> file: | |
| <pre class="examplecode"><folder name="Menu"> | |
| <folder name="Edit"> | |
| <file name="org-netbeans-modules-editor-MainMenuAction$StartMacroRecordingAction.instance_hidden"/> | |
| <file name="org-netbeans-modules-editor-MainMenuAction$StopMacroRecordingAction.instance_hidden"/> | |
| </folder> | |
| </folder></pre> | |
| <p> | |
| The result of the above snippet is that the <tt>Start Macro Recording</tt> and <tt>Stop Macro Recording</tt> | |
| actions provided by another module are removed from the menu by your branding module. | |
| To show them again, simply delete the tags above from the <tt>layer.xml</tt> file. | |
| <li><p>Use the approach described in the previous step to hide as many toolbars, toolbar buttons, | |
| menus, and menu items as you want.</p> | |
| <p>When you have completed this stage, look in the <tt>layer.xml</tt> file. When you do so, | |
| you should see something similar to the following, depending on the items that you have deleted:</p> | |
| <p><pre><?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.1//EN" "https://netbeans.org/dtds/filesystem-1_1.dtd"> | |
| <filesystem> | |
| <folder name="Menu"> | |
| <file name="BuildProject_hidden"/> | |
| <folder name="File"> | |
| <file name="Separator2.instance_hidden"/> | |
| <file name="SeparatorNew.instance_hidden"/> | |
| <file name="SeparatorOpen.instance_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-CloseProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-CustomizeProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-NewFile.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-NewProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-OpenProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-RecentProjects.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-SetMainProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-groups-GroupsMenu.shadow_hidden"/> | |
| </folder> | |
| <file name="Refactoring_hidden"/> | |
| <file name="RunProject_hidden"/> | |
| <folder name="Window"> | |
| <file name="ViewRuntimeTabAction.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-logical-tab-action.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-physical-tab-action.shadow_hidden"/> | |
| </folder> | |
| </folder> | |
| </filesystem></pre> | |
| </ol> | |
| <!-- ===================================================================================== --> | |
| <h2 class="tutorial"><a name="tweakingthewindowlayout"></a>Tweaking the Window Layout</h2> | |
| <p> | |
| By using the <tt><this layer in context></tt> node, you can not only delete existing | |
| items, but you can also change their content. For example, the | |
| HTML Editor works on HTML files, so in contrast to the regular IDE, which works with Java source files and projects as well, | |
| it makes sense to show the <tt>Favorites</tt> window in the initial layout. | |
| </p> | |
| <p> | |
| The definition of the window layout is also described as files in layers, | |
| all stored under the <tt>Windows2</tt> folder. The files in the <tt>Windows2</tt> folder are | |
| pseudo-human readable XML files defined by the | |
| <a href="http://bits.netbeans.org/dev/javadoc/org-openide-windows/org/openide/windows/doc-files/api.html"> | |
| Window System APIs</a>. They are quite complex but the good news is | |
| that, for purposes of our HTML Editor, it is not necessary | |
| to understand them fully, as shown below. | |
| </p> | |
| <ol><li>In your branding module's <tt><this layer in context></tt> node, | |
| right-click the <tt>Windows2</tt> node and choose Find, | |
| as shown below:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/find-favorites-61.png" alt="Invoking the Find menu"> | |
| <li>Search | |
| for an object named <tt>Favorites</tt>, ignoring the case. You will find two files: | |
| </p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/find-favorites2-61.png" alt="Finding the Favorites window"> | |
| <p> | |
| The first file defines what the component is going to look like and | |
| how it gets created. As this does not need to be changed, there is no need to | |
| modify the file. The second is more interesting for your purposes, | |
| it contains the following: | |
| </p> | |
| <pre class="examplecode"> | |
| <tc-ref version="2.0"> | |
| <module name="org.netbeans.modules.favorites/1" spec="1.1" /> | |
| <tc-id id="favorites" /> | |
| <state opened="false" /> | |
| </tc-ref></pre> | |
| <p> | |
| <li>Even though most of the XML is cryptic, there is one line which | |
| seems promising—without needing to read | |
| any kind of documentation, it seems likely that | |
| changing the <tt>false</tt> to <tt>true</tt> is going to make the component | |
| opened by default. Do so now. | |
| <li> | |
| In a similar way you can change the following windows from their | |
| default open state to the state that you might want them to behave in | |
| the HTML Editor: | |
| <ul> | |
| <li><tt>CommonPalette.wstcref</tt>. The Component Palete's | |
| open state is <tt>false</tt>. Change it to <tt>true</tt>. | |
| <li><tt>navigatorTC.wstcref</tt>. The Navigator's | |
| open state is <tt>true</tt>. Change it to <tt>false</tt>. | |
| <li><tt>projectTabLogical_tc.wstcref</tt>. The Projects window's | |
| open state is <tt>true</tt>. Change it to <tt>false</tt>. | |
| <li><tt>projectTab_tc.wstcref</tt>. The Files window's | |
| open state is <tt>true</tt>. Change it to <tt>false</tt>. | |
| <li><tt>runtime.wstcref</tt>. The Services window's | |
| open state is <tt>true</tt>. Change it to <tt>false</tt>. | |
| </ul> | |
| </ol> | |
| <p>You should now see that your branding module contains several new files, | |
| one for each of the files that you changed. In effect, these files | |
| override the ones that you found in the previous steps, so that you | |
| have now provided the required information for overriding the window | |
| layout:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/wstcrefs-overridden-61.png" alt="Overridden Favorites layout"> | |
| <p>Check that the <tt>layer.xml</tt> file now contains the following content. If it does not, | |
| copy and paste the content below into the <tt>layer.xml</tt> file. | |
| <pre><?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.1//EN" "https://netbeans.org/dtds/filesystem-1_1.dtd"> | |
| <filesystem> | |
| <folder name="Menu"> | |
| <file name="BuildProject_hidden"/> | |
| <folder name="File"> | |
| <file name="Separator2.instance_hidden"/> | |
| <file name="SeparatorNew.instance_hidden"/> | |
| <file name="SeparatorOpen.instance_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-CloseProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-CustomizeProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-NewFile.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-NewProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-OpenProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-RecentProjects.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-SetMainProject.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-groups-GroupsMenu.shadow_hidden"/> | |
| </folder> | |
| <file name="Refactoring_hidden"/> | |
| <file name="RunProject_hidden"/> | |
| <folder name="Window"> | |
| <file name="ViewRuntimeTabAction.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-logical-tab-action.shadow_hidden"/> | |
| <file name="org-netbeans-modules-project-ui-physical-tab-action.shadow_hidden"/> | |
| </folder> | |
| </folder> | |
| <folder name="Windows2"> | |
| <folder name="Modes"> | |
| <folder name="commonpalette"> | |
| <file name="CommonPalette.wstcref" url="CommonPaletteWstcref.xml"/> | |
| </folder> | |
| <folder name="explorer"> | |
| <file name="favorites.wstcref" url="favoritesWstcref.xml"/> | |
| <file name="projectTabLogical_tc.wstcref" url="projectTabLogical_tcWstcref.xml"/> | |
| <file name="projectTab_tc.wstcref" url="projectTab_tcWstcref.xml"/> | |
| <file name="runtime.wstcref" url="runtimeWstcref.xml"/> | |
| </folder> | |
| <folder name="navigator"> | |
| <file name="navigatorTC.wstcref" url="navigatorTCWstcref.xml"/> | |
| </folder> | |
| </folder> | |
| </folder> | |
| </filesystem></pre> | |
| <!-- ===================================================================================== --> | |
| <h2 class="tutorial"><a name="tweakingthefavorites"></a>Tweaking the Favorites Window</h2> | |
| <p> | |
| In the subfolders of a NetBeans Platform Application project's <tt>branding</tt> folder, which | |
| is visible in the Files window, you | |
| can override strings defined in the NetBeans sources. In | |
| this section, you will override strings that define | |
| labels used in the Favorites window. For example, we | |
| will change the "Favorites" label to "HTML Files", | |
| because we will use that window specifically for | |
| HTML files. | |
| </p> | |
| <ol><li>Open the Files window and | |
| expand the NetBeans Platform Application project's <tt>branding</tt> folder. | |
| <li>Create a new folder structure within <tt>branding/modules</tt>. | |
| (In the IDE, you can create folders | |
| by right-clicking a folder and then | |
| choosing New | Other and then choosing Folder from the Other category.) | |
| The new folder should be named <tt>org-netbeans-modules-favorites.jar</tt>. | |
| Within that folder, create a folder hierarchy | |
| of <tt>org/netbeans/modules/favorites</tt>. Within the final folder, | |
| i.e. <tt>favorites</tt>, create a new <tt>Bundle.properties</tt> file: | |
| <p><img border="1" src="../../images/tutorials/htmleditor/favorites-branding-61a.png" alt="Branding the Favorites window"> | |
| <p>This folder structure and properties file matches the | |
| folder structure in the NetBeans sources that relate to | |
| the Favorites window. | |
| <li>Add the strings shown in the screenshot below, | |
| to override the same strings defined in the matching | |
| properties file in the Favorites window sources:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/favorites-branding-61b.png" alt="Branding the Favorites window"> | |
| <p>To simplify this step, copy and paste the strings defined above: | |
| <pre>Favorites=HTML Files | |
| ACT_AddOnFavoritesNode=&Find HTML Files... | |
| ACT_Remove=&Remove from HTML Files List | |
| ACT_View=HTML Files | |
| ACT_Select=HTML Files | |
| ACT_Select_Main_Menu=Select in HTML Files List | |
| # JFileChooser | |
| CTL_DialogTitle=Add to HTML Files List | |
| CTL_ApproveButtonText=Add | |
| ERR_FileDoesNotExist={0} does not exist. | |
| ERR_FileDoesNotExistDlgTitle=Add to HTML Files List | |
| MSG_NodeNotFound=The document node could not be found in the HTML Files List.</pre> | |
| </ol> | |
| <p>Later, when you start up the application, you will see that | |
| the texts and labels in the Favorites window have changed | |
| to those listed above. This illustrates that you can take | |
| a component from the NetBeans Platform and then brand it to | |
| match your needs. | |
| <!-- ===================================================================================== --> | |
| <h2 class="tutorial"><a name="runningtheapplication"></a>Running the Application</h2> | |
| <p> | |
| Running your application is as simple | |
| as right-clicking the project node | |
| and choosing a menu item. | |
| </p> | |
| <ol> | |
| <li>Right-click the application's project node and | |
| choose Clean and Build All. | |
| <li>Right-click the application's project node and | |
| choose Run. | |
| <li>After the application is deployed, you can right-click | |
| inside the Favorites window and choose a folder containing | |
| HTML files, and then open an HTML file, as shown below:</p> | |
| <img src="../../images/tutorials/htmleditor/html_editor_final-61.png" border="1" alt="Open HTML file"> | |
| </ol> | |
| <p>You now have a complete, functioning, HTML Editor, which you | |
| created without typing a single line of Java code. | |
| <!-- ===================================================================================== --> | |
| <!-- ===================================================================================== --> | |
| <h2 class="tutorial"><a name="distributingtheapplication"></a>Distributing the Application</h2> | |
| <p> | |
| Choose one of two approaches for distributing | |
| your application. If you want to maintain as much | |
| control over your application as possible, you will | |
| use web start to distribute your application over the web. | |
| In this scenario, whenever you want to update the application, | |
| you will do so locally and let your end users know about the | |
| update, which they will automatically have available next time | |
| they start up your application over the web. Alternatively, | |
| distribute a ZIP file containing your application. The end users | |
| will then have the complete application locally available. You would | |
| then distribute updates and new features via the update mechanism, | |
| described below. | |
| <h3 class="tutorial"><a name="zip"></a>Distributing the Application via a ZIP File</h3> | |
| <p> To make your application extendable, you need to let your | |
| users install modules to enhance the application's | |
| functionality. To do so, you simply need to enable a few | |
| extra modules, which will bundle the Plugin Manager with | |
| your HTML Editor. | |
| </p> | |
| <ol><li>Right-click the NetBeans Platform Application project and | |
| choose Properties. In the Project Properties dialog box, | |
| use the Libraries panel and select the <tt>Update Centers</tt> checkbox, | |
| the <tt>Auto Update Services</tt> checkbox, and the | |
| <tt>Auto Update UI</tt> checkbox that | |
| are highlighted below:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/auto-update-61.png" alt="Auto Update modules"> | |
| <li>Right-click the application's project node and | |
| choose Clean and Build All. | |
| <li>Run the application again and notice that | |
| you now have a new menu item, named "Plugins", | |
| under the Tools menu:</p> | |
| <img src="../../images/tutorials/htmleditor/auto-update2-61.png" border="1" alt="Showing the Plugin Manager"> | |
| <li>Choose the new Plugins menu item and install | |
| some plugins that are useful to your HTML Editor. | |
| Browse the <a href="http://plugins.netbeans.org/PluginPortal/">Plugin Portal</a> | |
| to find some suitable ones. This is also how your end users will update their | |
| local installation of your application. | |
| <li><p>Right-click the application's project node and | |
| choose Build ZIP Distribution.</p> | |
| <li>In the <tt>dist</tt> folder (visible in the | |
| Files window), you should now be able to see | |
| a ZIP file that you can expand, to see its | |
| contents:</p> | |
| <p><img border="1" src="../../images/tutorials/htmleditor/unzipped-app-61.png" alt="Generated ZIP file"> | |
| <p><b class="notes">Note:</b> The application's launcher is created in | |
| the <tt>bin</tt> folder, as shown above. | |
| </ol> | |
| <br /> | |
| <!-- ======================================================================================== --> | |
| <h3><a name="webstart"></a>Distributing the HTML Editor via the Shared NetBeans Web Start Repository</h3> | |
| <p> | |
| Instead of distributing a ZIP file, let's prepare for | |
| a webstart distribution by finetuning the <tt>master.jnlp</tt> file that is | |
| generated the first time you start the application. Even though it does the job, it | |
| is not yet ready for distribution. At the very least, you need to change the | |
| information section to provide better descriptions and icons. | |
| <p> | |
| Another change to the standard JNLP infrastructure is the use of a | |
| shared JNLP repository on www.netbeans.org. By default, the JNLP application | |
| generated for a suite always contains all its modules as well as all the modules it depends on. | |
| This may be useful for intranet usage, but it is a bit less practical for | |
| wide internet use. When on the internet, it is much better if all the | |
| applications built on the NetBeans Platform refer to one repository of | |
| NetBeans modules, which means that such modules are shared and | |
| do not need to be downloaded | |
| more than once. | |
| </p> | |
| <p> | |
| There is such a repository for NetBeans 6.1. It does not contain all | |
| the modules that NetBeans IDE has, but | |
| it contains enough to make non-IDE applications like our HTML Editor | |
| possible. | |
| To use the repository you only need to modify <tt>platform.properties</tt> | |
| by adding the correct URL: | |
| </p> | |
| <pre class="examplecode"> | |
| # share the libraries from common repository on netbeans.org | |
| # this URL is for release60 JNLP files: | |
| jnlp.platform.codebase=https://netbeans.org/download/6_0/jnlp/ | |
| </pre> | |
| <p> | |
| As soon as the application is started as a JNLP application, all its shared plug-in modules | |
| are going to be loaded from netbeans.org and shared with other | |
| applications doing the same.</p> | |
| <br /> | |
| <!-- ======================================================================================== --> | |
| <br> | |
| <div class="feedback-box"><a href="https://netbeans.org/about/contact_form.html?to=3&subject=Feedback:%20NetBeans%20Platform%206.1%20Quick%20Start%20Tutorial">Send Us Your Feedback</a></div> | |
| <br style="clear:both;" /> | |
| <!-- ======================================================================================== --> | |
| <h2><a name="nextsteps"></a>See Also</h2> | |
| <p>This concludes the NetBeans Platform Quick Start. This document has described | |
| how to create a plugin that adds a Google Search toolbar to the IDE. | |
| For more information about creating and developing applications on the NetBeans Platform, see the following resources: | |
| <ul> | |
| <p><li><a href="https://netbeans.org/kb/trails/platform.html">Other Related Tutorials</a></li> | |
| <p><li><a href="https://netbeans.org/download/dev/javadoc/">NetBeans API Javadoc</a></li> | |
| </ul> | |
| <hr> | |
| <!-- ======================================================================================== --> | |
| </body> | |
| </html> |