Visual Web Tools Reference Guide

JBoss Developer Studio provides the following when working with JSF:

JBoss Developer Studio allows you to create brand new JSF projects . A new JSF project will have all JSF libraries, tag libraries and a JSF configuration file.

JBoss Developer Studio comes with a number of predefined project templates. These templates are flexible and easily customizable.

To create a brand new JSF project, select File > New > Project > JBoos Tools Web > JSF > JSF Project and click Next :

Figure 2.10. Choosing a JSF Project

On this form enter Project Name. You can also select where to create the project.

JSF Version allows you to select which JSF implementation to use:

Figure 2.11. Creating a New JSF Project

You can also pick a different template on which to base the project. Almost all templates come in two variations: with jsf libraries and without ones. Some servers already provide jsf libs and you take risk of getting conflicting libraries while deploying your project. So the idea here is to avoid such conflicts. Select a template without libs if you use a server with its own jsf libraries.

Figure 2.12. JSF Templates

The JSFBlank template will create a standard Web project structure with all JSF capabilities.

The JSFKickStart template will create the same standard structure but will also include a sample application that is ready to run.

You can of course create your own custom templates. More information on templates creation could be found in Chapter 5.

Figure 2.13. Choosing JSF Template

On the next screen select what Servlet version to use and whether to register this application with JBoss AS (or other server) for running and testing of your application.

Context Path is the name under which the application will be deployed.

The Runtime value tells Eclipse where to find Web libraries in order to build (compile) the project. It is not possible to finish project creation without selecting Runtime. If you don't have any values, select New... to add new Runtime.

Target Server allows you specify whether to deploy the application. The Target Server corresponds to the Runtime value selected above.

If you don't want to deploy the application, uncheck this value:

Figure 2.14. Registering the Project on Server

When you are all done, you should have the project that has been created in the Package Explorer view:

Figure 2.15. A New Project in the Package Explorer

At this point you can open faces-config.xml and start working on your application.

For detailed information on migration projects to JBoss Developer Studio see Migration Guide.

With JBoss Developer Studio you can add JSF capability (JSF libraries, tag libraries) to any existing Eclipse project in your workspace.

By adding JSF capability to your project, you can now edit any file using JBoss Developer Studio editors, such as JSF configuration editor, JBoss Tools JSP editor and any others.

Right click the project and select JBoss Tools > Add JSF Capabilities . This will start the process of adding all necessary libraries, files to make this a Web JSF project:

Figure 2.16. Adding JSF Capabilities

The wizard will first show you the web.xml file location and the project name:

Figure 2.17. Project Location

On the last form you can set the different folders for your project as well as register this application with a servlet container.

Make sure to select Add JSF Libraries for JBoss Developer Studio to add all required JSF related libraries to this project.

Context Path is the name under which the application will be deployed.

The Runtime value tells Eclipse where to find Web libraries in order to build (compile) the project. It is not possible to finish project import without selecting Runtime. If you don't have any values, select New... to add new Runtime.

Target Server allows you specify whether to deploy the application. The Target Server corresponds to the Runtime value selected above.

If you don't want to deploy the application, uncheck this value:

Figure 2.18. Project Folders

Once your project is imported you can see that JSF related libraries have been added to your project jsf-api.jar and jsf-impl.jar.

You are now ready to work with JSF by creating a new JSF configuration file:

Figure 2.19. Creating a New JSF Configuration File

JBoss Developer Studio has a powerful templating capability for creating new and importing existing Struts and JSF projects. This templating facility has a variety of aspects to consider. But, let's start with the most straightforward case.

Let's say you have a project that you want to use as the basis for a new template. Follow these steps to make a template out of it:

Figure 2.20. Saving Your Project as Template

That's it. Now, you can use this template with any new or imported project that uses the same run-time implementation as the project you turned into a template.

The Diagram view displays the navigation rules in the JSF configuration file:

Figure 2.21. Diagram View

To create a new page (view), you can click the page icon on this toolbar and then click anywhere on the diagram. A New Page Wizard will appear.

To create a transition (rule) connecting pages:

A transition will appear between the two pages:

Figure 2.22. Transition Between JSP Pages

It is also possible to create a new page by right-clicking anywhere on the diagram and selecting New View .

Figure 2.23. Creating a New View

To edit an existing transition, first select the transition line. Then, place the mouse cursor over the last black dot (on the target page). The mouse cursor will change to a big +. At this point, drag the line to a new target page:

Figure 2.24. Editing Transition Between Views

The Tree mode for the editor displays all JSF application artifacts referenced in the configuration file in a tree format. Select any node and its properties will appear in the right-hand area:

Figure 2.25. Tree View

To edit, right-click any node and select one of the available actions in the context menu. You can also edit in the properties window to the right:

Figure 2.26. Editing in Tree View

The Source mode for the editor displays a text view of the JSF configuration file. All three viewers are always synchronized, so any changes made in one of the viewers will immediately appear in the others:

Figure 2.27. Source View

Content assist is always available in the Source viewer:

Figure 2.28. Content Assist in Source View

Errors will be reported by JBoss Developer Studio's verification facility:

Figure 2.29. Error Reporting in Source View

Other errors are also reported.

Figure 2.30. Others Errors Reporting

You can also work in the Source viewer with the help of the Outline view . The Outline views show a tree structure of the JSF configuration file. Simply select any element in the Outline view, and it will jump to the same place in the Source viewer.

Figure 2.31. Outline View

If your diagram is large, within Outline view you can switch to a Diagram Navigator mode by selecting the middle icon at the top of the view window. It allows you to easily move around the diagram. Just move the blue area in any direction, and the diagram on the left will also move:

Figure 2.32. Outline View for Diagram

You can also edit in the Tree viewer with the help of the Properties view as shown below:

Figure 2.33. Properties View

JBoss Developer Studio gives you lots of power to work with managed beans.

To start, create a new managed bean in JSF configuration file editor, in the Tree view.

Figure 2.34. Creation of New Managed Bean

When you define a new managed bean, make sure that Generate Source Code is checked as shown in the figure below:

Figure 2.35. New Managed Bean

After the "Java" class has been generated you can open it for additional editing. There are two ways to open the "Java" class:

Figure 2.36. Opening of Created Managed Bean

The generated Java source:

Figure 2.37. Java Source Code

You can also generate source code for properties - this also includes "getter" and "setter" methods:

Figure 2.38. Generation of Source Code for Properties

Make sure that all the check boxes are selected:

Figure 2.39. "Add Property" Form

Once the generation is complete, you can open the file and see the added property with "getter" and "setter" methods:

Figure 2.40. Generated Java Source Code for Property

If you already have a Java bean you can easily add it to a JSF configuration file.

You should start the same way you create a new managed bean. Use Browse... to add your existing Java class.

Figure 2.41. New Managed Bean Form

Once the class is set, it's Name will be set as well. But you can easily substitute it for the other one. Notice that Generate Source Code option is not available as the "Java" class already exists.

After adding your class Next button will be activated. Pressing it you'll get Managed Properties dialog where all corresponding properties are displayed. Check the necessary ones to add them into your JSF Configuration File.

If you don't want to add any, just click Finish .

Figure 2.42. Selection of Bean's Properties.

JBoss Developer Studio provides the following when working with Struts.

JBoss Developer Studio includes a New Struts Project Wizard that radically simplifies the process for getting started with a new Struts project. You just need to follow these 4 steps:

Figure 3.2. Selecting Struts Wizard

Figure 3.3. Creating Struts Project

Figure 3.4. Registering The Project at Server

Figure 3.5. Selecting Tag Libraries

After the project is created, you should have the following project structure (if you used the KickStart template):

Figure 3.6. Project Structure

For detailed information on migration projects to JBoss Developer Studio see Migration Guide.

With JBoss Developer Studio you can add Struts capabilities (including Struts libraries, tag libraries and a Struts configuration file) to any existing Web application project in your Eclipse workspace. By adding a Struts Nature to your project, you can now edit files using JBoss Developer Studio editors, such as the Struts configuration editor and the JBoss Tools JSP editor.

Right-click the project and select JBoss Tools > Add Struts Capabilities from the context menu. This will start the process of adding all necessary libraries and files to make this a Web JSF project.

Figure 3.7. Adding Struts Capabilities

The wizard will first show you the web.xml file location and the project name.

Figure 3.8. Choosing Project Location

After hitting Next, you will see the following screen. This screen simply means that you need to add at least one Struts module to your project to make this project a Struts project. Adding a Struts module means that a new struts-config.xml will be added to your project and registered in the web.xml file. In addition, all required Struts libraries will be added. To add a Struts module, select the Add Struts Support button.

Figure 3.9. Project Modules

Here you can select what Struts version, Servlet class, URL pattern and TLDs to add to this project.

Figure 3.10. Selecting Struts Support Options

When done, you will see the default Struts module configuration information. See how to Edit Struts modules.

Figure 3.11. Project Configuration Information

On the last screen you can set the different folders for your project as well as register this application with a servlet container.

Figure 3.12. Registering the Project at Server

When done, you can open the struts-config.xml file. (The Struts configuration is shown below in the Tree viewer).

Figure 3.13. Struts-config.xml File

The Diagram mode graphically displays the Web flow of the application defined in the Struts configuration file.

Figure 3.14. Diagram Mode

Just by right-clicking anywhere on the diagram, you can use a context menu to create the building blocks of a Struts application:

Figure 3.15. Diagram Context Menu

Along the upper-left side of the editor is a stack of seven icons for changing the behavior of the cursor in the diagram. The first icon switches to the default regular selection cursor, the second to the marquee selection cursor and the third to the new connection cursor. The last four icons switch the cursor to an insert cursor for each type of Struts build block listed above (and in the order listed).

For instance, clicking on the first of these four icons (the one with the gears) will switch the cursor to insert actions. Clicking anywhere in the diagram with this cursor has the same effect as right-click and selecting Add > Action... from the context menu with the regular cursor active. It's just more efficient to use this cursor if you're adding more than one action at once.

Figure 3.16. Insert Actions Cursor

In the Tree mode, the different elements of the Struts application are organized into functional categories on the left-hand side and a form for editing the properties of currently selected items on the right-hand side.

Figure 3.17. Tree Mode

You can also right-click on any node in the category tree and perform appropriate operations through a context menu. For instance, by right-clicking on the action-mappings category node, you can add new actions to the application.

Figure 3.18. Tree Context Menu

In the Source mode, you have complete editing control of the underlying XML coding:

Figure 3.19. Source Mode

You can take advantage of code assist:

Figure 3.20. Code Assist

The editor will also immediately flag any errors:

Figure 3.21. Errors in Source Mode

Finally, you can use the Outline view with the editor to easily navigate through the file:

Figure 3.22. Outline View

To create a new Tiles files, right click any folder and select New > Tiles File.

Figure 3.23. Creating a New Tiles File

In the Tree mode, the different elements of the Tiles file are organized into functional categories on the left-hand side and a form for editing the properties of currently selected items on the right-hand side.

Figure 3.24. Tree View

To edit the file, simply right click any node and select among the available actions:

Figure 3.25. Editing in Tiles Editor

The Diagram mode is shown below:

Figure 3.26. Diagram Mode

To create new definitions, simply right click anywhere in the diagram:

Figure 3.27. Creating New Definition

You can also use the Diagram toolbar to make editing easier:

Figure 3.28. Diagram Toolbar

The Tiles editor also comes with a Source view that gives you full control over the source. Any changes here will immediately appear in other viewers when you switch to them.

Figure 3.29. Source View

Content assist is available in the Source mode:

Figure 3.30. Content Assist in Source Mode

Any errors are immediately reported as shown below:

Figure 3.31. Errors Reporting

You can also use the Outline view together with the editor's Source mode. Selecting any node in the Outline view will jump to that place in the source.

Figure 3.32. Outline View

JBoss Developer Studio supports working with Struts projects that have multiple modules. You can easily do the following:

During Struts project import, if the project has multiple modules, you will see a screen with all existing modules. You can select each module and edit its details.

Figure 3.40. Configuring Project Modules

To edit modules in an existing project, right click the project and select JBoss Tools > Modules Configuration.

Figure 3.41. Choosing Modules Configuration

You will see the same screen as above where you will be able to select a module and edit its details:

Figure 3.42. Modules Configuration

Adding a new module is very simple. First switch to Web Project view. Expand your project to the Configuration folder. Under that folder you should see the current modules. Right click on Configuration and select New > Struts Config.

Figure 3.43. Adding New Modules

You will see the screen below. You can specify a new module name and also add the new Struts configuration file to web.xml file.

Figure 3.44. Adding New Modules

In the Palette Editor window(Figure 5.1. "Palette Editor") we can see that every group contains its own subgroups. For example, JSF includes Core, Facelets, HTML. So, in the Palette every group has the next view: <Group name> <Subgroup name>.

Figure 4.2. JBoss Tools Palette

By default the Palette is represented in Web Development Perspective with four groups(Figure 5.2. "JBoss Tools Palette"). If you can't see it, select Window > Show View Other... > JBoos Tools Web > JBoss Tools Palette from the menu bar.

By using Show/Hide button you can add any predefined group of tag libraries. It's also possible to create your own group.

A new tag can be added into any text file including jsp, xhtml и htm(l).

It's very simple to do this. Place the cursor in the JSP page where you want to add a tag and then click the tag in the palette. In the example below, the commandButton tag has been inserted. Notice also that if you place the cursor over any tag, a balloon tip is shown with all the "tag" attributes.

Figure 4.3. Inserting Tag

The cursor position after adding a tag into a file is specified by "|" symbol in the tag template on the right in the Palette Editor window.

Figure 4.4. Palette Editor

Above you can see where the cursor position for HTML/Form/input is set. So, after adding this tag into your file the cursor will be in the attribute "type". Then, you can straight use the combination of buttons Ctrl + Space to inquire about a prompting.

Figure 4.5. Cursor position

There are two ways to add any custom or 3rd party tag library to the JBoss Tools Palette:

Before you can add your custom component library, you need to make sure it is included in your project. Either place the ".tld" file or the ".jar" that includes your tag library under the lib folder in your project.

Switch to the Web Projects view and expand the Tag Libraries folder. If the view not active, select Window > Show View > Web Projects from the menu bar.

Figure 4.6. Web Projects View

Also make sure that the JBoss Tools Palette is open. Select the tag library that you want to add and simply drag-and-drop it on to the JBoss Tools Palette.

You will see the following dialog window. As you can see JBoss Developer Studio takes care of all the details. You just need to set the Group name to which to add this tag library. You can either add this tag library to an existing Group or just create a new one.

Figure 4.7. Import Tags From TLD File Form

Once you are finished, you will see the new tag library added to the JBoss Tools Palette.

Figure 4.8. JBoss Tools Palette with New Tag Library

The same you can do with Import button.

Figure 4.9. Import Button

On this screen you can select Browse to locate the tag library that you want to add.

Figure 4.10. Import Tags From TLD File Form

Now select the TLD file you want to be added:

Figure 4.11. Select TLD File

To edit the Pallete view use Edit button. The Palette Editor provides following possibilities: