gwtClassRun: User’s Guide

Introduction

gwtClassRun running alongside Java IDE and GWT Hosted Mode browser

gwtClassRun  is a standalone utility application that is very useful for developers developing application using their favourite IDE utilizing the Edit-Compile-Debug development cycle. A Java application contains many classes, and most of the time, it is very effective and efficient just to test certain classes rather than the whole application. For example, a developer might want to test out a user interface class before integrating it into the main application. However, developers usually resist doing best practice of isolating of class for testing because of extra non-intuitive steps needed to perform such operation. These steps include having to edit GWT’s module file descriptor file ending with gwt.xml extension and having to ensure that they enter the correct EntryPoint class name and its package. These mundane steps might seem manageable, however in the long run, it incurs wasteful time that might better off use for other meaningful purposes.

gwtClassRun is designed especially to automate such task easily and quickly. This utility is developed due to the creator’s own frustration in waiting for the increasingly long GWT compilation of processing all relevant classes to test a GWT application. Having to manually change a EntryPoint class in the gwt.xml is not appealing either. Therefore, gwtClassRun is created to handle the problem with minimal intervention from the user.

gwtClassRun is a small application having a intuitive user interface that minimal and straight-forward. It is non-intrusive and occupies just a fraction of the screen. In addition, it also works with any IDE obviating the need for plug-in.

 

How it works

Every GWT project comes with a main module descriptor file ending with gwt.xml extension. It is this file that GWT knows how to execute and initialize the necessary classes. What gwtClassRun does is to modify the file through EntryPoint tag to reflect the desired class to run. gwtClassRun supports multiple EntryPoint classes and it put the desired Class in the first EntryPoint tag. Hence, gwtClassRun does not modify any other files aside from the descriptor file.

Similarly to GWT project, gwtClassRun uses the same project terminology. A project in gwtClassRun consists a set of settings that tell it where to look for the EntryPoint classes, descriptor file and how it want the EntryPoint tag to be modified. After the user setup the project, all he needs to do is just simple request gwtClassRun to update its database of EntryPoint classes for the GWT application. After this, user can just select the desired EntryPoint class to run through a intuitive point-n-click interface, or using a powerful and flexible search function.

 

Highly recommended to work out the tutorial as a picture is worth a thousand words.

 

User Interface

The user interface of gwtClassRun is very simple and focus. It contains all the necessary features to make using gwtClassRun a pleasant and fruitful experience.

 

 

#	Description
1	Main Screen The MainScreen is the point of access to consolidate gwtClassRun’s functions.
2	Project Management Menu/EntryPoint Code Copy Menu This menu integrates both project management function and EntryPoint Java Code copy. Project Management Menu The user can add, edit and delete the project. Note that when there is no project available. The following AddProject screen will appear (It also appears when gwtClassRun is first run as there is no project defined yet) The Add and Edit function screens are the same therefore, the subsequent screen capture applies whether in Add or Edit mode. When user request project deletion, a confirmation box will appear. When no available project, the following screen appear. Click on the A   Detail Tab Name: name of gwtClassRun project. User should only enter name that has the same rule as fileName eg no space, accept only character & digits , underscore Root Dir: This implies the source root level of source code. For example, myproject.client.MyClass implies that the root dir should be the parent directory of myproject. Search SubDir: This is used to assist gwtClassRun to search only client directory. Usually, a GWT project contains many packages, and it is superfluous to search other package other than client directory since classes in client directory can define EntryPoint interface and run by GWT only. However, since the Root Dir references the top source root, it will search all source code of any packages onwards, and this incurs time. Therefore user can specify the Search SubDir to help limit search to specific Client directory, improving the performance of gwtClassRun. IMPORTANT How does gwtClassRun determines a EntryPoint class ? gwtClassRun identifies any class as EntryPoint if the class implements the EntryPoint interface. To improve the performance, gwtClassRun simply search for the keyword ‘EntryPoint’ and ‘onModuleLoad()’ together in the Java source directories. Therefore, take note that even if those keywords appear together as comment, gwtClassRun still treat those classes as EntryPoint. GWT XML: This is main descriptor file that is the heart of GWT application. It controls the resources to load and run, and the class to execute. Click to allow file dialog selection of the file. EntryPoint tab  Default Class TextBox: This is the default class that user can easily activate through a click rather than select from textbox dropdown. Note that gwtClassRun will check for its existence when this option is clicked. Include EntryPoint Classes TextBox: Additional EntryPoint classes to be defined as EntryPoint tag in the gwt.xml file. The order of entry is the sequence of generation. gwtClassRun actually removes all EntryPoint tag and then regenerate them back using desired class and these EntryPoint classes. Note that desired class is always the first EntryPoint class. Project creation and renaming A gwtClassRun project file has a extension of prj (eg PRO1.PRJ) with the project name as fileName. If project name is altered, the prj file will reflect the change. EntryPoint Code Copy: Copy EntryPoint Interface  (Alt+A) Copy the phrase ” implements EntryPoint” into clipboard. Copy OnModuleLoad Interface (Alt+S) Copy the phrase ” public void onModuleLoad() {}” into clipboard.
3	Help Menu Help: Run web browser and lead user to www.geekyware.com site for support information pertaining to gwtClassRun. About: Information on gwtClassRun and Credit information.
4	Default Class: (Alt+Q) Set the default class defined in the gwtClassRun project as the desired EntryPoint class. A sound will generate and the titlebar will show the className change  visually as EntryPoint for 1 sec to indicate that change has been made. List: (Alt+W) Show all the EntryPoint classes belonging to gwtClassRun project. User can select the non-editable class name and copy it to clipboard. Update: (Alt+E) Upon click, this will immediately update project database of all EntryPoint classes so that it can be searched in the textbox.
5	Search TextBox: This allows user to perform real time search on class name. As user type, a list of class will appear that satisfy the search criteria. Note that the dropdown will only appear if there is matching criteria, otherwise a beep will occur and no dropdown will be shown. As the criteria match, the file match will be reflected The following is the list of valid keys in the textbox. Key Usage ; When enter as the only text, this implies show all class in the dropdown. ESCAPE Clear the entry and remove the dropdown. SPACE, DOWN, UP A SPACE is equivalent to DOWN key in the dropdown. User can navigate the the class in dropdown. ENTER Immediate assign the selected class as EntryPoint class to run. A beep will be generated and a visual effect in the form of className will flash at window title bar temporary for 1 sec to indicate that change to underlying gwt.xml file has been made.
6	Project Selection ComboBox: User can select the gwtClassRun project to be used accordingly to the project currently active in the IDE.
7	Clear Search Button: This is similar to pressing escape in the TextBox to clear the search entry.
8	Project Selection Enabled Checkbox: Due to the design of the application to be compact as not to occupy precious screen estate, the components are placed quite closely to each other. Hence it is easy to inadvertently select the project comboBox where user intend to select the textBox. Uncheck the checkbox will disable project selection.

 

Last updated: 17 May 2008