Chapter 5. JSF Configuration File Editor

First, we should mention that JSF configuration file ( faces-config.xml ) is intended for registering JSF application resources such as Converters, Validators, Managed Beans and page-to-page navigation rules.

Now, let's look at how you can easily configure this file by means of a special graphical editor for JSF configuration file. The editor has three main views:

Diagram
Tree
Source

They can be selected via the tabs at the bottom of the editor.

5.1. Diagram view

Here, we will show you how to work with JSF configuration file through the Diagram view of the editor.

As you can see on the figure below, the Diagram view displays the navigation rules in the faces-config.xml:

Figure 5.1. Diagram View

If your diagram is large, make use of the Outline view. Within it 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 5.2. Outline View for Diagram

To create a new page here, you should click the page icon (View Template) on the toolbar from the left and then click anywhere on the diagram. A New Page Wizard will appear.

To create a transition for connecting pages:

Select the transition icon from the toolbar (New Connection).
Click the source page.
Click the target page.

A transition will appear between the two pages:

Figure 5.3. Transition between JSP Pages

It is also possible to create a new page with context menu by right-clicking anywhere on the diagram and selecting Rule...

Figure 5.4. 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 5.5. Editing Transition between Views

5.2. Tree View

You can find it more convenient to edit your JSF Configuration file in the Tree view of the VPE.

The view displays all JSF application artifacts referenced in the configuration file in a tree format. By selecting any node on the left, you can see and edit its properties which will appear in the right-hand area. Let's look at the structure of this tree more closely.

Under the Application node you can adjust JSF application specific settings such as internationalization, possibility to set extensions, add property and variable resolvers, etc.

Figure 5.6. JSF Application Specific Settings

The Components node is for registering custom JSF components. Right-click and choose New > Component or just press the Add button in the right-hand area to add a new component to the JSF Configuration file.

Figure 5.7. Registering a New JSF Component

In the Add Component wizard you should set a component type and point to a component class by using the Browse button or create a new class for this component by using the Component-Class link.

Figure 5.8. Adding a New JSF Component to the JSF Configuration File

Use the Render Kit node to create and register a set of related renderers for custom JSF components.

Figure 5.9. Adding a New JSF Renderer Kit to the JSF Configuration File

Under the Converters node you can create a converter class for your JSF application either with id or for a proper class. How to do that see the Create and Register a Custom Converter section.

Figure 5.10. Creating a New Custom Converter

The Managed Bean node is meant for creating and registering Bean classes in your JSF application. Read more on the topic in the Managed Beans chapter.

Figure 5.11. Managed Beans

Use the Navigation Rules node to configure a navigation between the pages in your application: create a new navigation rule and adjust necessary properties for it in the right-hand area.

Tip:

The same you can do in the Diagram view of the JSF Configuration file editor.

Figure 5.12. Configuring Navigation Rules

Under the Referenced Beans node you can add a new Referenced Bean and configure various properties for it. To learn more on this refer to the Create and Register Referenced Beans section.

Figure 5.13. Referenced Beans

The Validators node is needed to create validator classes for organizing the validation of your application data. You can read more on the topic in the Create and Register a Custom Validator section.

Figure 5.14. Validators

The Extensions node is for setting extensions for your faces-config.xml.

Figure 5.15. Adding Extensions

In the Tree view you can also edit the properties of the selected element with the help of the Properties view as shown below:

Figure 5.16. Properties View

5.3. Source View

Here, we'll discuss how you can configure your faces-config.xml with the help of Source View.

The Source view for the editor displays a text content of the JSF configuration file. It is always synchronized with other two views, so any changes made in one of the views will immediately appear in the other:

Figure 5.17. Source View

You can also work in the Source view with the help of the Outline view. The Outline view shows 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 editor, so you can navigate through the source code with Outline view.