From richfaces-svn-commits at lists.jboss.org Fri Aug 15 10:06:34 2008 Content-Type: multipart/mixed; boundary="===============6057206840326999574==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r10116 - in trunk/docs/cdkguide/en/src/main/docbook: modules and 1 other directory. Date: Fri, 15 Aug 2008 10:06:34 -0400 Message-ID: --===============6057206840326999574== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: smukhina Date: 2008-08-15 10:06:34 -0400 (Fri, 15 Aug 2008) New Revision: 10116 Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml trunk/docs/cdkguide/en/src/main/docbook/includes/protoui.xml trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml trunk/docs/cdkguide/en/src/main/docbook/includes/rendererbase.xml trunk/docs/cdkguide/en/src/main/docbook/includes/taghandler.xml trunk/docs/cdkguide/en/src/main/docbook/includes/template.xml trunk/docs/cdkguide/en/src/main/docbook/includes/ui_conf.xml trunk/docs/cdkguide/en/src/main/docbook/modules/intro.xml trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml Log: https://jira.jboss.org/jira/browse/RF-3692 - the is checked = Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml 2008-08-15= 13:49:26 UTC (rev 10115) +++ trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml 2008-08-15= 14:06:34 UTC (rev 10116) @@ -29,7 +29,7 @@ - Here are main directories with descriptions: + Here are the main directories with descriptions: The project structure @@ -77,7 +77,7 @@
- It is necessary to extend predefined structure with the following directo= ries: + It is necessary to extend a predefined structure with the following direc= tories: The project structure Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/protoui.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/cdkguide/en/src/main/docbook/includes/protoui.xml 2008-08-15= 13:49:26 UTC (rev 10115) +++ trunk/docs/cdkguide/en/src/main/docbook/includes/protoui.xml 2008-08-15= 14:06:34 UTC (rev 10116) @@ -45,14 +45,14 @@ All information about styles applied to the <inputDate> - component is considered in the following chapter. + component is provided in the following chapter. This is the result of your prototype which shows a simple page wit= h an input field and an icon indicating that = this is a date field:
- The date field component prototype implemented in HTML with= an icon + The date field component prototype implementation in HTML w= ith an icon = Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml 2008-08-1= 5 13:49:26 UTC (rev 10115) +++ trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml 2008-08-1= 5 14:06:34 UTC (rev 10116) @@ -17,8 +17,8 @@ in order to create and to deliver the resource. = - So, you need to proceed to the inputDate/src/main/config/resou= rces directory and - register following resources in the resource-config.xml file: + Hence, you need to proceed to the inputDate/src/main/config/re= sources directory and + register the following resources in the resource-config.xml file: @@ -45,7 +45,7 @@ - Here you could find = a full example of the resource-config.xml = + Here you could find = a complete example of the resource-config.xml = for the <inputDate> component.
@@ -73,12 +73,12 @@ ...]]> - There are two element in the example above: + There are two elements in the example above: an obligatory <name>= element which defines resource name and = a <path> = element which defines the path to the resource. The <path> element is optional as it is possible to register = dynamic resources with the "class" attribute. - For example you could register dynamic created image as it is shown in = the following example: + For example you could register a dynamically created image as it is sho= wn in the following example: @@ -108,7 +108,7 @@ ...]]> - Sometimes the definition of content type of the resource is needed, so = it is possible to add = + Sometimes the definition of a content type of the resource is needed, s= o it is possible to add = the <content-type> element with the proper MIME type. Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/rendererbase.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/cdkguide/en/src/main/docbook/includes/rendererbase.xml 2008-= 08-15 13:49:26 UTC (rev 10115) +++ trunk/docs/cdkguide/en/src/main/docbook/includes/rendererbase.xml 2008-= 08-15 14:06:34 UTC (rev 10116) @@ -40,7 +40,7 @@ The InputDateRendererBase class extends a HeaderResour= cesRendererBase class. In the HeaderResourcesRendererBase class all the encode() methods for = the right resources encoding - are already realized, so in the InputDateRendererBase class = you need to override + are already implemented, so in the InputDateRendererBase cla= ss you need to override the decode() method only: - Finally on the the Renderer Response phase the valu= e of the component is rendered back to the view. + Finally on the Renderer Response phase the value o= f the component is rendered back to the view. The converter is responsible for transforming the object data back in to= a string representation, so you need to = implement getValueAsString() method: Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/taghandler.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/cdkguide/en/src/main/docbook/includes/taghandler.xml 2008-08= -15 13:49:26 UTC (rev 10115) +++ trunk/docs/cdkguide/en/src/main/docbook/includes/taghandler.xml 2008-08= -15 14:06:34 UTC (rev 10116) @@ -18,7 +18,7 @@ indicate which JSF UIComponent is needed for the applicatio= n. The custom tag has a corresponding tag handler class, which is responsib= le for creating the UIComponent = and transferring each declarative JSP tag attribute to the UICompo= nent instance. = - So you need a custom tag class that returns = + Hence you need a custom tag class that returns = the component type (org.mycompany.InputDate) and the render= er (org.mycompany.InputDateRenderer). Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/template.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/cdkguide/en/src/main/docbook/includes/template.xml 2008-08-1= 5 13:49:26 UTC (rev 10115) +++ trunk/docs/cdkguide/en/src/main/docbook/includes/template.xml 2008-08-1= 5 14:06:34 UTC (rev 10116) @@ -132,7 +132,7 @@ Note: - As is easy to see, in the Template Skeleton the Ren= derer Baseclass is org.ajax4jsf.renderkit.AjaxComponentRendererBase. + As it is seen in the Template Skeleton the Renderer= Baseclass is org.ajax4jsf.renderkit.AjaxComponentRendererBase. You need to define Renderer Base class special for the <inputDate> component. In the next section "Creating a Rend= erer Base class" = we will create Renderer Base class org.mycompany.renderkit.InputDa= teRendererBase. Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/ui_conf.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/cdkguide/en/src/main/docbook/includes/ui_conf.xml 2008-08-15= 13:49:26 UTC (rev 10115) +++ trunk/docs/cdkguide/en/src/main/docbook/includes/ui_conf.xml 2008-08-15= 14:06:34 UTC (rev 10116) @@ -41,7 +41,7 @@ - Application instance stores resources defined in the descriptors at appl= ication start-up, so it is neccessary to register = + Application instance stores resources defined in the descriptors at appl= ication start-up, so it is necessary to register = following classes: Modified: trunk/docs/cdkguide/en/src/main/docbook/modules/intro.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/cdkguide/en/src/main/docbook/modules/intro.xml 2008-08-15 13= :49:26 UTC (rev 10115) +++ trunk/docs/cdkguide/en/src/main/docbook/modules/intro.xml 2008-08-15 14= :06:34 UTC (rev 10116) @@ -13,20 +13,20 @@ The major benefit of the JSF framework is a component based archit= ecture. = The component in JSF is not just a set of HTML code rendered and i= nterpreted by a browser. = - The JSF component is a composition of a client-side widget coupled= with the server-side object = + The JSF component is a combination of a client-side widget coupled= with the server-side object = that represents component behavior including data validation, even= ts handling, business layers bean binding, etc. = = - In contrast to a page-oriented development approach, = + Comparing to a page-oriented development approach, = JSF allows to use a component-oriented paradigm to build a well-de= signed, = highly customizable UI interface based on reusable components. - - However, there is not yet enough sets of rich components on the ma= rket that might enable the rapid application developments. = - One of important problems is a long and very complicated process o= f the component creation. = - Even the very primitive JSF component requires to write the UIComponent class, = + + However, there is not yet enough sets of rich components on the ma= rket that might enable the rapid application development. = + One of the most important problems is a time-consuming and very co= mplicated process of the component creation. = + Even the very primitive JSF component requires the UICom= ponent class, = Renderer class, Tag class - and a faces configuration file (faces-config.xml). = + and a faces configuration file (faces-config.xml) to be written. = In order to use the component library in a Facelets environment, = @@ -36,9 +36,9 @@ Creation of the rich component takes even more time. = You have to provide the ListenerTagHandler class, a class for creating a listener interface, an event processing method name in a listener interface, = - an event class, render specific classes for each possible render k= it used with the component. + an event class, render specific classes for each possible render k= it used with the component. - + Therefore, the process of JSF component creation is pretty complic= ated but repeatable. = Jonas Jacobi and John R. Fallows in their "Pro JSF and Ajax B= ulling Rich Internet Components" book describe = the process in details. = @@ -46,20 +46,20 @@ for Component Development Kit (CDK) - a sub-p= roject of RichFaces that allows you to easily create rich components with built-in Aja= x support. = = - + - - The significant features of the Component Development Ki= t (CDK) are: + + The significant features of the Component Development Ki= t (CDK) are: - - + + Quick development start. = A new component development starts from a pre-generated co= mponent project template. = - It contains the whole required infrastructure and necessar= y files generated. + It contains the whole required infrastructure and necessar= y files generated. It's necessary only to have a Maven installed. = - All other required stuff will be loaded and configured aut= omatically. - + All other required stuff will be loaded and configured aut= omatically. + @@ -89,7 +89,7 @@ At the moment of generating the initial project structure, = the Unit Test classes are also genera= ted. = The RichFaces also provides the Mock-= test facility that allows to emulate = - a run-time environment and automatically test the componen= ts before their are gathered into the result library. + a run-time environment and automatically test components b= efore their are gathered into the result library. @@ -107,6 +107,6 @@ RichFaces comes with a number of predefined skins to get y= ou started, = but you can also easily create your own custom skins. = - + \ No newline at end of file Modified: trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml 2008-08-15 13= :49:26 UTC (rev 10115) +++ trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml 2008-08-15 14= :06:34 UTC (rev 10116) @@ -30,7 +30,7 @@ - Browser (on client side) + Browser (on the client side) After the Maven is installed you should co= nfigure it. In this case, @@ -89,15 +89,15 @@ -...]]> +...]]> - In order to activate new profile, please, add the following aft= er the + In order to activate a new profile, add the following after the profiles section: cdk -...]]> +...]]> Note: @@ -110,7 +110,7 @@ The environment is set up now to use the Component De= velopment Kit (CDK). We are going to create two components throughout the RichFaces = CDK Developer Guide, but - at first you need take the following steps in order to set up the + at first you need take the following steps to set up the Project and create your library: @@ -181,7 +181,7 @@ 3.2.1.GA -]]> +]]> --===============6057206840326999574==--