Create new JBDS Documentation Jira issue

This will launch the JBDS Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.comEnterprise Documentation

Visual Web Tools Reference Guide

Version: 3.0.0.GA


1. Visual Web Tools
1.1. Key Features of Visual Web Tools
1.2. Other relevant resources on the topic
2. Spring Tools
2.1. Spring IDE guide
2.1.1. Add Spring Project Nature
2.1.2. Create New Spring Project
2.1.3. Add References To Other Spring Projects
2.1.4. Add Spring Beans Config Files
2.1.5. Create Spring Beans Config Sets
2.1.6. Open Spring Explorer
2.1.7. Validate Spring Beans Config
2.1.8. Open Spring Beans Graph
2.1.9. Search Spring Beans
3. Editors
3.1. Editors Features
3.1.1. OpenOn
3.1.2. Content Assist
3.1.3. Synchronized Source and Visual Editing
3.2. Visual Page Editor
3.2.1. Visual/Source View
3.2.2. Pages Styling
3.2.3. Templating
3.2.4. VPE Toolbar
3.2.5. Page Preview
3.2.6. Support for Custom Facelets Components
3.2.7. Setup notes for Linux
3.3. More Editors
3.3.1. Graphical Properties Editor
3.3.2. Graphical TLD Editor
3.3.3. Graphical Web Application File (web.xml) Editor
3.3.4. CSS Editor
3.3.5. JavaScript Editor
3.3.6. XSD Editor
3.3.7. Support for XML Schema
4. JBoss Tools Palette
4.1. Palette Options
4.1.1. Palette Editor
4.1.2. Show/Hide
4.1.3. Import
4.2. Using the Palette
4.2.1. Inserting Tags into a JSP File
4.2.2. Adding Custom JSF Tags to the JBoss Tools Palette
5. CSS Editing Perspective
5.1. Outline view
5.2. Properties view
5.3. CSS Properties view
5.4. CSS Preview
6. RichFaces Support
6.1. Code Assist for RichFaces
6.2. OpenOn for RichFaces
6.3. RichFaces in the JBoss Tools Palette
6.4. Relevant Resources Links
7. Web Projects View
7.1. Project Organization
7.2. Drag and Drop
7.2.1. For a Property
7.2.2. For Managed Bean Attributes
7.2.3. Navigation Rules
7.2.4. For a Tag Library File Declaration
7.2.5. For JSP Pages
7.3. Developing the Application
7.4. Expanding Tag Library Files
7.5. Drag and Drop Tag Libraries on to JBoss Tools Palette
7.6. Create and Import JSF and Struts Projects
8. JBoss Tools Preferences
8.1. Packaging Archives
8.2. Editors
8.3. Visual Page Editor
8.4. El Variables
8.5. JSF
8.6. JSF Pages
8.7. JSF Project
8.8. JSF Validator
8.9. JSF Flow Diagram
8.10. Label Decorations
8.11. Seam
8.12. Seam Validator
8.13. Seam Pages Diagram
8.14. Struts
8.15. Struts Automation
8.16. Plug-in Insets
8.17. Resource Insets
8.18. Struts Customization
8.19. Struts Project
8.20. Struts Support
8.21. Struts Pages
8.22. Struts Flow Diagram
8.23. Tiles Diagram
8.24. Verification
8.25. Server Preferences
8.26. XDoclet
9. Context Menu Preferences and Options
9.1. Add/Remove Struts Capabilities
9.2. Add/Remove JSF Capabilities
9.3. Add Custom Capabilities
10. FAQ
10.1. What should I do if Visual Page Editor does not start under Linux?
10.2. How do I change the auto-formating preferences for the Visual Page Editor?
11. Conclusion

This guide covers the usage of Visual Web Tools in JBoss Developer Studio and JBoss Tools. The difference between these products is that JBoss Tools are just a set of Eclipse plugins where JBoss Developer Studio adds the following functionality:

  • an installer

  • Eclipse and Web Tools preconfigured

  • JBoss EAP with JBoss AS and Seam preconfigured

  • 3rd party plugins bundled and configured

  • access to RHEL and Red Hat Network

  • access to the JBoss/Red Hat supported software

For additional information, please visit the JBoss Developer Studio home page at: http://www.jboss.com/products/devstudio.

In JBoss Tools there is an extensive collection of specialized wizards, editors and views that can be used in various scenarios while developing Web applications. The following chapters walk through these features.

Here is the table of the main features of Visual Web Tools:

Table 1.1. Key Functionality for Visual Web Tools

FeatureBenefitChapter
Visual Page EditorPowerful and customizable visual page editor. Possibility to develop an application using any web technology: jsf, seam, struts, jsp, html and others. Developing using four tabs: visual/source, visual, source and preview. Fast and easy switching between these tabs. Split screen design of visual and source views. Full and instant synchronization between source and visual views. Integration with properties and outline views. Graphical toolbar to add inline styling to any tag. visual page editor
Multiple EditorsAn extensive collection of specialized editors for different file types: properties, TLD, web.xml, tiles, and so on: Graphical Properties Editor, Graphical TLD Editor, Graphical Web Application File (web.xml) Editor, CSS Editor, JavaScript Editor, XSD Editor, Support for XML Schema. more editors
JBoss Tools PaletteOrganizing various tags by groups, inserting tags into a jsp or xhtml page with one click, adding custom or 3rd party tag libraries into the palette, easy controlling the number of tag groups shown on the palette. jboss tools palette
Web Projects ViewVisualizing and displaying projects by function. Easy selecting of different kinds of items and dropping them into jsp pages. Using context menus to develop the application. Using icon shortcuts to create and import JSF and Struts projects. Expanding and inspecting tag library files. Selecting custom and third-party tag libraries to drag and drop onto the JBoss Tools Palette. web projects view
OpenOnEasy navigation between views and other parts of your projects. openOn
Content AssistCode completion proposals while working with html, java, JavaScript , xml, jsp, xhtml, xhtml, seam project and jsf configuration files. Content assist based on project data (dynamic code assist); with graphical editor. Code completion for values from property files, beans attributes and methods, navigation rule outcomes and jsf variables. content assist
Drag-and-DropPossibility of inserting any tag onto the page you are editing by just drag-and-droping it from the palette to this page. Adding any properties, managed bean attributes, navigation rules, tag library file declarations, jsp files from web projects view by clicking them and dragging to source code. visual page editor drag-and-drop
RichFaces SupportTight integration between JBDS and RichFaces frameworks. Easy managing RichFaces components in any web application. Support for RichFaces and Ajax4jsf libraries in JBoss Tools Palette. Rendering RichFaces components in Visual Page Editor. RichFaces support
Flexible ConfigurationVarious features of JBoss Developer Studio can be easily configured via the Preferences screen. preferences

JBoss Developer Studio is bundled with Spring IDE for Eclipse. Visit Spring IDE site for the latest versions and documentation.

In the JSF Tools Reference Guide and Struts Tools Reference Guide you had possibility to read about Graphical Editor for JSF and Struts configuration files, Graphical Editor for Tiles Files, Graphical Editor for Struts Validation Files. All these editors have OpenOn and Content Assist features, which are described in more details in this document. In addition you get to know a Visual Page Editor for combined visual and source editing of Web pages and many other editors for different types of files.

JBoss Developer Studio has powerful editor features that help you easily navigate within your application and make use of content and code assist no matter what project file (.jsp, .xhtml, .xml, .css, etc.) you are working on.

The mentioned features are the following:

OpenOn lets you easily link directly from one resource to another in your project without using the Package Explorer view (project tree). With OpenOn, you can simply use F3 or Ctrl+Click on a reference to another file and the file will be opened.

OpenOn is available for:

Content assist is available when working with

Notice, that code completion for EL variables has icons illustrating what they are from. Currently it's performed for resource bundles, JSF and Seam components.



Also, as you can see, the ranking and sorting are available in EL code completions.

When working with JSF project in JBoss Developer Studio, you can use various Content Assist features while developing:

Here is what you need to do to add project based code assist to a custom component added in JBoss Developer Studio 2.X:

Follow these steps to set what is available for code assist:


<AttributeType ...>
       <proposal type="jsfVariables"/>
</AttributeType>

<AttributeType ...>
       <proposal type="bundleProperty"/>
</AttributeType>

<AttributeType ...>
       <proposal type="beanProperty"/>
</AttributeType>

<AttributeType ...>
       <proposal type="beanProperty">
          <param name="type" value="java.lang.Boolean"/>
       </proposal>
</AttributeType>

<AttributeType ...>
       <proposal type="beanMethodBySignature">
          <param name="paramType" value="javax.faces.context.FacesContext"/>
          <param name="paramType" value="javax.faces.component.UIComponent"/>
          <param name="paramType" value="java.lang.Object"/>
          <param name="returnType" value="void"/>
       </proposal>
</AttributeType>

From JBoss Developer Studio 3.0.0.M1 you should not do any of the steps described before,dynamic code assist to custom components is added automatically.

If you open projects that were created in older studio versions such message could appear:


It shows that some features of content assist including this one probably will not work. To fix this problem and turn off the message box execute the following steps:

  • Right click the project in Package Explorer.

  • Select Configure -> Add JSF Capabilities from the context menu.

  • Configure your project using Add JSF Capabilities wizard and press Finish

JBoss Developer Studio comes with a powerful and customizable Visual Page Editor (VPE). You can use the Visual Page Editor to develop an application using any technology: JSF, Struts, JSP, HTML and others. Double-click on the necessary file in the Package Explorer view to open it in the Visual Editor or just drag-and-drop it into perspective (the drag-and-drop feature can be also applied to JSP, XHTML or HTML files created locally).

As a new JSF 2.0 specification has been released, support of new features is now implemented in the Visual Page Editor. The JSF 2.0 tags like <h:body>, <h:head>, <h:outputscript>, <h:outputstyle> are supported in the editor as well as the composite components and the resource handling from the expression language. (See the following link on how to use composite components and following blog post on how to handle the resources form the EL).

Current VPE version has three tabs: Visual/Source, Source and Preview. To switch between the views you can use tabs at the bottom of the VPE or the shortcuts Ctrl + PageUp/Ctrl + PageDown .


Using the Visual/Source view you can edit your pages in the Source and Visual modes simultaneously having an instant synchronization between them:


The view is designed in the form of a split pane with toggle buttons for quickly moving between Source, Visual or Source/Visual modes as shown on the figure above.

One more way to toggle between the various states of the split pane is using the shortcuts Shift + F6 for maximizing/restoring the Source part and Shift + Alt + F6 for maximizing/restoring the Visual part.

Tip:

When editing large documents hiding the Visual part will speed up the editing.

It should be pointed out that, no matter in what mode you are working, you get a full integration with Properties and Outline views:


The Outline view displays a specific outline of a structured file that is currently open in the editor area, and lists its structural elements. Right-click on the elements will open additional options that allow adding other specific elements in necessary positions.

The Properties view shows property names and their values for a selected item. The values are editable, just select any and click on the button that appeared to choose a new value. Key combination Ctrl+Z will return the previous value, Ctrl+Y will return the new value again. The Properties view has additional options and can be set up to display categories and advanced properties.

It's also possible to use the JBoss Tools Palette to insert any tag from the list of tag libraries to the page you are editing with just a click or drag-and-drop.


You can insert a tag/component from the palette into either the Source or the Visual part by calling a context menu and selecting Insert around, Insert before, Insert after or Replace With, pointing to From Palette, picking the type of the tag and finally choosing the tag you want to insert.

The image below illustrates how you can insert a tag into the Source part.


And this is how a tag is inserted using a context menu in the Visual part.


Visual Page Editor also displays custom tags correctly if they are configured properly. The picture below shows an example how custom tags "pagination" and "echo" will be displayed in VPE.


The listings of the custom tags implementations will help to clear how VPE works.

  • echo.xhtml:

    
    
    <ui:composition xmlns:ui="http://java.sun.com/jsf/facelets">
        <span class="message">#{msg}</span>
    </ui:composition>
  • paginator.xhtml:

    
    
                            <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    <html xmlns="http://www.w3.org/1999/xhtml"
        xmlns:ui="http://java.sun.com/jsf/facelets"
        xmlns:h="http://java.sun.com/jsf/html"
        xmlns:f="http://java.sun.com/jsf/core">
    <ui:component>
    <!-- h:inputHidden id="currentPage" replace, because if on page two fields,
    two elements with equal id has been used, but should be used only one -->
        <h:panelGrid style="margin-right:auto;margin-left:auto;" columns="4">
            <h:commandButton value="&lt;&lt;" type="submit" 
            onclick="document.getElementById('currentPage').value=0" >
            </h:commandButton>
            <h:commandButton value="&lt;" type="submit" 
            onclick="document.getElementById('currentPage').value=#{user.currentPage-user.rowsPerPage}">
            </h:commandButton>
            <h:commandButton value="&gt;" type="submit" 
            onclick="document.getElementById('currentPage').value=#{user.currentPage+user.rowsPerPage}">
            </h:commandButton>
            <h:commandButton value="&gt;&gt;" type="submit" 
            onclick="document.getElementById('currentPage').value=#{user.numberOfItems - user.rowsPerPage}">
            </h:commandButton>
        </h:panelGrid>
        <h:inputHidden id="currentPage" value=""/>
    </ui:component>
    </html>

If your custom tags aren't configured correctly your Visual mode will look like this:


Most web pages use the cascading style sheets (CSS) to control the way they look. With Visual Page Editor you can easily stylise your pages. In this section we are going to introduce you to a powerful mechanism that VPE provides for a complete control over pages styling. More helpful information on wok with CSS files can be found in CSS Perspective chapter

The pages you are working with in VPE can use external stylesheets. VPE allows you to create new style classes in existing stylesheets and/or edit them as well. For these purposes Edit Style Class Dialog is provided.

Select the element for which you need to create or edit style class and press button next to styleClass field in Properties view.


It'll pick up the Edit Style Class Dialog which looks like on the figure below:


Choose a style class from the variants provided and click on the Ok button to apply the changes.

To open a CSS dialog based on the active CSS file click on in the top panel or use hot-keys (Shift+Ctrl+C).

To create a new CSS class for the file click on the Add CSS Class button, write its name in the field appeared and click on the Ok button:


Then you can configure style settings switching between the tabs: Text/Font, Background, Boxes, Property Sheet. The list of already existing classes with names beginning with the symbols printed will be displayed on standard "Ctrl+Space" key combination. To add existing styling to the chosen element just point to the necessary one. Each time you select any class it is displayed in the Preview tab. Click on the Apply button will apply the changes without closing the window.


The Edited properties tab gives a preview of the properties which are set for the existing style class. You can easily modify them with the help of this wizard.


If the style class isn't chosen, the tab doesn't show any properties.


The Preview tab is for observing the content of the chosen CSS file. This tab is hidden if no CSS file is chosen.


At the top of the CSS Class Dialog you can see a preview box which visualizes the result. To edit the preview you should double click in the box. To leave the focus, use Ctrl + Tab.


The dialog for creating a new CSS class, which is called from New > Other... > JBoss Tools Web > CSS Class, looks this way:


Click on the Browse button to open a dialog to select the CSS file to create a CSS class for:


Choose the necessary CSS file and click on the Ok button.

The Visual Page Editor toolbar includes the next buttons:


The Page Design Options button ( ) leads to a window which helps you specify necessary references of the resources. It is represented by a window with 4 tabs. The first one, Actual Run-Time folders, is used to replace absolute and relative path values when generating a preview:


The second tab, Included CSS files , is used to add CSS files to be linked by Visual Page Editor when generating a preview:


The third one, Included tag libs, can be used to add Taglibs that can be used by the editor for getting appropriate templates to generate a preview:


And finally, the Substituted El expressions tab is used to add El expressions that will be substituted by the editor when generating a preview:


The first two tabs of the window let you define actual runtime folders. The example below will help you understand how this can be done.

Suppose you have the following project structure:


WebContent/
  pages/
    img/
       a.gif
    header.jsp
  main.jsp
  

The content of the header.jsp is:


My Header
<img src="img/a.gif"/>

and main.jsp content is:


<jsp:include page="pages/header.jsp" />

When you open main.jsp in Visual Page Editor, it will not be able to resolve the image from the header, however, it will work fine in runtime. To fix this in design time, click the Page Design Options button and set Actual Run-Time Relative Folder to 'projectName > WebContent > pages' and you will see the image appeared.

Let' consider an example for other tabs. For instance, the definition of your CSS on the page is the next:


<link rel="stylesheet" type="text/css"  
    href="#{facesContext.externalContext.requestContextPath}/style.css"/>

This will work fine in runtime, but the Visual Page Editor doesn't know what requestContextPath in design time is. In order to see the necessary styles applied in design time your should add a path to your stylesheet in the CSS File Path section.

The next URI section lets you add URI taglibs so that the editor knows where to find the tag libraries.

And the last Substituted EL expressions section is provided to specify the values for specific EL variables. It can be useful for a preview generation.

As an example look at the figure below:


Here bath in Source and Visual modes you see the EL expression #{user.name}. When you switch to Preview view, you'll also see this expression. Now press Page Design Options button and set the value for the "user.name" as World.


As a result in Visual mode and Preview view the word World is displayed.


Visual Page Editor (starting from 3.0.0.M3 version of JBoss Tools) supports custom Facelets tag libraries both declared in the web.xml file (for details, see Creating a component) and packed into the JAR file.

Tip:

In case of Facelets tag library packed in .jar, remember to put *.taglib.xml in right place: [filename].jar/META-INF/*.taglib.xml

Visual Page Editor recognizes the tags from the custom Facelets tag library and correctly renders them both in source and visual view of the editor.


While editing an XHTML file that uses a custom Facelets components you can always make use of the following editor's features:

Linux users who are going to use earlier then JBoss Tools 3.1.0.M4 versions may need to do the following to get the Visual Page Editor to work correctly on their machines.

The Visual Page Editor requires the library libstdc++.so.5. This library is contained in the compat-libstdc++-33.i386 package.

In case you have the library installed and you still have issue with starting the visual page editor then close all browser views/editors and leave one visual page editor open and restart eclipse. This should force a load of the right XULRunner viewer.

If it doesn't help and you use Fedora Core Linux and Eclipse Version: 3.4.1,the issue can be produced because libswt-xulrunner-gtk-3449.so file doesn't present in eclipse-swt-3.4.1-5.fc10.x86_64.rpm/eclipse/plugins/org.eclipse.swt.gtk.linux.x86_64_3.4.1.v3449c.jar.To add this file to eclipse you should:

Besides Visual Page Editor JBDS is supplied with a huge range of various editors for different file types: properties, TLD, web.xml, tiles, and so on.

This chapter will introduce you to the functionality provided by JBoss Tools Palette. The Palette allows you to quickly and easily create your JSP or JSF pages. Now you can do it more faster without additional knowledge.

The JBoss Tools Palette allows you to:

  • Insert tags into a JSP or JSF page with one click

  • Add custom and 3rd party tags

The JBoss Tools Palette contains a developer's project tag libraries and provides possibility to add any tag libraries to it. Also you can choose a necessary one from the list of already existed tag libraries:

  • HTML

  • JBoss

  • JSF

  • JSTL

  • MyFaces

  • Oracle ADF Faces

  • Struts

  • XHTML


By default JBoss Tools Palette is not displayed. If you want to use it select Window > Show View Other... > JBoss Tools Web > JBoss Tools Palette from the menu bar.

The standard Eclipse Palette is displayed by default in both Web Development and Seam perspectives. Now, the standard Eclipse Palette is featured with all JBoss Tools Palette options and capabilities.

To open the standard Eclipse Palette navigate to Window->Show View->Others->General->Palette.

The differences between the two palettes are as follows:

  • The standard Eclipse Palette is blank by default; the content of the palette is available only if Visual Page Editor is open and active, while JBoss Tools Palette always contains a predefined set of components.

  • The Expanded/Collapsed state of components in the standard Eclipse Palette is not global as in JBoss Tools Palette: the state is associated with an instance of Visual Page Editor. It means that the state can be different for various files, and each new file opened in Visual Page Editor will have the default state of Palette with all components collapsed.

To facilitate your work, you can configure the Palette in your own way, by selecting the corresponding icon on the Palette toolbar.

There is a possibility to configure the JBoss Tools Palette:


JBoss Tools Palette contains existing libraries of tags, thus the Palette editor is intended to work with them or create your new one, as well.

To open the editor, click on the Palette Editor icon().

The window has two parts. There is a reflected grouped list of components on the left side of the palette editor. Each group is divided into multiple groups, every of which is a tag library. The right side of the palette editor is an editing window where it's possible to change values of group or tag library attributes that you've chosen on the left part of the window.

It can also be done by right click and using Edit… option.

For example, JSF group consists of Core, Facelets, HTML tag libraries and the attributes as name, description and hidden which are available for editing:


The Palette Editor provides the following possibilities when working with existing tags or icons:

If you have changed any abject in the tree view and you don't like the final result you can always use the Restore Defaults button. Click on it will restore defaults for the object selected and for its children elements. Please remember that the button will only restore data for objects defined in the default palette. If selected object is created by you, the button will be disabled. Child objects added by you will not be removed.

When updating JBoss Tools the palette content is not updated.

There are two ways to add any custom (including custom Facelets libraries) or 3rd party tag library to the JBoss Tools Palette:

Before you add your custom component library, you need to make sure it is included in your project. You need to either place the ".tld" file or the ".jar" that includes your tag library under the lib folder in your project. Or you can just add ".tld" or ".jar" file to the classpath , and the library will be added to the Tag Library List in Web Projects View.

The same you can do with Import button().You can see this button at the top right side of the JBoss Tools Palette.

By clicking on the Import button you will see the Import Tag window a similar like in the Drag-and-Drop method. Set the name and prefix of the library and Library URL. Also you need to set the Group name to which you'd like to add your tag library. And like in the previous method you can add it to an existing Group or create a new one. On this Import Tag form you can use Browse... button to locate the tag library that you want to add:


In this chapter we will discuss CSS Editing Perspective views, more information about style sheets can be found in Page Styling section of Editor chapter

The CSS Editing Perspective combines a set of views which allow you to see the structure of your css files,edit them and see the results. To use this perspective you need to choose Window >Open Perspective> CSS Editing .All of the views are fully synchronized with each other:the changes being made in one view are reflected in othes at once.

As you know, there are three ways of inserting a style sheet:

  • External style sheet (.css file)

  • Internal style sheet (using the <style> tag in the head section of an HTML/XHTML/JSP page)

  • Inline style (using style attribute)

Using CSS Editing Perspective you can change your style sheet, inserted in any of the possible places described before, in three ways:


CSS Properties view has five tabs:

JBoss Developer Studio comes with a tight integration with RichFaces component framework.

Note:

RichFaces 3.3.X is fully supported in the current version of JBoss Developer Studio (i. e. 2.1.0.GA) and JBoss Tools 3.0.1.GA.

The following features are implemented and fully supported for the current version of the RichFaces components:

All you have to do is to download and install RichFaces libraries into your project, i. e. just put richfaces-*.jar files into the /lib project folder. Also how to get started with RichFaces you can find in RichFaces documentation.

To get more in-depth information on RichFaces framework refer to RichFaces Developer Guide.

It may be also helpful for you to look through the movies where there are ones that demonstrate the usage of RichFaces components.

Web Projects is a special view that comes with JBoss Developer Studio.

If the Web Projects view's tab is not visible next to the Package Explorer tab, select Window > Show View > Other > JBoss Tools Web > Web Projects from the menu bar.

With the Web Projects view, you can:

  • Visualize the project better because the project artifacts for JSF, Struts and Seam projects are organized and displayed by function.

  • Select these kinds of items to drag and drop into JSP pages:

    • JSF managed bean attributes

    • JSF navigation rules outcomes

    • Property file values

    • Tag library files

    • Tags from tag libraries

    • JSP page links

  • Use context menus to develop the application (all create and edit functions are available)

  • Use icon shortcuts to create and import JSF and Struts projects

  • Expand and inspect tag library files

  • Select custom and third-party tag libraries to drag and drop onto the JBoss Tools Palette

Web Projects View has a drag and drop option that can be used for property, managed bean attributes, navigation rules, tag library file declaration and JSP Pages.

Configuring the various JBoss Developer Studio features is done via the Preferences screen by selecting Window > Preferences > JBoss Tools from the menu bar.


From this screen, you can select these more specific sets of JBoss Tools preferences:

The Preferences dialog ( Window > Preferences) also allows to adjust settings for JBoss Server and XDoclet module.

JBoss Tools > Web > Editors > Visual Page Editor screen allows you to control some aspects of the behavior of the Visual Page Editor (VPE) for JSF/HTML files.


The next table lists the possible settings that you can adjust on the General tab of the VPE Preferences page.

Table 8.3. VPE Preferences

OptionDescriptionDefault
Show border for unknown tagsThe option allows to place the border around unknown tags or undo thisOn
Show non-visual tagsCheck this box, if you want the editor shows non-visual elements on the page you're editingOff
Show selection tag barThe option allows to show/hide the Selection BarOn
Show text formatting barCheck this box in order to show/hide the Text Formatting barOn
Show resource bundles usage as EL expressionsIf the option is checked, the editor will show EL expressions instead of the resource valuesOff
Ask for tag attributes during tag insert Having this option off, the dialog with possible attributes for inserting tag won't appear if all its attributes are optionalOn
Ask for confirmation when closing the Selection BarCheck this box if you don't want the confirmation window appears when closing the Selection BarOn
Select the default active editor's tabThe option provides possibility to choose one of the following views - Visual/Source, Source or Preview, as default when opening the editorVisual/Source
Visual/Source editors splittingThe option allows to choose one of the following Visual,Source layouts - Vertical Source on top, Vertical Visual on top,Horizontal Source to the left or Horizontal Visual to the left, as a default one when opening the Visual/Source viewVertical splitting with Source Editor on the top
Size of the Visual Editor pane (0 – 100%)With the help of this scroll bar you can adjust the percentage rating between the Source and Visual modes of the Visual/Source view50%

On the Templates tab you can edit or remove VPE templates.


Select a template for editing from the available list and press Edit button. It will pick up the Template dialog where you can adjust new settings.

Select JBoss Tools > Web > JSF > Project to see JSF Project preferences page.

On the New Project tab you can set default values for New JSF Project wizard:

  • Version for setting the default JSF Environment

  • Project Template so as New JSF Project wizard shows this template as default for the chosen JSF Environment

  • Project Root for specifying default location for a new JSF project

    If you check Use Default Path here, this box will be also checked in the New JSF Project wizard.

  • Servlet Version for setting the default Servlet version of a new JSF project

    Here it's also possible to define whether to register Web Context in server.xml while organizing a new project or not. Check the proper box in order to do that.


On the Import Project tab in the JSF Project screen you can determine the default Servlet version for the Import JSF Project wizard and also whether to register Web Context in server.xml or not.


Selecting JBoss Tools > Web > Editors > JSF Flow Diagram allows you to specify some aspects of the Diagram mode of the JSF configuration file editor.


The first two items control the background grid for the diagram. The next two items allow you to control the appearance of the labels for views (pages) and the transitions between views. For these two items, clicking the Change... button allows you to assign a font with a dialog box.

The first check box determines whether a view in the diagram that doesn't have a transition connecting it to another view yet should be written to the source code as a partial navigation rule. The next check box determines whether the diagram cursor reverts immediately to the standard selection mode after it's used in the transition-drawing mode to draw a transition. Finally, the last two check boxes concern shortcuts. A shortcut is a transition that is there but isn't actually displayed in the diagram as going all the way to the target view it's connected to, in order to make the diagram clearer. With the check boxes, you can decide whether to display a small shortcut icon as part of the shortcut and also whether to display the target view as a label or not.


Selecting the Add Page tab in the JSF Flow Diagram screen allows you to determine the default template and file extension for views (pages) you add directly into the diagram using a context menu or the view-adding mode of the diagram cursor.

To adjust the project specific preferences, you should bring the context menu for your project and select the Preferences option. More details on what adjustments you can perform in the Preferences screen, see in the "JBoss Tools Preferences" chapter.

Under the JBoss Tools option in the context menu there are also several actions provided by JBDS:

  • Add/Remove Struts Capabilities

  • Add/Remove JSF Capabilities

  • Add Custom Capabilities

The Visual Page Editor requires the library libstdc++.so.5. This library is contained in the compat-libstdc++-33.i386 package.

In case you have the library installed and you still have issue with starting the Visual Page Editor then close all browser views/editors and leave one Visual Page Editor open and restart eclipse. This should force a load of the right XULRunner viewer.

If it doesn't help and you use Fedora Core Linux and Eclipse Version: 3.4.1,the issue can be produced because libswt-xulrunner-gtk-3449.so file doesn't present in eclipse-swt-3.4.1-5.fc10.x86_64.rpm/eclipse/plugins/org.eclipse.swt.gtk.linux.x86_64_3.4.1.v3449c.jar.To add this file to eclipse you should:

On the whole, this document should guide you to those parts of JBoss Tools which you specifically need to develop Web Applications. It covers different aspects of visual components such as editors, views, etc. for browsing, representing and editing web resources you are working with.

If there's anything we didn't cover or you can't figure out, please feel free to visit our JBoss Developer Studio Users Forum or JBoss Tools Users Forum to ask questions. There we are also looking for your suggestions and comments.