From richfaces-svn-commits at lists.jboss.org Tue Sep 8 13:44:22 2009 Content-Type: multipart/mixed; boundary="===============3238755663650483026==" 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: r15498 - branches/community/3.3.X/docs/userguide/en/src/main/docbook/included. Date: Tue, 08 Sep 2009 13:44:22 -0400 Message-ID: <200909081744.n88HiMIN030266@svn01.web.mwc.hst.phx2.redhat.com> --===============3238755663650483026== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: artdaw Date: 2009-09-08 13:44:21 -0400 (Tue, 08 Sep 2009) New Revision: 15498 Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j= _form.xml Log: https://jira.jboss.org/jira/browse/RF-7275 - a4j:form section restructuring Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu= ded/a4j_form.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 --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4= j_form.xml 2009-09-08 16:02:37 UTC (rev 15497) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4= j_form.xml 2009-09-08 17:44:21 UTC (rev 15498) @@ -1,140 +1,214 @@
- - < - a4j:form - > - <emphasis role=3D"since"> - <superscript> available since <emphasis role=3D"version">3.0.0</e= mphasis> - </superscript> - </emphasis> - -
- - - a4j:form - component - - - Description + + < + a4j:form + > + <emphasis role=3D"since"> + <superscript>available since + <emphasis role=3D"version">3.0.0</emphasis> + </superscript> + </emphasis> + +
+ + + a4j:form + component + + + Description - The - <a4j:form> - component is very similar to JSF - <h:form> - the only difference is in generation of links inside = and possibility of default Ajax submission. + The + + <a4j:form> + + component enhances functionality of the standard JSF + + <h:form> + + component with possibility of default Ajax submission + and fixes the problem with + + <h:commandLink> + + generation inside the form. -
-
- Details of Usage - - The difference with the original component is th= at all hidden fields - required for command links are always render= ed and it doesn't depend - on links rendering on the initial page. It s= olves the problem with - invalid links that weren't rendered on a pag= e immediately, but after - some Ajax request. - Beginning with release 1.0.5 additional attribut= es that make this form - variant universal have appeared. - If - "ajaxSubmit" - attribute is true, it becomes po= ssible to set Ajax - submission way for any components inside wit= h the help of the javascript - A4J.AJAX.Submit(...)call. In th= is case, the - "reRender" - attribute contains a list of Ids= of components defined for - re-rendering. If you have - <h:commandButton><= /property> - or - <h:commandLink> - inside the form, they work as - <a4j:commandButton>= ; - . - - Example: - - - ... - - ... - - ... - - ... - - ... +
+
+ Details of Usage + + Along with + + a4j:htmlCommandLink + + , + + <a4j:form> + + component fixes the problem of + + <h:commandLink> + + component that cannot be re-rendered + without re-rendering the whole form it belongs to. For the fur= ther details see the + Ajax Form Usage + page at RichFaces Livedemo. + + + + The + + <a4j:form> + + component adds extra functionality to non-Ajax action/command = components: submission is performed + via Ajax when + + "ajaxSubmit" + + attribute set to "true". + + + If the + + <a4j:form> + + component + works in an Ajax mode, the standard Ajax attributes such as + + "reRender" + + , + + "limitToList" + + , + + "requestDelay" + + , etc. can be used. + + + Example: + + + + + + -]]> - - This example shows that in order to make - <t:datascroller> - submissions to be Ajax ones it's required only to pla= ce this - <t:datascroller> - into - <a4j:form> - . = - In the other case it is necessary to redefine re= nders for its child links elements that are defined as - <h:commandLink> - and can't be made Ajax ones with using e.g. - <a4j:support> - . - - - With the help of - "limitToList" - attribute you can limit areas, which are updated afte= r the responses. = - If - "limitToList" - is true, only the reRender attribute is taken in acco= unt. = - Therefore, if you use blocks of text wrapped wit= h - <a4j:outputPanel> - and ajaxRendered=3D "true", blocks of te= xt are ignored. = - - - Information about the - "process" - attribute usage you can find in the "Decide what to process" guide section. = - -
-
- Reference Data - - Table of = - <a4j:form> = - attributes. - - - Component Identification Parameters - - - - Name - Value - - - - - component-type - org.ajax4jsf.Form= - - - component-family<= /entry> - javax.faces.Form<= /entry> - - - component-class - org.ajax4jsf.comp= onent.html.AjaxForm - - - renderer-type - org.ajax4jsf.Form= Renderer - - - -
-
-
- Relevant Resources Links - - Visit AjaxForm at RichFaces Li= vedemo for examples of component usage and their sources. - a -
+...]]> + + Here is a managed bean: + + + + In the example above the + ajaxSubmit=3D"true", + so all standard action components on this form become ajaxable. + The + + "reRender" + + attribute contains an Id of component for + re-rendering after an Ajax response. + + + Tip: + + If you have + + <h:commandButton> + + or + + <h:commandLink> + + inside a form, they work as + + <a4j:commandButton> + + . + + + + Note: + + You should not use + + <a4j:form> + + component with + ajaxSubmit=3D"true" + if it contains other Ajax command components. + Also, due to the security reason, file upload form element= cannot be convertible to the be ajaxable. + + +
+
+ Reference Data + + Table of + <a4j:form> + attributes. + + + Component Identification Parameters + + + + Name + Value + + + + + component-type + org.ajax4jsf.Form + + + component-family + javax.faces.Form + + + component-class + org.ajax4jsf.component.html.AjaxForm + + + renderer-type + org.ajax4jsf.FormRenderer + + + +
+
+
+ Relevant Resources Links + + Visit + Ajax Form + page + at RichFaces Livedemo for examples of component usage and thei= r sources. + + + For additional information about attributes of this component = read'Ajax + Attribute' section. + +
\ No newline at end of file --===============3238755663650483026==--