JBoss Tools SVN: r15206 - branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:41:15 -0400 (Mon, 11 May 2009)
New Revision: 15206
Added:
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_exception.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_page.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_page1.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_page2.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_param.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_exception.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_marquee.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_new_link.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_plus.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_select.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/outline_navigation.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/outline_tree.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_10.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_11.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_12.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_2a.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_7.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_8.png
branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_9.png
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_exception.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/element_exception.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_page.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/element_page.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_page1.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/element_page1.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_page2.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/element_page2.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/element_param.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/element_param.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_exception.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/icon_exception.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_marquee.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/icon_marquee.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_new_link.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/icon_new_link.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_plus.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/icon_plus.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/icon_select.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/icon_select.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/outline_navigation.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/outline_navigation.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/outline_tree.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/outline_tree.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_10.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/seam_editors_10.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_11.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/seam_editors_11.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_12.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/seam_editors_12.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_2a.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/seam_editors_2a.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_7.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/seam_editors_7.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_8.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/seam_editors_8.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/images/seam_editors/seam_editors_9.png (from rev 15128, trunk/seam/docs/reference/en/images/seam_editors/seam_editors_9.png)
===================================================================
(Binary files differ)
15 years, 2 months
JBoss Tools SVN: r15205 - branches/jbosstools-3.0.x/seam/docs/reference/en/modules.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:40:39 -0400 (Mon, 11 May 2009)
New Revision: 15205
Added:
branches/jbosstools-3.0.x/seam/docs/reference/en/modules/seam_faq.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Copied: branches/jbosstools-3.0.x/seam/docs/reference/en/modules/seam_faq.xml (from rev 15128, trunk/seam/docs/reference/en/modules/seam_faq.xml)
===================================================================
--- branches/jbosstools-3.0.x/seam/docs/reference/en/modules/seam_faq.xml (rev 0)
+++ branches/jbosstools-3.0.x/seam/docs/reference/en/modules/seam_faq.xml 2009-05-11 16:40:39 UTC (rev 15205)
@@ -0,0 +1,74 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<chapter id="seam_faq" xreflabel="seam_faq">
+ <?dbhtml filename="vwt_faq.html"?>
+ <title>FAQ</title>
+
+ <section id="seam_question_1">
+ <title>How to get Code Assist for Seam specific resources in an externally generated
+ project?</title>
+
+ <para>To get Code Assist for Seam specific resources in an externally generated project, you
+ should enable Seam features in Project Preferences. Right click an imported project and
+ navigate <emphasis>
+ <property>Properties > Seam Settings</property>.</emphasis> Check <emphasis>
+ <property>Seam support</property>
+ </emphasis> box to enable all available <link linkend="project_pref">Seam
+ Settings</link>.</para>
+ </section>
+
+ <section id="seam_question_2">
+ <title>How to import an example Seam project from jboss-eap directory?</title>
+
+ <para>To import an example Seam project from <emphasis>
+ <property>jboss-eap</property>
+ </emphasis> into your working directory, you should perform the following steps:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Go to <emphasis>
+ <property>New > Other > Java Project from Existing Buildfile</property>
+ </emphasis></para>
+ </listitem>
+
+ <listitem>
+ <para>Point to the <emphasis>
+ <property>build.xml</property>
+ </emphasis> of any chosen project by pressing <emphasis>
+ <property>Browse</property>
+ </emphasis> button</para>
+ </listitem>
+
+ <listitem>
+ <para>Hit <emphasis>
+ <property>Finish</property>
+ </emphasis> to open the project</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>As these seam examples are non WTP projects, next you should enable Seam support for
+ them. To do that, right click the project and go to <emphasis>
+ <property>Properties > Seam Settings</property>.</emphasis></para>
+ </section>
+
+ <section id="seam_question_3">
+ <title>How to change the deploy folders for Seam source code from src/hot and src/main?</title>
+
+ <para>You should right-click the project, select <emphasis>
+ <property>Properties > Java Build Path</property>,</emphasis> then switch to the <emphasis>
+ <property>Source tab</property>,</emphasis> select the output folder for <emphasis>
+ <property>src/hot</property></emphasis> (<emphasis>
+ <property>src/main</property>)</emphasis> and click <emphasis>
+ <property>Edit</property></emphasis> to change their output location.</para>
+
+ <para>In conclusion, the main goal of this document is to get you know with a full featureset
+ that <property>JBoss Tools</property> provides to support Seam development. Thus if you have
+ some questions, comments or suggestions on the topic, please fell free to ask in the <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss
+ Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in
+ future leaving your vote on our page <ulink
+ url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture"
+ >here</ulink>. </para>
+
+ <para>A set of movies on Seam tooling is available <ulink url="http://docs.jboss.org/tools/movies">here</ulink>.</para>
+ </section>
+</chapter>
15 years, 2 months
JBoss Tools SVN: r15203 - in branches/jbosstools-3.0.x/portlet/docs/reference: en and 1 other directories.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:39:00 -0400 (Mon, 11 May 2009)
New Revision: 15203
Modified:
branches/jbosstools-3.0.x/portlet/docs/reference/en/master.xml
branches/jbosstools-3.0.x/portlet/docs/reference/en/modules/intro.xml
branches/jbosstools-3.0.x/portlet/docs/reference/en/modules/seam_portlet.xml
branches/jbosstools-3.0.x/portlet/docs/reference/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Modified: branches/jbosstools-3.0.x/portlet/docs/reference/en/master.xml
===================================================================
--- branches/jbosstools-3.0.x/portlet/docs/reference/en/master.xml 2009-05-11 16:38:50 UTC (rev 15202)
+++ branches/jbosstools-3.0.x/portlet/docs/reference/en/master.xml 2009-05-11 16:39:00 UTC (rev 15203)
@@ -39,7 +39,7 @@
<holder>JBoss, a division of Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 1.0.0.GA
+ Version: 1.0.1.GA
</releaseinfo>
<abstract>
Modified: branches/jbosstools-3.0.x/portlet/docs/reference/en/modules/intro.xml
===================================================================
--- branches/jbosstools-3.0.x/portlet/docs/reference/en/modules/intro.xml 2009-05-11 16:38:50 UTC (rev 15202)
+++ branches/jbosstools-3.0.x/portlet/docs/reference/en/modules/intro.xml 2009-05-11 16:39:00 UTC (rev 15203)
@@ -124,10 +124,7 @@
</listitem>
<listitem>
- <para>
- <ulink url="http://www.jboss.com/products/devstudio/docs">Stable JBossTools/JBDS
- documentation</ulink> (supplied with the latest JBDS release, 1.1.0 GA
- currently) </para>
+ <para>JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
</listitem>
</itemizedlist>
Modified: branches/jbosstools-3.0.x/portlet/docs/reference/en/modules/seam_portlet.xml
===================================================================
--- branches/jbosstools-3.0.x/portlet/docs/reference/en/modules/seam_portlet.xml 2009-05-11 16:38:50 UTC (rev 15202)
+++ branches/jbosstools-3.0.x/portlet/docs/reference/en/modules/seam_portlet.xml 2009-05-11 16:39:00 UTC (rev 15203)
@@ -70,7 +70,7 @@
<para>Thus you should have JBoss Portlet Bridge downloaded and extracted somewhere on
your hard drive. You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink
- url="http://www.jboss.org/portletbridge/download/">here</ulink>.</para>
+ url="http://www.jboss.org/portletbridge/download/">www.jboss.org/portletbridge/download</ulink>.</para>
</tip>
<para>Now, to add Seam Portlet to the project you should follow to <emphasis>
Modified: branches/jbosstools-3.0.x/portlet/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/portlet/docs/reference/pom.xml 2009-05-11 16:38:50 UTC (rev 15202)
+++ branches/jbosstools-3.0.x/portlet/docs/reference/pom.xml 2009-05-11 16:39:00 UTC (rev 15203)
@@ -89,6 +89,11 @@
<version>1.1.0</version>
<type>jdocbook-style</type>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
</dependencies>
15 years, 2 months
JBoss Tools SVN: r15202 - branches/jbosstools-3.0.x/portlet/docs/reference/en.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:38:50 -0400 (Mon, 11 May 2009)
New Revision: 15202
Added:
branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml
Removed:
branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Deleted: branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml 2009-05-11 16:38:13 UTC (rev 15201)
+++ branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml 2009-05-11 16:38:50 UTC (rev 15202)
@@ -1,995 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.docbook.org/xml/4.3/docbookx.dtd"
-
-[<!ENTITY intro SYSTEM "modules/intro.xml">
-<!ENTITY installation SYSTEM "modules/installation.xml">
-<!ENTITY starting_project SYSTEM "modules/starting_project.xml">
-<!ENTITY jsf_portlet SYSTEM "modules/jsf_portlet.xml">
-<!ENTITY seam_portlet SYSTEM "modules/seam_portlet.xml">
-<!ENTITY portlets_to_nonWTP_projects SYSTEM "modules/portlets_to_nonWTP_projects.xml">
-
-<!ENTITY seamlink "../../seam/html_single/index.html">
-<!ENTITY aslink "../../as/html_single/index.html">
-<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
-<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
-<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
-<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
-<!ENTITY jsflink "../../jsf/html_single/index.html">
-<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
-<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
-<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
-<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>JBoss Portal Tools Reference Guide</title>
-
- <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
- <author><firstname>Snjezana</firstname><surname>Peco</surname><email>snjezana.peco(a)redhat.com</email></author>
- <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
- <author><firstname>Thomas</firstname><surname>Heute</surname><email>theute(a)jboss.org</email></author>
-
- <pubdate>September 2008</pubdate>
- <copyright>
- <year>2008</year>
- <year diffmk:change="added"><diffmk:wrapper diffmk:change="added">2009</diffmk:wrapper></year>
- <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.0.0.GA
- </diffmk:wrapper></releaseinfo>
-
-<abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_portal_tools_r...">PDF version</ulink>
- </para>
-</abstract>
-
-
- </bookinfo>
- <toc></toc>
-
-
-
-<chapter id="intro" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/intro.xml" xreflabel="intro">
- <?dbhtml filename="intro.html"?>
- <title>Introduction</title>
-
- <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins extends <property moreinfo="none">JBoss Portal</property>
- features. Thus, this guide is intended to explain you how to manage the functionality
- <property moreinfo="none">JBoss Tools</property> provide to ease the development with <property moreinfo="none">JBoss
- Portal</property>.</para>
-
- <section id="preface">
- <title>Preface</title>
- <para><property moreinfo="none">JBoss Portal</property> provides an open source platform for hosting and
- serving a portal's Web interface, publishing and managing its content, and customizing
- its experience. It supports a wide range of features, including standard portlets,
- single sign-on, clustering, and internationalization.</para>
- </section>
-
- <section id="key_features">
- <title>Key Features</title>
- <para>The next table lists key features supplied by <property moreinfo="none">JBoss Portal Tools</property>.</para>
-
- <table>
- <title>Key Functionality of JBoss Portal Tools</title>
- <tgroup cols="3">
-
- <colspec align="left" colnum="1" colwidth="1*"></colspec>
- <colspec colnum="2" colwidth="5*"></colspec>
- <colspec align="left" colnum="3" colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- <entry>Chapter</entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry>
- <para>Wizards for creating Projects with Portlet Facets</para>
- </entry>
- <entry>
- <para>New Dynamic Web Project wizard allows you to select a proper
- Configuration to enable Portlet Facet in it.</para>
- </entry>
- <entry>
- <link linkend="creating_project_with_jbossportal">Creating a Dynamic
- Web Project</link>
- </entry>
- </row>
-
-
- <row>
- <entry>
- <para>Create Java Portlet wizard</para>
- </entry>
-
- <entry>
- <para>The wizard enables creating a JSR-186/JSR-286 compliant
- portlet.</para>
- </entry>
- <entry>
- <link linkend="adding_java_portlet">Adding Java Portlet to a
- project</link>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Create JSF/Seam Portlet wizard</para>
- </entry>
- <entry>
- <para>This wizard allows to create JSF/Seam portlets</para>
- </entry>
- <entry>
- <link linkend="jsf_portlet">Creating JSF Portlet</link>
- <link linkend="seam_portlet">Creating Seam Portlet</link>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section id="rel_resources">
- <title>Other relevant resources on the topic</title>
-
- <itemizedlist>
- <listitem>
- <para>
- <ulink url="http://www.jboss.org/jbossportal/">JBoss Portal Home Page</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink url="http://wiki.jboss.org/wiki/JBossPortal">JBoss Portal Wiki</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest
- JBossTools/JBDS documentation builds</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink url="http://www.jboss.com/products/devstudio/docs">Stable JBossTools/JBDS
- documentation</ulink> (supplied with the latest JBDS release, 1.1.0 GA
- currently) </para>
- </listitem>
- </itemizedlist>
-
- </section>
-</chapter>
-
-
-<chapter id="installation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/installation.xml" xreflabel="installation">
- <?dbhtml filename="installation.html"?>
- <title>Installation issues</title>
-
- <para>This section provides you with the steps on how to start with <property moreinfo="none">JBoss
- Portal</property> and integrated features using <property moreinfo="none">JBoss Tools</property>.</para>
-
- <itemizedlist>
- <listitem>
- <para>First, you need to have Eclipse Ganymede with JBoss Tools 3.0.0.Alpha1 and higher installed.</para>
-
- <tip>
- <title>Tip:</title>
- <para>Read <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">JBoss Tools
- Installation</ulink> section in our Getting Started documentation to find out
- how to install <property moreinfo="none">JBoss Tools</property> onto Eclipse.</para>
- </tip>
- </listitem>
-
- <listitem>
- <para>Next, download the JBoss Portal + JBoss AS bundle from <ulink url="http://www.jboss.org/jbossportal/download/index.html">JBoss Portal Download
- page</ulink></para>
-
- <note>
- <title>Note:</title>
- <para>You need JBoss Portal 2.7 if you want to work with a Portlet 2.0</para>
- </note>
-
- </listitem>
-
- <listitem>
- <para>Extract the bundle wherever you want on your hard drive</para>
- </listitem>
- </itemizedlist>
-
- <para>Now, when you have it installed, we are going to demonstrate some powerful features of
- <property moreinfo="none">JBoss Portal</property> tooling for Eclipse.</para>
-</chapter>
-
-
-<chapter id="starting_project" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/starting_project.xml" xreflabel="starting_project">
- <?dbhtml filename="starting_project.html"?>
- <title>Starting the Project with JBoss Portal</title>
-
- <para>To get started with <property moreinfo="none">JBoss Portal</property> and <property moreinfo="none">JBoss
- Tools</property>, you should first have a Web Project pointed to the JBoss Portal Runtime.
- Thus, in this chapter we are going to show you how to create a Dynamic Web Project, add Java
- Portlet to it and deploy it to the <property moreinfo="none">JBoss Portal</property>.</para>
-
- <section id="creating_project_with_jbossportal">
- <title>Creating a Dynamic Web Project</title>
-
- <para>To create a Dynamic Web Project, go to <emphasis>
- <property moreinfo="none">File > New > Dynamic Web Project</property>
- </emphasis> if you are in the <property moreinfo="none">Web Perspective</property> or <property moreinfo="none">File >
- New > Other > Web > Dynamic Web Project</property> in any other Perspective. The
- first page of the New Dynamic Web Project wizard looks as follows.</para>
-
- <figure float="0">
- <title>New Dynamic Web Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Fill out the name of your project. Next, click the <emphasis>
- <property moreinfo="none">New</property>
- </emphasis> button in the <emphasis>
- <property moreinfo="none">Target Runtime</property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> section to specify a new Target Runtime. Choose </diffmk:wrapper><emphasis>
- <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"> JBoss Community > JBoss 4.2 Runtime</diffmk:wrapper></property>
- </emphasis><diffmk:wrapper diffmk:change="added"> and select the </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Create a new local server</diffmk:wrapper></property>
- </emphasis><diffmk:wrapper diffmk:change="added"> checkbox. Click </diffmk:wrapper><emphasis>
- <property moreinfo="none">Next</property>.</emphasis></para>
-
- <figure float="0">
- <title>New Server Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the next page you should give a name to the runtime. Let's call it <emphasis>
- <property moreinfo="none">JBoss Portal 2.7 Runtime</property>
- </emphasis>, and then point it to the location of your JBoss AS + Portal
- installation.</para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">New Server Runtime Environment</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/starting_project/server_runtime_environment.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
-
- <para>The JBoss Tools Portlet feature has been tested using 2.6.5 and 2.7.0.ALPHA
- versions of <property moreinfo="none">JBoss Portal</property>. Remember, if you want to use Portlet
- version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</para>
- </note>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">At this point a new JBoss Server instance will be created. Here you can verify the
- defined runtime information. If something is incorrect, press </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Back</diffmk:wrapper></property>
- </emphasis><diffmk:wrapper diffmk:change="added"> to return on the previous wizard page.</diffmk:wrapper></para>
-
- <figure float="0">
- <title><diffmk:wrapper diffmk:change="changed">Target Server</diffmk:wrapper></title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Click <emphasis>
- <property moreinfo="none">Finish</property>.</emphasis></para>
-
- <para>On the next step you should click the <emphasis>
- <property moreinfo="none">Modify</property>
- </emphasis> button next to the <property moreinfo="none">Configuration</property> section to enable
- Portlet Facets for the project.</para>
-
- <figure float="0">
- <title>Setting the Project Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On this page you should check the <emphasis>
- <property moreinfo="none">JBoss Core Portlet</property>
- </emphasis> and press <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis>.</para>
-
- <figure float="0">
- <title>Enabling the Portlet Facet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_4_a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If the portlet libraries aren't available in the runtime you targeted,
- JBoss Portlet facets will be hidden on this page.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To made portal functionality always visible no matter what the runtime support,
- you should go to </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window > Preferences</diffmk:wrapper></property>
- </emphasis><diffmk:wrapper diffmk:change="added"> and then </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Tools > JBoss Portlet</diffmk:wrapper></property>
- </emphasis><diffmk:wrapper diffmk:change="added"> and deselect </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Check runtimes for Portlet Components</diffmk:wrapper></property>
- </emphasis><diffmk:wrapper diffmk:change="added"> checkbox (see figure below).</diffmk:wrapper></para>
- </note>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Runtime Preferences</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/starting_project/portlet_preferences.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para><diffmk:wrapper diffmk:change="changed">The next page is for configuring web modules. Here all values are set, so you can
- leave everything as it is.</diffmk:wrapper></para>
-
- <figure float="0">
- <title>The Project Web Modules</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para><diffmk:wrapper diffmk:change="added">Finally, the last wizard page will ask you to add JBoss Portlet capabilities to your
- project. Here you can choose whether to set up user libraries, libraries provided by
- server runtime or not include libraries at all.</diffmk:wrapper></para>
-
- <itemizedlist diffmk:change="added">
- <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To set up server runtime libraries, you need to select </diffmk:wrapper><emphasis>
- <property moreinfo="none"><diffmk:wrapper diffmk:change="added">Libraries provided by server runtime</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> in the list box.</diffmk:wrapper></para>
- </listitem>
- </itemizedlist>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Including Server Runtime Libraries</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist diffmk:change="added">
- <listitem diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For setting up user libraries, select </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">User library</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> in the list box and then press </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> in the </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">User Library</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> section.</diffmk:wrapper></para>
- </listitem>
- </itemizedlist>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding User Library</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Then press </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and type the user library name in the appeared dialog.</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding User Library</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Next add necessary jar's.</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding the Portlet API Jar</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Hit </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">OK</diffmk:wrapper></property>.</emphasis><diffmk:wrapper diffmk:change="added"> The user library will be added.
- </diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">User Library Added</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist diffmk:change="added">
- <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you don't need to include libraries at all, just deselect the </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Enable implementation library</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> checkbox.</diffmk:wrapper></para>
- </listitem>
- </itemizedlist>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Disabling Implementation Libraries</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">After setting JBoss Portlet capabilities press </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para>
-
- <para>That's it! Our base project is done.</para>
-
- </section>
-
- <section id="structure_overview">
- <title>The Project Structure Overview</title>
-
- <para>Now, let's look at the structure of the just created project.</para>
-
- <figure float="0">
- <title>The Project Structure Overview</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Here <property moreinfo="none">JBoos Tools</property> added JBoss Portlet facet to the project,
- created an empty <emphasis>
- <property moreinfo="none">portlet.xml</property>
- </emphasis> file and added the Portlet library to the project classpath.</para>
- </section>
-
- <section id="adding_java_portlet">
- <title>Adding a Java Portlet to the Project</title>
-
- <para>At this point we'll show what the steps you need to proceed to add a new Java
- Portlet to the project.</para>
-
- <para>Call the <property moreinfo="none">Create Portlet wizard</property> by selecting <emphasis>
- <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > Java
- Portlet</property>.</emphasis></para>
-
- <figure float="0">
- <title>New Java Portlet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The wizard fills in the Web Project and Source Folder fields for you. Then you need to
- specify the Java package and the Class name and click <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis>.</para>
-
- <figure float="0">
- <title>Specifying Class File Destination</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the other page you will be able to set the display name of the Portlet, a title, a
- description, the supported modes and init parameters.</para>
-
- <figure float="0">
- <title>Specifying Class File Destination</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_9.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the next screen you can define which methods from
- <emphasis>GenericPortlet</emphasis> you want to override.</para>
-
- <figure float="0">
- <title>Specifying Class File Destination</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_10.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The last screen lets you build <property moreinfo="none">JBoss Portal</property> specific descriptors
- to create an instance during the deployment and place it directly on the Portal.</para>
-
- <figure float="0">
- <title>Specifying Class File Destination</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_11.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip>
- <title>Tip:</title>
-
- <para>If you uncheck the <emphasis> Create Portlet Instance</emphasis> checkbox,
- <property moreinfo="none">JBoss Tools</property> won't create the deployment elements
- in the <emphasis> default-object.xml</emphasis> and <emphasis>
- portlet-instances.xml</emphasis> files.</para>
- </tip>
-
- <para>Once Java Portlet is created, new resources have been added to the project structure.
- As you can see on the figure below, it adds a Java Portlet class (<emphasis>
- <property moreinfo="none">TestPortlet.java</property>
- </emphasis> in our case), <emphasis>
- <property moreinfo="none">default-object.xml</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">portlet-instances.xml</property>
- </emphasis> files and updates <emphasis>
- <property moreinfo="none">portlet.xml</property>
- </emphasis> as well.</para>
-
- <figure float="0">
- <title>The structure of Web Project with Java Portlet created</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_12.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Thus, now the Project is ready to be built and deployed.</para>
- </section>
-
- <section id="deploying_to_portal">
- <title>Deploying a Portlet to JBoss Portal</title>
-
- <para>You can deploy the created project in the way you deploy any other Web Application.
- Right click on the project and do <emphasis>
- <property moreinfo="none">Run As > Run On Server</property>
- </emphasis> and accept the defaults. On the <emphasis>
- <property moreinfo="none">Add and Remove Projects</property>
- </emphasis> page move the created Project to the right and click <emphasis>
- <property moreinfo="none">Finish</property>.</emphasis></para>
-
- <figure float="0">
- <title>Deploying the Portlet Application</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_13.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It will deploy the Portlet Web Application and start <property moreinfo="none">JBoss
- AS</property>.</para>
-
- <tip>
- <title>Tip:</title>
-
- <para>You should use <emphasis>http://localhost:8080/portal</emphasis> URL to see your
- Portlet in the Browser.</para>
- </tip>
-
- <para>In the Browser the Portlet looks as follows:</para>
-
- <figure float="0">
- <title>Java Portlet in the Browser Window</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_14.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Consequently, here you learnt how to create a Dynamic Web Project, add Java Portlet to
- it and deploy the project to <property moreinfo="none">JBoss Portal</property>.</para>
- </section>
-
-</chapter>
-
-
-<chapter id="jsf_portlet" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/jsf_portlet.xml" xreflabel="jsf_portlet">
- <?dbhtml filename="jsf_portlet.html"?>
- <title>Creating JSF Portlet</title>
-
- <para>This chapter will explain how you can configure JSF Portlet within Dynamic Web
- Project and JSF Project by using the wizards <property moreinfo="none">JBoss Tools</property> provides.</para>
-
- <section id="jsf_portlet1">
- <title>Adding JSF Portlet to Dynamic Web Project</title>
-
- <para>To add JSF Portlet to a Dynamic Web Project, you should set the Configuration to <emphasis>
- <property moreinfo="none">JavaServer Faces v1.1 Project</property>
- </emphasis> or <emphasis>
- <property moreinfo="none">JavaServer Faces v1.2 Project</property>
- </emphasis> and configure the JSF Portlet Facets in the <property moreinfo="none">New Dynamic Web
- Project wizard</property> by clicking the <emphasis>
- <property moreinfo="none">Modify</property>
- </emphasis> button.</para>
-
- <figure float="0">
- <title>Setting the JSF Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the Project Facets dialog you should select <property moreinfo="none">JBoss Core Portlet</property>
- and <property moreinfo="none">JBoss JSF Portlet</property> check boxes.</para>
-
- <figure float="0">
- <title>Enabling the Portlet Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Next wizard page is for configuring JSF Capabilities. You can leave everything as it
- is here.</para>
-
- <figure float="0">
- <title>JSF Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>To support Portlets in JSF/Seam applications <property moreinfo="none">JBoss Tools</property> works
- with <property moreinfo="none">JBoss Portlet Bridge</property>. Thus on the next page you should add JSF Portlet
- capabilities by pointing to the Portletbridge Runtime location.</para>
-
- <figure float="0">
- <title>JSF Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip>
- <title>Tip:</title>
-
- <para>You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink url="http://www.jboss.org/portletbridge/download/">here</ulink>.</para>
- </tip>
-
- <para>Next click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> to organize the Project.</para>
- <para id="add_jsf_portlet">To add JSF Portlet to generated project you should call the
- <property moreinfo="none">Create Portlet wizard</property> by navigating to <emphasis>
- <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam
- Portlet</property>.</emphasis></para>
-
- <figure float="0">
- <title>Calling New Portlet Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As you see, the Seam and JSF Portlet wizards are merged into one. We set JSF
- Configuration for the project, so default values in this wizard will be set as for a JSF
- portlet.</para>
-
- <figure float="0">
- <title>Creating JSF Portlet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> to complete JSF Portlet creation. Now you can deploy the project the same
- way as it was <link linkend="deploying_to_portal">described above</link>.</para>
-
- <para>In the Browser JSF Portlet looks as follows.</para>
-
- <figure float="0">
- <title>JSF Portlet in the Browser</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="jsf_portlet_to_JSF_project">
- <title>Adding JSF Portlet to JSF Project</title>
-
- <para>How to organize a JSF Project you can find out in our <ulink url="../../jsf_tools_ref_guide/html_single/index.html#new_jsf_project">JSF Tools Reference Guide</ulink>. Just
- remember to point Target Runtime to JBoss Portal directory location.</para>
-
- <figure float="0">
- <title>Creating New JSF Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Before adding a Portlet to the project you should enable necessary facets for it.
- Right-click the created project and click <emphasis>
- <property moreinfo="none">Preferences</property>
- </emphasis> to open the <property moreinfo="none">Project Preferences</property> screen.</para>
- <para>On the <property moreinfo="none">Project Facets</property> page select the <emphasis>
- <property moreinfo="none">JBoss Core Portlet</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">JBoss JSF Portlet</property>
- </emphasis> checkboxes. And then the screen will ask you to enable <emphasis>
- <property moreinfo="none">JavaServer Faces</property>
- </emphasis> facet as well.</para>
-
- <figure float="0">
- <title>Project Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Notice, <emphasis>
- <property moreinfo="none">"Further configuration required..."</property>
- </emphasis> warning appears at the bottom of the screen. It means that you should click
- it to configure JSF and JSF Portlet Capabilities in the project.</para>
-
- <figure float="0">
- <title>JSF Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet10.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure float="0">
- <title>Project Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet11.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After setting the path to Portletbridge Runtime location, click <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis> and then <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis> again.</para>
-
- <para>Now you can add JSF Portlet to the generated JSF Project. How to do it we showed in
- <link linkend="add_jsf_portlet">the previous section</link>.</para>
- </section>
-</chapter>
-
-
-<chapter id="seam_portlet" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/seam_portlet.xml" xreflabel="seam_portlet">
- <?dbhtml filename="seam_portlet.html"?>
- <title>Creating Seam Portlet</title>
-
- <para>This chapter covers the steps on how to configure Seam Portlet within Dynamic Web
- Project and Seam Project by using the wizards <property moreinfo="none">JBoss Tools</property> provides.</para>
-
- <section id="seam_portlet1">
- <title>Adding Seam Portlet to Dynamic Web Project</title>
-
- <para>To add Seam Portlet to a Dynamic Web Project first you should organize New Dynamic Web
- Project with the Configuration setting to <emphasis>
- <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>.</emphasis></para>
-
- <figure float="0">
- <title>Calling New Portlet Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It will add all needed facets to your project. By clicking the <emphasis>
- <property moreinfo="none">Modify</property>
- </emphasis> button you can observe the chosen configuration of facets as well as modify
- it. As you can see, all JBoss Portlets are checked.</para>
-
- <figure float="0">
- <title>Project Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Next wizard pages are for adjusting the Project Web Modules and JSF Configuration.
- They include default values, so you can skip them by pressing <emphasis>
- <property moreinfo="none">Next</property>.</emphasis></para>
-
- <para>On the <property moreinfo="none">Seam Facet</property> page <ulink url="../../seam/html_single/index.html#seamFacet">set
- Connection Profile</ulink> and hit <emphasis>
- <property moreinfo="none">Next</property>.</emphasis></para>
-
- <figure float="0">
- <title>Seam Facet Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Last wizard page will prompt you to set the path to Portletbridge Runtime
- location.</para>
-
- <figure float="0">
- <title>Setting the Portletbridge Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip>
- <title>Tip:</title>
-
- <para>Thus you should have JBoss Portlet Bridge downloaded and extracted somewhere on
- your hard drive. You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink url="http://www.jboss.org/portletbridge/download/">here</ulink>.</para>
- </tip>
-
- <para>Now, to add Seam Portlet to the project you should follow to <emphasis>
- <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam
- Portlet</property>.</emphasis> This will call the wizard for creating JSF/Seam
- Portlets.</para>
-
- <figure float="0">
- <title>Calling the Create Portlet Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As we set Seam Configuration for the Dynamic Web Project, the wizard puts the values
- as for Seam Portlet.</para>
-
- <figure float="0">
- <title>Creating Seam Portlet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After creating the Seam Portlet, you should <link linkend="deploying_to_portal">deploy
- the project to JBoss Portal</link> and start the Server. In a Browser
- you'll see the following:</para>
-
- <figure float="0">
- <title>Seam Portlet in the Browser</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="seam_portlet_to_seam_project">
- <title>Adding Seam Portlet to Seam Project</title>
-
- <para>First start a Seam Project by following to <emphasis>
- <property moreinfo="none">New > Other > Seam > Seam Web Project</property>. </emphasis> On the first
- wizard page specify JBoss Portal directory location as <property moreinfo="none">Target
- Runtime</property> and <emphasis>
- <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>
- </emphasis> as <property moreinfo="none">Configuration</property>.</para>
-
- <figure float="0">
- <title>Project Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Next steps will be the same as we did for the Dynamic Web Project in the <link linkend="seam_portlet1">Adding Seam Portlet to Dynamic Web Project</link>
- section.</para>
- </section>
-</chapter>
-
-
-<chapter id="portlets_to_nonWTP_projects" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/portlets_to_nonWTP_projects.xml" xreflabel="portlets_to_nonWTP_projects">
- <?dbhtml filename="portlets_to_nonWTP_projects.html"?>
- <title>Adding Portlets to non-WTP Projects</title>
-
- <para>Starting from <property moreinfo="none">JBoss Tools 3.0.0.Beta1</property> version the JBoss Portlet
- wizards no longer require a WTP project to be able to create Portlets.</para>
-
- <note>
- <title>Note:</title>
- <para>Please note, if the project does not have the proper portlet API jar's, the generated
- classes will have compile errors.</para>
- </note>
-
- <para>In conclusion, with this document you've learnt how to get started with <property moreinfo="none">JBoss
- Portal</property> using <property moreinfo="none">JBoss Tools</property> suite of Eclipse plugins.
- The above chapters walked you through the steps on how to organize a web project with
- portlets which includes a sample staff and deploy it onto the <property moreinfo="none">JBoss
- Portal</property>.</para>
-
- <para>If you still have questions or suggestions you are always welcome on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">Forum</ulink>. Your feedback will be very much appreciated.</para>
-
-</chapter>
-
-
-</book>
Copied: branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml (from rev 15128, trunk/portlet/docs/reference/en/master_output.xml)
===================================================================
--- branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml 2009-05-11 16:38:50 UTC (rev 15202)
@@ -0,0 +1,995 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[<!ENTITY intro SYSTEM "modules/intro.xml">
+<!ENTITY installation SYSTEM "modules/installation.xml">
+<!ENTITY starting_project SYSTEM "modules/starting_project.xml">
+<!ENTITY jsf_portlet SYSTEM "modules/jsf_portlet.xml">
+<!ENTITY seam_portlet SYSTEM "modules/seam_portlet.xml">
+<!ENTITY portlets_to_nonWTP_projects SYSTEM "modules/portlets_to_nonWTP_projects.xml">
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>JBoss Portal Tools Reference Guide</title>
+
+ <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author><firstname>Snjezana</firstname><surname>Peco</surname><email>snjezana.peco(a)redhat.com</email></author>
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+ <author><firstname>Thomas</firstname><surname>Heute</surname><email>theute(a)jboss.org</email></author>
+
+ <pubdate>September 2008</pubdate>
+ <copyright>
+ <year>2008</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 1.0.1.GA
+ </diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_portal_tools_r...">PDF version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+ <toc></toc>
+
+
+
+<chapter id="intro" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/intro.xml" xreflabel="intro">
+ <?dbhtml filename="intro.html"?>
+ <title>Introduction</title>
+
+ <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins extends <property moreinfo="none">JBoss Portal</property>
+ features. Thus, this guide is intended to explain you how to manage the functionality
+ <property moreinfo="none">JBoss Tools</property> provide to ease the development with <property moreinfo="none">JBoss
+ Portal</property>.</para>
+
+ <section id="preface">
+ <title>Preface</title>
+ <para><property moreinfo="none">JBoss Portal</property> provides an open source platform for hosting and
+ serving a portal's Web interface, publishing and managing its content, and customizing
+ its experience. It supports a wide range of features, including standard portlets,
+ single sign-on, clustering, and internationalization.</para>
+ </section>
+
+ <section id="key_features">
+ <title>Key Features</title>
+ <para>The next table lists key features supplied by <property moreinfo="none">JBoss Portal Tools</property>.</para>
+
+ <table>
+ <title>Key Functionality of JBoss Portal Tools</title>
+ <tgroup cols="3">
+
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="5*"></colspec>
+ <colspec align="left" colnum="3" colwidth="1*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para>Wizards for creating Projects with Portlet Facets</para>
+ </entry>
+ <entry>
+ <para>New Dynamic Web Project wizard allows you to select a proper
+ Configuration to enable Portlet Facet in it.</para>
+ </entry>
+ <entry>
+ <link linkend="creating_project_with_jbossportal">Creating a Dynamic
+ Web Project</link>
+ </entry>
+ </row>
+
+
+ <row>
+ <entry>
+ <para>Create Java Portlet wizard</para>
+ </entry>
+
+ <entry>
+ <para>The wizard enables creating a JSR-186/JSR-286 compliant
+ portlet.</para>
+ </entry>
+ <entry>
+ <link linkend="adding_java_portlet">Adding Java Portlet to a
+ project</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Create JSF/Seam Portlet wizard</para>
+ </entry>
+ <entry>
+ <para>This wizard allows to create JSF/Seam portlets</para>
+ </entry>
+ <entry>
+ <link linkend="jsf_portlet">Creating JSF Portlet</link>
+ <link linkend="seam_portlet">Creating Seam Portlet</link>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section id="rel_resources">
+ <title>Other relevant resources on the topic</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.org/jbossportal/">JBoss Portal Home Page</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://wiki.jboss.org/wiki/JBossPortal">JBoss Portal Wiki</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest
+ JBossTools/JBDS documentation builds</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.com/products/devstudio/docs">Stable JBossTools/JBDS
+ documentation</ulink> (supplied with the latest JBDS release, 1.1.0 GA
+ currently) </para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+</chapter>
+
+
+<chapter id="installation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/installation.xml" xreflabel="installation">
+ <?dbhtml filename="installation.html"?>
+ <title>Installation issues</title>
+
+ <para>This section provides you with the steps on how to start with <property moreinfo="none">JBoss
+ Portal</property> and integrated features using <property moreinfo="none">JBoss Tools</property>.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>First, you need to have Eclipse Ganymede with JBoss Tools 3.0.0.Alpha1 and higher installed.</para>
+
+ <tip>
+ <title>Tip:</title>
+ <para>Read <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">JBoss Tools
+ Installation</ulink> section in our Getting Started documentation to find out
+ how to install <property moreinfo="none">JBoss Tools</property> onto Eclipse.</para>
+ </tip>
+ </listitem>
+
+ <listitem>
+ <para>Next, download the JBoss Portal + JBoss AS bundle from <ulink url="http://www.jboss.org/jbossportal/download/index.html">JBoss Portal Download
+ page</ulink></para>
+
+ <note>
+ <title>Note:</title>
+ <para>You need JBoss Portal 2.7 if you want to work with a Portlet 2.0</para>
+ </note>
+
+ </listitem>
+
+ <listitem>
+ <para>Extract the bundle wherever you want on your hard drive</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Now, when you have it installed, we are going to demonstrate some powerful features of
+ <property moreinfo="none">JBoss Portal</property> tooling for Eclipse.</para>
+</chapter>
+
+
+<chapter id="starting_project" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/starting_project.xml" xreflabel="starting_project">
+ <?dbhtml filename="starting_project.html"?>
+ <title>Starting the Project with JBoss Portal</title>
+
+ <para>To get started with <property moreinfo="none">JBoss Portal</property> and <property moreinfo="none">JBoss
+ Tools</property>, you should first have a Web Project pointed to the JBoss Portal Runtime.
+ Thus, in this chapter we are going to show you how to create a Dynamic Web Project, add Java
+ Portlet to it and deploy it to the <property moreinfo="none">JBoss Portal</property>.</para>
+
+ <section id="creating_project_with_jbossportal">
+ <title>Creating a Dynamic Web Project</title>
+
+ <para>To create a Dynamic Web Project, go to <emphasis>
+ <property moreinfo="none">File > New > Dynamic Web Project</property>
+ </emphasis> if you are in the <property moreinfo="none">Web Perspective</property> or <property moreinfo="none">File >
+ New > Other > Web > Dynamic Web Project</property> in any other Perspective. The
+ first page of the New Dynamic Web Project wizard looks as follows.</para>
+
+ <figure float="0">
+ <title>New Dynamic Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Fill out the name of your project. Next, click the <emphasis>
+ <property moreinfo="none">New</property>
+ </emphasis> button in the <emphasis>
+ <property moreinfo="none">Target Runtime</property>
+ </emphasis> section to specify a new Target Runtime. Choose <emphasis>
+ <property moreinfo="none"> JBoss Community > JBoss 4.2 Runtime</property>
+ </emphasis> and select the <emphasis>
+ <property moreinfo="none">Create a new local server</property>
+ </emphasis> checkbox. Click <emphasis>
+ <property moreinfo="none">Next</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>New Server Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the next page you should give a name to the runtime. Let's call it <emphasis>
+ <property moreinfo="none">JBoss Portal 2.7 Runtime</property>
+ </emphasis>, and then point it to the location of your JBoss AS + Portal
+ installation.</para>
+
+ <figure float="0">
+ <title>New Server Runtime Environment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/server_runtime_environment.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+
+ <para>The JBoss Tools Portlet feature has been tested using 2.6.5 and 2.7.0.ALPHA
+ versions of <property moreinfo="none">JBoss Portal</property>. Remember, if you want to use Portlet
+ version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</para>
+ </note>
+
+ <para>At this point a new JBoss Server instance will be created. Here you can verify the
+ defined runtime information. If something is incorrect, press <emphasis>
+ <property moreinfo="none">Back</property>
+ </emphasis> to return on the previous wizard page.</para>
+
+ <figure float="0">
+ <title>Target Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>.</emphasis></para>
+
+ <para>On the next step you should click the <emphasis>
+ <property moreinfo="none">Modify</property>
+ </emphasis> button next to the <property moreinfo="none">Configuration</property> section to enable
+ Portlet Facets for the project.</para>
+
+ <figure float="0">
+ <title>Setting the Project Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On this page you should check the <emphasis>
+ <property moreinfo="none">JBoss Core Portlet</property>
+ </emphasis> and press <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis>.</para>
+
+ <figure float="0">
+ <title>Enabling the Portlet Facet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_4_a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>If the portlet libraries aren't available in the runtime you targeted,
+ JBoss Portlet facets will be hidden on this page.</para>
+ <para>To made portal functionality always visible no matter what the runtime support,
+ you should go to <emphasis>
+ <property moreinfo="none">Window > Preferences</property>
+ </emphasis> and then <emphasis>
+ <property moreinfo="none">JBoss Tools > JBoss Portlet</property>
+ </emphasis> and deselect <emphasis>
+ <property moreinfo="none">Check runtimes for Portlet Components</property>
+ </emphasis> checkbox (see figure below).</para>
+ </note>
+
+ <figure float="0">
+ <title>JBoss Runtime Preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/portlet_preferences.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The next page is for configuring web modules. Here all values are set, so you can
+ leave everything as it is.</para>
+
+ <figure float="0">
+ <title>The Project Web Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Finally, the last wizard page will ask you to add JBoss Portlet capabilities to your
+ project. Here you can choose whether to set up user libraries, libraries provided by
+ server runtime or not include libraries at all.</para>
+
+ <itemizedlist>
+ <listitem><para>To set up server runtime libraries, you need to select <emphasis>
+ <property moreinfo="none">Libraries provided by server runtime</property></emphasis> in the list box.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Including Server Runtime Libraries</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/portlet_capabilities6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>For setting up user libraries, select <emphasis>
+ <property moreinfo="none">User library</property></emphasis> in the list box and then press <emphasis>
+ <property moreinfo="none">Add</property></emphasis> in the <emphasis>
+ <property moreinfo="none">User Library</property></emphasis> section.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Adding User Library</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/portlet_capabilities1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Then press <emphasis>
+ <property moreinfo="none">New</property></emphasis> and type the user library name in the appeared dialog.</para>
+
+ <figure float="0">
+ <title>Adding User Library</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/portlet_capabilities2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Next add necessary jar's.</para>
+
+ <figure float="0">
+ <title>Adding the Portlet API Jar</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/portlet_capabilities3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Hit <emphasis>
+ <property moreinfo="none">OK</property>.</emphasis> The user library will be added.
+ </para>
+
+ <figure float="0">
+ <title>User Library Added</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/portlet_capabilities4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem><para>If you don't need to include libraries at all, just deselect the <emphasis>
+ <property moreinfo="none">Enable implementation library</property></emphasis> checkbox.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Disabling Implementation Libraries</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/portlet_capabilities5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After setting JBoss Portlet capabilities press <emphasis>
+ <property moreinfo="none">Finish</property>.</emphasis></para>
+
+ <para>That's it! Our base project is done.</para>
+
+ </section>
+
+ <section id="structure_overview">
+ <title>The Project Structure Overview</title>
+
+ <para>Now, let's look at the structure of the just created project.</para>
+
+ <figure float="0">
+ <title>The Project Structure Overview</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Here <property moreinfo="none">JBoos Tools</property> added JBoss Portlet facet to the project,
+ created an empty <emphasis>
+ <property moreinfo="none">portlet.xml</property>
+ </emphasis> file and added the Portlet library to the project classpath.</para>
+ </section>
+
+ <section id="adding_java_portlet">
+ <title>Adding a Java Portlet to the Project</title>
+
+ <para>At this point we'll show what the steps you need to proceed to add a new Java
+ Portlet to the project.</para>
+
+ <para>Call the <property moreinfo="none">Create Portlet wizard</property> by selecting <emphasis>
+ <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > Java
+ Portlet</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>New Java Portlet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The wizard fills in the Web Project and Source Folder fields for you. Then you need to
+ specify the Java package and the Class name and click <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis>.</para>
+
+ <figure float="0">
+ <title>Specifying Class File Destination</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the other page you will be able to set the display name of the Portlet, a title, a
+ description, the supported modes and init parameters.</para>
+
+ <figure float="0">
+ <title>Specifying Class File Destination</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the next screen you can define which methods from
+ <emphasis>GenericPortlet</emphasis> you want to override.</para>
+
+ <figure float="0">
+ <title>Specifying Class File Destination</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The last screen lets you build <property moreinfo="none">JBoss Portal</property> specific descriptors
+ to create an instance during the deployment and place it directly on the Portal.</para>
+
+ <figure float="0">
+ <title>Specifying Class File Destination</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+
+ <para>If you uncheck the <emphasis> Create Portlet Instance</emphasis> checkbox,
+ <property moreinfo="none">JBoss Tools</property> won't create the deployment elements
+ in the <emphasis> default-object.xml</emphasis> and <emphasis>
+ portlet-instances.xml</emphasis> files.</para>
+ </tip>
+
+ <para>Once Java Portlet is created, new resources have been added to the project structure.
+ As you can see on the figure below, it adds a Java Portlet class (<emphasis>
+ <property moreinfo="none">TestPortlet.java</property>
+ </emphasis> in our case), <emphasis>
+ <property moreinfo="none">default-object.xml</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">portlet-instances.xml</property>
+ </emphasis> files and updates <emphasis>
+ <property moreinfo="none">portlet.xml</property>
+ </emphasis> as well.</para>
+
+ <figure float="0">
+ <title>The structure of Web Project with Java Portlet created</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_12.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Thus, now the Project is ready to be built and deployed.</para>
+ </section>
+
+ <section id="deploying_to_portal">
+ <title>Deploying a Portlet to JBoss Portal</title>
+
+ <para>You can deploy the created project in the way you deploy any other Web Application.
+ Right click on the project and do <emphasis>
+ <property moreinfo="none">Run As > Run On Server</property>
+ </emphasis> and accept the defaults. On the <emphasis>
+ <property moreinfo="none">Add and Remove Projects</property>
+ </emphasis> page move the created Project to the right and click <emphasis>
+ <property moreinfo="none">Finish</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Deploying the Portlet Application</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_13.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It will deploy the Portlet Web Application and start <property moreinfo="none">JBoss
+ AS</property>.</para>
+
+ <tip>
+ <title>Tip:</title>
+
+ <para>You should use <emphasis>http://localhost:8080/portal</emphasis> URL to see your
+ Portlet in the Browser.</para>
+ </tip>
+
+ <para>In the Browser the Portlet looks as follows:</para>
+
+ <figure float="0">
+ <title>Java Portlet in the Browser Window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_14.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Consequently, here you learnt how to create a Dynamic Web Project, add Java Portlet to
+ it and deploy the project to <property moreinfo="none">JBoss Portal</property>.</para>
+ </section>
+
+</chapter>
+
+
+<chapter id="jsf_portlet" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/jsf_portlet.xml" xreflabel="jsf_portlet">
+ <?dbhtml filename="jsf_portlet.html"?>
+ <title>Creating JSF Portlet</title>
+
+ <para>This chapter will explain how you can configure JSF Portlet within Dynamic Web
+ Project and JSF Project by using the wizards <property moreinfo="none">JBoss Tools</property> provides.</para>
+
+ <section id="jsf_portlet1">
+ <title>Adding JSF Portlet to Dynamic Web Project</title>
+
+ <para>To add JSF Portlet to a Dynamic Web Project, you should set the Configuration to <emphasis>
+ <property moreinfo="none">JavaServer Faces v1.1 Project</property>
+ </emphasis> or <emphasis>
+ <property moreinfo="none">JavaServer Faces v1.2 Project</property>
+ </emphasis> and configure the JSF Portlet Facets in the <property moreinfo="none">New Dynamic Web
+ Project wizard</property> by clicking the <emphasis>
+ <property moreinfo="none">Modify</property>
+ </emphasis> button.</para>
+
+ <figure float="0">
+ <title>Setting the JSF Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the Project Facets dialog you should select <property moreinfo="none">JBoss Core Portlet</property>
+ and <property moreinfo="none">JBoss JSF Portlet</property> check boxes.</para>
+
+ <figure float="0">
+ <title>Enabling the Portlet Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Next wizard page is for configuring JSF Capabilities. You can leave everything as it
+ is here.</para>
+
+ <figure float="0">
+ <title>JSF Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To support Portlets in JSF/Seam applications <property moreinfo="none">JBoss Tools</property> works
+ with <property moreinfo="none">JBoss Portlet Bridge</property>. Thus on the next page you should add JSF Portlet
+ capabilities by pointing to the Portletbridge Runtime location.</para>
+
+ <figure float="0">
+ <title>JSF Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+
+ <para>You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink url="http://www.jboss.org/portletbridge/download/">here</ulink>.</para>
+ </tip>
+
+ <para>Next click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to organize the Project.</para>
+ <para id="add_jsf_portlet">To add JSF Portlet to generated project you should call the
+ <property moreinfo="none">Create Portlet wizard</property> by navigating to <emphasis>
+ <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam
+ Portlet</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Calling New Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As you see, the Seam and JSF Portlet wizards are merged into one. We set JSF
+ Configuration for the project, so default values in this wizard will be set as for a JSF
+ portlet.</para>
+
+ <figure float="0">
+ <title>Creating JSF Portlet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to complete JSF Portlet creation. Now you can deploy the project the same
+ way as it was <link linkend="deploying_to_portal">described above</link>.</para>
+
+ <para>In the Browser JSF Portlet looks as follows.</para>
+
+ <figure float="0">
+ <title>JSF Portlet in the Browser</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="jsf_portlet_to_JSF_project">
+ <title>Adding JSF Portlet to JSF Project</title>
+
+ <para>How to organize a JSF Project you can find out in our <ulink url="../../jsf_tools_ref_guide/html_single/index.html#new_jsf_project">JSF Tools Reference Guide</ulink>. Just
+ remember to point Target Runtime to JBoss Portal directory location.</para>
+
+ <figure float="0">
+ <title>Creating New JSF Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Before adding a Portlet to the project you should enable necessary facets for it.
+ Right-click the created project and click <emphasis>
+ <property moreinfo="none">Preferences</property>
+ </emphasis> to open the <property moreinfo="none">Project Preferences</property> screen.</para>
+ <para>On the <property moreinfo="none">Project Facets</property> page select the <emphasis>
+ <property moreinfo="none">JBoss Core Portlet</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">JBoss JSF Portlet</property>
+ </emphasis> checkboxes. And then the screen will ask you to enable <emphasis>
+ <property moreinfo="none">JavaServer Faces</property>
+ </emphasis> facet as well.</para>
+
+ <figure float="0">
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Notice, <emphasis>
+ <property moreinfo="none">"Further configuration required..."</property>
+ </emphasis> warning appears at the bottom of the screen. It means that you should click
+ it to configure JSF and JSF Portlet Capabilities in the project.</para>
+
+ <figure float="0">
+ <title>JSF Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure float="0">
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After setting the path to Portletbridge Runtime location, click <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis> and then <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis> again.</para>
+
+ <para>Now you can add JSF Portlet to the generated JSF Project. How to do it we showed in
+ <link linkend="add_jsf_portlet">the previous section</link>.</para>
+ </section>
+</chapter>
+
+
+<chapter id="seam_portlet" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/seam_portlet.xml" xreflabel="seam_portlet">
+ <?dbhtml filename="seam_portlet.html"?>
+ <title>Creating Seam Portlet</title>
+
+ <para>This chapter covers the steps on how to configure Seam Portlet within Dynamic Web
+ Project and Seam Project by using the wizards <property moreinfo="none">JBoss Tools</property> provides.</para>
+
+ <section id="seam_portlet1">
+ <title>Adding Seam Portlet to Dynamic Web Project</title>
+
+ <para>To add Seam Portlet to a Dynamic Web Project first you should organize New Dynamic Web
+ Project with the Configuration setting to <emphasis>
+ <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Calling New Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It will add all needed facets to your project. By clicking the <emphasis>
+ <property moreinfo="none">Modify</property>
+ </emphasis> button you can observe the chosen configuration of facets as well as modify
+ it. As you can see, all JBoss Portlets are checked.</para>
+
+ <figure float="0">
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Next wizard pages are for adjusting the Project Web Modules and JSF Configuration.
+ They include default values, so you can skip them by pressing <emphasis>
+ <property moreinfo="none">Next</property>.</emphasis></para>
+
+ <para>On the <property moreinfo="none">Seam Facet</property> page <ulink url="../../seam/html_single/index.html#seamFacet">set
+ Connection Profile</ulink> and hit <emphasis>
+ <property moreinfo="none">Next</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Seam Facet Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Last wizard page will prompt you to set the path to Portletbridge Runtime
+ location.</para>
+
+ <figure float="0">
+ <title>Setting the Portletbridge Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+
+ <para>Thus you should have JBoss Portlet Bridge downloaded and extracted somewhere on
+ your hard drive. You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink url="http://www.jboss.org/portletbridge/download/"><diffmk:wrapper diffmk:change="changed">www.jboss.org/portletbridge/download</diffmk:wrapper></ulink>.</para>
+ </tip>
+
+ <para>Now, to add Seam Portlet to the project you should follow to <emphasis>
+ <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam
+ Portlet</property>.</emphasis> This will call the wizard for creating JSF/Seam
+ Portlets.</para>
+
+ <figure float="0">
+ <title>Calling the Create Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As we set Seam Configuration for the Dynamic Web Project, the wizard puts the values
+ as for Seam Portlet.</para>
+
+ <figure float="0">
+ <title>Creating Seam Portlet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After creating the Seam Portlet, you should <link linkend="deploying_to_portal">deploy
+ the project to JBoss Portal</link> and start the Server. In a Browser
+ you'll see the following:</para>
+
+ <figure float="0">
+ <title>Seam Portlet in the Browser</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="seam_portlet_to_seam_project">
+ <title>Adding Seam Portlet to Seam Project</title>
+
+ <para>First start a Seam Project by following to <emphasis>
+ <property moreinfo="none">New > Other > Seam > Seam Web Project</property>. </emphasis> On the first
+ wizard page specify JBoss Portal directory location as <property moreinfo="none">Target
+ Runtime</property> and <emphasis>
+ <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>
+ </emphasis> as <property moreinfo="none">Configuration</property>.</para>
+
+ <figure float="0">
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Next steps will be the same as we did for the Dynamic Web Project in the <link linkend="seam_portlet1">Adding Seam Portlet to Dynamic Web Project</link>
+ section.</para>
+ </section>
+</chapter>
+
+
+<chapter id="portlets_to_nonWTP_projects" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/portlets_to_nonWTP_projects.xml" xreflabel="portlets_to_nonWTP_projects">
+ <?dbhtml filename="portlets_to_nonWTP_projects.html"?>
+ <title>Adding Portlets to non-WTP Projects</title>
+
+ <para>Starting from <property moreinfo="none">JBoss Tools 3.0.0.Beta1</property> version the JBoss Portlet
+ wizards no longer require a WTP project to be able to create Portlets.</para>
+
+ <note>
+ <title>Note:</title>
+ <para>Please note, if the project does not have the proper portlet API jar's, the generated
+ classes will have compile errors.</para>
+ </note>
+
+ <para>In conclusion, with this document you've learnt how to get started with <property moreinfo="none">JBoss
+ Portal</property> using <property moreinfo="none">JBoss Tools</property> suite of Eclipse plugins.
+ The above chapters walked you through the steps on how to organize a web project with
+ portlets which includes a sample staff and deploy it onto the <property moreinfo="none">JBoss
+ Portal</property>.</para>
+
+ <para>If you still have questions or suggestions you are always welcome on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">Forum</ulink>. Your feedback will be very much appreciated.</para>
+
+</chapter>
+
+
+</book>
15 years, 2 months
JBoss Tools SVN: r15201 - in branches/jbosstools-3.0.x/jsf/docs: jsf_tools_ref_guide/en and 11 other directories.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:38:13 -0400 (Mon, 11 May 2009)
New Revision: 15201
Removed:
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/web_projects/web_projects_15.png
Modified:
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master.xml
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/modules/introduction.xml
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/pom.xml
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/images/jsf_application/jsf_application_10.png
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master.xml
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/adding_navigation.xml
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/introduction.xml
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/jsp_view_files.xml
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/running_application.xml
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/pom.xml
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/palette/palette_3.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/palette/palette_8.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_15.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_16.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_31.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_32.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_33.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_7.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_8.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/web_projects/web_projects_11.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/master.xml
branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/Visual_Web_Tools.xml
branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/editors.xml
branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/preferences.xml
branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/richfaces_support.xml
branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/web_projects.xml
branches/jbosstools-3.0.x/jsf/docs/userguide/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -41,7 +41,7 @@
<holder>JBoss, a division of Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 3.0.0.GA
+ Version: 3.0.1.GA
</releaseinfo>
<abstract>
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/modules/introduction.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/modules/introduction.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/modules/introduction.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -106,7 +106,7 @@
</section>
<section>
<title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/">here</ulink>.</para>
- <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
+ <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
+ <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/pom.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/pom.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -77,6 +77,11 @@
<artifactId>jbosstools-docbook-xslt</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
</dependencies>
<configuration>
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/images/jsf_application/jsf_application_10.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -42,7 +42,7 @@
</copyright>
<releaseinfo>
- Version: 3.0.0.GA
+ Version: 3.0.1.GA
</releaseinfo>
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/adding_navigation.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/adding_navigation.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/adding_navigation.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -69,18 +69,14 @@
<itemizedlist>
<listitem>
<para>In the diagram, select the connection icon third from the top along
- the upper left side of the diagram</para>
+ the upper left side of the diagram (<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_3.png"/>
+ </imageobject>
+ </inlinemediaobject>) to get an arrow cursor with a two-pronged plug at the arrow's bottom.</para>
</listitem>
</itemizedlist>
- <figure>
- <title>Connection Icon</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>to get an arrow cursor with a two-pronged plug at the arrow's bottom.</para>
+
<itemizedlist>
<listitem>
<para>Click on the <emphasis>
@@ -108,5 +104,5 @@
</listitem>
</itemizedlist>
</section>
-
+
</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/introduction.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/introduction.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/introduction.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -24,8 +24,8 @@
<section>
<title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://www.jboss.com/products/devstudio/docs">here</ulink>.</para>
- <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
+ <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
+ <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/jsp_view_files.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/jsp_view_files.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/jsp_view_files.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -155,7 +155,7 @@
<body>
<f:view>
<h:form id="greeting">
-<para>Please enter a name:</para>
+Please enter name:
<h:inputText id="name" value="#{personBean.name}"/>
<h:commandButton value=" Say Hello " action="greeting"/>
</h:form>
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/running_application.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/running_application.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/modules/running_application.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -30,19 +30,16 @@
</listitem>
<listitem>
- <para>Click the Run icon or right click your project folder and select <emphasis>
+ <para>Click the Run icon(<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_10.png"/>
+ </imageobject>
+ </inlinemediaobject>) or right click your project folder and select <emphasis>
<property>Run As > Run on Server</property>
</emphasis>:</para>
</listitem>
</itemizedlist>
- <figure>
- <title>Run Icon</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+
<para>This is the equivalent of launching the browser and typing <emphasis>
<property>http://localhost:8080/jsfHello</property>
</emphasis> into your browser. Our <property>JSF application</property> should now
Modified: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/pom.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/pom.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -77,6 +77,11 @@
<artifactId>jbosstools-docbook-xslt</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
</dependencies>
<configuration>
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/palette/palette_3.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/palette/palette_8.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_15.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_16.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_31.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_32.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_33.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_7.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/preferences/preferences_8.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/web_projects/web_projects_11.png
===================================================================
(Binary files differ)
Deleted: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/web_projects/web_projects_15.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/master.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/userguide/en/master.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/userguide/en/master.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -10,6 +10,7 @@
<!ENTITY richfaces_support SYSTEM "modules/richfaces_support.xml">
<!ENTITY web_projects SYSTEM "modules/web_projects.xml">
<!ENTITY preferences SYSTEM "modules/preferences.xml">
+<!ENTITY vwt_faq SYSTEM "modules/vwt_faq.xml">
<!ENTITY seamlink "../../seam/html_single/index.html">
<!ENTITY aslink "../../as/html_single/index.html">
@@ -36,7 +37,7 @@
<holder>JBoss, a division of Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 2.0.0.GA
+ Version: 2.0.1.GA
</releaseinfo>
<abstract>
<title/>
@@ -56,4 +57,5 @@
&richfaces_support;
&web_projects;
&preferences;
+ &vwt_faq;
</book>
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/Visual_Web_Tools.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/Visual_Web_Tools.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/Visual_Web_Tools.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -80,7 +80,7 @@
<row>
<entry>JBoss Tools Palette</entry>
<entry>Organizing 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 controling the number
+ click, adding custom or 3rd party tag libraries into the palette, easy controlling the number
of tag groups shown on the palette.</entry>
<entry>
<link linkend="palette">jboss tools palette</link>
@@ -123,7 +123,7 @@
<entry>Possibility 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
- draging to source code.</entry>
+ dragging to source code.</entry>
<entry>
<link linkend="visual_page">visual page editor</link>
<link linkend="DragAndDrop">drag-and-drop</link>
@@ -146,8 +146,8 @@
<section>
<title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://www.jboss.com/products/devstudio/docs">here</ulink>.</para>
- <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
+ <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
+ <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/editors.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/editors.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/editors.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -609,9 +609,8 @@
<itemizedlist>
<listitem>
<para>Adds code assist for JSF pre-defined objects, such as
- <![CDATA[value=]]><emphasis role="italic">
- <property>"#{param}"</property>
- </emphasis>:</para>
+ <code>value="#{param}"</code>
+ :</para>
</listitem>
</itemizedlist>
<programlisting role="XML"><![CDATA[<AttributeType ...>
@@ -746,7 +745,7 @@
<para><property>JBoss Developer Studio</property> comes with a powerful and customizable
<property>Visual Page Editor</property> (VPE). You can use the Visual Page Editor to
- develop an application using any technology: JSF, Struts, JSP, HTML and others.</para>
+ 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).</para>
<para>Current VPE version has three tabs: <property>Visual/Source</property>,
<property>Source</property> and <property>Preview</property>. To switch between the
@@ -817,7 +816,7 @@
</imageobject>
</mediaobject>
</figure>
- <para> You can insert a tag/component from the pallet into either the Source or the
+ <para> You can insert a tag/component from the palette into either the Source or the
Visual part by calling a context menu and selecting <property>Insert
around</property>, <property>Insert before</property>, <property>Insert
after</property> or <property>Replace With</property>, pointing to
@@ -891,14 +890,12 @@
<itemizedlist>
<listitem>
- <para>HTML comments (<emphasis>
- <property><!-- --></property>
- </emphasis>) which are output to the client </para>
+ <para>HTML comments (<code><!-- --></code>) which are output to the client </para>
</listitem>
<listitem>
- <para>JSP comments (<emphasis>
- <property><%-- --%></property>
- </emphasis>) which are not output to the client as part of the JSP page
+ <para>JSP comments (<code>
+ <%-- --%>
+ </code>) which are not output to the client as part of the JSP page
output</para>
</listitem>
</itemizedlist>
@@ -970,12 +967,12 @@
different parameters or preview according to the framework version (like seam
1.2 and seam 2.0, or JSF 1.1 and JSF 1.2).</para>
- <para>For example, <emphasis>
- <property><s:decorate></property>
- </emphasis> element in seam has different parameters in versions 1.2 and 2.0 as
- well as <emphasis>
- <property><h:outputLink></property>
- </emphasis> JSF element has different preview in versions 1.1 and 1.2.</para>
+ <para>For example, <code>
+ <s:decorate>
+ </code> element in seam has different parameters in versions 1.2 and 2.0 as
+ well as
+ <code><h:outputLink></code>
+ JSF element has different preview in versions 1.1 and 1.2.</para>
</section>
</section>
@@ -1086,9 +1083,9 @@
<emphasis>
<property>Boxes</property>, </emphasis>
<emphasis>
- <property>Property Sheet</property>. </emphasis>To add existing styling to
- the chosen element expand the list of the existed style classes and point to the
- necessary one.</para>
+ <property>Property Sheet</property>. </emphasis>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 <emphasis><property>Apply</property></emphasis> button will apply the changes without closing the window.</para>
<figure>
<title>Style Class Selection</title>
@@ -1377,8 +1374,7 @@
<para>The third one, <emphasis>
- <property>Included tag libs</property>
- </emphasis>, can be used to add Taglibs that can be used by the editor for
+ <property>Included tag libs</property></emphasis>, can be used to add Taglibs that can be used by the editor for
getting appropriate templates to generate a preview:</para>
<figure>
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/preferences.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/preferences.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/preferences.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -58,7 +58,7 @@
<listitem>
<para>
- <link linkend="JSFPropject">JSF Propject</link>
+ <link linkend="JSFPropject">JSF Project</link>
</para>
</listitem>
@@ -594,7 +594,7 @@
</itemizedlist>
<figure>
- <title>New JSF Propject Preferences</title>
+ <title>New JSF Project Preferences</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/preferences/preferences_13.png"/>
@@ -611,7 +611,7 @@
</emphasis> or not.</para>
<figure>
- <title>Import JSF Propject Preferences</title>
+ <title>Import JSF Project Preferences</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/preferences/preferences_14.png"/>
@@ -739,6 +739,31 @@
</mediaobject>
</figure>
</section>
+
+ <section id="SeamPagesDiagram">
+ <?dbhtml filename="SeamPagesDiagram.html"?>
+ <title>Seam Pages Diagram</title>
+
+
+
+ <para>In order to customize the layout of the Diagram used for editing and composing <property>page.xml</property> file in <property>Graphical mode</property> of <property>Seam Pages Editor</property> you can go to
+ <property>Window > Preferences > JBoss Tools > Web > Seam > Editors > Seam Pages Diagram</property>.
+ </para>
+
+ <figure>
+ <title>Preferences of Seam Pages Diagram</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/preferences/preferences_44.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+
+
+
<section id="Struts">
<?dbhtml filename="Struts.html"?>
@@ -761,7 +786,7 @@
<title>Struts Automation</title>
<para>On <emphasis>
<property>Automation</property>
- </emphasis> panel you can modify default text for the Tilel Struts plug-in element, the
+ </emphasis> panel you can modify default text for the Title Struts plug-in element, the
Validator Struts plug-in element, and error message resource files.</para>
<figure>
<title>Struts Automatic</title>
@@ -956,7 +981,7 @@
<property>JBoss Tools > Web > Verification</property>
</emphasis> page.</para>
<para>On Rules Configuration tab of <emphasis>
- <property>Verifcation</property>
+ <property>Verification</property>
</emphasis> panel you can determine JSF and Struts rules.</para>
<figure>
<title>Verification</title>
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/richfaces_support.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/richfaces_support.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/richfaces_support.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -17,7 +17,7 @@
<note>
<title>Note:</title>
<para><ulink url="http://www.jboss.org/jbossrichfaces/downloads/">RichFaces
- 3.3</ulink> is fully supported in the current version of <property>JBoss Developer Studio</property> (i. e. 2.0.0.GA) and <property>JBoss Tools 3.0.0.GA</property>.</para>
+ 3.3</ulink> is fully supported in the current version of <property>JBoss Developer Studio</property> (i. e. 2.0.1.GA) and <property>JBoss Tools 3.0.1.GA</property>.</para>
</note>
<para>The following features are implemented and fully supported for the current version of the RichFaces components:</para>
@@ -69,11 +69,11 @@
<property>.jsp/.xhtml</property></emphasis> pages in <property>VPE</property> you can also take the advantage of <emphasis>
<property>OpenOn</property></emphasis> feature for the <property>RichFaces</property> components.</para>
- <para>For example, <property>Richfaces</property> tags <emphasis>
- <property><rich:insert></property>
- </emphasis> and <emphasis>
- <property><a4j:include></property>
- </emphasis> has <property>OpenOn</property> support.</para>
+ <para>For example, <property>Richfaces</property> tags
+ <code><rich:insert></code>
+ and <code>
+ <a4j:include>></code>
+ has <property>OpenOn</property> support.</para>
<figure>
<title>OpenOn With Richfaces Tag</title>
@@ -97,7 +97,7 @@
<section id="RF_in_palette">
<title>RichFaces in the JBoss Tools Palette</title>
- <para>RichFaces and Ajax4jsf tag libraries always exist in <link linkend="palette">JBoss Tools
+ <para>RichFaces and<link linkend="palette">JBoss Tools
Palette</link>.</para>
<figure>
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/web_projects.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/web_projects.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/web_projects.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -68,7 +68,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>Drag the property and drop it between the quotes for the value attribute in the JSP file. Notice that JBoss Developer Studio added the correctly formatted expression for referring to the property value <emphasis><property>#{Message.header}</property></emphasis> automatically.</para>
+ <para>Drag the property and drop it between the quotes for the value attribute in the JSP file. Notice that JBoss Developer Studio added the correctly formatted expression for referring to the property value <code>#{Message.header}</code> automatically.</para>
<figure>
<title>Inserted Property</title>
<mediaobject>
@@ -78,7 +78,7 @@
</mediaobject>
</figure>
<para>You can actually place the tag anywhere in the page, not just inside an existing tag. In this case,
- JBoss Developer Studio will place the complete tag <emphasis><property><h:outputText value="#{Message.header}"/></property></emphasis> in the page.</para>
+ JBoss Developer Studio will place the complete tag <code><h:outputText value="#{Message.header}"/></code> in the page.</para>
</section>
<section id="ForManagedBeanAttributes">
@@ -93,7 +93,7 @@
</imageobject>
</mediaobject>
</figure>
-<para>Once again, JBoss Developer Studio adds the correct expression, <emphasis>#{user.name}</emphasis>.</para>
+<para>Once again, JBoss Developer Studio adds the correct expression, <code>#{user.name}</code>.</para>
<figure>
<title>Added Expression</title>
<mediaobject>
@@ -118,7 +118,7 @@
</figure>
<para>Drag and drop it inside the commandButton tag:</para>
<figure>
-<title>Naviagation Rule in CommandButton Tag</title>
+<title>Navigation Rule in CommandButton Tag</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/web_projects/web_projects_8.png"/>
@@ -201,17 +201,31 @@
<title>Expanding Tag Library Files</title>
-<para>You can easily expand any TLD file in the project. Browse to the Tag Libraries folder. Right-click a TLD file and select <emphasis><property>Expand</property></emphasis>. The TLD file will now be expanded.</para>
+<para>You can easily expand any TLD file in the project. Browse to the Tag Libraries folder. Right-click a TLD file and select <emphasis><property>Set Expanded</property></emphasis>:</para>
+
+ <figure>
+ <title>Expanding Tag Library File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/web_projects/web_projects_15a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> The TLD file will now be expanded:</para>
+ <figure>
+ <title>Expanded File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/web_projects/web_projects_15b.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
<para>You can then select any tag and drag it onto a JSP page.</para>
-<figure>
-<title>Expanding Tag Library File</title>
-<mediaobject>
- <imageobject>
- <imagedata fileref="images/web_projects/web_projects_15.png"/>
- </imageobject>
-</mediaobject>
-</figure>
+
</section>
<section id="DragAndDropTagLibrariesOnToRedHatPalette">
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/userguide/pom.xml 2009-05-11 16:37:33 UTC (rev 15200)
+++ branches/jbosstools-3.0.x/jsf/docs/userguide/pom.xml 2009-05-11 16:38:13 UTC (rev 15201)
@@ -77,6 +77,11 @@
<artifactId>jbosstools-docbook-xslt</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
</dependencies>
<configuration>
15 years, 2 months
JBoss Tools SVN: r15200 - branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:37:33 -0400 (Mon, 11 May 2009)
New Revision: 15200
Added:
branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/vwt_faq.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Copied: branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/vwt_faq.xml (from rev 15128, trunk/jsf/docs/userguide/en/modules/vwt_faq.xml)
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/vwt_faq.xml (rev 0)
+++ branches/jbosstools-3.0.x/jsf/docs/userguide/en/modules/vwt_faq.xml 2009-05-11 16:37:33 UTC (rev 15200)
@@ -0,0 +1,50 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<chapter id="vwt_faq" xreflabel="vwt_faq">
+ <?dbhtml filename="vwt_faq.html"?>
+ <title>FAQ</title>
+
+ <section id="question_1">
+ <title>What should I do if Visual Page Editor does not start under Linux?</title>
+
+ <para> The <property>Visual Page Editor</property> requires the library libstdc++.so.5. This library is
+ contained in the compat-libstdc++-33.i386 package.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>To install this package on Fedora Core or Red Hat Enterprise Linux run the
+ following command:</para>
+ <programlisting role="JAVA"><![CDATA[yum install compat-libstdc++-33.i386
+]]></programlisting>
+ </listitem>
+
+ <listitem>
+ <para>On any other rpm based distributions download libstdc++.so.5 and run the
+ following command:</para>
+ <programlisting role="JAVA"><![CDATA[rpm -Uvh compat-libstdc++-33.i386
+]]></programlisting>
+ </listitem>
+
+ <listitem>
+ <para>On Debian based distributives run the following command: </para>
+ <programlisting role="JAVA"><![CDATA[apt-get install compat-libstdc++-33.i386
+]]></programlisting>
+ </listitem>
+ </itemizedlist>
+
+ <para> In case you have the library installed and you still have issue with starting the
+ <property>Visual Page Editor</property> then close all browser views/editors and leave one <property>Visual Page
+ Editor</property> open and restart eclipse. This should force a load of the right XULRunner
+ viewer.</para>
+ </section>
+
+ <section id="question_2">
+ <title>How do I change the auto-formating preferences for the Visual Page Editor?</title>
+
+ <para>JBoss HTML/JSP editor uses basic eclipse HTML formatter to format files. So if you
+ want to change preferences of formatter for the <property>Visual Page Editor</property>, you should change it
+ for eclipse html editor (open <emphasis><property>Window >
+ Preferences</property>,</emphasis> then choose <emphasis>
+ <property>Web > HTML Files > Editor</property>
+ </emphasis>).</para>
+ </section>
+</chapter>
15 years, 2 months
JBoss Tools SVN: r15199 - branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/web_projects.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:37:24 -0400 (Mon, 11 May 2009)
New Revision: 15199
Added:
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/web_projects/web_projects_15a.png
branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/web_projects/web_projects_15b.png
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Copied: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/web_projects/web_projects_15a.png (from rev 15128, trunk/jsf/docs/userguide/en/images/web_projects/web_projects_15a.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/jsf/docs/userguide/en/images/web_projects/web_projects_15b.png (from rev 15128, trunk/jsf/docs/userguide/en/images/web_projects/web_projects_15b.png)
===================================================================
(Binary files differ)
15 years, 2 months
JBoss Tools SVN: r15198 - branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:37:05 -0400 (Mon, 11 May 2009)
New Revision: 15198
Added:
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml
Removed:
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Deleted: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml 2009-05-11 16:36:49 UTC (rev 15197)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml 2009-05-11 16:37:05 UTC (rev 15198)
@@ -1,798 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.docbook.org/xml/4.3/docbookx.dtd"
-
-[<!ENTITY introduction SYSTEM "modules/introduction.xml">
-<!ENTITY jsf_application SYSTEM "modules/jsf_application.xml">
-<!ENTITY adding_navigation SYSTEM "modules/adding_navigation.xml">
-<!ENTITY adding_managed_bean SYSTEM "modules/adding_managed_bean.xml">
-<!ENTITY jsp_view_files SYSTEM "modules/jsp_view_files.xml">
-<!ENTITY start_page SYSTEM "modules/start_page.xml">
-<!ENTITY running_application SYSTEM "modules/running_application.xml">
-<!ENTITY relevant_resources SYSTEM "modules/relevant_resources.xml">
-
-<!ENTITY seamlink "../../seam/html_single/index.html">
-<!ENTITY aslink "../../as/html_single/index.html">
-<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
-<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
-<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
-<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
-<!ENTITY jsflink "../../jsf/html_single/index.html">
-<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
-<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
-<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
-<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
-
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>JSF Tools Tutorial</title>
-
- <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
- <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
- <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
-
- <pubdate>April 2008</pubdate>
- <copyright>
- <year>2007</year>
- <year><diffmk:wrapper diffmk:change="changed">2009</diffmk:wrapper></year>
- <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
- </copyright>
-
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 3.0.0.GA
- </diffmk:wrapper></releaseinfo>
-
-
-<abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_tutoria...">PDF version</ulink>
- </para>
-</abstract>
-
-
- </bookinfo>
-
- <toc></toc>
-
-
-
-<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/introduction.xml" xreflabel="introduction">
- <?dbhtml filename="introduction.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
- <title>Introduction</title>
- <para>The following chapters describe how to deal with classic/old style of JSF development. We
- recommend users to use <ulink url="../../seam/html_single/index.html">JBoss
- Seam</ulink> to simplify development, but until then you can read about classical JSF
- usage here.</para>
-
- <para>Thus, in this document we are going to show you how to create a simple <property moreinfo="none">JSF application
- </property>using <property moreinfo="none">JBoss Tools</property> plugins for Eclipse. The completed
- application will ask a user to enter a name and click a button. The resulting new page
- will display the familiar message, "Hello <name>!" This
- tutorial will show you how to create and run such an application from the beginning along the
- way demonstrating some of the powerful features of <property moreinfo="none">JBoss Tools</property>.</para>
-
- <section>
- <title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://www.jboss.com/products/devstudio/docs">here</ulink>.</para>
- <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
- </section>
-
-</chapter>
-
-
-<chapter id="jsf_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/jsf_application.xml" xreflabel="jsf_application">
- <?dbhtml filename="jsf_application.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Creating a Simple JSF Application</title>
-
- <para>Firstly, we assume that you have already launched Eclipse with <property moreinfo="none">JBoss Tools</property>
- plug-ins installed and also that the <property moreinfo="none">Web Development perspective</property> is the current
- one. (If not, make it active by selecting <emphasis>
- <property moreinfo="none">Window > Open Perspective > Web Development</property>
- </emphasis> from the menu bar or by selecting <emphasis>
- <property moreinfo="none">Window > Open Perspective > Other...</property>
- </emphasis> from the menu bar and then selecting <emphasis>
- <property moreinfo="none">Web Development</property>
- </emphasis> from the Select Perspective dialog box.)</para>
-
- <section id="setting_up_the_project">
- <?dbhtml filename="SettingUpTheProject.html"?>
- <title>Setting Up the Project</title>
- <para>Now we are going to create a new project for the application.</para>
- <itemizedlist>
- <listitem>
- <para>For that go to the menu bar and select <emphasis>
- <property moreinfo="none">File > New > Project...</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">JBoss Tools Web > JSF > JSF Project</property>
- </emphasis> in the New Project dialog box</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Enter "jsfHello" as the project name.</para>
- </listitem>
- <listitem>
- <para>Leave everything else as is, and click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis></para>
- </listitem>
-
- </itemizedlist>
- </section>
-
- <section id="TheJSFApplicationConfigurationFile">
- <?dbhtml filename="TheJSFApplicationConfigurationFile.html"?>
- <title>JSF Configuration File</title>
- <para>A jsfHello node should appear in the upper-left Package Explorer view.</para>
- <figure float="0">
- <title>Package Explorer View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Click the plus sign next to <emphasis>
- <property moreinfo="none">jsfHello</property>
- </emphasis> to reveal the child nodes</para>
- </listitem>
- <listitem>
- <para>Click the plus sign next to <emphasis>
- <property moreinfo="none">WebContent</property>
- </emphasis> under jsfHello</para>
- </listitem>
- <listitem>
- <para>Click the plus sign next to <emphasis>
- <property moreinfo="none">WEB-INF</property>
- </emphasis> under WebContent</para>
- </listitem>
-
- <listitem>
- <para>Then double-click on the <property moreinfo="none">faces-config.xml</property> node to display
- the JSF application configuration file editor</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Configuration File Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-</chapter>
-
-
-<chapter id="adding_navigation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/adding_navigation.xml" xreflabel="adding_navigation">
- <?dbhtml filename="adding_navigation.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Adding Navigation to the Application</title>
-
- <para>In our simple application, the flow is defined as a single navigation rule connecting
- two views (presentation files). At this point, we will create the placeholders for the
- two JSP presentation files and then the navigation rule to connect them as views. Later,
- we will complete the coding for the JSP presentation files. We can do all of this in the
- Diagram mode of the configuration file editor.</para>
- <section id="AddingTwoViewsJSPPages">
- <?dbhtml filename="AddingTwoViewsJSPPages.html"?>
- <title>Adding Two Views (JSP Pages)</title>
- <itemizedlist>
- <listitem>
- <para>Right-click anywhere on the diagram and select <emphasis>
- <property moreinfo="none">New View...</property>
- </emphasis> from the pop-up menu</para>
- </listitem>
- <listitem>
- <para>In the dialog box, type <emphasis>
- <property moreinfo="none">pages/inputname</property>
- </emphasis> as the value for From-view-id</para>
- </listitem>
- <listitem>
- <para>Leave everything else as is</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis></para>
- <para>If you look in the Package Explorer view you should see a <emphasis>
- <property moreinfo="none">pages</property>
- </emphasis> folder under WebContent. Opening it will reveal the JSP file you
- just created</para>
- </listitem>
- <listitem>
- <para>Back on the diagram, right-click anywhere and select <emphasis>
- <property moreinfo="none">New View...</property>
- </emphasis> from the pop-up menu</para>
- </listitem>
- <listitem>
- <para>In the dialog box, type <emphasis>
- <property moreinfo="none">pages/greeting</property>
- </emphasis> as the value for From-view-id</para>
- </listitem>
- <listitem>
- <para>Leave everything else as is</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
-
- </section>
- <section id="CreatingTheTransitionNavigationRule">
- <?dbhtml filename="CreatingTheTransitionNavigationRule.html"?>
- <title>Creating the Transition (Navigation Rule)</title>
- <itemizedlist>
- <listitem>
- <para>In the diagram, select the connection icon third from the top along
- the upper left side of the diagram</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Connection Icon</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>to get an arrow cursor with a two-pronged plug at the arrow's bottom.</para>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property moreinfo="none">pages/inputname</property>
- </emphasis> page icon and then click on the <emphasis>
- <property moreinfo="none">pages/greeting</property>
- </emphasis> page icon</para>
- </listitem>
-
- </itemizedlist>
- <para>A transition should appear between the two icons.</para>
- <figure float="0">
- <title>Transition Between Two Icons</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">File > Save</property>
- </emphasis> from the menu bar</para>
- </listitem>
- </itemizedlist>
- </section>
-
-</chapter>
-
-<chapter id="adding_managed_bean" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/adding_managed_bean.xml" xreflabel="adding_managed_bean">
- <?dbhtml filename="adding_managed_bean.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Adding a Managed Bean to the Application</title>
- <para>To store data in the application, we will use a managed bean.</para>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property moreinfo="none">Tree</property>
- </emphasis> tab at the bottom of the editing window</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis>
- <property moreinfo="none">Managed Beans</property>
- </emphasis> node and then click the <emphasis>
- <property moreinfo="none">Add...</property>
- </emphasis> button displayed along the right side of the editor window</para>
- </listitem>
- <listitem>
- <para>Type in <emphasis>
- <property moreinfo="none">jsfHello.PersonBean</property>
- </emphasis> for Class and <emphasis>
- <property moreinfo="none">personBean</property>
- </emphasis> for Name. Leave Scope as is and Generate Source Code as is
- (checked)</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>personBean will now be selected and three sections of information: <emphasis>
- <property moreinfo="none">Managed Bean</property>
- </emphasis>, <emphasis>
- <property moreinfo="none">Properties</property>
- </emphasis>, and <emphasis>
- <property moreinfo="none">Advanced</property>
- </emphasis>, will be displayed about it. Under the Properties section, click the <emphasis>
- <property moreinfo="none">Add...</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Type in <emphasis>
- <property moreinfo="none">name</property>
- </emphasis> for Property-Name. Leave everything else as is. (When Property-
- Class is not filled in, String is the assumed type)</para>
- </listitem>
- <listitem>
- <para>Click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>Select the <emphasis>
- <property moreinfo="none">personBean</property>
- </emphasis> node in the tree</para>
- </listitem>
- </itemizedlist>
- <para>You should see this now:</para>
- <figure float="0">
- <title>Tree View in Config Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">File > Save</property>
- </emphasis> from the menu bar</para>
- </listitem>
- </itemizedlist>
- <para>You have now registered the <emphasis>
- <property moreinfo="none">managed bean</property>
- </emphasis> and created a <emphasis>
- <property moreinfo="none">stub-coded class</property>
- </emphasis> file for it.</para>
-
- </chapter>
-
-<chapter id="jsp_view_files" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/jsp_view_files.xml" xreflabel="jsp_view_files">
- <?dbhtml filename="jsp_view_files.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Editing the JSP View Files</title>
-
- <para>Now we will finish editing the JSP files for our two "views" using
- JSP Visual Page.</para>
- <section id="Inputname.jsp">
- <title>inputname.jsp</title>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property moreinfo="none">Diagram</property>
- </emphasis> tab for the configuration file editor</para>
- </listitem>
- <listitem>
- <para>Open the editor for this first JSP file by double-clicking on the <emphasis>
- <property moreinfo="none">/pages/inputname. jsp</property>
- </emphasis> icon</para>
- </listitem>
- </itemizedlist>
-
- <para>The Visual Page Editor will open in a screen split between source code along the
- top and a WYSIWIG view along the bottom:</para>
- <figure float="0">
- <title>Visual Page Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Some JSF code is already in the file, because we have chosen a template to create
- a page.</para>
- <itemizedlist>
- <listitem>
- <para>Select the <emphasis>
- <property moreinfo="none">Visual</property>
- </emphasis> tab, so we can work with the editor completely in its WYSIWYG
- mode</para>
- </listitem>
- <listitem>
- <para>To the right of the editor, in the JBoss Tools Palette, expand the <emphasis>
- <property moreinfo="none">JSF HTML</property>
- </emphasis> palette folder by selecting it</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>JBoss Tools Palette</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Click on <emphasis>
- <property moreinfo="none">form</property>
- </emphasis> within this folder, drag the cursor over to the editor, and drop
- it inside the red box in the editor</para>
- </listitem>
- <listitem>
- <para>Another red box will appear inside the first red box</para>
- </listitem>
- <listitem>
- <para>Right-click on the innermost box and select <emphasis role="bold">
- <property moreinfo="none"><h:form></property>
- </emphasis> Attributes from the menu</para>
- </listitem>
- <listitem>
- <para>In the value field next to id, type <emphasis>
- <property moreinfo="none">greeting</property>
- </emphasis> and click on the <emphasis>
- <property moreinfo="none">Close</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Type "Please enter name:" inside the boxes</para>
- </listitem>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">inputText</property>
- </emphasis> within the JSF HTML palette folder and drag it into the
- innermost box in the editor after "Please enter
- name:"</para>
- </listitem>
- <listitem>
- <para>In the attributes dialog, click in the <emphasis>
- <property moreinfo="none">value</property>
- </emphasis> field next to the value attribute and click on the <property moreinfo="none">...
- </property>button</para>
- </listitem>
- <listitem>
- <para>Then, select the <emphasis>
- <property moreinfo="none">Managed Beans > personBean > name</property>
- </emphasis> node and click on the <emphasis>
- <property moreinfo="none">Ok</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Back in the attributes dialog, select the <emphasis>
- <property moreinfo="none">Advanced</property>
- </emphasis> tab, type in <emphasis>
- <property moreinfo="none">name</property>
- </emphasis> as the value for the <emphasis role="italic">
- <property moreinfo="none">"id"</property>
- </emphasis> attribute, and then click on the <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">commandButton</property>
- </emphasis> within the JSF HTML palette folder and drag it into the
- innermost box in the editor after the input box</para>
- </listitem>
- <listitem>
- <para>In the attributes dialog, click in the value field next to the <emphasis role="italic">
- <property moreinfo="none">"action"</property>
- </emphasis> attribute and click on the <property moreinfo="none">...
- </property>button</para>
- </listitem>
- <listitem>
- <para>Then, select the <emphasis>
- <property moreinfo="none">View Actions > greeting</property>
- </emphasis> node and click on the <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Back in the attributes dialog box, type in "Say Hello"
- as the value for the value attribute ("Say Hello") and
- then click on the <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> button</para>
- </listitem>
- </itemizedlist>
- <para>The source coding should be something like this now:</para>
- <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
-<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
-<html>
-<head>
-<title></title>
-</head>
-<body>
-<f:view>
-<h:form id="greeting">
-<para>Please enter a name:</para>
-<h:inputText id="name" value="#{personBean.name}"/>
-<h:commandButton value=" Say Hello " action="greeting"/>
-</h:form>
-</f:view>
-</body>
-</html>
-]]></programlisting>
- <para>The editor should look like this:</para>
- <figure float="0">
- <title>Visual Page Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Save the file by selecting <emphasis>
- <property moreinfo="none">File > Save</property>
- </emphasis> from the menu bar</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="Greeting.jsp">
- <title>greeting.jsp</title>
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis>
- <property moreinfo="none">faces-config.xml</property>
- </emphasis> tab to bring the diagram back</para>
- </listitem>
- <listitem>
- <para>Open the editor for the second file by double-clicking on the <emphasis>
- <property moreinfo="none">/pages/greeting.jsp</property>
- </emphasis> icon</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis>
- <property moreinfo="none">Visual</property>
- </emphasis> tab, so we can work with the editor completely in its WYSIWYG
- mode</para>
- </listitem>
- <listitem>
- <para>Type "Hello "(note space after Hello) into the
- box</para>
- </listitem>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">outputText</property>
- </emphasis> within the JSF HTML palette folder and drag it into the
- innermost box in the editor after "Hello"</para>
- </listitem>
- <listitem>
- <para>In the attributes dialog, click in <emphasis>
- <property moreinfo="none">value</property>
- </emphasis> field next to the value attribute and click on the
- <property moreinfo="none">...</property> (Browse) button</para>
- </listitem>
- <listitem>
- <para>Then, select the <emphasis>
- <property moreinfo="none">Managed Beans > personBean > name</property>
- </emphasis> node, click on the <emphasis>
- <property moreinfo="none">Ok</property>
- </emphasis> button, and then click on the <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> button</para>
- </listitem>
- <listitem>
- <para>Right after the output field, type an <emphasis>
- <property moreinfo="none">exclamation point</property>
- </emphasis> (<emphasis>
- <property moreinfo="none">!</property>
- </emphasis>)</para>
- </listitem>
- </itemizedlist>
- <para>The source coding should be something like this now:</para>
- <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
-<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
-<html>
-<head>
-<title></title>
-</head>
-<body>
-<f:view>
-Hello <h:outputText value="#{personBean.name}"/>!
-</f:view>
-</body>
-</html>
-]]></programlisting>
- <itemizedlist>
- <listitem>
- <para>Save the file</para>
- </listitem>
- </itemizedlist>
- </section>
- </chapter>
-
-<chapter id="start_page" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/start_page.xml" xreflabel="start_page">
- <?dbhtml filename="start_page.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Creating the Start Page</title>
- <para>You also need to create a start page as an entry point into the application.</para>
- <itemizedlist>
- <listitem>
- <para>In the Package Explorer view to the left, right-click <emphasis>
- <property moreinfo="none">jsfHello > WebContent</property>
- </emphasis> and select <emphasis>
- <property moreinfo="none">New > JSP File</property>
- </emphasis></para>
- </listitem>
- <listitem>
- <para>For Name type in <emphasis>
- <property moreinfo="none">index</property>
- </emphasis>, for Template select <emphasis>
- <property moreinfo="none">JSPRedirect</property>
- </emphasis> and click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <para>A JSP editor will open up on the newly created file.</para>
-
- <itemizedlist>
- <listitem>
- <para>In the Source part of the split screen, type <emphasis>
- <property moreinfo="none">/pages/inputname.jsf</property>
- </emphasis> in between the quotes for the page attribute</para>
- </listitem>
- </itemizedlist>
- <para>The source coding should look like this now:</para>
- <programlisting format="linespecific" role="XML"><![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head></head>
-<body>
-<jsp:forward page="/pages/inputname.jsf" />
-</body>
-</html>
-]]></programlisting>
-
- <para>Note the <emphasis>
- <property moreinfo="none">.jsf</property>
- </emphasis> extension for the file name. This is a mapping defined in the web.xml file
- for the project for invoking <property moreinfo="none">JavaServer Faces</property> when you run the
- application.</para>
- <itemizedlist>
- <listitem>
- <para>Select<emphasis>
- <property moreinfo="none"> File > Save</property>
- </emphasis> from the menu bar</para>
- </listitem>
- </itemizedlist>
- </chapter>
-
-<chapter id="running_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/running_application.xml" xreflabel="running_application">
- <?dbhtml filename="running_application.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Running the Application</title>
- <para>Everything is now ready for running our application by using the JBoss engine. For
- controlling JBoss server there is JBoss Server view:</para>
- <figure float="0">
- <title>JBoss Server View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_9.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Start up JBoss by clicking on the icon in JBoss Server view. (If JBoss is
- already running, stop it by clicking on the red icon and then start it again.
- Remember, the JSF run-time requires restarting the servlet engine when any
- changes have been made.) After the messages in the Console tabbed view stop
- scrolling, JBoss is available</para>
- </listitem>
-
- <listitem>
- <para>Click the Run icon or right click your project folder and select <emphasis>
- <property moreinfo="none">Run As > Run on Server</property>
- </emphasis>:</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Run Icon</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_application/jsf_application_10.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>This is the equivalent of launching the browser and typing <emphasis>
- <property moreinfo="none">http://localhost:8080/jsfHello</property>
- </emphasis> into your browser. Our <property moreinfo="none">JSF application</property> should now
- appear.</para>
- </chapter>
-
-<chapter id="relevant_resources" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/relevant_resources.xml" xreflabel="relevant_resources">
- <?dbhtml filename="relevant_resources.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>JSF application</keyword>
- <keyword>Java</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Other Relevant Resources on the topic</title>
- <para>JSF on Sun: <ulink url="http://java.sun.com/javaee/javaserverfaces/">JavaServer Faces
- Technology</ulink></para>
- <para>Core JSF: <ulink url="http://www.horstmann.com/corejsf/">Core JavaServer Faces</ulink></para>
- <para>API: <ulink url="http://java.sun.com/javaee/javaserverfaces/1.1/docs/api/index.html">JSF
- API</ulink></para>
- <para>JSF Tags: <ulink url="http://www.horstmann.com/corejsf/jsf-tags.html">JSF Core
- Tags</ulink></para>
- <para>HTML Tags Reference: <ulink url="http://www.exadel.com/tutorial/jsf/jsftags-guide.html">JSF HTML Tags Reference</ulink></para>
- <para>JSF Central: <ulink url="http://www.jsfcentral.com/">JSF Central - Your JavaServer Faces
- Community</ulink></para>
- <para>FAQ: <ulink url="http://wiki.java.net/bin/view/Projects/JavaServerFacesSpecFaq">JSF
- FAQ</ulink></para>
- <para>Download: <ulink url="http://java.sun.com/javaee/javaserverfaces/download.html">JavaServer
- Faces Technology - Download</ulink></para>
-
- <para>In summary, with this tutorial you should now know how to organize JSF sample application
- using the wizards provided by <property moreinfo="none">JBoss Tools</property>, configure its stuff and
- finally run it on the <property moreinfo="none">JBoss Server</property>.</para>
-
- <para>Find out more features on JSF tooling in our <ulink url="../../jsf_tools_ref_guide/html_single/index.html">JSF Tools
- Reference Guide</ulink>. If you have questions and suggestions, please refer to <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss
- Tools Forum</ulink>.</para>
-</chapter>
-
-</book>
Copied: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml (from rev 15128, trunk/jsf/docs/jsf_tools_tutorial/en/master_output.xml)
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml 2009-05-11 16:37:05 UTC (rev 15198)
@@ -0,0 +1,791 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[<!ENTITY introduction SYSTEM "modules/introduction.xml">
+<!ENTITY jsf_application SYSTEM "modules/jsf_application.xml">
+<!ENTITY adding_navigation SYSTEM "modules/adding_navigation.xml">
+<!ENTITY adding_managed_bean SYSTEM "modules/adding_managed_bean.xml">
+<!ENTITY jsp_view_files SYSTEM "modules/jsp_view_files.xml">
+<!ENTITY start_page SYSTEM "modules/start_page.xml">
+<!ENTITY running_application SYSTEM "modules/running_application.xml">
+<!ENTITY relevant_resources SYSTEM "modules/relevant_resources.xml">
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>JSF Tools Tutorial</title>
+
+ <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
+ <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 3.0.1.GA
+ </diffmk:wrapper></releaseinfo>
+
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_tutoria...">PDF version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+
+ <toc></toc>
+
+
+
+<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/introduction.xml" xreflabel="introduction">
+ <?dbhtml filename="introduction.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Introduction</title>
+ <para>The following chapters describe how to deal with classic/old style of JSF development. We
+ recommend users to use <ulink url="../../seam/html_single/index.html">JBoss
+ Seam</ulink> to simplify development, but until then you can read about classical JSF
+ usage here.</para>
+
+ <para>Thus, in this document we are going to show you how to create a simple <property moreinfo="none">JSF application
+ </property>using <property moreinfo="none">JBoss Tools</property> plugins for Eclipse. The completed
+ application will ask a user to enter a name and click a button. The resulting new page
+ will display the familiar message, "Hello <name>!" This
+ tutorial will show you how to create and run such an application from the beginning along the
+ way demonstrating some of the powerful features of <property moreinfo="none">JBoss Tools</property>.</para>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+ <para><diffmk:wrapper diffmk:change="changed">All JBoss Developer Studio/JBoss Tools release documentation you can find at</diffmk:wrapper><diffmk:wrapper diffmk:change="changed">http://docs.jboss.org/tools</diffmk:wrapper><diffmk:wrapper diffmk:change="changed"> in the corresponding release directory.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">The latest documentation builds are available at </diffmk:wrapper><ulink url="http://download.jboss.org/jbosstools/nightly-docs/"><diffmk:wrapper diffmk:change="changed">http://download.jboss.org/jbosstools/nightly-docs</diffmk:wrapper></ulink>.</para>
+ </section>
+
+</chapter>
+
+
+<chapter id="jsf_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/jsf_application.xml" xreflabel="jsf_application">
+ <?dbhtml filename="jsf_application.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Creating a Simple JSF Application</title>
+
+ <para>Firstly, we assume that you have already launched Eclipse with <property moreinfo="none">JBoss Tools</property>
+ plug-ins installed and also that the <property moreinfo="none">Web Development perspective</property> is the current
+ one. (If not, make it active by selecting <emphasis>
+ <property moreinfo="none">Window > Open Perspective > Web Development</property>
+ </emphasis> from the menu bar or by selecting <emphasis>
+ <property moreinfo="none">Window > Open Perspective > Other...</property>
+ </emphasis> from the menu bar and then selecting <emphasis>
+ <property moreinfo="none">Web Development</property>
+ </emphasis> from the Select Perspective dialog box.)</para>
+
+ <section id="setting_up_the_project">
+ <?dbhtml filename="SettingUpTheProject.html"?>
+ <title>Setting Up the Project</title>
+ <para>Now we are going to create a new project for the application.</para>
+ <itemizedlist>
+ <listitem>
+ <para>For that go to the menu bar and select <emphasis>
+ <property moreinfo="none">File > New > Project...</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">JBoss Tools Web > JSF > JSF Project</property>
+ </emphasis> in the New Project dialog box</para>
+ </listitem>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Enter "jsfHello" as the project name.</para>
+ </listitem>
+ <listitem>
+ <para>Leave everything else as is, and click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+
+ </itemizedlist>
+ </section>
+
+ <section id="TheJSFApplicationConfigurationFile">
+ <?dbhtml filename="TheJSFApplicationConfigurationFile.html"?>
+ <title>JSF Configuration File</title>
+ <para>A jsfHello node should appear in the upper-left Package Explorer view.</para>
+ <figure float="0">
+ <title>Package Explorer View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Click the plus sign next to <emphasis>
+ <property moreinfo="none">jsfHello</property>
+ </emphasis> to reveal the child nodes</para>
+ </listitem>
+ <listitem>
+ <para>Click the plus sign next to <emphasis>
+ <property moreinfo="none">WebContent</property>
+ </emphasis> under jsfHello</para>
+ </listitem>
+ <listitem>
+ <para>Click the plus sign next to <emphasis>
+ <property moreinfo="none">WEB-INF</property>
+ </emphasis> under WebContent</para>
+ </listitem>
+
+ <listitem>
+ <para>Then double-click on the <property moreinfo="none">faces-config.xml</property> node to display
+ the JSF application configuration file editor</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Configuration File Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+</chapter>
+
+
+<chapter id="adding_navigation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/adding_navigation.xml" xreflabel="adding_navigation">
+ <?dbhtml filename="adding_navigation.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Adding Navigation to the Application</title>
+
+ <para>In our simple application, the flow is defined as a single navigation rule connecting
+ two views (presentation files). At this point, we will create the placeholders for the
+ two JSP presentation files and then the navigation rule to connect them as views. Later,
+ we will complete the coding for the JSP presentation files. We can do all of this in the
+ Diagram mode of the configuration file editor.</para>
+ <section id="AddingTwoViewsJSPPages">
+ <?dbhtml filename="AddingTwoViewsJSPPages.html"?>
+ <title>Adding Two Views (JSP Pages)</title>
+ <itemizedlist>
+ <listitem>
+ <para>Right-click anywhere on the diagram and select <emphasis>
+ <property moreinfo="none">New View...</property>
+ </emphasis> from the pop-up menu</para>
+ </listitem>
+ <listitem>
+ <para>In the dialog box, type <emphasis>
+ <property moreinfo="none">pages/inputname</property>
+ </emphasis> as the value for From-view-id</para>
+ </listitem>
+ <listitem>
+ <para>Leave everything else as is</para>
+ </listitem>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ <para>If you look in the Package Explorer view you should see a <emphasis>
+ <property moreinfo="none">pages</property>
+ </emphasis> folder under WebContent. Opening it will reveal the JSP file you
+ just created</para>
+ </listitem>
+ <listitem>
+ <para>Back on the diagram, right-click anywhere and select <emphasis>
+ <property moreinfo="none">New View...</property>
+ </emphasis> from the pop-up menu</para>
+ </listitem>
+ <listitem>
+ <para>In the dialog box, type <emphasis>
+ <property moreinfo="none">pages/greeting</property>
+ </emphasis> as the value for From-view-id</para>
+ </listitem>
+ <listitem>
+ <para>Leave everything else as is</para>
+ </listitem>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+ <section id="CreatingTheTransitionNavigationRule">
+ <?dbhtml filename="CreatingTheTransitionNavigationRule.html"?>
+ <title>Creating the Transition (Navigation Rule)</title>
+ <itemizedlist>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">In the diagram, select the connection icon third from the top along
+ the upper left side of the diagram (</diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_3.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">) to get an arrow cursor with a two-pronged plug at the arrow's bottom.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">pages/inputname</property>
+ </emphasis> page icon and then click on the <emphasis>
+ <property moreinfo="none">pages/greeting</property>
+ </emphasis> page icon</para>
+ </listitem>
+
+ </itemizedlist>
+ <para>A transition should appear between the two icons.</para>
+ <figure float="0">
+ <title>Transition Between Two Icons</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">File > Save</property>
+ </emphasis> from the menu bar</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+</chapter>
+
+<chapter diffmk:change="added" id="adding_managed_bean" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/adding_managed_bean.xml" xreflabel="adding_managed_bean">
+ <?dbhtml filename="adding_managed_bean.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Adding a Managed Bean to the Application</title>
+ <para>To store data in the application, we will use a managed bean.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">Tree</property>
+ </emphasis> tab at the bottom of the editing window</para>
+ </listitem>
+ <listitem>
+ <para>Select the <emphasis>
+ <property moreinfo="none">Managed Beans</property>
+ </emphasis> node and then click the <emphasis>
+ <property moreinfo="none">Add...</property>
+ </emphasis> button displayed along the right side of the editor window</para>
+ </listitem>
+ <listitem>
+ <para>Type in <emphasis>
+ <property moreinfo="none">jsfHello.PersonBean</property>
+ </emphasis> for Class and <emphasis>
+ <property moreinfo="none">personBean</property>
+ </emphasis> for Name. Leave Scope as is and Generate Source Code as is
+ (checked)</para>
+ </listitem>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>personBean will now be selected and three sections of information: <emphasis>
+ <property moreinfo="none">Managed Bean</property>
+ </emphasis>, <emphasis>
+ <property moreinfo="none">Properties</property>
+ </emphasis>, and <emphasis>
+ <property moreinfo="none">Advanced</property>
+ </emphasis>, will be displayed about it. Under the Properties section, click the <emphasis>
+ <property moreinfo="none">Add...</property>
+ </emphasis> button</para>
+ </listitem>
+ <listitem>
+ <para>Type in <emphasis>
+ <property moreinfo="none">name</property>
+ </emphasis> for Property-Name. Leave everything else as is. (When Property-
+ Class is not filled in, String is the assumed type)</para>
+ </listitem>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Select the <emphasis>
+ <property moreinfo="none">personBean</property>
+ </emphasis> node in the tree</para>
+ </listitem>
+ </itemizedlist>
+ <para>You should see this now:</para>
+ <figure float="0">
+ <title>Tree View in Config Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">File > Save</property>
+ </emphasis> from the menu bar</para>
+ </listitem>
+ </itemizedlist>
+ <para>You have now registered the <emphasis>
+ <property moreinfo="none">managed bean</property>
+ </emphasis> and created a <emphasis>
+ <property moreinfo="none">stub-coded class</property>
+ </emphasis> file for it.</para>
+
+ </chapter>
+
+<chapter id="jsp_view_files" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/jsp_view_files.xml" xreflabel="jsp_view_files">
+ <?dbhtml filename="jsp_view_files.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Editing the JSP View Files</title>
+
+ <para>Now we will finish editing the JSP files for our two "views" using
+ JSP Visual Page.</para>
+ <section id="Inputname.jsp">
+ <title>inputname.jsp</title>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">Diagram</property>
+ </emphasis> tab for the configuration file editor</para>
+ </listitem>
+ <listitem>
+ <para>Open the editor for this first JSP file by double-clicking on the <emphasis>
+ <property moreinfo="none">/pages/inputname. jsp</property>
+ </emphasis> icon</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The Visual Page Editor will open in a screen split between source code along the
+ top and a WYSIWIG view along the bottom:</para>
+ <figure float="0">
+ <title>Visual Page Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Some JSF code is already in the file, because we have chosen a template to create
+ a page.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Select the <emphasis>
+ <property moreinfo="none">Visual</property>
+ </emphasis> tab, so we can work with the editor completely in its WYSIWYG
+ mode</para>
+ </listitem>
+ <listitem>
+ <para>To the right of the editor, in the JBoss Tools Palette, expand the <emphasis>
+ <property moreinfo="none">JSF HTML</property>
+ </emphasis> palette folder by selecting it</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>JBoss Tools Palette</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Click on <emphasis>
+ <property moreinfo="none">form</property>
+ </emphasis> within this folder, drag the cursor over to the editor, and drop
+ it inside the red box in the editor</para>
+ </listitem>
+ <listitem>
+ <para>Another red box will appear inside the first red box</para>
+ </listitem>
+ <listitem>
+ <para>Right-click on the innermost box and select <emphasis role="bold">
+ <property moreinfo="none"><h:form></property>
+ </emphasis> Attributes from the menu</para>
+ </listitem>
+ <listitem>
+ <para>In the value field next to id, type <emphasis>
+ <property moreinfo="none">greeting</property>
+ </emphasis> and click on the <emphasis>
+ <property moreinfo="none">Close</property>
+ </emphasis> button</para>
+ </listitem>
+ <listitem>
+ <para>Type "Please enter name:" inside the boxes</para>
+ </listitem>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">inputText</property>
+ </emphasis> within the JSF HTML palette folder and drag it into the
+ innermost box in the editor after "Please enter
+ name:"</para>
+ </listitem>
+ <listitem>
+ <para>In the attributes dialog, click in the <emphasis>
+ <property moreinfo="none">value</property>
+ </emphasis> field next to the value attribute and click on the <property moreinfo="none">...
+ </property>button</para>
+ </listitem>
+ <listitem>
+ <para>Then, select the <emphasis>
+ <property moreinfo="none">Managed Beans > personBean > name</property>
+ </emphasis> node and click on the <emphasis>
+ <property moreinfo="none">Ok</property>
+ </emphasis> button</para>
+ </listitem>
+ <listitem>
+ <para>Back in the attributes dialog, select the <emphasis>
+ <property moreinfo="none">Advanced</property>
+ </emphasis> tab, type in <emphasis>
+ <property moreinfo="none">name</property>
+ </emphasis> as the value for the <emphasis role="italic">
+ <property moreinfo="none">"id"</property>
+ </emphasis> attribute, and then click on the <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button</para>
+ </listitem>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">commandButton</property>
+ </emphasis> within the JSF HTML palette folder and drag it into the
+ innermost box in the editor after the input box</para>
+ </listitem>
+ <listitem>
+ <para>In the attributes dialog, click in the value field next to the <emphasis role="italic">
+ <property moreinfo="none">"action"</property>
+ </emphasis> attribute and click on the <property moreinfo="none">...
+ </property>button</para>
+ </listitem>
+ <listitem>
+ <para>Then, select the <emphasis>
+ <property moreinfo="none">View Actions > greeting</property>
+ </emphasis> node and click on the <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis> button</para>
+ </listitem>
+ <listitem>
+ <para>Back in the attributes dialog box, type in "Say Hello"
+ as the value for the value attribute ("Say Hello") and
+ then click on the <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button</para>
+ </listitem>
+ </itemizedlist>
+ <para>The source coding should be something like this now:</para>
+ <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
+<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
+<html>
+<head>
+<title></title>
+</head>
+<body>
+<f:view>
+<h:form id="greeting">
+Please enter name:
+<h:inputText id="name" value="#{personBean.name}"/>
+<h:commandButton value=" Say Hello " action="greeting"/>
+</h:form>
+</f:view>
+</body>
+</html>
+]]></programlisting>
+ <para>The editor should look like this:</para>
+ <figure float="0">
+ <title>Visual Page Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Save the file by selecting <emphasis>
+ <property moreinfo="none">File > Save</property>
+ </emphasis> from the menu bar</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="Greeting.jsp">
+ <title>greeting.jsp</title>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">faces-config.xml</property>
+ </emphasis> tab to bring the diagram back</para>
+ </listitem>
+ <listitem>
+ <para>Open the editor for the second file by double-clicking on the <emphasis>
+ <property moreinfo="none">/pages/greeting.jsp</property>
+ </emphasis> icon</para>
+ </listitem>
+ <listitem>
+ <para>Select the <emphasis>
+ <property moreinfo="none">Visual</property>
+ </emphasis> tab, so we can work with the editor completely in its WYSIWYG
+ mode</para>
+ </listitem>
+ <listitem>
+ <para>Type "Hello "(note space after Hello) into the
+ box</para>
+ </listitem>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">outputText</property>
+ </emphasis> within the JSF HTML palette folder and drag it into the
+ innermost box in the editor after "Hello"</para>
+ </listitem>
+ <listitem>
+ <para>In the attributes dialog, click in <emphasis>
+ <property moreinfo="none">value</property>
+ </emphasis> field next to the value attribute and click on the
+ <property moreinfo="none">...</property> (Browse) button</para>
+ </listitem>
+ <listitem>
+ <para>Then, select the <emphasis>
+ <property moreinfo="none">Managed Beans > personBean > name</property>
+ </emphasis> node, click on the <emphasis>
+ <property moreinfo="none">Ok</property>
+ </emphasis> button, and then click on the <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button</para>
+ </listitem>
+ <listitem>
+ <para>Right after the output field, type an <emphasis>
+ <property moreinfo="none">exclamation point</property>
+ </emphasis> (<emphasis>
+ <property moreinfo="none">!</property>
+ </emphasis>)</para>
+ </listitem>
+ </itemizedlist>
+ <para>The source coding should be something like this now:</para>
+ <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
+<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
+<html>
+<head>
+<title></title>
+</head>
+<body>
+<f:view>
+Hello <h:outputText value="#{personBean.name}"/>!
+</f:view>
+</body>
+</html>
+]]></programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Save the file</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </chapter>
+
+<chapter id="start_page" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/start_page.xml" xreflabel="start_page">
+ <?dbhtml filename="start_page.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Creating the Start Page</title>
+ <para>You also need to create a start page as an entry point into the application.</para>
+ <itemizedlist>
+ <listitem>
+ <para>In the Package Explorer view to the left, right-click <emphasis>
+ <property moreinfo="none">jsfHello > WebContent</property>
+ </emphasis> and select <emphasis>
+ <property moreinfo="none">New > JSP File</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>For Name type in <emphasis>
+ <property moreinfo="none">index</property>
+ </emphasis>, for Template select <emphasis>
+ <property moreinfo="none">JSPRedirect</property>
+ </emphasis> and click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <para>A JSP editor will open up on the newly created file.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>In the Source part of the split screen, type <emphasis>
+ <property moreinfo="none">/pages/inputname.jsf</property>
+ </emphasis> in between the quotes for the page attribute</para>
+ </listitem>
+ </itemizedlist>
+ <para>The source coding should look like this now:</para>
+ <programlisting format="linespecific" role="XML"><![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+<html>
+<head></head>
+<body>
+<jsp:forward page="/pages/inputname.jsf" />
+</body>
+</html>
+]]></programlisting>
+
+ <para>Note the <emphasis>
+ <property moreinfo="none">.jsf</property>
+ </emphasis> extension for the file name. This is a mapping defined in the web.xml file
+ for the project for invoking <property moreinfo="none">JavaServer Faces</property> when you run the
+ application.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Select<emphasis>
+ <property moreinfo="none"> File > Save</property>
+ </emphasis> from the menu bar</para>
+ </listitem>
+ </itemizedlist>
+ </chapter>
+
+<chapter id="running_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/running_application.xml" xreflabel="running_application">
+ <?dbhtml filename="running_application.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Running the Application</title>
+ <para>Everything is now ready for running our application by using the JBoss engine. For
+ controlling JBoss server there is JBoss Server view:</para>
+ <figure float="0">
+ <title>JBoss Server View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_application/jsf_application_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Start up JBoss by clicking on the icon in JBoss Server view. (If JBoss is
+ already running, stop it by clicking on the red icon and then start it again.
+ Remember, the JSF run-time requires restarting the servlet engine when any
+ changes have been made.) After the messages in the Console tabbed view stop
+ scrolling, JBoss is available</para>
+ </listitem>
+
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">Click the Run icon(</diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/jsf_application/jsf_application_10.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">) or right click your project folder and select </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Run As > Run on Server</property>
+ </emphasis>:</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>This is the equivalent of launching the browser and typing <emphasis>
+ <property moreinfo="none">http://localhost:8080/jsfHello</property>
+ </emphasis> into your browser. Our <property moreinfo="none">JSF application</property> should now
+ appear.</para>
+ </chapter>
+
+<chapter id="relevant_resources" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/relevant_resources.xml" xreflabel="relevant_resources">
+ <?dbhtml filename="relevant_resources.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JSF application</keyword>
+ <keyword>Java</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Other Relevant Resources on the topic</title>
+ <para>JSF on Sun: <ulink url="http://java.sun.com/javaee/javaserverfaces/">JavaServer Faces
+ Technology</ulink></para>
+ <para>Core JSF: <ulink url="http://www.horstmann.com/corejsf/">Core JavaServer Faces</ulink></para>
+ <para>API: <ulink url="http://java.sun.com/javaee/javaserverfaces/1.1/docs/api/index.html">JSF
+ API</ulink></para>
+ <para>JSF Tags: <ulink url="http://www.horstmann.com/corejsf/jsf-tags.html">JSF Core
+ Tags</ulink></para>
+ <para>HTML Tags Reference: <ulink url="http://www.exadel.com/tutorial/jsf/jsftags-guide.html">JSF HTML Tags Reference</ulink></para>
+ <para>JSF Central: <ulink url="http://www.jsfcentral.com/">JSF Central - Your JavaServer Faces
+ Community</ulink></para>
+ <para>FAQ: <ulink url="http://wiki.java.net/bin/view/Projects/JavaServerFacesSpecFaq">JSF
+ FAQ</ulink></para>
+ <para>Download: <ulink url="http://java.sun.com/javaee/javaserverfaces/download.html">JavaServer
+ Faces Technology - Download</ulink></para>
+
+ <para>In summary, with this tutorial you should now know how to organize JSF sample application
+ using the wizards provided by <property moreinfo="none">JBoss Tools</property>, configure its stuff and
+ finally run it on the <property moreinfo="none">JBoss Server</property>.</para>
+
+ <para>Find out more features on JSF tooling in our <ulink url="../../jsf_tools_ref_guide/html_single/index.html">JSF Tools
+ Reference Guide</ulink>. If you have questions and suggestions, please refer to <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss
+ Tools Forum</ulink>.</para>
+</chapter>
+
+</book>
15 years, 2 months
JBoss Tools SVN: r15197 - branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:36:49 -0400 (Mon, 11 May 2009)
New Revision: 15197
Added:
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml
Removed:
branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Deleted: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml 2009-05-11 16:34:26 UTC (rev 15196)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml 2009-05-11 16:36:49 UTC (rev 15197)
@@ -1,1987 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.docbook.org/xml/4.3/docbookx.dtd"
-
-[
-<!ENTITY introduction SYSTEM "modules/introduction.xml">
-<!ENTITY jsf_support SYSTEM "modules/jsf_support.xml">
-<!ENTITY projects SYSTEM "modules/projects.xml">
-<!ENTITY jsf_config_file SYSTEM "modules/jsf_config_file.xml">
-<!ENTITY managed_beans SYSTEM "modules/managed_beans.xml">
-<!ENTITY creation_and_registration SYSTEM "modules/creation_and_registration.xml">
-<!ENTITY jsf_project_verification SYSTEM "modules/jsf_project_verification.xml">
-
-<!ENTITY seamlink "../../seam/html_single/index.html">
-<!ENTITY aslink "../../as/html_single/index.html">
-<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
-<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
-<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
-<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
-<!ENTITY jsflink "../../jsf/html_single/index.html">
-<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
-<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
-<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
-<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
-<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html">
-
-
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
- <bookinfo>
- <title>JSF Tools Reference Guide</title>
-
- <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
- <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
- <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
-
- <pubdate>April 2008</pubdate>
- <copyright>
- <year>2007</year>
- <year><diffmk:wrapper diffmk:change="changed">2009</diffmk:wrapper></year>
- <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 3.0.0.GA
- </diffmk:wrapper></releaseinfo>
-
-<abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_ref_guide/...">PDF version</ulink>
- </para>
-</abstract>
-
- </bookinfo>
-
- <toc></toc>
-
-
-<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/introduction.xml">
- <?dbhtml filename="introduction.html"?>
-
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- <keyword>JSF Tools</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Introduction</title>
-
- <para>JSF Tools are especially designed for supporting JSF and JSF-related technologies. JSF
- Tools provide extensible and exemplary tools for building JSF-based applications as well as
- adding JSF capabilities to existing web projects, importing JSF projects and choosing any
- JSF implementation while developing JSF application.</para>
-
- <para>In this guide we provide you with the information on JSF tooling which allows you to
- develop JSF applications much faster and with far fewer errors so sparing your time.</para>
-
- <section id="jsf_key_features">
- <title>Key Features of JSF Tools</title>
-
- <para>Here, we provide you with a key functionality which is integrated in JSF tooling.</para>
-
- <table>
- <title>Key Functionality for JSF Tools</title>
- <tgroup cols="3">
-
- <colspec align="left" colnum="1" colwidth="2*"></colspec>
- <colspec colnum="2" colwidth="4*"></colspec>
- <colspec colnum="3" colwidth="2*"></colspec>
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- <entry>Chapter</entry>
- </row>
- </thead>
- <tbody>
-
- <row>
- <entry>JSF and Facelets support</entry>
- <entry>Step-by-step wizards for creating new JSF and Facelets projects with a number of predefined templates, importing existing ones and adding JSF capabilities to non-jsf web projects.</entry>
- <entry><link linkend="jsf_support">jsf support</link></entry>
- </row>
-
- <row>
- <entry>Flexible and customizable project template management</entry>
- <entry>Jump-start development with out-of-the-box templates or easily
- customized templates for re-use.</entry>
- <entry>
- <link linkend="projects">projects</link>
- </entry>
- </row>
-
- <row>
- <entry>Support for JSF Configuration File</entry>
- <entry>Working on file using three modes: diagram, tree and source.
- Synchronization between the modes and full control over the code. Easy
- moving around the diagram using the Diagram Navigator.</entry>
- <entry>
- <link linkend="jsf_config_file">graphical editor for jsf</link>
- </entry>
- </row>
-
- <row>
- <entry>Support for Managed Beans</entry>
- <entry>Adding new managed beans, generating code for attributes, properties
- and getter/setter methods.</entry>
- <entry>
- <link linkend="managed_beans">managed beans</link>
- </entry>
- </row>
-
- <row>
- <entry>Support for Custom Converters and Validators</entry>
- <entry>Fast creating of custom converters and validators with tree view of
- faces-config.xml file.</entry>
- <entry>
- <link linkend="creation_and_registration">converters and validators</link>
- </entry>
- </row>
-
- <row>
- <entry>Verification and Validation</entry>
- <entry>All occuring errors will be immediately reported by verification
- feature, no matter in what view you are working. Constant validation and
- errors checking allows to catch many of the errors during development
- process that significantly reduces development time.</entry>
- <entry>
- <link linkend="jsf_project_verification">verification and
- validation</link>
- </entry>
-
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- <section>
- <title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/">here</ulink>.</para>
- <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
- </section>
-</chapter>
-
-
-<chapter id="jsf_support" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_support.xml">
- <?dbhtml filename="jsf_support.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>JSF Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>JavaServer Faces Support</title>
-
- <para>We don't lock you into any one <property moreinfo="none">JavaServer
- Faces</property> implementation. You can always select the one which is
- necessary for you while <link linkend="new_jsf_project">creating a new JSF
- project</link>, <link linkend="add_jsf_capability">adding JSF capability</link> to
- any existing Eclipse project or <link linkend="ImportingExsJSFProjWithAnyStr74447">importing existing JSF projects</link> as well.</para>
- <para>At this point the special wizard will prompt you to specify a proper JSF environment.
- It may be JSF 1.1.02 RI or JSF 1.2 which integrates a number of new features and
- changes. The wizard also lets you select JSF implementation with a component
- orientation such as JSF 1.2 with Facelets or MyFaces 1.1.4.</para>
-
- <figure float="0">
- <title>Choosing JSF Environment</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_11.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After specifying a proper JSF environment all the required libraries for the selected
- version will be added to your project.</para>
-
- <section id="FaceletsSupport865">
-
- <title>Facelets Support</title>
- <para>In this section we will focus more on all concepts that are integrated for
- working with Facelets.</para>
-
- <para>The Facelets extends JavaServer Faces by providing a lightweight framework
- that radically simplifies the design of presentation pages for JSF. Facelets can be used in a variety of ways that we
- will consider further in this section.</para>
-
- <section>
- <title>Facelets templates</title>
- <para>If you want to build an application using Facelets, just create a
- project with Facelets based on version 1.2 of the JSF Reference
- Implementation, i. e. select the <emphasis>
- <property moreinfo="none">JSF 1.2 with Facelets</property>
- </emphasis> in the JSF Environment section of the New JSF Project
- wizard.</para>
-
- <figure float="0">
- <title>Choosing Facelets Environment</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Once you've selected the environment, it's possible
- to specify the one of three available templates:</para>
- <figure float="0">
- <title>Choosing Facelets Template</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The following table lists possible templates with Facelets for any JSF
- project and gives a proper description for each one.</para>
- <table>
- <title>Facelets Templates</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1" colwidth="2*"></colspec>
- <colspec colnum="2" colwidth="3*"></colspec>
-
-
- <thead>
- <row>
- <entry align="center">
- <para>Template</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry>
- <para>
- <emphasis>
- <property moreinfo="none">FaceletsBlankWithoutLibs</property>
- </emphasis>
- </para>
- </entry>
-
- <entry>
- <para>Some servers already provide
- jsf libs and you take risk
- of getting conflicting
- libraries while deploying
- your project. To avoid such
- conflicts, use a template
- without libs if you have a
- server with its own jsf
- libraries</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>
- <emphasis>
- <property moreinfo="none">FaceletsKickStartWithRILibs</property>
- </emphasis>
- </para>
- </entry>
-
- <entry>
- <para>A sample application with
- Facelets that is ready to
- run</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>
- <emphasis>
- <property moreinfo="none">FaceletsKickStartWithoutLibs</property>
- </emphasis>
- </para>
- </entry>
-
- <entry>
- <para>A sample application without
- libraries</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
- </section>
- <section>
- <title>Facelets components</title>
-
- <para>The <ulink url="../../jsf/html_single/index.html#palette">JBoss Tools
- Palette</ulink> comes with the Facelets components ready to
- use. A useful tip appears when you hover the mouse cursor over the
- tag, the tip includes a detailed description of the tag component,
- the syntax and available attributes.</para>
-
- <!-- JBoss Developer Studio does not provide templates for MyFaces right out of the box, but you can easily do it
- yourself with the "Save As Template" feature (available on the File submenu). Just create a small project
- with MyFaces and Facelets and then save it as a template for future use.
-
- How can I add Facelets support to an existing project?</para>
- <para>A: Right-click on the folder of existing project and select <emphasis>JBoss Tools > Add Custom Capabilities.. > Facelets</emphasis>. </para>
- -->
- <figure float="0">
- <title>Facelets Components</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_4.png" scale="65"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>Code assist for Facelets</title>
-
- <para>One more feature which comes with Facelets support is code assist
- (Ctrl + Space). It is available for <property moreinfo="none">Facelets
- tags</property> while editing <emphasis>
- <property moreinfo="none">.xhtml</property>
- </emphasis> files.</para>
-
- <figure float="0">
- <title>XHTML File Code Assist</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_5.png" scale="60"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>What's more, code assist is also available for <emphasis role="italic">
- <property moreinfo="none">"jsfc"</property>
- </emphasis> attribute in any HTML tag.</para>
-
- <figure float="0">
- <title>Code Assist for JSFC Attribute</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_6.png" scale="70"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After selecting <emphasis role="italic">
- <property moreinfo="none">"jsfc"</property>
- </emphasis> you get the code assist for JSF components available on
- a page.</para>
-
- <figure float="0">
- <title>Code Assist for JSF Components</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_7.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>When a component is chosen you will see all available attributes for
- it.</para>
-
- <figure float="0">
- <title>Available Attributes for the Component</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_8.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>Open On feature</title>
- <para>Finally, Eclipse's <emphasis>
- <property moreinfo="none">OpenOn</property>
- </emphasis> feature for editing Facelets files is supported. Using this feature,
- you can easily navigate between the <property moreinfo="none">Facelets
- templates</property> and other parts of your projects. Just by
- holding down the Control key while hovering the mouse cursor over a
- reference to a template, the reference becomes a hyperlink to open
- that template.</para>
-
-
- <figure float="0">
- <title>Template Hyperlink</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_9.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <!-- <para>Additionally, when hovering the mouse cursor over <emphasis role="italic"><property>"Facelets tag"</property></emphasis> attributes, JBoss Developer Studio provides a pop-up help tip:</para>
- <figure>
-<title>Pop-up Help Tip for Facelets Tag Attributes</title>
-<mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/defaultImage.png"/>
- </imageobject>
-</mediaobject>
- </figure>
-
- -->
- <!-- <para>See <link linkend="faq_facelets">FAQ</link> concerning Facelets
- support.</para>
- -->
- </section>
-
- <!--section>
- <title>Relevant Resources Links</title>
- <para>Necessary information and support for Facelets find out <ulink
- url="https://facelets.dev.java.net/"
- >here</ulink>.</para>
- </section-->
- </section>
-
-
-
-
-
-
-
-
-
-
- <!--section>
- <title>Relevant Resources Links</title>
- <para>If you don't familiar with <ulink
- url="http://java.sun.com/javaee/javaserverfaces/">JSF
- technology</ulink>, we suggest that you walk through the
- information on the topic.</para>
- </section-->
-</chapter>
-
-
-<chapter id="projects" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/projects.xml">
- <?dbhtml filename="projects.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>JSF Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Projects</title>
- <para>To take an advantage of JSF firstly you should perform one of the next
- steps:</para>
-
- <itemizedlist>
- <listitem>
- <para>Create new JSF projects</para>
- </listitem>
- <listitem>
- <para>Import (open) existing JSF projects</para>
- </listitem>
- <listitem>
- <para>Add JSF capability to any existing Eclipse
- project</para>
- </listitem>
- <listitem>
- <para>Import and add JSF capability to any existing project
- created outside Eclipse.</para>
- </listitem>
- </itemizedlist>
- <para>In this section we're going to stop on each of them in
- detail.</para>
-
- <section id="new_jsf_project">
-
- <title>Creating a New JSF Project</title>
-
- <para>If you want your project to already contain all JSF
- libraries, tag libraries and JSF configuration file, just
- organize a new brand JSF project. It is possible to do this easily with the
- help of the special wizard. To get it, select<emphasis>
- <property moreinfo="none"> File > New > Project
- > JBoos Tools Web > JSF
- > JSF Project</property>
- </emphasis> and click <emphasis>
- <property moreinfo="none">Next</property>.</emphasis></para>
-
- <figure float="0">
- <title>Choosing a JSF Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_10.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the next form you'll be prompted to enter
- <property moreinfo="none">Project Name</property> and select a
- location for the project or just leave a default path.</para>
- <para>Here, JSF Version also allows you to select which JSF
- implementation to use.</para>
- <figure float="0">
- <title>Creating a New JSF Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_11.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>There is a number of predefined project templates that are flexible and
- easily customizable. Thus you can pick a different template
- on which the projects Importing Existing should be based on. Almost all
- templates come in two variations: with jsf libraries and
- without ones.</para>
- <figure float="0">
- <title>Choosing JSF Templates</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_12.png "></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The table below provides description for each possible JSF
- template.</para>
- <table>
- <title>JSF Project Templates</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1" colwidth="1*"></colspec>
- <colspec colnum="2" colwidth="3*"></colspec>
-
-
- <thead>
- <row>
- <entry align="center">
- <para>Template</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry>
- <para>
- <emphasis>
- <property moreinfo="none">JSFBlankWithLibs</property>
- </emphasis>
- </para>
- </entry>
-
- <entry>
- <para>This template will
- create a standard
- Web project
- structure with all
- JSF
- capabilities</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>
- <emphasis>
- <property moreinfo="none">JSFKickStartWithLibs</property>
- </emphasis>
- </para>
- </entry>
-
- <entry>
- <para>This template will
- create a standard
- Web project
- structure but will
- also include a
- sample application
- that is ready to
- run</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>
- <emphasis>
- <property moreinfo="none">JSFKickStartWithoutLibs</property>
- </emphasis>
- </para>
- </entry>
-
- <entry>
- <para>Some servers already
- provide jsf libs and
- you take risk of
- getting conflicting
- libraries while
- deploying your
- project. To avoid
- such conflicts, use
- a template without
- libs if you have a
- server with its own
- jsf libraries</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
-
- <!-- <para>You can of course create your own custom templates. More information
- on templates creation could be found in <link
- linkend="CreatingCustomJSPTemplates">Chapter 5</link>.</para>
- -->
-
- <para>On the next screen select what <emphasis>
- <property moreinfo="none">Servlet version</property>
- </emphasis> to use and whether to register this application
- with JBoss AS (or other server) for running and testing your application.</para>
-
- <para>The <emphasis>
- <property moreinfo="none">Context Path</property>
- </emphasis> is the name under which the application will be
- deployed.</para>
-
- <para>The <emphasis>
- <property moreinfo="none">Runtime</property>
- </emphasis> 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 <emphasis>
- <property moreinfo="none">New...</property>
- </emphasis> to add new Runtime.</para>
-
- <para>The <emphasis>
- <property moreinfo="none">Target Server</property>
- </emphasis> allows you specifying 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.</para>
- <figure float="0">
- <title>Registering the Project on Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_14.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>When you are all done, you should have the project that has
- been appeared in the Package Explorer view:</para>
- <figure float="0">
- <title>A New Project in the Package Explorer</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_15.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>At this point you can open <emphasis>
- <property moreinfo="none">faces-config.xml</property>
- </emphasis> and start working on your application.
- There are a lot of features
- to develop JSF applications. We will describe the features
- further.</para>
- </section>
-
- <section id="ImportingExsJSFProjWithAnyStr74447">
-
- <title>Importing Existing JSF Projects with Any Structure</title>
-
- <para>For detailed information on migration of JSF projects into a workspace see <ulink url="../../Exadel-migration/html_single/index.html#jsf_struts">Migration Guide</ulink>.</para>
-
- </section>
- <section id="add_jsf_capability">
-
- <title>Adding JSF Capability to Any Existing Eclipse Project</title>
-
- <para>It's also possible to add <property moreinfo="none">JSF capability</property>
- (JSF libraries, tag libraries) to any existing Eclipse
- project in your workspace. After that you'll be
- able to make use of such editors as JSF configuration editor, JBoss
- Tools JSP editor and any others.</para>
- <para>Right click the project and select <emphasis>
- <property moreinfo="none">JBoss Tools > Add JSF
- Capabilities</property>. </emphasis> This will start
- the process of adding all necessary libraries, files to make
- this a Web JSF project.</para>
- <figure float="0">
- <title>Adding JSF Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_16.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The wizard will first ask you to show the <emphasis>
- <property moreinfo="none">web.xml</property>
- </emphasis> file location and the project name.</para>
- <figure float="0">
- <title>Project Location</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_17.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On the last form you can set the different folders for your
- project as well as register this application with a servlet
- container.</para>
-
- <para>Make sure to select <emphasis>
- <property moreinfo="none">Add Libraries</property>
- </emphasis> to add all required JSF related libraries to this project.</para>
-
- <para>The <emphasis>
- <property moreinfo="none">Context Path</property>
- </emphasis> is the name under which the application will be
- deployed.</para>
-
- <para>The <emphasis>
- <property moreinfo="none">Runtime</property>
- </emphasis> 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 <emphasis>
- <property moreinfo="none">New...</property>
- </emphasis> to add new Runtime.</para>
-
- <para>The <emphasis>
- <property moreinfo="none">Target Server</property>
- </emphasis> allows you to 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.</para>
- <figure float="0">
- <title>Project Folders</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_18.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Once your project is imported you can see that JSF related
- libraries have been added to your project: <emphasis>
- <property moreinfo="none">jsf-api.jar</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">jsf-impl.jar</property>
- </emphasis>.</para>
- <note>
- <title>Note:</title>
- <para>Some application servers provide their own jsf
- implementation libraries. Thus, to avoid conflicts you
- should not add jsf libraries while adding jsf
- capabilities.</para>
- </note>
- <para>You are now ready to work with JSF by creating a new JSF
- configuration file:</para>
-
-
- <figure float="0">
- <title>Creating a New JSF Configuration File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_19.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Once the file has been created, it should be opened in a
- special <link linkend="jsf_config_file">Faces Config Editor</link>.</para>
- </section>
- <section id="AddingYourOwnProjectTemplates853">
-
- <title>Adding Your Own Project Templates</title>
- <para>Template is a set of files that is served as a basis to facilitate
- the creation of a new project. Project templates provide
- content and structure for a project.</para>
- <para>There is 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 and consider the
- process of creating a template from your existing JSF
- project.</para>
-
- <para>Let's say you have a project that you want to use as
- the basis for a new <property moreinfo="none">template</property>. Follow
- these steps to make a template out of it:</para>
- <itemizedlist>
- <listitem>
- <para>In the Web Projects view, right-click the
- project and select <emphasis>
- <property moreinfo="none">JBoss Tools JSF > Save As
- Template</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Saving Your Project as Template</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_20.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>In the first dialog box, you can choose a name
- for the template (defaults to the project
- name) and confirm what run-time
- implementation of the project
- technology will be used</para>
- </listitem>
-
- </itemizedlist>
- <figure float="0">
- <title>Define Template Properties</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_20_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <itemizedlist>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> and you will be sent to a dialog
- box with your project structure displayed
- with check boxes. Here you can check only
- those parts and files in your project
- directory that should be part of the
- template</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Define Template Properties</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_20_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>At this point, unless you want to designate
- some extra files as having Velocity template
- coding inside them, you should click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis>.</para>
- </listitem>
- </itemizedlist>
- <para>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.</para>
- <para>At this point, you have a fully configured project and now you can
- bring some new logic to it starting from JSF configuration
- file.</para>
- </section>
-</chapter>
-
-<chapter id="jsf_config_file" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_config_file.xml">
- <?dbhtml filename="jsf_config_file.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>JSF Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>JSF Configuration File Editor</title>
-
- <para>First, we should mention that JSF configuration file (<emphasis>
- <property moreinfo="none">faces-config.xml</property>
- </emphasis>) is intended for registering JSF application resources such as Converters,
- Validators, Managed Beans and page-to-page navigation rules.</para>
- <para>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:</para>
-
- <itemizedlist>
- <listitem>
- <para>Diagram</para>
- </listitem>
- <listitem>
- <para>Tree</para>
- </listitem>
- <listitem>
- <para>Source</para>
- </listitem>
- </itemizedlist>
-
- <para>They can be selected via the tabs at the bottom of the editor.</para>
-
- <section id="Diagram9553">
-
- <title>Diagram view</title>
-
- <para>Here, we will show you how to work with JSF configuration file through the Diagram
- view of the editor.</para>
- <para>As you can see on the figure below, the Diagram view displays the navigation rules in
- the faces-config.xml:</para>
- <figure float="0">
- <title>Diagram View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_21.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If your diagram is large, make use of the Outline view. Within it you can switch to a <emphasis>
- <property moreinfo="none">Diagram Navigator</property>
- </emphasis> 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:</para>
- <figure float="0">
- <title>Outline View for Diagram</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_32.png" scale="50"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>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.</para>
-
- <para>To create a transition for connecting pages:</para>
-
- <itemizedlist>
- <listitem>
- <para>Select the transition icon from the toolbar (New Connection).</para>
- </listitem>
- <listitem>
- <para>Click the source page.</para>
- </listitem>
- <listitem>
- <para>Click the target page.</para>
- </listitem>
- </itemizedlist>
-
- <para>A transition will appear between the two pages:</para>
- <figure float="0">
- <title>Transition between JSP Pages</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_22.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It is also possible to create a new page with context menu by right-clicking anywhere
- on the diagram and selecting <emphasis>
- <property moreinfo="none">New View</property>. </emphasis></para>
- <figure float="0">
- <title>Creating a New View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_23.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>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:</para>
- <figure float="0">
- <title>Editing Transition between Views</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_24.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="TreeView11123" role="updated">
-
- <title>Tree View</title>
-
- <para>You can find it more convenient to edit your JSF Configuration file in the Tree view of
- the <property moreinfo="none">VPE</property>.</para>
-
- <para>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.</para>
-
- <itemizedlist>
- <listitem>
- <para>Under the <emphasis>
- <property moreinfo="none">Application</property>
- </emphasis> node you can adjust JSF application specific settings such as
- internationalization, possibility to set extensions, add property and variable
- resolvers, etc.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>JSF Application Specific Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_24a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>The <emphasis>
- <property moreinfo="none">Components</property>
- </emphasis> node is for registering custom JSF components. Right-click and
- choose <emphasis>
- <property moreinfo="none">New > Component</property>
- </emphasis> or just press the <emphasis>
- <property moreinfo="none">Add</property>
- </emphasis> button in the right-hand area to add a new component to the JSF
- Configuration file.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Registering a New JSF Component</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_24b.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In the <property moreinfo="none">Add Component wizard</property> you should set a component
- type and point to a component class by using the <emphasis>
- <property moreinfo="none">Browse</property>
- </emphasis> button or create a new class for this component by using the <emphasis>
- <property moreinfo="none">Component-Class</property>
- </emphasis> link.</para>
-
- <figure float="0">
- <title>Adding a New JSF Component to the JSF Configuration File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_24c.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Use the <emphasis>
- <property moreinfo="none">Render Kit</property>
- </emphasis> node to create and register a set of related renderers for custom
- JSF components.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Adding a New JSF Component to the JSF Configuration File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_24d.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Under the <emphasis>
- <property moreinfo="none">Converters</property>
- </emphasis> 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 <link linkend="CreateAndRegisterACustomConverter94230">Create and Register a
- Custom Converter</link> section.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Creating a New Custom Converter</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_59.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>The <emphasis>
- <property moreinfo="none">Managed Bean</property>
- </emphasis> node is meant for creating and registering Bean classes in your JSF
- application. Read more on the topic in the <link linkend="managed_beans">Managed
- Beans</link> chapter.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Managed Beans</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_26.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Use the <emphasis>
- <property moreinfo="none">Navigation Rules</property>
- </emphasis> 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.</para>
- </listitem>
- </itemizedlist>
- <tip>
- <title>Tip:</title>
- <para>The same you can do in the <link linkend="Diagram9553">Diagram view</link> of the
- JSF Configuration file editor.</para>
- </tip>
-
- <figure float="0">
- <title>Configuring Navigation Rules</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_26a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Under the <emphasis>
- <property moreinfo="none">Referenced Beans</property>
- </emphasis> node you can add a new Referenced Bean and configure various
- properties for it. To learn more on this refer to the <link linkend="referenced_beans">Create and Register Referenced Beans</link>
- section.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Referenced Beans</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_26b.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>The <emphasis>
- <property moreinfo="none">Validators</property>
- </emphasis> node is needed to create validator classes for organizing the
- validation of your application data. You can read more on the topic in the <link linkend="CreateAndRegisterACustomValidator5632">Create and Register a Custom
- Validator</link> section.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Validators</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_26c.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>The <emphasis>
- <property moreinfo="none">Extensions</property>
- </emphasis> node is for setting extensions for your <emphasis>
- <property moreinfo="none">faces-config.xml</property>.</emphasis></para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Adding Extensions</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_26d.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In the <property moreinfo="none">Tree view</property> you can also edit the properties of the selected
- element with the help of the <property moreinfo="none">Properties view</property> as shown below:</para>
-
- <figure float="0">
- <title>Properties View </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_33.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
- <section id="SourceView4643">
-
- <title>Source View</title>
-
- <para>Here, we'll discuss how you can configure your faces-config.xml with the help
- of Source View.</para>
- <para>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:</para>
- <figure float="0">
- <title>Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_27.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>You can also work in the Source view with the help of the <emphasis>
- <property moreinfo="none">Outline view</property>.</emphasis> 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.</para>
- <figure float="0">
- <title>Outline View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_31.png" scale="50"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section id="jsf_editor_features">
- <title>Editor Features</title>
- <para>Here we'll discuss a very important features that JSF configuration file
- editor provides for work with JSF resources.</para>
-
- <section id="jsf_openOn">
- <title>Open On</title>
- <para>The JSF configuration file editor comes with a very useful OpenOn navigating
- feature. More fully you can read about it in our <ulink url="../../jsf/html_single/index.html#OpenOnSelection4Hyperlinknavigation">Visual Web Tools
- Guide</ulink>.</para>
- </section>
-
- <section id="ContentAssist976">
-
- <title>Code Assist</title>
- <para>Code Assist provides pop-up tip to help you complete your code statements. It
- allows you to write your code faster and with more accuracy.</para>
- <para>Code assist is always available in the Source mode:</para>
- <figure float="0">
- <title>Code Assist in Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_28.png" scale="65"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section id="ErrorReporting3324">
-
- <title>Error Reporting</title>
- <para>When you are developing your project, error checking is constantly provided. This
- greatly reduces your development time as it allows you to catch many of the errors
- during development.</para>
- <para>Errors will be reported by <link linkend="jsf_project_verification">
- verification</link> facility:</para>
- <figure float="0">
- <title>Error Reporting in Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_29.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Other errors are also reported.</para>
- <figure float="0">
- <title>Other Errors Reporting</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_30.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
- </section>
-
-</chapter>
-
-
-<chapter id="managed_beans" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/managed_beans.xml">
- <?dbhtml filename="managed_beans.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>JSF Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Managed Beans</title>
-
- <para>There is lots of power to work with <property moreinfo="none">managed beans</property>.</para>
- <itemizedlist>
- <listitem>
- <para>Add and generate code for new managed beans</para>
- <itemizedlist>
- <listitem>
- <para>Generate code for attributes and getter/setter methods</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Add existing managed beans to JSF configuration file</para>
- </listitem>
- </itemizedlist>
-
- <para>Thus, in this section we will guides you through all this possibilities.</para>
-
- <section id="CodeGenerationForManagedBeans421">
-
- <title>Code Generation for Managed Beans</title>
-
- <para>To start, create a new managed bean in JSF configuration file editor, in the Tree
- view.</para>
- <figure float="0">
- <title>Creation of New Managed Bean</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_34.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <note>
- <title>Note:</title>
- <para>When you define a new managed bean, make sure that <emphasis>
- <property moreinfo="none">Generate Source Code</property>
- </emphasis> is checked as shown in the figure below.</para>
- </note>
- <figure float="0">
- <title>New Managed Bean</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_35.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>After the <emphasis role="italic">
- <property moreinfo="none">"Java"</property>
- </emphasis> class has been generated you can open it for additional editing. There are
- two ways to open the <emphasis role="italic">
- <property moreinfo="none">"Java"</property>
- </emphasis> class:</para>
-
- <itemizedlist>
- <listitem>
- <para>click on <emphasis>
- <property moreinfo="none">Managed-Bean-Class</property>
- </emphasis> link in the editor</para>
- </listitem>
- </itemizedlist>
- <para>or</para>
- <itemizedlist>
- <listitem>
- <para>right click the <emphasis>
- <property moreinfo="none">managed bean</property>
- </emphasis> and select <emphasis>
- <property moreinfo="none">Open Source</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Opening of Created Managed Bean</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_36.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The generated Java source should look as follows:</para>
-
- <figure float="0">
- <title>Java Source Code</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_37.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can also generate source code for properties, also includes <emphasis role="italic">
- <property moreinfo="none">"getter"</property>
- </emphasis> and <emphasis role="italic">
- <property moreinfo="none">"setter"</property>
- </emphasis> methods. Right click on the bean and select <emphasis>
- <property moreinfo="none">New > Property</property>
- </emphasis>. You will see <property moreinfo="none">Add Property</property> dialog.</para>
- <figure float="0">
- <title>Generation of Source Code for Properties</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_38.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>When the form is open make sure that all the check boxes are selected:</para>
- <itemizedlist>
- <listitem>
- <para>Add Java property</para>
- </listitem>
- <listitem>
- <para>Generate Getter</para>
- </listitem>
- <listitem>
- <para>Generate Setter</para>
- </listitem>
- </itemizedlist>
- <para></para>
- <figure float="0">
- <title>"Add Property" Form</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_39.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Once the generation is complete, you can open the file and see the added property with
- <emphasis role="italic">
- <property moreinfo="none">"get"</property>
- </emphasis> and <emphasis role="italic">
- <property moreinfo="none">"set"</property>
- </emphasis> methods:</para>
- <figure float="0">
- <title>Generated Java Source Code for Property</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_40.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Thus, we've discussed everything which comes to creating a new Managed Bean.
- The next section will show you how to add an existing Bean into a JSF configuration
- file.</para>
- </section>
- <section id="AddExistingJavaBeansToAJSFConfigurationFile74332">
-
- <title>Add Existing Java Beans to a JSF Configuration File</title>
- <para>If you already have a Java bean you can easily add it to a <property moreinfo="none">JSF configuration
- file</property>.</para>
- <para>You should start the same way you create a new managed bean. Use the <emphasis>
- <property moreinfo="none">Browse...</property>
- </emphasis> button to add your existing Java class.</para>
- <figure float="0">
- <title>New Managed Bean Form</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_42.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Once the class is set, its <emphasis>
- <property moreinfo="none">Name</property>
- </emphasis> will be set as well. But you can easily substitute it for the other one.
- Notice that <emphasis>
- <property moreinfo="none">Generate Source Code</property>
- </emphasis> option is not available as the <emphasis role="italic">
- <property moreinfo="none">"Java"</property>
- </emphasis> class already exists. </para>
- <para>After adding your class <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> button will be activated. Pressing it you'll get <emphasis>
- <property moreinfo="none">Managed Properties</property>
- </emphasis> dialog where all corresponding properties are displayed. Check the necessary
- ones to add them into your <property moreinfo="none">JSF Configuration File</property>.</para>
-
- <figure float="0">
- <title>Selection of Bean's Properties.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_43.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If you don't want to add any, just click <emphasis>
- <property moreinfo="none">Finish</property>. </emphasis></para>
- <para>Above-listed steps have demonstrated how you can specify an existing Bean in the JSF
- configuration file, i.e. <emphasis>
- <property moreinfo="none">faces-config.xml</property>. </emphasis> In the next chapter
- you'll know how to organize and register another kind of artifacts.</para>
- </section>
-</chapter>
-
-
-<chapter id="creation_and_registration" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/creation_and_registration.xml">
- <?dbhtml filename="creation_and_registration.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>JSF Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
- <title>Creation and Registration</title>
-
- <section id="CreateAndRegisterACustomConverter94230">
-
- <title>Create and Register a Custom Converter</title>
-
- <para>It's also possible to create a
- custom Converter in order to specify your own converting rules. Let's look at how you can do this.</para>
-
- <para>To create and register a custom converter it's necessary to
- go through the following steps:</para>
-
- <itemizedlist>
- <listitem>
- <para>In the Project Explorer view open <emphasis>
- <property moreinfo="none">faces-config.xml</property>
- </emphasis> and select <emphasis>
- <property moreinfo="none">Tree</property>
- </emphasis> tab.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Converters</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_44.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">Converters</property>
- </emphasis> and click on<emphasis>
- <property moreinfo="none"> Add</property>
- </emphasis> button.</para>
- </listitem>
- <listitem>
- <para>On the form type the name of your converter in the <emphasis>
- <property moreinfo="none">Converter-id</property>
- </emphasis> field and name of the class for
- converters. After clicking <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> button your custom converter is
- registered under the entered name.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Add Converter Form</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_45.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Now you can create <emphasis role="italic">
- <property moreinfo="none">"converter"</property>
- </emphasis> class. In the Converter section you
- should see your <emphasis>
- <property moreinfo="none">Converter-id</property>
- </emphasis> and
- <emphasis><property moreinfo="none">Converter-class</property>.</emphasis>
- Click on <emphasis>
- <property moreinfo="none">Converter-class</property>
- </emphasis> to generate the source code.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Generation of Source Code for Converter Class</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_46.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>A usual wizard for creating a Java class will appear.
- All needed fields here will be adjusted
- automatically. Just leave everything without changes
- and click <emphasis>
- <property moreinfo="none">Finish</property>.
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>New Java Class Form</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_47.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>To open a converter class click again on <emphasis>
- <property moreinfo="none">Converter-class</property>
- </emphasis> link in the Converter section.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Converter Class</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_48.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Now you
- are able to add a business logic of converter in the
- Java editor.</para>
- </section>
-
- <section id="CreateAndRegisterACustomValidator5632">
-
- <title>Create and Register a Custom Validator</title>
-
- <para>It's also quite easy to develop your
- own custom Validators. You should perform the actions similar to the
- previous one. Go through the following steps:</para>
- <itemizedlist>
- <listitem>
- <para>In the Project Explorer view open<emphasis>
- <property moreinfo="none"> faces-config.xml</property>
- </emphasis> and select <emphasis>
- <property moreinfo="none">Tree </property>
- </emphasis>tab.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Validator in Faces Config Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_49.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">Validators</property>
- </emphasis> and click on <emphasis>
- <property moreinfo="none">Add </property>
- </emphasis>button.</para>
- </listitem>
- <listitem>
- <para>Type the name of your validator in the <emphasis>
- <property moreinfo="none">Validator-id</property>
- </emphasis> field and name of the class for
- validators. After clicking <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> button your custom validator is
- registered under the entered name.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Adding Validator</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_50.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Now you can create the "validator" class. </para>
- <itemizedlist>
- <listitem>
- <para>In the Validator section you can see your <emphasis>
- <property moreinfo="none">Validator-id</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">Validator-class</property></emphasis>. To generate the source code click on <emphasis>
- <property moreinfo="none">Validator-class</property>.
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Creating Validator Class</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_51.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Java class will be created automatically. Leave
- everything without changes and click <emphasis>
- <property moreinfo="none">Finish</property>.
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>New Java Class Form</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_52.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>To open validator class click again on <emphasis>
- <property moreinfo="none">Validator-Class</property>
- </emphasis> link in the Validator section. Now you
- are able to write a business logic of validator in
- the Java editor.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Converter Class Editing</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_53.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="referenced_beans">
- <title>Create and Register Referenced Beans</title>
-
- <para>Creation of Referenced Beans is similar to creation of Custom
- Validator as well. To perform this, let's walk through the necessary steps.</para>
-
- <itemizedlist>
- <listitem>
- <para>In the Project Explorer view open<emphasis>
- <property moreinfo="none"> faces-config.xml</property>
- </emphasis> and select <emphasis>
- <property moreinfo="none">Tree </property>
- </emphasis>tab.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Referenced Beans in Faces Config Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_54.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">Referenced Beans</property>
- </emphasis> and click on <emphasis>
- <property moreinfo="none">Add</property>
- </emphasis> button.</para>
- </listitem>
- <listitem>
- <para>Type in the name of your Referenced Bean and type in
- or select <emphasis>
- <property moreinfo="none">Referenced-Bean-Class</property>
- </emphasis> by using <emphasis>
- <property moreinfo="none">Browse</property>
- </emphasis> button.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Add Referenced Bean</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_55.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>In the Referenced Bean section you should see your <emphasis>
- <property moreinfo="none">Referenced-Bean-Name</property>
- </emphasis> and
- <emphasis><property moreinfo="none">Referenced-Bean-Class</property>.</emphasis>
- Click on the link to open the Java creation
- wizard.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Create Referenced Bean Class</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_56.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Java class will be created automatically. Leave
- everything without changes and click <emphasis>
- <property moreinfo="none">Finish</property>.
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>New Java Class Form</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_57.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>To open Referenced Bean class click again on <emphasis>
- <property moreinfo="none">Referenced-Bean-Class</property>
- </emphasis> in the Referenced Bean section. Now you
- are able to write business logic of Referenced Bean
- in the Java editor.</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Referenced Bean Class Editing</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_support/jsf_support_58.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-</chapter>
-
-<chapter id="jsf_project_verification" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_project_verification.xml">
- <?dbhtml filename="struts_project_verification.html"?>
-
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>JSF Tools</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>JSF Project Verification</title>
-
- <para>In this chapter we'll discuss a possible verification that you can take advantage
- of.</para>
- <!-- JBoss Developer Studio checks for many different rules for a JSF project -->
- <para>Many different rules are checked for a JSF project that can be configured by selecting <emphasis>
- <property moreinfo="none">Window > Preferences</property>
- </emphasis> from the menu bar, selecting <emphasis>
- <property moreinfo="none">JBoss Tools > Web > Verification</property>
- </emphasis> from the Preferences dialog box and then expanding the JSF Rules node.</para>
- <figure float="0">
- <title>JSF Rules</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/verif_valid/verif_valid_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Suppose you are working in the Source viewer for a JSF configuration file as shown below:</para>
- <figure float="0">
- <title>Faces-config.xml File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/verif_valid/verif_valid_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>While typing a class name, you might make a minor typo (like <emphasis role="italic">
- <property moreinfo="none">"jsfHello.PersonBean9"</property>
- </emphasis> instead of <emphasis role="italic">
- <property moreinfo="none">"jsfHello.PersonBean"</property>
- </emphasis>). After saving the file, verification checks to make sure everything is correct
- and finds the error below:</para>
- <figure float="0">
- <title>Error in Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/verif_valid/verif_valid_3.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Notice that the Package Explorer View shows a marked folder and a marked file where the
- error is.</para>
- <para>You can place the cursor over the line with an error message and get a detailed error
- message:</para>
- <figure float="0">
- <title>Error Message</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/verif_valid/verif_valid_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Verification also checks navigation rules:</para>
- <figure float="0">
- <title>Checking Navigation Rules</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/verif_valid/verif_valid_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>If you provide a page name that does not exist, verification will let you know about that:</para>
- <figure float="0">
- <title>Page Name Verification</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/verif_valid/verif_valid_6.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can always call up verification explicitly by right-clicking any element in the tree
- and selecting Verify from the context menu. This works from both the Tree and Diagram
- viewers for the JSF configuration file editor. You can also invoke verification from the Web
- Projects view. Below we are checking all of the elements in the configuration file.</para>
- <figure float="0">
- <title>Verify Command</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/verif_valid/verif_valid_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In summary, this document highlights all the JSF-specific features of <property moreinfo="none">JBoss Tools</property>
- meant for enhancing the development of rich Web applications based on JSF technology. The
- reference introduces you to wizards for creating and importing JSF projects, JSF
- Configuration File editor features, functionality for enabling JSF capabilities and etc.</para>
-
- <para>If you have questions or good suggestions, please refer to <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss
- Tools Forum</ulink>.</para>
-</chapter>
-
-</book>
Copied: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml (from rev 15128, trunk/jsf/docs/jsf_tools_ref_guide/en/master_output.xml)
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml 2009-05-11 16:36:49 UTC (rev 15197)
@@ -0,0 +1,1987 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[
+<!ENTITY introduction SYSTEM "modules/introduction.xml">
+<!ENTITY jsf_support SYSTEM "modules/jsf_support.xml">
+<!ENTITY projects SYSTEM "modules/projects.xml">
+<!ENTITY jsf_config_file SYSTEM "modules/jsf_config_file.xml">
+<!ENTITY managed_beans SYSTEM "modules/managed_beans.xml">
+<!ENTITY creation_and_registration SYSTEM "modules/creation_and_registration.xml">
+<!ENTITY jsf_project_verification SYSTEM "modules/jsf_project_verification.xml">
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html">
+
+
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+ <bookinfo>
+ <title>JSF Tools Reference Guide</title>
+
+ <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
+ <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 3.0.1.GA
+ </diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_ref_guide/...">PDF version</ulink>
+ </para>
+</abstract>
+
+ </bookinfo>
+
+ <toc></toc>
+
+
+<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/introduction.xml">
+ <?dbhtml filename="introduction.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ <keyword>JSF Tools</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Introduction</title>
+
+ <para>JSF Tools are especially designed for supporting JSF and JSF-related technologies. JSF
+ Tools provide extensible and exemplary tools for building JSF-based applications as well as
+ adding JSF capabilities to existing web projects, importing JSF projects and choosing any
+ JSF implementation while developing JSF application.</para>
+
+ <para>In this guide we provide you with the information on JSF tooling which allows you to
+ develop JSF applications much faster and with far fewer errors so sparing your time.</para>
+
+ <section id="jsf_key_features">
+ <title>Key Features of JSF Tools</title>
+
+ <para>Here, we provide you with a key functionality which is integrated in JSF tooling.</para>
+
+ <table>
+ <title>Key Functionality for JSF Tools</title>
+ <tgroup cols="3">
+
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <colspec colnum="3" colwidth="2*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+ <tbody>
+
+ <row>
+ <entry>JSF and Facelets support</entry>
+ <entry>Step-by-step wizards for creating new JSF and Facelets projects with a number of predefined templates, importing existing ones and adding JSF capabilities to non-jsf web projects.</entry>
+ <entry><link linkend="jsf_support">jsf support</link></entry>
+ </row>
+
+ <row>
+ <entry>Flexible and customizable project template management</entry>
+ <entry>Jump-start development with out-of-the-box templates or easily
+ customized templates for re-use.</entry>
+ <entry>
+ <link linkend="projects">projects</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>Support for JSF Configuration File</entry>
+ <entry>Working on file using three modes: diagram, tree and source.
+ Synchronization between the modes and full control over the code. Easy
+ moving around the diagram using the Diagram Navigator.</entry>
+ <entry>
+ <link linkend="jsf_config_file">graphical editor for jsf</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>Support for Managed Beans</entry>
+ <entry>Adding new managed beans, generating code for attributes, properties
+ and getter/setter methods.</entry>
+ <entry>
+ <link linkend="managed_beans">managed beans</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>Support for Custom Converters and Validators</entry>
+ <entry>Fast creating of custom converters and validators with tree view of
+ faces-config.xml file.</entry>
+ <entry>
+ <link linkend="creation_and_registration">converters and validators</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>Verification and Validation</entry>
+ <entry>All occuring errors will be immediately reported by verification
+ feature, no matter in what view you are working. Constant validation and
+ errors checking allows to catch many of the errors during development
+ process that significantly reduces development time.</entry>
+ <entry>
+ <link linkend="jsf_project_verification">verification and
+ validation</link>
+ </entry>
+
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section>
+ <title>Other relevant resources on the topic</title>
+ <para><diffmk:wrapper diffmk:change="changed">All JBoss Developer Studio/JBoss Tools release documentation you can find at</diffmk:wrapper><ulink url="http://docs.jboss.org/tools/"><diffmk:wrapper diffmk:change="changed">http://docs.jboss.org/tools</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="changed"> in the corresponding release directory.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">The latest documentation builds are available at </diffmk:wrapper><ulink url="http://download.jboss.org/jbosstools/nightly-docs/"><diffmk:wrapper diffmk:change="changed">http://download.jboss.org/jbosstools/nightly-docs</diffmk:wrapper></ulink>.</para>
+ </section>
+</chapter>
+
+
+<chapter id="jsf_support" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_support.xml">
+ <?dbhtml filename="jsf_support.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>JSF Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>JavaServer Faces Support</title>
+
+ <para>We don't lock you into any one <property moreinfo="none">JavaServer
+ Faces</property> implementation. You can always select the one which is
+ necessary for you while <link linkend="new_jsf_project">creating a new JSF
+ project</link>, <link linkend="add_jsf_capability">adding JSF capability</link> to
+ any existing Eclipse project or <link linkend="ImportingExsJSFProjWithAnyStr74447">importing existing JSF projects</link> as well.</para>
+ <para>At this point the special wizard will prompt you to specify a proper JSF environment.
+ It may be JSF 1.1.02 RI or JSF 1.2 which integrates a number of new features and
+ changes. The wizard also lets you select JSF implementation with a component
+ orientation such as JSF 1.2 with Facelets or MyFaces 1.1.4.</para>
+
+ <figure float="0">
+ <title>Choosing JSF Environment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After specifying a proper JSF environment all the required libraries for the selected
+ version will be added to your project.</para>
+
+ <section id="FaceletsSupport865">
+
+ <title>Facelets Support</title>
+ <para>In this section we will focus more on all concepts that are integrated for
+ working with Facelets.</para>
+
+ <para>The Facelets extends JavaServer Faces by providing a lightweight framework
+ that radically simplifies the design of presentation pages for JSF. Facelets can be used in a variety of ways that we
+ will consider further in this section.</para>
+
+ <section>
+ <title>Facelets templates</title>
+ <para>If you want to build an application using Facelets, just create a
+ project with Facelets based on version 1.2 of the JSF Reference
+ Implementation, i. e. select the <emphasis>
+ <property moreinfo="none">JSF 1.2 with Facelets</property>
+ </emphasis> in the JSF Environment section of the New JSF Project
+ wizard.</para>
+
+ <figure float="0">
+ <title>Choosing Facelets Environment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Once you've selected the environment, it's possible
+ to specify the one of three available templates:</para>
+ <figure float="0">
+ <title>Choosing Facelets Template</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The following table lists possible templates with Facelets for any JSF
+ project and gives a proper description for each one.</para>
+ <table>
+ <title>Facelets Templates</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Template</para>
+ </entry>
+
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para>
+ <emphasis>
+ <property moreinfo="none">FaceletsBlankWithoutLibs</property>
+ </emphasis>
+ </para>
+ </entry>
+
+ <entry>
+ <para>Some servers already provide
+ jsf libs and you take risk
+ of getting conflicting
+ libraries while deploying
+ your project. To avoid such
+ conflicts, use a template
+ without libs if you have a
+ server with its own jsf
+ libraries</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <emphasis>
+ <property moreinfo="none">FaceletsKickStartWithRILibs</property>
+ </emphasis>
+ </para>
+ </entry>
+
+ <entry>
+ <para>A sample application with
+ Facelets that is ready to
+ run</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <emphasis>
+ <property moreinfo="none">FaceletsKickStartWithoutLibs</property>
+ </emphasis>
+ </para>
+ </entry>
+
+ <entry>
+ <para>A sample application without
+ libraries</para>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section>
+ <title>Facelets components</title>
+
+ <para>The <ulink url="../../jsf/html_single/index.html#palette">JBoss Tools
+ Palette</ulink> comes with the Facelets components ready to
+ use. A useful tip appears when you hover the mouse cursor over the
+ tag, the tip includes a detailed description of the tag component,
+ the syntax and available attributes.</para>
+
+ <!-- JBoss Developer Studio does not provide templates for MyFaces right out of the box, but you can easily do it
+ yourself with the "Save As Template" feature (available on the File submenu). Just create a small project
+ with MyFaces and Facelets and then save it as a template for future use.
+
+ How can I add Facelets support to an existing project?</para>
+ <para>A: Right-click on the folder of existing project and select <emphasis>JBoss Tools > Add Custom Capabilities.. > Facelets</emphasis>. </para>
+ -->
+ <figure float="0">
+ <title>Facelets Components</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_4.png" scale="65"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>Code assist for Facelets</title>
+
+ <para>One more feature which comes with Facelets support is code assist
+ (Ctrl + Space). It is available for <property moreinfo="none">Facelets
+ tags</property> while editing <emphasis>
+ <property moreinfo="none">.xhtml</property>
+ </emphasis> files.</para>
+
+ <figure float="0">
+ <title>XHTML File Code Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_5.png" scale="60"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>What's more, code assist is also available for <emphasis role="italic">
+ <property moreinfo="none">"jsfc"</property>
+ </emphasis> attribute in any HTML tag.</para>
+
+ <figure float="0">
+ <title>Code Assist for JSFC Attribute</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_6.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After selecting <emphasis role="italic">
+ <property moreinfo="none">"jsfc"</property>
+ </emphasis> you get the code assist for JSF components available on
+ a page.</para>
+
+ <figure float="0">
+ <title>Code Assist for JSF Components</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_7.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When a component is chosen you will see all available attributes for
+ it.</para>
+
+ <figure float="0">
+ <title>Available Attributes for the Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_8.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>Open On feature</title>
+ <para>Finally, Eclipse's <emphasis>
+ <property moreinfo="none">OpenOn</property>
+ </emphasis> feature for editing Facelets files is supported. Using this feature,
+ you can easily navigate between the <property moreinfo="none">Facelets
+ templates</property> and other parts of your projects. Just by
+ holding down the Control key while hovering the mouse cursor over a
+ reference to a template, the reference becomes a hyperlink to open
+ that template.</para>
+
+
+ <figure float="0">
+ <title>Template Hyperlink</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_9.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <!-- <para>Additionally, when hovering the mouse cursor over <emphasis role="italic"><property>"Facelets tag"</property></emphasis> attributes, JBoss Developer Studio provides a pop-up help tip:</para>
+ <figure>
+<title>Pop-up Help Tip for Facelets Tag Attributes</title>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/defaultImage.png"/>
+ </imageobject>
+</mediaobject>
+ </figure>
+
+ -->
+ <!-- <para>See <link linkend="faq_facelets">FAQ</link> concerning Facelets
+ support.</para>
+ -->
+ </section>
+
+ <!--section>
+ <title>Relevant Resources Links</title>
+ <para>Necessary information and support for Facelets find out <ulink
+ url="https://facelets.dev.java.net/"
+ >here</ulink>.</para>
+ </section-->
+ </section>
+
+
+
+
+
+
+
+
+
+
+ <!--section>
+ <title>Relevant Resources Links</title>
+ <para>If you don't familiar with <ulink
+ url="http://java.sun.com/javaee/javaserverfaces/">JSF
+ technology</ulink>, we suggest that you walk through the
+ information on the topic.</para>
+ </section-->
+</chapter>
+
+
+<chapter id="projects" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/projects.xml">
+ <?dbhtml filename="projects.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>JSF Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Projects</title>
+ <para>To take an advantage of JSF firstly you should perform one of the next
+ steps:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Create new JSF projects</para>
+ </listitem>
+ <listitem>
+ <para>Import (open) existing JSF projects</para>
+ </listitem>
+ <listitem>
+ <para>Add JSF capability to any existing Eclipse
+ project</para>
+ </listitem>
+ <listitem>
+ <para>Import and add JSF capability to any existing project
+ created outside Eclipse.</para>
+ </listitem>
+ </itemizedlist>
+ <para>In this section we're going to stop on each of them in
+ detail.</para>
+
+ <section id="new_jsf_project">
+
+ <title>Creating a New JSF Project</title>
+
+ <para>If you want your project to already contain all JSF
+ libraries, tag libraries and JSF configuration file, just
+ organize a new brand JSF project. It is possible to do this easily with the
+ help of the special wizard. To get it, select<emphasis>
+ <property moreinfo="none"> File > New > Project
+ > JBoos Tools Web > JSF
+ > JSF Project</property>
+ </emphasis> and click <emphasis>
+ <property moreinfo="none">Next</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Choosing a JSF Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the next form you'll be prompted to enter
+ <property moreinfo="none">Project Name</property> and select a
+ location for the project or just leave a default path.</para>
+ <para>Here, JSF Version also allows you to select which JSF
+ implementation to use.</para>
+ <figure float="0">
+ <title>Creating a New JSF Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>There is a number of predefined project templates that are flexible and
+ easily customizable. Thus you can pick a different template
+ on which the projects Importing Existing should be based on. Almost all
+ templates come in two variations: with jsf libraries and
+ without ones.</para>
+ <figure float="0">
+ <title>Choosing JSF Templates</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_12.png "></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The table below provides description for each possible JSF
+ template.</para>
+ <table>
+ <title>JSF Project Templates</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Template</para>
+ </entry>
+
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para>
+ <emphasis>
+ <property moreinfo="none">JSFBlankWithLibs</property>
+ </emphasis>
+ </para>
+ </entry>
+
+ <entry>
+ <para>This template will
+ create a standard
+ Web project
+ structure with all
+ JSF
+ capabilities</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <emphasis>
+ <property moreinfo="none">JSFKickStartWithLibs</property>
+ </emphasis>
+ </para>
+ </entry>
+
+ <entry>
+ <para>This template will
+ create a standard
+ Web project
+ structure but will
+ also include a
+ sample application
+ that is ready to
+ run</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <emphasis>
+ <property moreinfo="none">JSFKickStartWithoutLibs</property>
+ </emphasis>
+ </para>
+ </entry>
+
+ <entry>
+ <para>Some servers already
+ provide jsf libs and
+ you take risk of
+ getting conflicting
+ libraries while
+ deploying your
+ project. To avoid
+ such conflicts, use
+ a template without
+ libs if you have a
+ server with its own
+ jsf libraries</para>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+
+ <!-- <para>You can of course create your own custom templates. More information
+ on templates creation could be found in <link
+ linkend="CreatingCustomJSPTemplates">Chapter 5</link>.</para>
+ -->
+
+ <para>On the next screen select what <emphasis>
+ <property moreinfo="none">Servlet version</property>
+ </emphasis> to use and whether to register this application
+ with JBoss AS (or other server) for running and testing your application.</para>
+
+ <para>The <emphasis>
+ <property moreinfo="none">Context Path</property>
+ </emphasis> is the name under which the application will be
+ deployed.</para>
+
+ <para>The <emphasis>
+ <property moreinfo="none">Runtime</property>
+ </emphasis> 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 <emphasis>
+ <property moreinfo="none">New...</property>
+ </emphasis> to add new Runtime.</para>
+
+ <para>The <emphasis>
+ <property moreinfo="none">Target Server</property>
+ </emphasis> allows you specifying 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.</para>
+ <figure float="0">
+ <title>Registering the Project on Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_14.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When you are all done, you should have the project that has
+ been appeared in the Package Explorer view:</para>
+ <figure float="0">
+ <title>A New Project in the Package Explorer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_15.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>At this point you can open <emphasis>
+ <property moreinfo="none">faces-config.xml</property>
+ </emphasis> and start working on your application.
+ There are a lot of features
+ to develop JSF applications. We will describe the features
+ further.</para>
+ </section>
+
+ <section id="ImportingExsJSFProjWithAnyStr74447">
+
+ <title>Importing Existing JSF Projects with Any Structure</title>
+
+ <para>For detailed information on migration of JSF projects into a workspace see <ulink url="../../Exadel-migration/html_single/index.html#jsf_struts">Migration Guide</ulink>.</para>
+
+ </section>
+ <section id="add_jsf_capability">
+
+ <title>Adding JSF Capability to Any Existing Eclipse Project</title>
+
+ <para>It's also possible to add <property moreinfo="none">JSF capability</property>
+ (JSF libraries, tag libraries) to any existing Eclipse
+ project in your workspace. After that you'll be
+ able to make use of such editors as JSF configuration editor, JBoss
+ Tools JSP editor and any others.</para>
+ <para>Right click the project and select <emphasis>
+ <property moreinfo="none">JBoss Tools > Add JSF
+ Capabilities</property>. </emphasis> This will start
+ the process of adding all necessary libraries, files to make
+ this a Web JSF project.</para>
+ <figure float="0">
+ <title>Adding JSF Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_16.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The wizard will first ask you to show the <emphasis>
+ <property moreinfo="none">web.xml</property>
+ </emphasis> file location and the project name.</para>
+ <figure float="0">
+ <title>Project Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_17.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On the last form you can set the different folders for your
+ project as well as register this application with a servlet
+ container.</para>
+
+ <para>Make sure to select <emphasis>
+ <property moreinfo="none">Add Libraries</property>
+ </emphasis> to add all required JSF related libraries to this project.</para>
+
+ <para>The <emphasis>
+ <property moreinfo="none">Context Path</property>
+ </emphasis> is the name under which the application will be
+ deployed.</para>
+
+ <para>The <emphasis>
+ <property moreinfo="none">Runtime</property>
+ </emphasis> 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 <emphasis>
+ <property moreinfo="none">New...</property>
+ </emphasis> to add new Runtime.</para>
+
+ <para>The <emphasis>
+ <property moreinfo="none">Target Server</property>
+ </emphasis> allows you to 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.</para>
+ <figure float="0">
+ <title>Project Folders</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_18.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Once your project is imported you can see that JSF related
+ libraries have been added to your project: <emphasis>
+ <property moreinfo="none">jsf-api.jar</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">jsf-impl.jar</property>
+ </emphasis>.</para>
+ <note>
+ <title>Note:</title>
+ <para>Some application servers provide their own jsf
+ implementation libraries. Thus, to avoid conflicts you
+ should not add jsf libraries while adding jsf
+ capabilities.</para>
+ </note>
+ <para>You are now ready to work with JSF by creating a new JSF
+ configuration file:</para>
+
+
+ <figure float="0">
+ <title>Creating a New JSF Configuration File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_19.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Once the file has been created, it should be opened in a
+ special <link linkend="jsf_config_file">Faces Config Editor</link>.</para>
+ </section>
+ <section id="AddingYourOwnProjectTemplates853">
+
+ <title>Adding Your Own Project Templates</title>
+ <para>Template is a set of files that is served as a basis to facilitate
+ the creation of a new project. Project templates provide
+ content and structure for a project.</para>
+ <para>There is 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 and consider the
+ process of creating a template from your existing JSF
+ project.</para>
+
+ <para>Let's say you have a project that you want to use as
+ the basis for a new <property moreinfo="none">template</property>. Follow
+ these steps to make a template out of it:</para>
+ <itemizedlist>
+ <listitem>
+ <para>In the Web Projects view, right-click the
+ project and select <emphasis>
+ <property moreinfo="none">JBoss Tools JSF > Save As
+ Template</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Saving Your Project as Template</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_20.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>In the first dialog box, you can choose a name
+ for the template (defaults to the project
+ name) and confirm what run-time
+ implementation of the project
+ technology will be used</para>
+ </listitem>
+
+ </itemizedlist>
+ <figure float="0">
+ <title>Define Template Properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_20_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <itemizedlist>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> and you will be sent to a dialog
+ box with your project structure displayed
+ with check boxes. Here you can check only
+ those parts and files in your project
+ directory that should be part of the
+ template</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Define Template Properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_20_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>At this point, unless you want to designate
+ some extra files as having Velocity template
+ coding inside them, you should click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis>.</para>
+ </listitem>
+ </itemizedlist>
+ <para>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.</para>
+ <para>At this point, you have a fully configured project and now you can
+ bring some new logic to it starting from JSF configuration
+ file.</para>
+ </section>
+</chapter>
+
+<chapter id="jsf_config_file" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_config_file.xml">
+ <?dbhtml filename="jsf_config_file.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>JSF Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>JSF Configuration File Editor</title>
+
+ <para>First, we should mention that JSF configuration file (<emphasis>
+ <property moreinfo="none">faces-config.xml</property>
+ </emphasis>) is intended for registering JSF application resources such as Converters,
+ Validators, Managed Beans and page-to-page navigation rules.</para>
+ <para>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:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Diagram</para>
+ </listitem>
+ <listitem>
+ <para>Tree</para>
+ </listitem>
+ <listitem>
+ <para>Source</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>They can be selected via the tabs at the bottom of the editor.</para>
+
+ <section id="Diagram9553">
+
+ <title>Diagram view</title>
+
+ <para>Here, we will show you how to work with JSF configuration file through the Diagram
+ view of the editor.</para>
+ <para>As you can see on the figure below, the Diagram view displays the navigation rules in
+ the faces-config.xml:</para>
+ <figure float="0">
+ <title>Diagram View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_21.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>If your diagram is large, make use of the Outline view. Within it you can switch to a <emphasis>
+ <property moreinfo="none">Diagram Navigator</property>
+ </emphasis> 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:</para>
+ <figure float="0">
+ <title>Outline View for Diagram</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_32.png" scale="50"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>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.</para>
+
+ <para>To create a transition for connecting pages:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Select the transition icon from the toolbar (New Connection).</para>
+ </listitem>
+ <listitem>
+ <para>Click the source page.</para>
+ </listitem>
+ <listitem>
+ <para>Click the target page.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>A transition will appear between the two pages:</para>
+ <figure float="0">
+ <title>Transition between JSP Pages</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_22.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It is also possible to create a new page with context menu by right-clicking anywhere
+ on the diagram and selecting <emphasis>
+ <property moreinfo="none">New View</property>. </emphasis></para>
+ <figure float="0">
+ <title>Creating a New View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_23.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>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:</para>
+ <figure float="0">
+ <title>Editing Transition between Views</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_24.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="TreeView11123" role="updated">
+
+ <title>Tree View</title>
+
+ <para>You can find it more convenient to edit your JSF Configuration file in the Tree view of
+ the <property moreinfo="none">VPE</property>.</para>
+
+ <para>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.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Under the <emphasis>
+ <property moreinfo="none">Application</property>
+ </emphasis> node you can adjust JSF application specific settings such as
+ internationalization, possibility to set extensions, add property and variable
+ resolvers, etc.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>JSF Application Specific Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_24a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <emphasis>
+ <property moreinfo="none">Components</property>
+ </emphasis> node is for registering custom JSF components. Right-click and
+ choose <emphasis>
+ <property moreinfo="none">New > Component</property>
+ </emphasis> or just press the <emphasis>
+ <property moreinfo="none">Add</property>
+ </emphasis> button in the right-hand area to add a new component to the JSF
+ Configuration file.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Registering a New JSF Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_24b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In the <property moreinfo="none">Add Component wizard</property> you should set a component
+ type and point to a component class by using the <emphasis>
+ <property moreinfo="none">Browse</property>
+ </emphasis> button or create a new class for this component by using the <emphasis>
+ <property moreinfo="none">Component-Class</property>
+ </emphasis> link.</para>
+
+ <figure float="0">
+ <title>Adding a New JSF Component to the JSF Configuration File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_24c.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Use the <emphasis>
+ <property moreinfo="none">Render Kit</property>
+ </emphasis> node to create and register a set of related renderers for custom
+ JSF components.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Adding a New JSF Component to the JSF Configuration File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_24d.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Under the <emphasis>
+ <property moreinfo="none">Converters</property>
+ </emphasis> 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 <link linkend="CreateAndRegisterACustomConverter94230">Create and Register a
+ Custom Converter</link> section.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Creating a New Custom Converter</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_59.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <emphasis>
+ <property moreinfo="none">Managed Bean</property>
+ </emphasis> node is meant for creating and registering Bean classes in your JSF
+ application. Read more on the topic in the <link linkend="managed_beans">Managed
+ Beans</link> chapter.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Managed Beans</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_26.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Use the <emphasis>
+ <property moreinfo="none">Navigation Rules</property>
+ </emphasis> 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.</para>
+ </listitem>
+ </itemizedlist>
+ <tip>
+ <title>Tip:</title>
+ <para>The same you can do in the <link linkend="Diagram9553">Diagram view</link> of the
+ JSF Configuration file editor.</para>
+ </tip>
+
+ <figure float="0">
+ <title>Configuring Navigation Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_26a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Under the <emphasis>
+ <property moreinfo="none">Referenced Beans</property>
+ </emphasis> node you can add a new Referenced Bean and configure various
+ properties for it. To learn more on this refer to the <link linkend="referenced_beans">Create and Register Referenced Beans</link>
+ section.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Referenced Beans</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_26b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <emphasis>
+ <property moreinfo="none">Validators</property>
+ </emphasis> node is needed to create validator classes for organizing the
+ validation of your application data. You can read more on the topic in the <link linkend="CreateAndRegisterACustomValidator5632">Create and Register a Custom
+ Validator</link> section.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Validators</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_26c.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <emphasis>
+ <property moreinfo="none">Extensions</property>
+ </emphasis> node is for setting extensions for your <emphasis>
+ <property moreinfo="none">faces-config.xml</property>.</emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Adding Extensions</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_26d.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In the <property moreinfo="none">Tree view</property> you can also edit the properties of the selected
+ element with the help of the <property moreinfo="none">Properties view</property> as shown below:</para>
+
+ <figure float="0">
+ <title>Properties View </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_33.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+ <section id="SourceView4643">
+
+ <title>Source View</title>
+
+ <para>Here, we'll discuss how you can configure your faces-config.xml with the help
+ of Source View.</para>
+ <para>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:</para>
+ <figure float="0">
+ <title>Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_27.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>You can also work in the Source view with the help of the <emphasis>
+ <property moreinfo="none">Outline view</property>.</emphasis> 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.</para>
+ <figure float="0">
+ <title>Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_31.png" scale="50"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="jsf_editor_features">
+ <title>Editor Features</title>
+ <para>Here we'll discuss a very important features that JSF configuration file
+ editor provides for work with JSF resources.</para>
+
+ <section id="jsf_openOn">
+ <title>Open On</title>
+ <para>The JSF configuration file editor comes with a very useful OpenOn navigating
+ feature. More fully you can read about it in our <ulink url="../../jsf/html_single/index.html#OpenOnSelection4Hyperlinknavigation">Visual Web Tools
+ Guide</ulink>.</para>
+ </section>
+
+ <section id="ContentAssist976">
+
+ <title>Code Assist</title>
+ <para>Code Assist provides pop-up tip to help you complete your code statements. It
+ allows you to write your code faster and with more accuracy.</para>
+ <para>Code assist is always available in the Source mode:</para>
+ <figure float="0">
+ <title>Code Assist in Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_28.png" scale="65"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="ErrorReporting3324">
+
+ <title>Error Reporting</title>
+ <para>When you are developing your project, error checking is constantly provided. This
+ greatly reduces your development time as it allows you to catch many of the errors
+ during development.</para>
+ <para>Errors will be reported by <link linkend="jsf_project_verification">
+ verification</link> facility:</para>
+ <figure float="0">
+ <title>Error Reporting in Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_29.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Other errors are also reported.</para>
+ <figure float="0">
+ <title>Other Errors Reporting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_30.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+ </section>
+
+</chapter>
+
+
+<chapter id="managed_beans" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/managed_beans.xml">
+ <?dbhtml filename="managed_beans.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>JSF Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Managed Beans</title>
+
+ <para>There is lots of power to work with <property moreinfo="none">managed beans</property>.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Add and generate code for new managed beans</para>
+ <itemizedlist>
+ <listitem>
+ <para>Generate code for attributes and getter/setter methods</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Add existing managed beans to JSF configuration file</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Thus, in this section we will guides you through all this possibilities.</para>
+
+ <section id="CodeGenerationForManagedBeans421">
+
+ <title>Code Generation for Managed Beans</title>
+
+ <para>To start, create a new managed bean in JSF configuration file editor, in the Tree
+ view.</para>
+ <figure float="0">
+ <title>Creation of New Managed Bean</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_34.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <note>
+ <title>Note:</title>
+ <para>When you define a new managed bean, make sure that <emphasis>
+ <property moreinfo="none">Generate Source Code</property>
+ </emphasis> is checked as shown in the figure below.</para>
+ </note>
+ <figure float="0">
+ <title>New Managed Bean</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_35.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>After the <emphasis role="italic">
+ <property moreinfo="none">"Java"</property>
+ </emphasis> class has been generated you can open it for additional editing. There are
+ two ways to open the <emphasis role="italic">
+ <property moreinfo="none">"Java"</property>
+ </emphasis> class:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>click on <emphasis>
+ <property moreinfo="none">Managed-Bean-Class</property>
+ </emphasis> link in the editor</para>
+ </listitem>
+ </itemizedlist>
+ <para>or</para>
+ <itemizedlist>
+ <listitem>
+ <para>right click the <emphasis>
+ <property moreinfo="none">managed bean</property>
+ </emphasis> and select <emphasis>
+ <property moreinfo="none">Open Source</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Opening of Created Managed Bean</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_36.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The generated Java source should look as follows:</para>
+
+ <figure float="0">
+ <title>Java Source Code</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_37.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also generate source code for properties, also includes <emphasis role="italic">
+ <property moreinfo="none">"getter"</property>
+ </emphasis> and <emphasis role="italic">
+ <property moreinfo="none">"setter"</property>
+ </emphasis> methods. Right click on the bean and select <emphasis>
+ <property moreinfo="none">New > Property</property>
+ </emphasis>. You will see <property moreinfo="none">Add Property</property> dialog.</para>
+ <figure float="0">
+ <title>Generation of Source Code for Properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_38.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>When the form is open make sure that all the check boxes are selected:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Add Java property</para>
+ </listitem>
+ <listitem>
+ <para>Generate Getter</para>
+ </listitem>
+ <listitem>
+ <para>Generate Setter</para>
+ </listitem>
+ </itemizedlist>
+ <para></para>
+ <figure float="0">
+ <title>"Add Property" Form</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_39.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Once the generation is complete, you can open the file and see the added property with
+ <emphasis role="italic">
+ <property moreinfo="none">"get"</property>
+ </emphasis> and <emphasis role="italic">
+ <property moreinfo="none">"set"</property>
+ </emphasis> methods:</para>
+ <figure float="0">
+ <title>Generated Java Source Code for Property</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_40.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Thus, we've discussed everything which comes to creating a new Managed Bean.
+ The next section will show you how to add an existing Bean into a JSF configuration
+ file.</para>
+ </section>
+ <section id="AddExistingJavaBeansToAJSFConfigurationFile74332">
+
+ <title>Add Existing Java Beans to a JSF Configuration File</title>
+ <para>If you already have a Java bean you can easily add it to a <property moreinfo="none">JSF configuration
+ file</property>.</para>
+ <para>You should start the same way you create a new managed bean. Use the <emphasis>
+ <property moreinfo="none">Browse...</property>
+ </emphasis> button to add your existing Java class.</para>
+ <figure float="0">
+ <title>New Managed Bean Form</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_42.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Once the class is set, its <emphasis>
+ <property moreinfo="none">Name</property>
+ </emphasis> will be set as well. But you can easily substitute it for the other one.
+ Notice that <emphasis>
+ <property moreinfo="none">Generate Source Code</property>
+ </emphasis> option is not available as the <emphasis role="italic">
+ <property moreinfo="none">"Java"</property>
+ </emphasis> class already exists. </para>
+ <para>After adding your class <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> button will be activated. Pressing it you'll get <emphasis>
+ <property moreinfo="none">Managed Properties</property>
+ </emphasis> dialog where all corresponding properties are displayed. Check the necessary
+ ones to add them into your <property moreinfo="none">JSF Configuration File</property>.</para>
+
+ <figure float="0">
+ <title>Selection of Bean's Properties.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_43.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>If you don't want to add any, just click <emphasis>
+ <property moreinfo="none">Finish</property>. </emphasis></para>
+ <para>Above-listed steps have demonstrated how you can specify an existing Bean in the JSF
+ configuration file, i.e. <emphasis>
+ <property moreinfo="none">faces-config.xml</property>. </emphasis> In the next chapter
+ you'll know how to organize and register another kind of artifacts.</para>
+ </section>
+</chapter>
+
+
+<chapter id="creation_and_registration" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/creation_and_registration.xml">
+ <?dbhtml filename="creation_and_registration.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>JSF Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Creation and Registration</title>
+
+ <section id="CreateAndRegisterACustomConverter94230">
+
+ <title>Create and Register a Custom Converter</title>
+
+ <para>It's also possible to create a
+ custom Converter in order to specify your own converting rules. Let's look at how you can do this.</para>
+
+ <para>To create and register a custom converter it's necessary to
+ go through the following steps:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>In the Project Explorer view open <emphasis>
+ <property moreinfo="none">faces-config.xml</property>
+ </emphasis> and select <emphasis>
+ <property moreinfo="none">Tree</property>
+ </emphasis> tab.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Converters</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_44.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">Converters</property>
+ </emphasis> and click on<emphasis>
+ <property moreinfo="none"> Add</property>
+ </emphasis> button.</para>
+ </listitem>
+ <listitem>
+ <para>On the form type the name of your converter in the <emphasis>
+ <property moreinfo="none">Converter-id</property>
+ </emphasis> field and name of the class for
+ converters. After clicking <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button your custom converter is
+ registered under the entered name.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Add Converter Form</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_45.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Now you can create <emphasis role="italic">
+ <property moreinfo="none">"converter"</property>
+ </emphasis> class. In the Converter section you
+ should see your <emphasis>
+ <property moreinfo="none">Converter-id</property>
+ </emphasis> and
+ <emphasis><property moreinfo="none">Converter-class</property>.</emphasis>
+ Click on <emphasis>
+ <property moreinfo="none">Converter-class</property>
+ </emphasis> to generate the source code.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Generation of Source Code for Converter Class</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_46.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>A usual wizard for creating a Java class will appear.
+ All needed fields here will be adjusted
+ automatically. Just leave everything without changes
+ and click <emphasis>
+ <property moreinfo="none">Finish</property>.
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>New Java Class Form</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_47.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>To open a converter class click again on <emphasis>
+ <property moreinfo="none">Converter-class</property>
+ </emphasis> link in the Converter section.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Converter Class</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_48.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Now you
+ are able to add a business logic of converter in the
+ Java editor.</para>
+ </section>
+
+ <section id="CreateAndRegisterACustomValidator5632">
+
+ <title>Create and Register a Custom Validator</title>
+
+ <para>It's also quite easy to develop your
+ own custom Validators. You should perform the actions similar to the
+ previous one. Go through the following steps:</para>
+ <itemizedlist>
+ <listitem>
+ <para>In the Project Explorer view open<emphasis>
+ <property moreinfo="none"> faces-config.xml</property>
+ </emphasis> and select <emphasis>
+ <property moreinfo="none">Tree </property>
+ </emphasis>tab.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Validator in Faces Config Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_49.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">Validators</property>
+ </emphasis> and click on <emphasis>
+ <property moreinfo="none">Add </property>
+ </emphasis>button.</para>
+ </listitem>
+ <listitem>
+ <para>Type the name of your validator in the <emphasis>
+ <property moreinfo="none">Validator-id</property>
+ </emphasis> field and name of the class for
+ validators. After clicking <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button your custom validator is
+ registered under the entered name.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Adding Validator</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_50.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Now you can create the "validator" class. </para>
+ <itemizedlist>
+ <listitem>
+ <para>In the Validator section you can see your <emphasis>
+ <property moreinfo="none">Validator-id</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">Validator-class</property></emphasis>. To generate the source code click on <emphasis>
+ <property moreinfo="none">Validator-class</property>.
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Creating Validator Class</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_51.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Java class will be created automatically. Leave
+ everything without changes and click <emphasis>
+ <property moreinfo="none">Finish</property>.
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>New Java Class Form</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_52.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>To open validator class click again on <emphasis>
+ <property moreinfo="none">Validator-Class</property>
+ </emphasis> link in the Validator section. Now you
+ are able to write a business logic of validator in
+ the Java editor.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Converter Class Editing</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_53.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="referenced_beans">
+ <title>Create and Register Referenced Beans</title>
+
+ <para>Creation of Referenced Beans is similar to creation of Custom
+ Validator as well. To perform this, let's walk through the necessary steps.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>In the Project Explorer view open<emphasis>
+ <property moreinfo="none"> faces-config.xml</property>
+ </emphasis> and select <emphasis>
+ <property moreinfo="none">Tree </property>
+ </emphasis>tab.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Referenced Beans in Faces Config Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_54.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">Referenced Beans</property>
+ </emphasis> and click on <emphasis>
+ <property moreinfo="none">Add</property>
+ </emphasis> button.</para>
+ </listitem>
+ <listitem>
+ <para>Type in the name of your Referenced Bean and type in
+ or select <emphasis>
+ <property moreinfo="none">Referenced-Bean-Class</property>
+ </emphasis> by using <emphasis>
+ <property moreinfo="none">Browse</property>
+ </emphasis> button.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Add Referenced Bean</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_55.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>In the Referenced Bean section you should see your <emphasis>
+ <property moreinfo="none">Referenced-Bean-Name</property>
+ </emphasis> and
+ <emphasis><property moreinfo="none">Referenced-Bean-Class</property>.</emphasis>
+ Click on the link to open the Java creation
+ wizard.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Create Referenced Bean Class</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_56.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Java class will be created automatically. Leave
+ everything without changes and click <emphasis>
+ <property moreinfo="none">Finish</property>.
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>New Java Class Form</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_57.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>To open Referenced Bean class click again on <emphasis>
+ <property moreinfo="none">Referenced-Bean-Class</property>
+ </emphasis> in the Referenced Bean section. Now you
+ are able to write business logic of Referenced Bean
+ in the Java editor.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Referenced Bean Class Editing</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_support/jsf_support_58.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
+
+<chapter id="jsf_project_verification" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_project_verification.xml">
+ <?dbhtml filename="struts_project_verification.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>JSF Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>JSF Project Verification</title>
+
+ <para>In this chapter we'll discuss a possible verification that you can take advantage
+ of.</para>
+ <!-- JBoss Developer Studio checks for many different rules for a JSF project -->
+ <para>Many different rules are checked for a JSF project that can be configured by selecting <emphasis>
+ <property moreinfo="none">Window > Preferences</property>
+ </emphasis> from the menu bar, selecting <emphasis>
+ <property moreinfo="none">JBoss Tools > Web > Verification</property>
+ </emphasis> from the Preferences dialog box and then expanding the JSF Rules node.</para>
+ <figure float="0">
+ <title>JSF Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Suppose you are working in the Source viewer for a JSF configuration file as shown below:</para>
+ <figure float="0">
+ <title>Faces-config.xml File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>While typing a class name, you might make a minor typo (like <emphasis role="italic">
+ <property moreinfo="none">"jsfHello.PersonBean9"</property>
+ </emphasis> instead of <emphasis role="italic">
+ <property moreinfo="none">"jsfHello.PersonBean"</property>
+ </emphasis>). After saving the file, verification checks to make sure everything is correct
+ and finds the error below:</para>
+ <figure float="0">
+ <title>Error in Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_3.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Notice that the Package Explorer View shows a marked folder and a marked file where the
+ error is.</para>
+ <para>You can place the cursor over the line with an error message and get a detailed error
+ message:</para>
+ <figure float="0">
+ <title>Error Message</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Verification also checks navigation rules:</para>
+ <figure float="0">
+ <title>Checking Navigation Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>If you provide a page name that does not exist, verification will let you know about that:</para>
+ <figure float="0">
+ <title>Page Name Verification</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_6.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You can always call up verification explicitly by right-clicking any element in the tree
+ and selecting Verify from the context menu. This works from both the Tree and Diagram
+ viewers for the JSF configuration file editor. You can also invoke verification from the Web
+ Projects view. Below we are checking all of the elements in the configuration file.</para>
+ <figure float="0">
+ <title>Verify Command</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In summary, this document highlights all the JSF-specific features of <property moreinfo="none">JBoss Tools</property>
+ meant for enhancing the development of rich Web applications based on JSF technology. The
+ reference introduces you to wizards for creating and importing JSF projects, JSF
+ Configuration File editor features, functionality for enabling JSF capabilities and etc.</para>
+
+ <para>If you have questions or good suggestions, please refer to <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss
+ Tools Forum</ulink>.</para>
+</chapter>
+
+</book>
15 years, 2 months
JBoss Tools SVN: r15196 - in branches/jbosstools-3.0.x/jmx/docs/reference: en/images and 1 other directories.
by jbosstools-commits@lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:34:26 -0400 (Mon, 11 May 2009)
New Revision: 15196
Modified:
branches/jbosstools-3.0.x/jmx/docs/reference/en/images/mbean-editor-horizontal-layout_0.2.0.png
branches/jbosstools-3.0.x/jmx/docs/reference/en/images/mbean-editor_0.2.0.png
branches/jbosstools-3.0.x/jmx/docs/reference/en/images/mbean-explorer-features.png
branches/jbosstools-3.0.x/jmx/docs/reference/en/images/mbean-explorer-query.png
branches/jbosstools-3.0.x/jmx/docs/reference/en/modules/extensions.xml
branches/jbosstools-3.0.x/jmx/docs/reference/en/modules/mbean_editor.xml
branches/jbosstools-3.0.x/jmx/docs/reference/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Modified: branches/jbosstools-3.0.x/jmx/docs/reference/en/images/mbean-editor-horizontal-layout_0.2.0.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jmx/docs/reference/en/images/mbean-editor_0.2.0.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jmx/docs/reference/en/images/mbean-explorer-features.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jmx/docs/reference/en/images/mbean-explorer-query.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jmx/docs/reference/en/modules/extensions.xml
===================================================================
--- branches/jbosstools-3.0.x/jmx/docs/reference/en/modules/extensions.xml 2009-05-11 16:34:14 UTC (rev 15195)
+++ branches/jbosstools-3.0.x/jmx/docs/reference/en/modules/extensions.xml 2009-05-11 16:34:26 UTC (rev 15196)
@@ -24,7 +24,7 @@
one child, a connectionProvider with a class that implements
org.jboss.tools.jmx.core.IConnectionProvider.</para>
- <para>An IConnectionProvider is resposnbile for creation and deletion of IConnectionWrapper
+ <para>An IConnectionProvider is responsible for creation and deletion of IConnectionWrapper
objects. It must also keep a list of listeners that it is expected to inform when a
connection is added or removed from its list. </para>
@@ -44,7 +44,9 @@
</listitem>
<listitem>
<para>org.jboss.tools.jmx.ui.attribute.controls - allows you to map class types to some
- Control to present them in the MBean Editor</para>
+ Control to present them in the MBean Editor</para>
+ <para>We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
</listitem>
</itemizedlist>
</section>
Modified: branches/jbosstools-3.0.x/jmx/docs/reference/en/modules/mbean_editor.xml
===================================================================
--- branches/jbosstools-3.0.x/jmx/docs/reference/en/modules/mbean_editor.xml 2009-05-11 16:34:14 UTC (rev 15195)
+++ branches/jbosstools-3.0.x/jmx/docs/reference/en/modules/mbean_editor.xml 2009-05-11 16:34:26 UTC (rev 15196)
@@ -17,14 +17,21 @@
<itemizedlist>
<listitem>
- <para>the Attributes page</para>
+ <para>the <emphasis>
+ <property>Attributes</property></emphasis> page</para>
</listitem>
<listitem>
- <para>the Operations page</para>
+ <para>the <emphasis>
+ <property>Operations</property></emphasis> page</para>
</listitem>
<listitem>
- <para>the Info page </para>
+ <para>the <emphasis>
+ <property>Notifications</property></emphasis> page </para>
</listitem>
+ <listitem>
+ <para>the <emphasis>
+ <property>Info</property></emphasis> page </para>
+ </listitem>
</itemizedlist>
<para> The <emphasis>
@@ -56,11 +63,22 @@
<section>
<title>Notifications Page</title>
- <para>One more page in the <property>MBean Editor</property> is a Notifications Page, which gives the possibility to
+ <para>One more page in the <property>MBean Editor</property> is the <emphasis>
+ <property>Notifications</property></emphasis> page, which gives the possibility to
subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp.
- unchecking) the Subscribe checkbox. </para>
+ unchecking) the <emphasis>
+ <property>Subscribe</property></emphasis> button in the right top corner. </para>
<para>The list of notifications is refreshed every time a new notification is
- received:</para>
+ received:</para>
+
+ <figure>
+ <title>MBean Editor Notifications Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/notifications.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
<note>
<title>Note</title>
Modified: branches/jbosstools-3.0.x/jmx/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/jmx/docs/reference/pom.xml 2009-05-11 16:34:14 UTC (rev 15195)
+++ branches/jbosstools-3.0.x/jmx/docs/reference/pom.xml 2009-05-11 16:34:26 UTC (rev 15196)
@@ -88,6 +88,11 @@
<version>1.1.0</version>
<type>jdocbook-style</type>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
</dependencies>
<configuration>
@@ -156,7 +161,9 @@
</distributionManagement>
<properties>
- <stylesdir>../../../documentation/jbosstools-docbook-xslt/src/main/resources/</stylesdir>
+ <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf>
<cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/org/css/</cssdir>
<master>master.xml</master>
<translation>en-US</translation>
15 years, 2 months