JadeIDE (Integrated Development Environment for Java TM) is a product of
"Wolfgang Kurz, Im Asemwald 2/18, D-70599 Stuttgart, Germany".
( Note: Java is a registered trademark of the SUN Corporation. )
To contact the author please send an E-Mail to info@wkurz.com
To get information about other products provided by the author please visit the "Homesite of Jade" by klicking the Jade Icon (if you are connected to the internet).
or via the hyperlink http://wkurz.com.
This is also the site where you always will find the most recent release of the JadeIDE product.
The Jade Integrated Development Environment is a lightweight but powerful development environment for Java. It allows a programmer working with a JDK (Java Development Kit e.g. from SUN Microsystems) to edit source code and to compile Java classes (without the need to use the operating system dependent command interface of the development tools offered by the JDK). Supported is also the invocation of Java applications and Java applets via the Java class containing the "main()" respectively the "init()" method. This comprises the provision of the parameters the "main()" or "init()" method expects.
JadeIDE provides a layer above the SUN JDK which eases the usage of this toolkit.
JadeIDE provides it's own editor optimized for Java coding, but it also supports the usage of external editors. JadeIDE therefore allows the users to choose the editor(s) they are most comfortable with.
(Note: The external editor JadeIDE has been most intensively tested with is the "Programmers's File Editor" from Alan Phillips. See also under "Installation").
Although some editors support the invocation of programs (e.g. the invocation of a compiler) to work with JadeIDE is normally more flexible and more efficient because the JADE Editor saves all files currently open under it before a compilation is started via this editor, because it is very easy to switch between editors, because JadeIDE only presents project relevant files to a programmer, because JadeIDE supports code generation, elementary debugging, and because JadeIDE allows to work in several "threads".
The following functions are provided by JadeIDE:
All actions provided by JadeIDE are controlled from the menus and menu items of the JadeIDE main window.
Information relevant and important for the actions to be performed are displayed in this JadeIDE main window. Only really important information is shown to reserve as much space as possible for the editors.
The JadeIDE main window is initially presented at the upper edge of the screen (but can be moved to any position). The main window is only 80 pixels deep. That gives enough room for other windows (e.g. the editor window) to guarantee convenient project work.
The important tools of the "SUN Development Toolkit" are invoked via a pretty awkward to use "ASCII command interface". They do not come with a user friendly graphical interface (GUI). Without the exploitation of a development environment a programmer has to keep in mind a lot of information in order to modify the required commands which have to be keyed in via the DOS window. This is pretty inconvenient, time consuming and error prone.
To make the programming more efficient, JadeIDE provides a graphical enduser interface, which allows to store the commands in the form required by the actual installation and to recall and modify them, whenever they are needed.
As a lot of developers pretty often use different text-editors, web-browsers and HTML-editors, JadeIDE allows to store more than one instance of an invocation command as base parameter (e.g. a command to invoke the Web-Browser).
A programmer can therefore activate his preferred set of base parameters for each development session.
As for a certain development project normally always the same set of commands (project parameters) is used, JadeIDE allows to group the desired commands and to store this group under a project name. Such a group than can be activated in a single action when a project is opened.
A command in almost any case can be split up in a section, which stays always the same and a section which is individual for a specific task. Therefore JadeIDE does not store a command in it's final form, as it would have to be keyed in, but in the form of a command or parameter template representing only the fixed part of the command. Such a template must be complemented by the variable part (e.g. the file name, a path, etc.). The error free compilation of the final command is done by JadeIDE, before submitting the command in order to trigger a desired action.
The parameters required when developing with JadeIDE fall into 2 categories. The first group are the base parameters, that are those parameters needed for each development. The second category are the project parameters. Project parameters are specific for a certain project.
The base parameters are:
Project parameters are:
As command templates are specific for each installation (e.g. the SUN JDK is not always stored on the same drive and there are different editors available), JadeIDE cannot provide these templates. They have to be specified by the user according to their specific installation. To support this process, JadeIDE provides a couple of "setup" dialogs.
Before you can work with JadeIDE you must - as the very first action after the product installation - define at least one value for each base parameter and make it the default value.
The dialog for the base parameter specification allows to define any number of values (parameter templates) for each of the 5 base parameter types "Browsers", "External Editors", "HTML Editors", "Code Checker", and "Java Dev. Kit".
Selection lists in the dialog window provide the already defined values of each parameter type. Via buttons you can add additional values, discard existing values, set a specific value as default value, and modify an existing value.
The dialog for the definition of base parameter templates is invoked via the JadeIDE main window menu "File" menu item "Maintain Basic Parameters".
Pressing general button "Start here" is the first "Setup Action" you have to perform.
It performs a search for installed Java Development Kits and Web-Browsers (searched will be for the files "iexplore.exe", "netscape.exe", "netscp6.exe", "opera.exe", "netscp.exe", "mozilla.exe", and "konquerer"). Then it presents a message, that reminds you, that you have - as the immediately following setup actions - to define a value for each of the 5 base parameters and make it the default value.
Note: In some installations there are files with the specified names found in various directories. The search program has no criteria to identify real browser executables. Therefore such invalid entries should be eliminated from the list of found files. In no case such an invalid entry should be made to the default value.
Please also take into consideration, that some browsers under Windows do not start immediately (if quickstart facility not activated) when they are supposed to run as a sub-process (e.g. Opera 6 and Netscape 6.2). These browsers should be started first from outside JadeIDE.
Via the dialog you now can perform the following actions:
General buttom "Exit" or the "X" (Exit) button at the right upper corner of the window closes the dialog.
Before you can work on a project with JadeIDE, you must first create it. This includes the definition of the parameters controlling the development work.
The dialog is used to name a development project and to specify the required control parameters.
The dialog fields and their usage:
The common buttons and their associated actions:
Searches for a project definition using the name specified in field Project Package Name as search argument. | ||
Resets all input fields and choice lists of the dialog. | ||
Deletes the actually shown project definition. | ||
Changes the persistently stored project definition according to the values currently presented. | ||
Creates a new project definition using the currently displayed values. If required, the button "Open" will be enabled. | ||
The actually displayed project is opened. All activated values are shown in the "Actual Parameter Selection" dialog. | ||
The dialog window is closed. |
The dialog to define the "compiler options" appears, when the "Create" button to the right of field "Compiler options" has been pressed in the dialog to setup the project parameters. If at this moment a value is shown in this field this value is used to initialize the fields of the new dialog. This provides a convenient way to clone and then modify parameter values.
The dialog allows the specification of the most important options as defined for the JAVAC.EXE compiler of the SUN JDK (Version 1.3 or better). The affect of the compiler options is described precisely in the SUN JDK tools documentation. The "Parm-Help" button will directly lead to the tools documentation, if this documentation is stored at "...\docs\tooldocs\win32\javac.html" respectively at "...\docs\tooldocs\linux\javac.html".
Are the initialization values not required or completely unacceptable, all fields can be reset to their default values by pressing the "Clear" button.
An option is selected by clicking into the selection field. Clicking the field again, deselects an already marked option.
For options which require a parameter value (Outp.Dir. and Sourcepath) the activation of the file dialog is supported in order to evaluate a path or a file name. The option is used, if the parameter textfield is not blank. Of course parameter text fields filled via a file dialog can be manipulated. This comprises the complete deletion of the field content.
Note: The sourcepath may contain several directories as well as ZIP and JAR archives. Multiple invocation of the file dialog is therefore allowed. Each evaluation result is appended to the already existing content, separated by a list separation character. A file dialog normally does only allow the selection of a file (and not of a directory) therefore you have to delete the file part of a result manually, if only a directory is required.
After the compiler and the desired options are selected, you must press the "Apply" button. This transfers the correctly assembled value into the field "Compiler options" of the "Dialog to Setup the Project Parameters". Here you can - if needed - complement the value by additional options, wich cannot be specified via the JadeIDE definition dialog.
Clicking the "Apply" button does not close the dialog window, because there may be modifications needed. The dialog window is closed either by clicking the "Quit" button or by clicking the "X" (Exit) button in the top right corner of the window.
The dialog to define the "run options" appears, when the "Create" button to the right of field "Runtime options" has been pressed in the dialog to setup the project parameters. If at this moment a value exists in this field, this value is used to initialize the fields of the new dialog. This provides a convenient way to clone and then modify parameter values.
Are the initialization values not required or completely unacceptable, all fields can be reset to their default values by pressing the "Clear" button.
The dialog allows the specification of the most important options as defined for the JAVA.EXE launcher of the SUN JDK (Version 1.3 or better). The affect of the launcher options is described precisely in the SUN JDK tools documentation. The "Parm-Help" button will directly lead to the tools documentation, if this documentation is stored at "...\docs\tooldocs\win32\java.html" respectively at "...\docs\tooldocs\linux\java.html". Just let be mentioned the "DebugOptions". If marked, the value "-Xdebug -Xrunjdwp:transport=dt_shmem,server=y,suspend=n" will be inserted. The option "-Xnoagent" has to be inserted manually if needed and option "-Djava.compiler=NONE" may be specified as a "Property".
An option is selected by clicking into the selection field. Clicking the field again, deselects an alreay marked option.
The Java launcher can hold project specific properties required by a specific application. The properties are provided to the launcher via the -D option. There is no limit for the -D options and there is no specific sequence required. The dialog allows to prepare the -D options via the "Name" and "Value" text fields. The entered name and value will be appended to the value or the "Properties" text area in the form "-Dname=value", as soon as the "Add Prop." button has been pressed. Is a value erronous, it can be deleted by highlighting the erronous or unwanted character sequence and by pressing the "Del Prop." button.
After the desired options are selected, you must press the "Apply" button. This transfers the correctly assembled value into the field "Runtime options" of the invoking dialog. Here you can - if needed - complement the value by additional options, wich cannot be specified via the JadeIDE definition dialog.
Clicking the "Apply" button does not close the dialog window, because there may be modifications needed. The dialog window is closed either by clicking the "Quit" button or by clicking the "X" (Exit) button in the top right corner of the window.
The Dialog to select the options for the Java Standard Doclet appears, when the "Create" button to the right of field "Standard Doclet Options" has been pressed in the dialog to setup the project parameters. If at this moment a value is shown in the field "Standard Doclet Options" of the invoking dialog these values are used to initialize the fields of the new dialog. This provides a convenient way to clone and then modify parameter values.
Are the initialization values not required or completely unacceptable, all fields can be reset to their default values by pressing the "Default" button.
The dialog allows the specification of the most important options as defined for the JAVADOC.EXE of the SUN JDK (Version 1.3 or better) if no user provided Doclet class is exploited. The affect of the options is described precisely in the SUN JDK tools documentation. The "Help" button directly leads to this description if the required files are available in the J2SDK Documentation (example: "D:/j2sdk1.4.0/docs/tooldocs/javadoc/index.html").
An option is selected by clicking into the selection field. Clicking the field again, deselects an alreay marked option. An option is specified by filling the corresponding input field.
After the desired options are selected, you must press the "Save" button. This transfers the correctly assembled value into the field "Standard Doclet Options" of the invoking dialog. Here you can verify the values.
Clicking the "Save" button does not close the dialog window, because there may be modifications needed. The dialog window is closed either by clicking the "Return" button or by clicking the "X" (Exit) button in the top right corner of the window.
The dialog to define the "start class" and "start parameters" appears, when the "Create" button to the right of field "Main class" has been pressed in the dialog to setup the project parameters. If at this moment a value is shown in the fields "Main class" and "Invocation Parameters" of the invoking dialog these values are used to initialize the fields of the new dialog. This provides a convenient way to clone and then modify parameter values.
Are the initialization values not required or completely unacceptable, all fields can be reset to their default values by pressing the "Clear" button.
The dialog allows either the selection of the desired Java start class (the project class with the "main()" method) or the selection of a user archive (.jar file). These selections are mutually exclusive. If an archive is selected, the manifest file of this archive must provide the name of the start class. For both alternatives the eventually required start parameters expected by the "main()" method can be defined. Of course these parameters are project specific.
The start class and the user archive can be selected via the operating system specific file dialog. This dialog is invoked, when you press the "Browse" button behind the field. A value provided by the file dialog of course can be manipulated using the standard text manipulation functions. This includes deletion of a value.
If an invocation parameter happens to be a file or directory, you can use the "Append File to Args" button to search for the file specification using the operating system specific file dialog.
The "Erase Sel. Argument" button deletes a highlighted sequence from the "Arguments" text area.
After the start class or the archive and the invocation parameters are selected, you must press the "Apply" button. This transfers the correctly assembled values into the fields "Main class" and "Invocation parameters" of the invoking dialog. Here you can - if needed - complement the value.
Clicking the "Apply" button does not close the dialog window, because there may be modifications needed. The dialog window is closed either by clicking the "Quit" button or by clicking the "X" (Exit) button in the top right corner of the window.
With the dialog "Modify presentation font properties" it is possible to adjust the fonts used in the dialog windows of JadeIDE to an individual environment. This can be desireable if the used screen resolution causes that text is displayed too tiny or truncated.
3 different types of fonts can be modified:
With button the default values provided by JadeIDE are specified. With button the manually entered values are used to generate the fonts. It might be needed to close and re-open JadeIDE to activate the changes for some JadeIDE windows. The defined values are stored in the "JadeIDE.ini" file as parameters which are used to initialize JadeIDE in the future.
To check, which parameter templates are currently active, you can use the dialog named "Actual Parameter Selection". This dialog is invoked via menu item "Display Selected Values" in the "File" menu of the JadeIDE main window.
Never manipulate file jadeide.ini with an editor. This very likely will make this file unusable because the file contains binary pointers which become invalid if a length change appears within the file.
As soon as all desired and required command templates have been defined during the "setup" phase, you can start working with JadeIDE.
The various actions performed during project development are controlled via the menus and menu items of the JadeIDE main window. It can be distinguished between two major groups of actions:
The function "Work on Projects" is used to prepare and activate the command templates required to work on the project and to build the menu items of menu "Java Files" and menu "HTML Files".
When the "File -> Work on Projects" menu item is selected a "Selection dialog" opens presenting all existing projects. Projects are identified by their package name.
Select a package name from the list of available projects and press the button.
The project specific parameter values are tested against the currently existing environment and activated if there is no error. The project's ".java" files are placed into menu "Java Files", and the project's ".htm(l)" files are placed into menu "HTML Files". If the "JADE Parameter Selection" window is open, the window content is updated.
In textfield "Act.package" of the JadeIDE main window, the name of the selected project is shown as actual project.
As long as for a package (project) no ".java" files are found in the package folder automatically a template for a start class (named $StartClass) is generated. This template than can be modified according to the project needs.
Note: As long as $StartClass is the only ".java" file in the package folder, a new start class will be immediately generated, if the old $StartClass file is deleted.
Via the button of this dialog you can also invoke dialog Update Development Project if the parameters need to be modified before the project gets opened.
Note: A selected project you work with is marked as active project. It will be automatically restarted, when you invoke JadeIDE the next time. If a project is closed via the "Close Project" function, then there is no active project. That means the JadeIDE cannot automatically start a project, it must be started using this function.
The function "Close Project" ("File -> Close project") is used to deactivate the selected project. Menu item "Functions -> Show Java API Doc", the menus "Java Files", and "HTML Files" are disabled and the textfields of the main window are cleared. All actually selected command templates are deselected.
The "Functions" menu of the JadeIDE main window shows the menu items to invoke the supporting functions.
The function "Main Window to Top" moves the JadeIDE main window to the top of the screen and resizes it to the screen width and default depth (80 pixels).
The function "Set Default Look and Feel" exploits the system default look and feel for all windows opened after the selection of this function. The selection is stored in the base parameter BC_LAF (value=D). BC_LAF is used to set the look and feel when JadeIDE is started again. This means, the look and feel of the JadeIDE main window is changed only after a JadeIDE restart.
The function "Set Cross Platform Look and Feel" exploits the Java cross platform look and feel for all windows opened after the selection of this function. The selection is stored in the base parameter BC_LAF (value=X). BC_LAF is used to set the look and feel when JadeIDE is started again. This means, the look and feel of the JadeIDE main window is changed only after a JadeIDE restart.
Note: Under Linux the system default look and feel is identical to the Java cross platform look and feel.
Function "Invoke User Exit" allows you to open a user specific dialog window. This dialog can be used to trigger user provided functions. You must modify class UserExit in such a way, that your functions are properly handled by it. JadeIDE provides the Java source code of UserExit. In order to modify and compile it, you must create the project "com.kur.ide".
The following parameters must be specified:
Project Package Name = com.kur.ide
Project Library  = the name of the JadeIDE installation directory
Main Class = Control
Invocation parameters = Lang=E
The function "Start HTML Editor" opens the HTML Editor you have specified via the JadeIDE program invocation parameters (Parameter HTML=......).
The function "Start XML Editor" opens the XML Editor you have specified via the JadeIDE program invocation parameters (Parameter XML=......).
The function "Start UML Editor UMLet" opens the UML Editor UMLet provided by the Vienna University of Technology. To run UMLet the "umlet.jar" file must be loaded to the "....\com\kur\ide\jars" directory. If you do not have such a directory, you have to generate one. If the "umlet.jar" file is not found, this menu-item is inactive.
The function "Show Java API Doc" is used to invoke the browser you have specified via the JadeIDE program invocation parameters (Parameter BRWS=.....) to present the SUN Java JDK API documentation you have specified via the JadeIDE program invocation parameters (Parameter JAPI=.....).
The function "Show Package API Doc" is used to invoke the browser you have specified via the JadeIDE program invocation parameters (Parameter BRWS=.....) to present the project's JavaDoc HTML-file (if one has been generated with the "Generate JavaDoc" function provided in the "Project Actions" menu).
To show a package API, select a package name from the list of available packages and press the button.
The browser opens the associated API documentation file.
The function "Show clipboard content" opens a window, that shows in a text area the actual content of the system clipboard. This allows easy verification of what would be inserted at the caret position during the next insert operation.
Via button you can erase the content of the system clipboard.
The menu "Project Actions" of the JadeIDE main window shows the menu items for the real project work actions. This menu is structured into 4 sections. The first section comprises all actions which are single file (class) related, the second section comprises all project related actions, the third section provides the command to cancel ongoing processes, and section 4 handels the archive related actions.
To create a new source file the "Create & Initialize File" Dialog is used:
The dialog allows to generate and initialize project files of type ".java", ".html", ".xml", and type ".jct". To generate a new file perform the following actions:
none | no initialization or only rudimentary initialization | |
default | initialize it from a JadeIDE default template. For a ".html" file the "Generate HTML File" dialog is invoked to generate the initialization for an applet invocation. |
|
copy from | The initial file content is copied from the specified file |
The button resets the dialog fields and the button closes the dialog window.
A small hint: If you insert into the class header of your Java source code an @author line containing the text "last change:" (Example: " * @author xxxxxx yyyyy last change: "), the JadeEditor will insert after "last change:" a time stamp showing the actual time and date. By that you always know, when your source code has been saved the last time to a persistent media (disk, diskette, ...).
The "Delete a Project File" dialog is used to delete project files of type .java, .html, .xml, and .jct. The dialog provides a choice field for each type, which is filled with the file specifications of all existing project files of this type.
To delete a file from the project folder or templates folder the following actions have to be performed:
To close the dialog window click the button.
To edit a file with the JADE-Editor the following actions have to be performed:
To edit a file the following actions have to be performed:
To compile a source file (which is represented by the class name) the following actions have to be performed:
Clicking on menu item "Generate Window Frame" in menu "Project Actions" of the JadeIDE main window opens the Generate a Window Frame dialog.
Clicking on menu item "Generate Dialog Window" in menu "Project Actions" of the JadeIDE main window opens the "Dialog Window Generation" dialog
The function "Compile active Project" is used to compile all classes of the active project sequentially. If a compilation error comes up for a class, a "Messages and Errors" dialog window is opened. To keep valid the relationship between the compiled class and the error list, more than one "Messages and Errors" dialog can be open at a time. This allows convenient correction of all errors detected. To correct a source file you can use the "Edit" button directly from the "Messages and Errors" dialog.
The function "Generate Header Files for JNI" is used to generate the C/C++ header files for the selected class, if this class provides references to native methods. The header file (xxxx.h file) is stored in the project library and can be edited via the "miscellaneous files" menu. The file should not be modified. It must be included in the C/C++ program in order to establish the correct signatures of the provided native functions.
Clicking on the "Generate Jar Archive File" menu item in menu "Project Actions" on the JadeIDE main window starts the Jar Archive generation process for the active package (project).
The JAR file will be stored in the JadeIDE installation folder. The JAR file name will be generated from the last part of the project specification appended by the suffix "JAR.jar". Example: project id: com.kur.test, resulting archive name: testJAR.jar.
The "Generate Jar Archive File" dialog allows to define the JAR Command options and to define the files to be included into the archive. The following elements can be specified:
Button triggered functions:
Clicking on the "Generate Java Doc (standard)" menu item in menu "Project Actions" on the JadeIDE main window starts the Java Doc generation process for the active package (project).
The Java documentation will be stored in a folder inside the project folder. The foldername will be generated from the last part of the project specification appended by the suffix "Doc". Example: project id: com.kur.test, resulting folder name: testDoc. In this folder you will find the start file "index.html".
Clicking on the "Generate Java Doc (modified)" menu item in menu "Project Actions" on the JadeIDE main window starts the "Generate JavaDoc Project Documentation" dialog for the active package (project).
The "Generate JavaDoc Project Documentation" dialog allows to modify the parameters and options provided to the Java Documentation Tool. The following elements can be modified:
Button triggered functions:
To run the project's top level class containing the init() method as an applet via the currently selected appletviewer the following actions have to be performed:
To run the project's top level class containing the main() method the following actions have to be performed:
To cancel a running compilation or execution click on the "Cancel active action" item of menu "Project Actions" in the JadeIDE main window. After termination of the compilation or execution a message is displayed showing the execution result. Finally a message and error dialog is displayed to show messages generated during the compilation or execution (messages: max. 64 K bytes or up to about 300 entries; errors: max 64 K bytes or up to about 300 entries).
To maintain the existing archive folders of a project you must click the "Maintain Archives" menu item.
This opens a window with the title "Maintain existing archives" which shows all potential archive folders of a project in ascending order - that is in the sequence of their creation: oldest archive on top, most recent archive at the bottom of the list.
By marking an archive specification in the offered list and by clicking the "Delete" button, the related folder will be deleted. Caution: there is no confirmation of the deletion action requested!
The window is closed via the "Quit" button or via the "X" (Exit) button in the upper right corner of the window.
To persistently archive (backup) an actual snapshot of a development project's source files you have to click the "Archive current project" button.
An archive folder will be created as a subfolder in the actual project folder. The folder is named with the timestamp that indicates the generation time. The format is YYYYMMDDHHMM - year, month, day, hour, minute. Into this archive folder all actually existing source files of the project will be copied (all files with the extension .jav, .java, .htm, .html). The successful generation of the archive will be signalled and recorded in the session protocol.
To restore previously archived source files of a project from an existing archive folder in order to activate them for the actual project work you have to click the "Restore from archive" button.
A window with the titel "Restore project from selected archive" opens. This window shows all potential archive folders of a project in ascending order - that is in the sequence of their creation: oldest archive on top, most recent archive at the bottom of the list.
By marking an archive in the list and by clicking the "Restore" button all source files (files with extension .jav, .java, .htm, .html) stored in the archive will be copied to the actual project folder. Existing files with the same name will be replaced without further warning. All other files in the project folder (e.g. all .class files) will be kept. If the .class files have to be made consistent with the restored source files a full project compilation has to be performed.
The button "FileDialog" opens the platform specific file dialog. With this file dialog you can select a single file that has to be restored. It is allowed to switch to a different folder. The selected file from the archive folder shown in the file dialog is copied to the project folder, as soon as the "Restore" button is pressed. Again no confirmation of the action is requested!
The window is closed via the "Quit" button or via the "X" (Exit) button in the upper right corner of the window.
The "Generate HTML File" dialog is used to determine the parameters needed to initialize the HTML file in order to allow the applet invocation via an appletviewer or a web-browser.
The "Generate HTML File" dialog is invoked from the JadeIDE "Create & Initialize file" dialog (triggered from the JadeIDE main window via menu "Project Actions" and menu item "Create & Initialize file") if file type ".html" and template "default" has been marked. The dialog provides the following fields:
The "HTML File Generation" dialog offers the following functions:
When the "Reset" button is pressed, all dialog fields are reset to their initial (default) values.
To add a new parameter the following actions have to be performed:
To move a specified parameter in the list of defined parameters one position up, the following actions have to be performed:
To move a specified parameter in the list of defined parameters one position down, the following actions have to be performed:
To delete a specified parameter in the list of defined parameters, the following actions have to be performed:
When the "Save and Exit" button is pressed, the provided input is checked for errors. If an error is detected, a message about the field in error is presented so that the error can be corrected.
If everything is OK the HTML file content is generated. If needed, the file is generated and the generated text is inserted into the file. If the file is not new, the existing content is overridden without further notice.
The dialog to generate the source code for a Java "window Frame" is used to define the parameters needed to control the generation process. The dialog is invoked from the menu "Project Actions" of the JadeIDE main window via item "Generate Window Frame" (see: The JadeIDE Project Actions).
Generated will be the code template for the window frame including the menu bar, the various menu entries, the menu items for each menu entry, as well as the window content ("content pane"). For the window generation the standard AWT constructs (Label, TextField, TextArea, Choice, Button, .....) or the standard Swing constructs (JLabel, JTextField, JTextArea, JButton, JComboBox .....) can be used.
To prepare the generation of a "Window Frame" the desired menu structure should be comletely sketched out. That means, all menu names, all menu item designations including the characters to be used for keyboard shortcuts, should be known, and the sequence of the menus and menu items should be determined.
The dialog window provides all required input fields as well as the buttons to trigger the offered actions.
The dialog provides the following fields:
The dialog provides the following functions:
In the same way as described under Generate "Dialog Windows" (Start Dialog) this dialog is used to maintain the rows structuring the content pane. The following buttons are available:
The following input will generate the "Window Frame" shown below:
Window name: DemoWindow Window width: 500 Window height: 400 New entry: File (store via button "Add as menu") New entry: Shortcut: new open save S save as exit X (via button "Add as item" with menu "File" selected ) Neuer Eintrag: Edit (store via button "Add as menu") New entry: Shortcut: undo redo cut copy C paste V (via button "Add as item" with menu "Edit" selected ) Neuer Eintrag: Help (store via button "Add as menu") New entry: Shortcut: content about (via button "Add as item" with menu "Help" selected ) Row definitions: Row name Element type Element name Field width line1 with Label Textfield TextField TF1 40 line2 with Label Textarea TextArea TA1 40 line3 with Label Selections Checkbox Check1 1 Checkbox Check2 0 Choice/.. Combo1 line4 with Label List List List1 Label Canvas Canvas Canvas1 line5 with GridPanel GridPan1 (click: Fill Panel) GridPan1 with Button Help Button Defaults Button Return
Generated window (using AWT constructs)
Generated window (using Swing constructs)
The dialogs to generate the source code for "dialog windows" are used to define the parameters needed to control the generation process. The start dialog for the generation is invoked from the "Project Actions" menu of the JadeIDE main window via item "Generate Dialog Window" (see: The JadeIDE Project Actions). The sub dialog is invoked from a button within the start dialog window.
The following scheme shows the principle of the dialog window generation:
The start dialog is used to define the base parameters (window name and window dimension) as well as the rows of the dialog window. The start dialog allows also to display the generated window for testing and verification. Finally it is used to trigger the final source code generation process.
The start dialog provides the following fields:
The start dialog provides the following functions:
Note: If the start dialog for the "dialog window" generation is closed, all parameters defined for an actual generation will be discarded. It is (currently) not planned to save the provided input, because the number of information to be provided to generate a dialog window is so modest and the whole generation process is so short, that it always can be completed.
The second dialog is used to determine the information fields which should be contained in a information group. Information group may be a window row, but it also could be a so called "container". A container is a means to group somehow related information fields (e.g. a group of buttons).
The secondary dialog contains the following information fields:
The socondary dialog provides the following functions:
To generate source code for dialog windows you should follow the following scheme:
Example
The following parameters generate the dialog shown below - left (or top) exploiting standard AWT components and right (or bottom) exploiting Swing components!
Start dialog: width: 325, height 300; add rows: R1, R2, R3, R4, R5 Secondary dialog: for R1: Label,Field 1; TextArea,Field_1,32; for R2: Label,Checkmarks; GridPanel,GP1; for GP1: CheckBox,Box_1,0; CheckBox,Box_2,0; CheckBox,Box_3,1; for R3: Label,Field 2; TextField,Field_2,32; for R4: Label,Field 3; Choice/ComboBox,Field_3; for R5: GridPanel,GP2; for GP2: Button,Button_1; Button,Button_2; Button,Button_3;
The JADE-Editor is an editor, which has been especially developed for programmers writing Java source code. The JADE-Editor is seemlessly integrated into JadeIDE and is the preferred editor of this development environment. The editor is designed to provide the desirable functionality rather than for nice appearance. This is to keep the editor small and by that (although completely written in Java) make it reasonably fast.
The JADE-Editor window comprises a menu bar, a tool bar at the left window border, a source text area, a (input protected) line number area and (in the lower left corner) a field, which presents the position of the mouse pointer (not to confuse with the caret position) in the source text. The first number is the line number the mouse pointer is in, and the second number is the character position in the text line. The maximum value for a character position is the actual line length.
Note: The caret position is counted from the beginning of the text. It tells therefore the position of a character in the source text. The first character of a text is located at caret position 0, the last one at caret position = text length - 1.
Via the editors file menu the save, print and exit functions are invoked. Most of these functions may also be invoked via their associated keyboard shortcuts.
(Caution: keyboard shortcuts only function, if the editor window has the input focus. This is the case, when the window header is highlighted!)
The functions (and their associated keyboard shortcuts) are shown in the following picture:
With the "Save" function the actually presented source text will be persistently stored on a storage media. This function also removes the remark about unsaved modifications in the title bar of the window.
With the "Save all and Compile this" function the actually presented source text of all currently open JADE-Editor windows will be saved and than the compilation of the class presented in the window, that has triggered the action is started. This provides a convenient way to trigger final and intermediate compilations e.g. to detect still existing coding errors. Errors and messages are presented in the JadeIDE windows for Standard-Out and Standard-Error. From the "Standard Error" window you directly can branch to the statements on error. You just have to click into the relevant error message block. This will position the erronous line at the top of the JadeEDIT window displaying the Java source text. If the erronous class is currently not displayed in a Jade-Editor window a editor window is opened automatically, but in this case the source text is presented starting from line 1. Therefore you have to do the action again to position the source text to the erronous line.
The standard out and standard error messages can be printed via the JadeEditor. To do this, you have to transfer the information to the JadeEditor via button "Show in Editor". From the JadeEditor you can call the "print preview" respectively the "print" function. This procedure enables the editing of the information (e.g. to add important remarks) prior to printing it.
Function "Save all and Compile this" also removes the remark about unsaved modifications in the title bar of the window.
Caution: Source text opened and still presented via an external editor will not be saved, even if this source text has been modified!
The "Select Paper Format" function shows a submenu presenting the available paper sizes. The submenu is used to select the desired paper size.
Currently supported a the 6 most commonly used paper sizes. These are
and
Function "Print Preview" allows to verify the print output before printing. The dialog allows to browse through the output via the (red arrow) buttons of the tool bar. Supported are: first page, last page, previous page, and following page.
The window of the dialog can be resized. The print output will be adjusted to the actual size of the window.
You can start the actual printing from the tool bar. Available are: print all pages, and print currently presented page. With the "Exit" button the dialog is terminated without triggering a print action.
Function "Print the Document" triggers the printing of a Java source file. To select a printer the system specific "Print" dialog is presented. This "Print" dialog also allows to reroute the output to a file and to specify the number of copies to be printed.
Each printed page shows in the header the path and the filename of the printed class. In the footer you get the page number and the exact printing time.
Function "Generate HTML Output" generates a HTML formatted form of the Java source file. This file can be viewed with a WEB-Browser.
With the "Quit (no Save)" function the editor session is terminated without saving the actually presented source text persistently. By this it can be avoided that a corrupted source text is persistently saved to disk. On the persistent storage the source text stored during the last successful save operation will be kept.
Caution: If the function "Save all Compile this" has been invoked from a different JADE-Editor window, this is the last performed successful save operation.
With the "Exit with Save" function the actually presented source text will be persistently stored on a storage media and the editor session is terminated. The termination actions triggered via the windows system menu and via the exit button in the title bar perform this action as well.
Via the Edit-Menu of the editor a number of edit and navigation functions to manipulate the source text are invoked. Most of these functions may also be invoked via their associated keyboard shortcuts.
(Caution: keyboard shortcuts only function, if the editor window has the input focus. This is the case, when the window header is highlighted!)
The functions (and their associated keyboard shortcuts) are shown in the following picture:
Function "Undo" sets back a performed edit action. Multiple resets are supported.
Function "Redo" re-establishes a undone edit action. Multiple redos are supported.
Function "remove all checkpoints" deletes all /* CKPT */ statements in the source code of the actual class.
With the "Cut" function the actual selection (the light blue highlighted text) of the source text is copied to the System Clipboard and removed from the actually presented source text.
With the "Copy" function the actual selection (the light blue highlighted text) of the source text is copied to the System Clipboard but the presented source text remains unchanged.
With the "Paste" function the actual content of the System Clipboard will be inserted into the presented source text directly after the actual caret position. If a text selection exists, this actual text selection is replaced by the actual System Clipboard content.
With the "Select all" function the complete source text is highlighted as actual selection so that it can be cut or copied.
With the "Goto method" function the dialog "Locate method..." is invoked. This dialog presents the class constructor and all "public", "private", and "protected" declared methods of the currently presented class via a tree view, that is in the sequence of their appearance in the source text. If the "Locate entry" button is pressed, the source text is positioned to the definition of the currently selected (highlighted) entry. This function does not position the source text to the methods invocations. To achieve this, the "Find / Replace" function must be used.
Button "Calling classes" of the "Locate method..." dialog will generate a list of all classes in the actual project, which invoke the selected method or have a method with identical name. This can be used to ease the search for potential method calls from other (project-)classes. Pressing button "Edit selected class" invokes the JadeEditor presenting the class selected (highlighted) in the combo box showing the list of invoking classes.
Button "Quit" closes the dialog without repositioning the source text.
Notes:
1. Because Java has no unique keyword to identify a method and because a method definition can contain comments and user defined class names as return types and parameter types in some rare cases it may occure that JadeIDE does not detect a method definition. In those cases you must use the "Find / Replace" function to locate the function definition. In any case it is good practice to avoid comments in a method definition. Instead provide comments in the method's header or in a separate comment line after the method definition line.
2. To ease the identification of constructor methods, constructors should be defined with a visibility keyword (public, private, protected).
3. If a tree view appears truncated (not all existing methods are shown), it is very likely, that the rather complex analysis algorithm has been disturbed by a string constant (literal) containing characters, that have a syntactical meaning in the Java source code. Critical are characters like / \ // ; { [ ' " etc.. It is very desirable and good coding practice, to provide such characters as a Unicode ("\uxxxx"). The characters can be generated via function insert Unicode. If a tree is obviously incomplete, the reason is normally found in the method shown as last entry in the tree. This method should be analysed and corrected.
With the "Goto line" function you can position the source text to a certain text line. After the line number has been entered and the "Enter" button has been pressed in the "Goto line..." dialog, the source text is positioned to the desired line number. If the dialog is closed via the dialogs system menu or the exit button in the title bar no text positioning is performed.
Function "Goto associated }-brace" highlights a "{..}" block (light red) in the source text. As start brace the first "{" brace is used following the actual caret position.
Function "Goto associated {-brace" highlights a "{..}" block (light red) in the source text. As start brace the first "}" brace is used following the actual caret position.
With the "Goto top" function the presented source text is positioned to the beginning of the text.
With the "Goto bottom" function the presented source text is positioned to the end of the text.
With the "Find / Replace" function you can locate certain text strings in the presented source text and replace them with another string, if desired. The searched text (if existent) is highlighted (light blue background) and the source text is positioned to the line, in which the search string has been detected. A search starts at the current caret position (the actual insertion point) and can be done towards the end or towards the beginning of the document. You can also ignore the case for a search string.
The dialog supports the following sub-functions:
Function "set Find highlights off" removes the highlights set to search results.
The "Indent lines" function allows to indent a number of lines by a certain number of blank characters or to truncate the lines at the beginning by a certain number of blank characters. Truncation is only performed, if no valid text gets lost. Valid text is any non blank text.
Provide the number of the first line and the last line to be indented respectively truncated at the beginning. Then provide the number of blank characters to be inserted (positive value) or the number of blank characters to be cut off (negative value). If field "make / is comment" is checked, then for an indentation the Java comment string "//" is added (indentation = number of blank chars + 2) and for a truncation the line is shortened, even if the Java comment string "//" occurs at the beginning of the line (truncation = number of chars + 2). If the field is not checked, "//" at the beginning of a line is considered to be a valid text, a truncation therefore will not happen.
The function "Insert Unicode" allows at any position in the source text to insert a character in Unicode representation (\uxxxx). Allowed are Unicodes in the range from 0000 to 007F. The character to be inserted is determined via the dialog "Select the desired Unicode".
The dialog allows to specify the character in two differnt ways, dependent on the type of character. Is the character to be inserted an unprintable character (Unicode 0000 to Unicode 0020 and Unicode 007f), than the selection has to be done via the choice field "unprintable Characters" (select the desired code). In this case, the field "printable Characters" must be empty, otherwise the value of this field will be taken. Are the characters to be inserted a sequence of printable characters (Unicode 0021 to Unicode 007e), than the selection has to be done via the field "printable Characters" (provide the desired character(s)). In this case, the selection in field "unpritable Characters" is not used. After pressing button "Insert", the specified character(s) will be inserted at the current caret position into the source text in Unicode representation.
The function "Insert text template" allows to insert a Jade Code Template at any position in the presented source text. The text template must be stored as a file in the "templates" sub-folder with a extension of ".jct".
The selection of the text template to be inserted is done via the "Template Selection Dialog". The dialog shows all available templates. By pressing button "Open" the selected template will be inserted into the source text at the current caret position.
Button "Cancel" terminates the dialog without any further action.
JadeIDE provides a series of predefined templates. These templates may be individually modified and own templates may be added to the folder (e.g. with the function "Save selection as template" in the Options Menu.
Via the Options Menu of the editor some special functions are invoked. Some of these functions may also be invoked via their associated keyboard shortcuts.
(Caution: keyboard shortcuts only function, if the editor window has the input focus. This is the case, when the window header is highlighted!)
The functions (and their associated keyboard shortcuts) are shown in the following picture:
Function "Wrap long lines" allows to wrap long text lines which cannot be shown completely in the available window width because of their length.
Note: If a compilation is performed as long as this option is set, the line numbers in potential error messages may be different from those shown in the editor.
Function "Reset wrapping" resets an existing line wrapping, so that long lines are again shown only partially.
Function "Check pairs" allows to test, if the strings "/*" and "*/", "(" and ")", "{" and "}", "[" and "]", as well as single quotes and double quotes only appear as pairs in the source text.
Note: As these characters may also appear in comments and literals (e.g. as "'" or '"') the result of the analysis is not always correct. If this is the case, you must use the Java Compiler/Interpreter to do the test.
Function "check with JiveLint" (currently only Windows) calls the Code Checker JiveLint of Sureshot (see also "http://www.bysoft.se/sureshot/javalint/index.html" ) to analyse the Java code statically.
To use the function in the Base Parameter Maintenance Dialog the Code Checker from Sureshot must be defined (Base Parameter BC_JCK). In addition the file "jconfig.txt" should exist in the "user.classpath", the directory into which JadeIDE has been installed and the file "JadeIDE.ini" is located. File "jconfig.txt" controls the exclusion of the JiveLint rules (see the relevant JiveLint documentation). In the "jconfig.txt" file delivered with JadeIDE rule 1022 is disabled.
The result of the test is presented in the StandardOut presentation window and similar to the presentation of compilation errors you can directly jump to the source line in error, if you locate the cursor onto the desired JiveLint message line and than press the "Goto Error" button.
Function "set Comment highlights on/off" switches the highlighting of comments in the source text on or off. Comments are highlighted by a light green background. If highlighting is switched on, it follows text movements (e.g. if new text is inserted or text is removed), but newly inserted comments are not directly highlighted. To highlight them, you first have to switch comment highlighting off and the on again.
Function "set String highlights on/off" switches the highlighting of strings in the source text on or off. Strings are highlighted by a light red background. If highlighting is switched on, it follows text movements (e.g. if new text is inserted or text is removed), but newly inserted strings are not directly highlighted. To highlight them, you first have to switch string highlighting off and the on again.
Function "set Keyword highlights on/off" switches the highlighting of java keywords in the source text on or off. Keywords are highlighted by a light blue background. If highlighting is switched on, it follows text movements (e.g. if new text is inserted or text is removed), but newly inserted keywords are not directly highlighted. To highlight them, you first have to switch keyword highlighting off and then on again.
Function "set Checkpoint highlights on/off" switches the highlighting of Jade Checkpoints in the number area on or off. Checkpoints are highlighted white. If highlighting is switched on, it does not follow text movements (e.g. if new text is inserted or text is removed). To update the highlights, if checkpoints have been added or removed, just switch checkpoint highlighting off and then on again.
Function "extract String literals" extracts all text literals (strings started and ended by a double quote character). The java source text is not changed, but the extracted strings are appended to the source text as a string definition made to a single line comment. The programmer can than decide how to further use these definitions.
Function "Save selection as template" allows to save the current selection in the source text as a Jade Code Template to folder "templates".
The dialog allows to provide the template name. You can specify any valid file name but it is good practice to use a menaingful name. The file extension ".jct" is added automatically by JadeIDE. After pressing the "Save" button a file is created in the "templates" folder and the selection is saved to this file. The new name is added to menu "Code Templates" so you can immediately edit the newly generated template.
If button "Cancel" is pressed, the dialog will be terminated without any further action.
Function "Change Editor Font Size" allows to change the size of the editor font. To do so, you have to enter the desired font size in points in the upcoming dialog and to press the "Select" button. Pressing the "Default" button sets the default font size (13 points). If you close the dialog (via the "X" button) without selecting a font size, the font size remains unchanged.
The specified value will be added as entry to the INI file and will be used for all further editor invocations.
Via the "Bookmarks" menu of the editor you can set and remove bookmarks for the source code and jump to the position in the source file defined by a bookmark.
JadeEditor bookmarks are session bookmarks. They are not saved for a later session.
The JadeEditor uses the content of a complete line as a bookmark but it omits the line number.
The line number is omitted because it is very likely, that line numbers change during the editing of a source file.
The Bookmarks Menu provides the following functions:
Function "set line as bookmark" adds a new bookmark menu item to the end of the Bookmarks menu. This entry is marked with the prefix "BM:" followed by the text of the source code line, the caret is positioned in during function selection.
Function "remove bookmark" removes a bookmark menu item from the Bookmarks menu. Removed is the menu item (below the separator line) which has been selected during the immediately preceeding item selection action.
The selection of a bookmark menu item (below the separation line) positions the source code to the line defined by the bookmark and highlights it. This of course only functions, if the line has not been changed since the bookmark has been created. A line number change does not matter, because the JadeEditor searches for the text string represented by the bookmark. If there are several identical strings in the source file, the file will be positioned to the first occurence of the string.
If the control-key and a mouse button (left or right) is pressed simultaneously a pop-up menu is shown at the current caret position.
Function "add checkpoint above" inserts a checkpoint (a /* CKPT */ statement) one line above the current caret position into the source code of the actual class.
Function "add checkpoint below" inserts a checkpoint (a /* CKPT */ statement) one line below the current caret position into the source code of the actual class
With the functions mentioned above two types of checkpoints can be inserted in the source text of a class:
1. plain checkpoints, checkpoints that simply show as a standard out message, that the marked line has been passed during a test.
and
2. checkpoints displaying a variable content, these are checkpoints which - in addition to the output of a plain checkpoint statement - show the actual content of a specified variable in the standard-out message.
Definition of a variable: a variable for a checkpoint statement will be defined by highlighting the variable with the mouse while the pop-up menu is open, but this is possible only in the line, the caret is actually located, when triggering the pop-up menu.
Procedure:
Checkpoint messages will be presented as "Standard Out" [ System.out.println ... ] messages. They will be shown in the message window of JadeIDE, if the program is invoked via JadeIDE.
Function "remove checkpoint" removes the checkpoint statement ( /* CKPT */.... line ) at the current caret position.
Function "remove all checkpoints" removes all checkpoint statements ( /* CKPT */ .... lines ) defined in the source text of a class. (see also: remove all checkpoints in the edit menu).
Function "insert text template" allows to insert a Jade code template into the source text of a class at the actual caret position. (see also: insert text template in the edit menu).
Function "make line to // comment" allows to change the line containing the caret to a Java comment line by adding "// ".
Function "remove // from line" automatically removes the comment indicator ("//") from the beginning of the line containing the caret. The function removes only the following sequences: "// ", "//*", and "//-".
Function "generate Getter method" allows to generate a "public Getter method" for the highlighted variable. The getter method will be inserted into the source code at the end of the source code file (that is after the "} /* end of class definition */ " line). The generated code snippet must be manually moved (with cut and paste) to the desired position in the source code. The selection of the variable has to be done in the same manner as the selection of the variable for a checkpoint generation (see above).
This function must only be used in variable (class or instance) definition lines. Otherwise it will produce invalid results.
Function "generate Setter method" allows to generate a "public Setter method" for the highlighted variable. The setter method will be inserted into the source code at the end of the source code file (that is after the "} /* end of class definition */ " line). The generated code snippet must be manually moved (with cut and paste) to the desired position in the source code. The selection of the variable has to be done in the same manner as the selection of the variable for a checkpoint generation (see above).
This function must only be used in variable (class or instance) definition lines. Otherwise it will produce invalid results.
Function "generate Getter and Setter method" allows to generate a "public Getter method" and a "public Setter method" for the highlighted variable. The methods will be inserted into the source code at the end of the source code file (that is after the "} /* end of class definition */ " line). The generated code snippets must be manually moved (with cut and paste) to the desired positions in the source code. The selection of the variable has to be done in the same manner as the selection of the variable for a checkpoint generation (see above).
This function must only be used in variable (class or instance) definition lines. Otherwise it will produce invalid results.
The tool bar is located at the left border of the editor window to provide space for as much as possible source text lines. The available line width is considered to be of less importance with regards to the amount of available rows.
The tool bar provides the following entries:
To run JadeIDE a JDK 1.4 or higher together with the associated API documentation (e.g. from SUN Microsystems) must be installed (currently - February 2004 - I recommend to use JDK 1.4.2_02).
The JDK is available for free from the SUN Download Center via "http://www.sun.com/software/shop/index.html#free".
In the system there must be about 3 MB of disk space available. The required disk space for the JDK is not included!
The system should have at least 64 MB of main storage and should be equipped with a processor with at least 300 MHz. Weaker systems will also work but the performance will of course be affected.
If you want to use also a file editor external to JadeIDE, editors like "PFE (Programmers File Editor)" from Alan Phillips may be installed.
The PFE can be obtained from "http://www.lancs.ac.uk/people/cpaap/pfe" or via Winsite or Simtel
The product is currently freeware.
For Linux (e.g. Suse Linux 7.x) with KDE2 the "kwrite" editor can be used.
For function "Start HTML Editor" a HTML Editor and for function "Start XML Editor" a XML Editor should be installed. "HTML Editor Phase 5.3" (windows) from Hans-Dieter Berretz and "HTML-Format" (Windows and Linux) from Christian Diekmann are excellent HTML Editors.
XMLMind is an outstanding XML Editor provided by the XML Products Division of Pixware, 78180 Montigny Le Bretonneux France [ "http://www.pixware.fr" ].
XMLmind can be downloaded from URL "http://www.xmlmind.com/xmleditor/download.shtml",
HTML Editior Phase 5.3 can be downloaded from URL "http://www.ftp-uploader.de/ftp-download.php4"
and
HTML-Format can be downloaded from URL "http://www.downloadbereich.de/HTML-Format/HF-download.htm"
The products are currently Freeware.
For Linux (e.g. Suse Linux 7.x and KDE2) the "kwrite" editor may be used as well.
To use the Jade editor function "check with JiveLint" you must have installed the Java Code Checker "JiveLint" from Sureshot. "JiveLint" can be downloaded from URL "http://www.bysoft.se/sureshot/javalint/index.html".
To use the JadeIDE function "Start UML-Editor UMLet" the UML Editor UMLet provided by the Vienna University of Technology must be installed in the "/jars" directory located directly under the JadeIDE project library (e.g. "D:/JadeIDE/com/kur/ide/jars"). "UMLet" can be downloaded via URL "http://www.swt.tuwien.ac.at/umlet/index.html".
The Jade System is provided as a ZIP file. The folder information is contained
in the ZIP file. For Windows a self-extracting .exe file is also available.
Just extract the file into a directory of your choice,
[e.g. D:\jadeIDE (Windows) or /home/xxxx/jadeIDE (Unix/Linux where xxxx is your user id). Under Linux of course you can install JadeIDE also into the /opt or /usr directory if the required access rights are granted.]
with a product like PKZIP, WINZIP, PowerArchiver, WINRAR, or the Java JAR-Tool. Make sure, that the file structure is kept when expanding the archive.
The file will expand into the following file structure:
DOS/Windows form:
D:\jadeIDE user.dir (respectively user.classpath), => will hold jadeide.ini and holds jconfig.txt as well as winjade.ico (icon for shortcuts on the desktop) .....\com\kur\ide => all ".class" files .....\com\kur\ide\images => jade.gif, jadesmal.gif, noinput.gif, all icons used in the JadeIDE windows, .....\com\kur\ide\jars => JAR archives of Java applications, that can be invoked out of JadeIDE (e.g. UMLet),  .....\com\kur\idedt => directory for the test of individual windows and dialogs .....\help => jidehelp_x.htm .....\help\images  => all ".gif" files required for Help .....\templates   => all JadeIDE provided Jade Code Templates
/home/xxxx/jadeIDE user.dir (respectively user.classpath), => will hold jadeide.ini and holds jconfig.txt as well as winjade.ico (icon for shortcuts on the desktop) ...../com/kur/ide => all ".class" files ...../com/kur/ide/images => jade.gif, jadesmal.gif, noinput.gif, all icons used in the JadeIDE windows, ...../com/kur/ide/jars => JAR archives of Java applications, that can be invoked out of JadeIDE (e.g. UMLet),  ...../com/kur/idedt => directory for the test of individual windows and dialogs ...../help => jidehelp_x.htm ...../help/images  => all ".gif" files required for Help ...../templates   => all JadeIDE provided Jade Code Templates
To run the JADE IDE besides the ".class" files the following files are needed in the following directories:
If you want to save space on your disk you can delete for the language you do not use the help file and the associated images. The language of the file is indicated by the name suffic "_d" (for German [deutsch]) and "_e" (for English).
JadeIDE adds no entries at all to the registry of the exploited windows operating system. To completely remove JadeIDE from a windows system (as well as from a Linux system) it is sufficient, to delete the folder (with all it's sub-folders) into which the JadeIDE files have been unpacked.
JadeIDE is written completely in Java. Therefore there is no "....exe" file. The controlling EXE is the Java-Launcher (java.exe [Windows] respectively java [Linux]) which invokes the JadeIDE main class "Control.class". To simplify the relatively complex java program invocation JadeIDE can be invoked from a terminal or via a script/batch file e.g. like this:
DOS/Windows form of an invocation via a DOS window:
it is assumed, that the JDK is installed in C:\j2sdk1.4.0
C:\>d: D:\>cd jadeIDE D:\jadeIDE>C:\j2sdk1.4.0\bin\java.exe -classpath D:\jadeIDE; com.kur.ide.Control LANG=parmUnix/Linux form of an invocation via a Terminal ( xxxx represents the user id ):
xxxx@linux:~ > xxxx@linux:~ > cd jadeIDE xxxx@linux:~ /jadeIDE > /usr/java/j2sdk1.4.0/bin/java -classpath /home/xxxx/jadeIDE com.kur.ide.Control LANG=parm
Make sure that line 3 of the invocation (the text after the ">" character) is presented to the "command interpreter" of the OS as a single line!
A message like "Exception in thread "main" java.lang.NoClassDefFoundError" indicates, that a name (e.g. Control) has not been provided in the correct case. Remember: Java names are case sensitive.
In this example user.dir is "D:\jadeIDE" or "/home/xxxx/jadeIDE",
parm defines the language used for JadeIDE execution. Currently supported is "E" for English and "D" for German (Deutsch).
e.g. LANG=E
If you want, that the "Shortcut" on the desktop to the BAT-File invoking JadeIDE shows the Jade Icon, you can use the "winjade.ico" icon (to be found in the jadeIDE directory).
Very important Note: Please consider, that you have to set the parameters required by JadeIDE at the first invocation of the product. The first action therefore is to invoke the setup dialogs (with their associated sub dialogs) via menu "File -> Maintain Basic Parameters" and "File -> Define/Update Projects" !
For more information go to: The "Setup" Dialogs for the JadeIDE Parameter Definition.