The Plug-in works with NetBeans releases 4.0 - 5.5 or the corresponding Sun ONE Studio or Java Studio Creator versions.

See Section 1.1, “System requirements” for the basic requirements to run Jalopy.

The Plug-in comes as an executable Jar Archive (Jar) that contains a graphical setup wizard to let you easily install the software. Wizard installation is recommended and explained in detail in Section 1.3, “Wizard Installation”.

If you would rather install the Plug-in manually, you have to decompress and copy the appropriate files into the different application folders. To decompress the contents of the installer Jar, you can either use the Jar tool that ships with your Java distribution or any other software that can handle the ZIP compression format (e.g. 7Zip or WinZip).

If you're upgrading from a prior version and want to keep your settings, first copy or rename the current Jalopy settings directory to match the version number of the new release. For instance, if your current settings directory is "C:\Documents and Settings\John Doo\.jalopy\1.0.4" and you're about to install Jalopy 1.9.1, either copy the directory contents or rename it to "C:\Documents and Settings\.jalopy\John Doo\1.9.1". Wizard installation can perform this step automatically.

Make sure NetBeans is not running and remove any prior Jalopy Jar files in your NetBeans extension folder. The NetBeans extension folder is located under the root directory of your NetBeans installation, e.g. C:\Program Files\NetBeans\modules. Remove all Jar files starting with "jalopy-" from this folder and the "/ext" subfolder.

Now decompress the contents of the installer Jar file into a temporary directory and copy the file "jalopy-netbeans-1.9.1.jar" from the temporary directory into the NetBeans modules folder. Place the file "jalopy-1.9.1.jar" into the "/ext" subfolder.

The Jalopy options are available through the NetBeans options dialog. In order to display the options dialog, on Mac OS X you use NetBeans → Preferences... and select the "Jalopy" item in the top pane. On other platforms the dialog is available through Tools → Options and you can select the "Jalopy" item in the left pane.

Please note that the options dialog is only available since NetBeans 5.0. With earlier versions, Jalopy adds a new menu item to the menu bar to display the Jalopy options.

Figure 13.1. Jalopy options dialog

The main options page lets you manage your Jalopy profiles. A profile stores the actual code convention to define formatting output, as well as user-specific data like file and dialog histories. You can add, remove, activate, map and configure any number of profiles.

For a detailed explantation of the available options, please refer to the section called “Main window”.

The module adds a new menu items into the main menu of the current Workspace to seamlessly integrate with NetBeans:

Figure 13.2. Jalopy Format menu bar item

The Format item can be also reached via the popup menu of the Explorer. Note that the item only appears for folder nodes or Java source files.

Figure 13.3. Jalopy Format explorer item

If it happens that a file has an open editor view, this view will be updated, not the actual file. You have to save the view first to see the physical file updated.

The software adds a new menu item into the context popup menu of Java code editors:

Figure 13.4. Jalopy editor popup menu item

Jalopy displays all runtime messages in its own dockable window.

Messages are shown in a tree control, with each branch containing the messages for a specific file, and individual messages displayed as leafs. File messages display the number of leaves and the warning and error count.

The message types are differentiated with icons and by color: Errors are red with an error icon, warnings are shown in blue and display a warning sign, informational messages are black and carry a file icon and debugging messages are black and prepended by a bug icon.

Figure 13.5. Jalopy dockable window

Clicking on a file name will open that file, clicking on a message that contains location information will open the file containing the message and move the caret to the nominated location.

Figure 13.6. Jalopy dockable window

The window provides a context menu with some useful actions.

You can define keyboard shortcuts for the different Jalopy actions via the NetBeans Keyboard Shortcuts dialog. You can open the dialog via

The "Format" action is available in the "Edit" section.

To add a keyboard shortcut, select an action and press the Add... button. A dialog opens that will let you enter the desired shortcut.