[richfaces-svn-commits] JBoss Rich Faces SVN: r22212 - in trunk/examples/richfaces-showcase/src/main/webapp/richfaces: mediaOutput and 6 other directories.

Author: SeanRogers Date: 2011-03-14 21:40:09 -0400 (Mon, 14 Mar 2011) New Revision: 22212 Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/log/log.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/mediaOutput/imgUsage.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/compositemessages.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/samples/compositemessages-sample.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/simple.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/region/region.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/region/samples/region-sample.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/referencedusage.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/samples/simple-sample.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/samples/viewusage-sample.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/simple.xhtml trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/viewusage.xhtml Log: Revised showcase text for Ajax Output/Containers: RFPL-1213 Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/log/log.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/log/log.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/log/log.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -5,9 +5,9 @@ xmlns:ui="http://java.sun.com/jsf/facelets"> <ui:composition> - <p>Log component allows you to inspect client side activities - during an Ajax request. It shows reuqest data, response data, DOM tree - changes on update and other useful debug information.</p> + <p>The <b>a4j:log</b> component allows you to inspect client-side activities + during an Ajax request. It shows request data, response data, the DOM tree + changes on an update, and other useful debug information.</p> <ui:include src="#{demoNavigator.sampleIncludeURI}" /> <ui:include src="/templates/includes/source-view.xhtml"> <ui:param name="src" value="#{demoNavigator.sampleIncludeURI}" /> @@ -17,4 +17,4 @@ </ui:include> </ui:composition> -</html> \ No newline at end of file +</html> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/mediaOutput/imgUsage.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/mediaOutput/imgUsage.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/mediaOutput/imgUsage.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -5,28 +5,28 @@ xmlns:ui="http://java.sun.com/jsf/facelets"> <ui:composition> - <p>a4j:mediaOutput allows to generate images, video, sounds and - other binary resources defined by a user on-the-fly.</p> - <p><b>createContent</b> attribute references to the method that - will be used for content creating. The method accepts two parameters. - The first parameter has an <b>OutputStream </b>type. It is a reference - to the steam that should be used for output. The second parameter is a - reference to a '<b>value</b>' attribute of the component.</p> - <p><b>value</b> attribute references to data that can be used as - input data for a content creator method. The data should be - serializable because it is encoded to the URL of the resource.</p> - <p><b>mimeType</b> attribute defines the type of output content. It - is used to define the corresponded type in the header of an HTTP + <p>The <b>a4j:mediaOutput</b> component allows images, video, sounds, and + other binary resources to be displayed as defined by a user on the fly.</p> + <p>The <b>createContent</b> attribute references the method that + is used for creating content. The method accepts two parameters:</p> + <ul><li>The <b>OutputStream</b> parameter is a reference + to the stream that is used for output.</li> + <li>The second parameter is a reference to the <b>value</b> attribute + of the component.</li></ul> + <p>The <b>value</b> attribute references data that can be used as + input data for the content creator method. The data should be + serializable since it is encoded as the URL of the resource.</p> + <p>The <b>mimeType</b> attribute defines the type of output content. It + is used to define the corresponding type in the header of an HTTP response.</p> - <p><b>cacheable</b> attribute is a flag that defines the caching - strategy. If 'cacheable' is set to false, the response will not be - cached. If it is set to true, it will be cached and the serialized - value of 'value' attribute plays the role of a cache key.</p> + <p>The <b>cacheable</b> attribute is a flag that defines the caching + strategy. If <b>cacheable</b> is set to false, the response will not be + cached. If set to true, it will be cached and the serialized + value of the <b>value</b> attribute is used as a cache key.</p> - <p>As <b>Google Application Engine restricts AWT classes usage</b> - in - this sample we <b>reading existent image and performing just re-indexing of the - palette</b> using colors you selected below. So try to change the color and - click process.</p> + <p>As the <i>Google Application Engine</i> restricts AWT class usage, + this example reads the existing image and only performs re-indexing of the + palette using colors you selected below.</p> <ui:include src="#{demoNavigator.sampleIncludeURI}" /> <ui:include src="/templates/includes/source-view.xhtml"> <ui:param name="src" value="#{demoNavigator.sampleIncludeURI}" /> @@ -36,4 +36,4 @@ </ui:include> </ui:composition> -</html> \ No newline at end of file +</html> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/compositemessages.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/compositemessages.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/compositemessages.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -5,9 +5,9 @@ xmlns:ui="http://java.sun.com/jsf/facelets"> <ui:composition> - <p>Next sample shows how you could simply create composite - component from standard h:messages and a4j:outputPanel in order to get - them updated for any ajax request without render definition.</p> + <p>This sample shows how you could simply create a composite + component using standard <b>h:messages</b> and <b>a4j:outputPanel</b> components. + The composite component is updated for any Ajax request without render definition.</p> <ui:include src="#{demoNavigator.sampleIncludeURI}" /> <ui:include src="/templates/includes/source-view.xhtml"> <ui:param name="src" value="#{demoNavigator.sampleIncludeURI}" /> @@ -23,4 +23,4 @@ </ui:include> </ui:composition> -</html> \ No newline at end of file +</html> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/samples/compositemessages-sample.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/samples/compositemessages-sample.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/samples/compositemessages-sample.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -7,7 +7,7 @@ xmlns:rich="http://richfaces.org/rich" xmlns:r="http://java.sun.com/jsf/composite/org.richfaces.showcase&qu... <h:form> - <rich:panel id="psnel"> + <rich:panel id="panel"> <f:facet name="header"> <h:outputText value="User Details Panel" /> </f:facet> @@ -17,8 +17,8 @@ <h:inputText value="#{userBean.name}" required="true" label="Name"> <f:validateLength minimum="3" maximum="12" /> </h:inputText> - <h:outputText value="Adress:" /> - <h:inputTextarea value="#{userBean.address}" label="Adress" + <h:outputText value="Address:" /> + <h:inputTextarea value="#{userBean.address}" label="Address" required="true"> <f:validateLength maximum="100" /> </h:inputTextarea> @@ -33,4 +33,4 @@ </a4j:outputPanel> </rich:panel> </h:form> -</ui:composition> \ No newline at end of file +</ui:composition> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/simple.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/simple.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/outputPanel/simple.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -6,22 +6,21 @@ <ui:composition> - <p><b>a4j:outputPanel</b> component designed to provide next + <p>The <b>a4j:outputPanel</b> component provides the following features: <ul> - <li><b>Automaticall updates</b> of the child content on Ajax + <li><i>Automatic updating</i> of any child content during Ajax requests</li> - <li>Wrapper component for <b>conditional rendering of nested - elements</b> via Ajax</li> - <li><b>Configurable layouts</b>: + <li>A wrapper component for <i>conditional rendering of nested + elements</i> through Ajax</li> + <li><i>Configurable layouts</i>: <ul> - <li>inline - rendered as span element</li> - <li>block - rendered as div element</li> - <li>none - special layout for nested components confitional - rendering cases</li> + <li><b>inline</b>, rendered as a <b>span</b> element.</li> + <li><b>block</b>, rendered as <b>div</b> element.</li> + <li><b>none</b>, special layout for nested components with conditional + rendering cases.</li> </ul> </li> - <li></li> </ul> </p> <ui:include src="#{demoNavigator.sampleIncludeURI}" /> @@ -33,4 +32,4 @@ </ui:include> </ui:composition> -</html> \ No newline at end of file +</html> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/region/region.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/region/region.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/region/region.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -5,22 +5,22 @@ xmlns:ui="http://java.sun.com/jsf/facelets"> <ui:composition> - <p><b>a4j:region</b> component designed for marking zones which - should be processed during Ajax requests without using execute - definitions at Ajax behaviors/components. This allow to decouple the - processing definitions from components id's and use declarative - wrapping by this tag instead.</p> - <p>In <b>RichFaces 3.3</b> all the view was processed if no regions - specified as <b>ViewRoot itself was region by default</b>. And in <b>RichFaces - 4.x</b> - all the controls has <b>execute="@this" by default</b> according - to JSF 2 specifications. But if the <b>controls wrapped with - a4j:region</b> component and has no execute definitions - them uses<b> - execute="@region"</b></p> - <p>Look to the simple example below. There are two similar user - info panels. But the <b><u>button inside the first panel will not works</u> </b>as not uses execute - declarations and by default execut equals to @this. Separate definition needed to start working properly. - And the <b>second panel inputs - just wrapped to region with the commandButton and works</b> without any additional execute definitions.</p> + <p>The <b>a4j:region</b> component is used to mark zones which + should be processed during Ajax requests without using <b>execute</b> + definitions for Ajax behaviors or components. This allows the + processing definitions and component identifiers to be decoupled, + and declarative wrapping with the <b>a4j:region</b> tag is used instead.</p> + <p>In <i>RichFaces 3.3</i>, the whole view was processed if no regions were + specified, as <b>ViewRoot</b> itself was the region by default. In <i>RichFaces + 4.x</i>, all the controls have <b>execute="@this"</b> by default according + to JSF 2 specifications. However, if the controls wrapped with the + <b>a4j:region</b> tag and have no execute definitions, they use <b> + execute="@region"</b> instead.</p> + <p>The example below contains two similar user + info panels. The button inside the first panel will not work, as it does not use execute + declarations; by default it uses <b>execute="@this"</b>. A separate definition is needed + to make the button work properly. The second panel inputs + are wrapped in a region with the <b>commandButton</b>, and input works without any additional execute definitions.</p> <ui:include src="#{demoNavigator.sampleIncludeURI}" /> <ui:include src="/templates/includes/source-view.xhtml"> <ui:param name="src" value="#{demoNavigator.sampleIncludeURI}" /> @@ -29,4 +29,4 @@ <ui:param name="hideLabel" value="Hide Source" /> </ui:include> </ui:composition> -</html> \ No newline at end of file +</html> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/region/samples/region-sample.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/region/samples/region-sample.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/region/samples/region-sample.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -10,7 +10,7 @@ <h:panelGrid columns="2"> <h:panelGrid> <f:facet name="header"> - User Info Panel explicitly execute'd by Id + User Info Panel explicitly executed by identifier </f:facet> <h:panelGrid columns="2" id="userInfoPanel1"> <h:outputText value="User Name: " /> @@ -60,4 +60,4 @@ </h:form> </ui:composition> -</html> \ No newline at end of file +</html> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/referencedusage.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/referencedusage.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/referencedusage.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -4,11 +4,11 @@ xmlns:f="http://java.sun.com/jsf/core" xmlns:ui="http://java.sun.com/jsf/facelets"> <ui:composition> - <p>Example of status which referenced from the components</p> - <p>There are two inputs with Ajax behaviors attached. And there are - two statuses which are referenced from that behaviors. <b>status</b> - attribute at Ajax tags defined with corresponding statuses <b>name</b> - attributes values.</p> + <p>This example shows the <b>a4j:status</b> component referenced from other components.</p> + <p>The two inputs have attached Ajax behaviors. Two <b>a4j:status</b> components + are referenced from those behaviors. The <b>status</b> + attribute for the Ajax tags defines the <b>name</b> + attribute of the corresponding <b>a4j:status</b> components.</p> <ui:include src="#{demoNavigator.sampleIncludeURI}" /> <ui:include src="/templates/includes/source-view.xhtml"> @@ -18,4 +18,4 @@ <ui:param name="hideLabel" value="Hide Source" /> </ui:include> </ui:composition> -</html> \ No newline at end of file +</html> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/samples/simple-sample.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/samples/simple-sample.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/samples/simple-sample.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -6,7 +6,7 @@ xmlns:a4j="http://richfaces.org/a4j" xmlns:rich="http://richfaces.org/rich"> <h:form> - <rich:panel id="psnel"> + <rich:panel id="panel"> <f:facet name="header"> <h:outputText value="Panel with status" /> </f:facet> @@ -15,7 +15,7 @@ <a4j:ajax event="keyup"> <h:outputText value="User name:" /> <h:inputText value="#{userBean.name}" /> - <h:outputText value="Adress:" /> + <h:outputText value="Address:" /> <h:inputText value="#{userBean.address}" /> </a4j:ajax> </h:panelGrid> @@ -30,4 +30,4 @@ <h:outputText value="#{userBean.recordStatus}" id="out" /> </rich:panel> </h:form> -</ui:composition> \ No newline at end of file +</ui:composition> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/samples/viewusage-sample.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/samples/viewusage-sample.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/samples/viewusage-sample.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -7,7 +7,7 @@ xmlns:rich="http://richfaces.org/rich"> <h:panelGrid columns="3"> <h:form> - <rich:panel id="psnel"> + <rich:panel id="panel"> <f:facet name="header"> <h:outputText value="User Details Panel" /> </f:facet> @@ -15,7 +15,7 @@ <a4j:ajax event="keyup"> <h:outputText value="User name:" /> <h:inputText value="#{userBean.name}" /> - <h:outputText value="Adress:" /> + <h:outputText value="Address:" /> <h:inputText value="#{userBean.address}" /> </a4j:ajax> </h:panelGrid> @@ -41,4 +41,4 @@ </f:facet> </a4j:status> </h:panelGrid> -</ui:composition> \ No newline at end of file +</ui:composition> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/simple.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/simple.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/simple.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -5,8 +5,8 @@ xmlns:ui="http://java.sun.com/jsf/facelets"> <ui:composition> - <p>Example of form scoped status. It's defined within a form and - handles all Ajax requests within this form</p> + <p>This example demonstrates a form-scoped <b>a4j:status</b> component. The component is defined within a form, and + it handles all Ajax requests within the form.</p> <ui:include src="#{demoNavigator.sampleIncludeURI}" /> <ui:include src="/templates/includes/source-view.xhtml"> <ui:param name="src" value="#{demoNavigator.sampleIncludeURI}" /> @@ -16,4 +16,4 @@ </ui:include> </ui:composition> -</html> \ No newline at end of file +</html> Modified: trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/viewusage.xhtml =================================================================== --- trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/viewusage.xhtml 2011-03-14 23:37:38 UTC (rev 22211) +++ trunk/examples/richfaces-showcase/src/main/webapp/richfaces/status/viewusage.xhtml 2011-03-15 01:40:09 UTC (rev 22212) @@ -5,19 +5,20 @@ xmlns:ui="http://java.sun.com/jsf/facelets"> <ui:composition> - <p>a4j:status is an indicator of an Ajax request. It has two states - - start and stop. The start state indicates that an Ajax request is in - progress. When Ajax Response comes back, the component switches to the - stop stage.</p> - <p>Status could be defined: + <p>The <b>a4j:status</b> component is an indicator of an Ajax request. + It has two states: <i>start</i> and <i>stop</i>. + The <i>start</i> state indicates that an Ajax request is in progress. + When an Ajax Response is returned, the component switches to the + <i>stop</i> state.</p> + <p>The <b>a4j:status</b> component could be defined as follows: <ul> - <li>Default for View</li> - <li>Default for form</li> - <li>Referenced explicity from the component which sends request</li> + <li>As the default for a view.</li> + <li>As the default for a form.</li> + <li>Referenced explicity from the component sending the request.</li> </ul> </p> - <p>Example of View scoped status. It should be defined outside of - any form and will handle all the Ajax requests within the view.</p> + <p>This example shows a view-scoped <b>a4j:status</b> component. It should be defined outside of + any forms, and will handle all the Ajax requests within the view.</p> <ui:include src="#{demoNavigator.sampleIncludeURI}" /> <ui:include src="/templates/includes/source-view.xhtml"> <ui:param name="src" value="#{demoNavigator.sampleIncludeURI}" /> @@ -26,4 +27,4 @@ <ui:param name="hideLabel" value="Hide Source" /> </ui:include> </ui:composition> -</html> \ No newline at end of file +</html>