JBuilder Quick Start Tutorial. Embarcadero Application Development Tools

Transcription

1 JBuilder Quick Start Tutorial Embarcadero Application Development Tools

2 COPYRIGHT Under the copyright laws, this document may not be copied, photocopied, reproduced, translated, reduced to any electronic medium or machine-readable form, in whole or in part, without the prior written consent of Embarcadero Technologies, Inc. Copyright 2001 Embarcadero Technologies, Inc. 425 S. Market Street, Suite 425 San Francisco, CA U.S.A. All rights reserved. Printed in the United States. Embarcadero Technologies is a registered trademark in the United States and certain other countries of Embarcadero Technologies, Inc. or its subsidiaries. is a registered trademark, in the United States and certain other countries, of Embarcadero Technologies, Inc. or its subsidiaries. Other product names and trademarks are the property of their respective owners.

3 Table of Contents Introduction... 1 Running the JBuilder/ Integration... 2 JBuilder Main Window... 5 Create a New Project... 5 Project Properties Create a Class Creating a Web Report Exiting the Application... 19

4 Introduction What is JBuilder? JBuilder software is an integrated development environment (IDE) for the Java platform providing a fully modular and easily extensible environment. This environment, called the AppBrowser, consists of several panes and panels for performing most development functions: editing, visual designing, navigating, browsing, compiling and debugging. Why Integrate with? The JBuilder/ integration allows Unified Modeling Language (UML) tools to communicate with Integrated Development Environments (IDE). This eliminates the need to switch back and forth from design environment to development environment and maintains synchronization between design elements and the source code as you design systems. The two environments are combined by embedding modeling functionality within JBuilder allowing you to view and manipulate the class model and its underlining code simultaneously. integrates with JBuilder 4.0 and JBuilder 5.0. Enterprise and Developer The JBuilder integration works with both Enterprise and Developer. In this document, unless specified otherwise, the instructions and functionality behave the same in both Enterprise and Developer. Following is a brief description of each application: Enterprise offers a seamless, embedded integration within leading Java IDEs to provide a single, integrated modeling and development environment. With superior navigation, wizard-based automation of common tasks, and synchronous, round-trip engineering, turns the UML into a live tool for understanding and manipulating the source base. Developer is designed for the individual professional or corporate developer implementing complex Java applications where better design visibility during the construction phase enables better coding decisions. Developer extends the functionality of the Java programmer s IDE by adding class and sequence diagrams, those used most frequently during implementation, directly into the developers workspace. Developer embeds into the interface of leading IDE s like Forte for Java or Borland JBuilder, providing a single environment. Source code and models are synchronized automatically, ensuring UML visibility at all times, without any overhead effort. -1-

5 Running the JBuilder/ Integration Starting JBuilder: 1. Choose START->PROGRAMS->JBUILDER->JBUILDER. 2. As the JBuilder application starts, the integration with is automatically detected. Initially, the JBuilder splash screen opens. 3. Once the application is loaded, a splash screen also opens briefly. If you are running JBuilder with the Developer Integration, just a splash screen opens. No action is required to launch the application, which runs in the background. If you are running JBuilder with the application, the splash screen requires you to enter a User Name and Password. Once you enter the appropriate information and click OK, the application is launched but is hidden in the background. -2-

6 4. The main JBuilder dialog box opens. Each portion of this dialog box is explained in the following topics. -3-

7 -4-

8 JBuilder Main Window Once you have created a project and diagram the main JBuilder window resembles the following graphic. Click here for additional information on the main window. The next step in this tutorial is to create a new project in JBuilder. Create a New Project JBuilder uses a wizard to create a project file. This project contains the project settings and all files added to the project. The project settings can include directory structure, library paths, sources, JDK versions and relevant deployment settings. These project settings are referenced each time you work in the project. 1. Choose PROJECT->NEW PROJECT from the JBuilder main menu. -5-

9 The Project Wizard dialog box opens. 2. Enter the name of the new project in the Project Name text box. For purposes of this tutorial we will name the project "JBuilderDemo". 3. For Type select jpr from the drop-down menu. The.jpr file type can be used for most purposes. The.jpx file type is an XML file supporting team development features and version control. -6-

10 4. A description for each text field in the "Select project template and directory names" section follows. For purposes of this tutorial, do not change the default information. Project for defaults: Root path: The default name is (Default project). The drop down arrow lists all the existing projects. If you click, the Open Project dialog box opens. You can browse to another project name. By choosing Default project, a template sets the root path to the jbproject directory in your home directory. If you choose another project, the project directory is a subdirectory of the selected project's directory. If you click, the Select Directory dialog box opens. You can change directories using this dialog box. Project directory name: Source directory name: Backup directory name: Output directory name: Project directory is parent to source and output directories: This is the same as the name you entered in the Project name text box. This source directory labeled "src" is created as a subdirectory under the jbproject directory. This backup directory labeled "bak" is created as a subdirectory under the jbproject directory. The name of the directory where all generated files are stored. The default setting is that the project directory is parent to source and output directories. 5. Click and the second Project Wizard dialog box opens. You can modify any settings you made on the previous screen. We will not make any changes to this dialog box. You can also change the JDK version and add required libraries at this point in the wizard. We will use the default JDK version and will not use any libraries for this tutorial. -7-

11 6. Click and the third Project Wizard dialog box opens. All the information in this dialog box is optional so we will not fill in the text boxes. 7. Click and the Create New Diagram dialog box opens. -8-

12 8. Enter the name ClassDemo in the Name text box. Then click the drop down arrow in the Diagram Type. Select Class Diagram from the list and click. With Developer, only the Class and Sequence diagrams are available in the Diagram Type drop down menu. 9. The Diagram pane within the JBuilder main window opens. Notice that it is labeled ClassDemo. -9-

13 Once the diagram is created, note that the Class Methodology icons are now active in the JBuilder main window. When you create a project and diagram in JBuilder, a corresponding project and diagram are created and opened in. Project Properties By default, JBuilder creates a new system each time a new JBuilder project is created. If you want to link an existing JBuilder project to an existing system, you can do so under the PROJECT->PROJECT PROPERTIES->DESCRIBE TAB->SELECT SYSTEM pull down. -10-

14 Create a Class We are going to create a class with an attribute as the final step in this quick start tutorial. 1. Click the class icon in the JBuilder toolbar. 2. Click once in the Diagram Pane and a class notation is placed in the pane. 3. Once the class is in place, we will label it and give it one attribute. Click once on the <unnamed> label in the Class symbol and the ClassIdentifier pop-up editor opens. -11-

15 Name this class "ClassOne" in the ClassName text box and press the Enter key. 4. Next we will add a data member (attribute) to the new class. Click in the middle section of the ClassOne symbol and the "Attributes" pop-up dialog box appears. Enter the attribute name "verify" with a type of "int". Press Enter twice to close the pop-up editor. Notice the source code in the Source Pane updates to reflect your newly added attribute. You can also add methods (operations) using the same basic steps. Clicking the bottom section of the class and an Operations pop-up editor opens. Enter the method information in the appropriate text boxes and press Enter. -12-

16 5. Not only do changes to your design diagram update your code, try adding a new attribute in the Source pane directly and notice your model updates automatically. In the Source pane, on the line after the text "private int verify;" add a new attribute of type int named counter;. Notice as soon as you type the final statement ending semi-colon, ClassOne in your design diagram is also updated to reflect changes in your code. -13-

17 You can also use Property Editors to populate the class. Double-click on the class symbol and the Properties Editor for Class opens. Changes made to your class using the dialog will also be reflected in your source code. -14-

18 Creating a Web Report The Web Viewer Report is a reporting mechanism that allows you to generate a series of web pages containing key information about a system. The report contains information about classes, templates, utility classes, packages, and actors. 1. Choose DESCRIBE->WEB VIEWER. The Web Viewer wizard starts. Click the Next button to advance to the second screen. -15-

19 2. Select the system from the list box and click the Next button. The third wizard window opens. 3. Use this dialog box to select the directory for the output of the report. -16-

20 4. Click the located to the right of the text box and the Search for Folder dialog box opens. 5. Select the directory where you want to place the output for the generated diagram. Click OK, the dialog box closes and the selected directory appears in the path text box. 6. Click Next and a summary dialog box opens. -17-

21 7. Click and a Progress dialog box opens, tracking the progress of the diagram generation. 8. Click Done and the completed report opens. -18-

22 9. Close the Web Report by choosing FILE->CLOSE from the main menu. Exiting the Application 1. To finish this tutorial exit the JBuilder application by choosing FILE->EXIT. The Save Modified Files dialog box opens. The files you created in the tutorial are listed. 2. Select all the files listed in the dialog box and click. Both JBuilder and close. -19-