Author: ochikvina Date: 2009-02-02 08:39:02 -0500 (Mon, 02 Feb 2009) New Revision: 13420 Added: trunk/jsf/docs/userguide/en/modules/richfaces_support.xml Log: https://jira.jboss.org/jira/browse/JBDS-556 - creating a new chapter "RichFaces support"; Added: trunk/jsf/docs/userguide/en/modules/richfaces_support.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/richfaces_support.xml (rev 0) +++ trunk/jsf/docs/userguide/en/modules/richfaces_support.xml 2009-02-02 13:39:02 UTC (rev 13420) @@ -0,0 +1,168 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="richfaces_support" xreflabel="richfaces_support" role="new"> + <?dbhtml filename="editors.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>RichFaces</keyword> + </keywordset> + </chapterinfo> + + <title>RichFaces Support</title> + + <para><property>JBoss Developer Studio</property> comes with a tight integration with <ulink + url="http://labs.jboss.com/jbossrichfaces/">RichFaces component framework</ulink>.</para> + + <note> + <title>Note:</title> + <para><ulink url="http://www.jboss.org/jbossrichfaces/downloads/">RichFaces + 3.3</ulink> is fully supported in the currant version of <property>JBoss Developer Studio</property> (i. e. 2.0.0.CR2) and <property>JBoss Tools 3.0.0.CR2</property>.</para> + </note> + + <para>The following features are implemented and fully supported for the currant version of the RichFaces components:</para> + + <itemizedlist> + <listitem><para><link linkend="ContentAssistForRF">Content Assist</link></para></listitem> + <listitem><para><link linkend="RF_openOn">OpenOn</link></para></listitem> + <listitem><para><link linkend="RF_in_palette">Representing in JBoss Tools Palette</link></para></listitem> + </itemizedlist> + + <para>All you have to do is to <ulink url="http://www.jboss.org/jbossrichfaces/downloads/">downloa... and install RichFaces libraries into your + project, i. e. just put <emphasis> + <property>richfaces-*.jar</property> + </emphasis> files into the <emphasis> + <property>/lib</property> + </emphasis> project folder. Also how to get started with <property>RichFaces</property> you can find in <ulink + url="http://jboss.org/file-access/default/members/jbossrichfaces/fre... + >RichFaces documentation</ulink>.</para> + + <section id="ContentAssistForRF"> + <title>Code Assist for RichFaces</title> + + <para><property>JBDS/JBoss Tools</property> indeed provide code completion for <ulink + url="http://www.jboss.org/jbossrichfaces">RichFaces</ulin... framework + components.</para> + + <tip> + <title>Tip:</title> + + <para>RichFaces 3.3 is now fully supported in code completion.</para> + </tip> + + <figure> + <title>Content Assist for RichFaces Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_29.png" + scale="65"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="RF_openOn"> + <title>OpenOn for RichFaces</title> + + <para>Working with <emphasis> + <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>&lt;rich:insert&gt;</property> + </emphasis> and <emphasis> + <property>&lt;a4j:include&gt;</property> + </emphasis> has <property>OpenOn</property> support.</para> + + <figure> + <title>OpenOn With Richfaces Tag</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_8a.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>OpenOn With A4j Tag</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_8b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <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 + Palette</link>.</para> + + <figure> + <title>RichFaces Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_13.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To insert a <property>RichFaces</property> component on a page:</para> + <itemizedlist> + <listitem> + <para>expand <emphasis> + <property>JBoss RichFaces</property> + </emphasis> group on the palette</para> + </listitem> + + <listitem> + <para>click on some component</para> + </listitem> + + <listitem> + <para>put the needed attributes in the <emphasis> + <property>Insert Tag</property> + </emphasis> dialog and click <emphasis> + <property>Finish</property> + </emphasis> button + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Inserting Tag</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_30.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>RichFaces</property> component will be inserted on your page and displayed in source and visual + modes:</para> + + <figure> + <title>RichFaces Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_31.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section> + <title>Relevant Resources Links</title> + + <para>To get more in-depth information on <property>RichFaces</property> framework refer to <ulink url="http://jboss.org/file-access/default/members/jbossrichfaces/fre... Developer Guide</ulink>.</para> + <para>It may be also helpful for you to look through the <ulink + url="http://docs.jboss.org/tools/movies/" + >movies</ulink> where there are ones that demonstrate the usage of RichFaces components.</para> + </section> +</chapter> \ No newline at end of file