Author: ilya_shaikovsky Date: 2010-06-01 11:37:15 -0400 (Tue, 01 Jun 2010) New Revision: 17453 Modified: root/dist/trunk/readme-examples.txt root/dist/trunk/readme-ui.txt root/examples/core-demo/trunk/readme.txt root/examples/richfaces-showcase/trunk/readme.txt root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/extendedDataTable/simpleTable.xhtml root/ui/core/trunk/readme.txt root/ui/iteration/trunk/readme.txt root/ui/misc/trunk/readme.txt Log: https://jira.jboss.org/browse/RFPL-607 + minor demo description update Modified: root/dist/trunk/readme-examples.txt =================================================================== --- root/dist/trunk/readme-examples.txt 2010-06-01 15:24:43 UTC (rev 17452) +++ root/dist/trunk/readme-examples.txt 2010-06-01 15:37:15 UTC (rev 17453) @@ -6,21 +6,15 @@ Getting up and running quickly ------------------------------- -This demo application should be built using Maven 2.1.0 +The core-demo and richfaces-showcase demo applications should be built using Maven 2.1.0 tomcat6/jetty targetted build: -1) execute "mvn install" in root application folder(examples/richfaces-showcase) + +1) execute "mvn install" in root application folder(examples/richfaces-showcase or examples/core-demo) 2) Deploy to tomcat 6.x or just run using maven on jetty using "mvn jetty:run-war" -For JEE6 application server: -1) execute "mvn install -P jee6" in root application folder(examples/richfaces-showcase) -2) Deploy to Jboss 4.x or higher or some other jee6 application servers. -3) Do not forget to change the JSF implementation shipped with application server to JSF 2 (latest SNAPSHOT) +Type http://localhost:8080/richfaces-showcase http://localhost:8080/core-demo in your browser command line after starting server. -To build both archives execute "mvn install -P release" - -Type http://localhost:8080/richfaces-showcase in your browser command line after starting server. - Learn more ---------- RichFaces Project - http://www.jboss.org/richfaces Modified: root/dist/trunk/readme-ui.txt =================================================================== --- root/dist/trunk/readme-ui.txt 2010-06-01 15:24:43 UTC (rev 17452) +++ root/dist/trunk/readme-ui.txt 2010-06-01 15:37:15 UTC (rev 17453) @@ -7,36 +7,72 @@ Getting up and running quickly ------------------------------- -1) Put RichFaces libraries and its dependencies in your application libraries folder: - 1.1) richfaces-api - 1.2) richfaces-impl - 1.3) core-ui - 1.4) commons-logging - 1.5) commons-beanutils - 1.6) slf4j-api - 1.7) slf4j-log4j12 (or whatever else - select the implementation according to logging framework that you use) - -2) As opposed to the previous 3.x.y versions of RichFaces, no special configuration steps are necessary. -You don't need to modify web.xml or faces-config.xml - -3) Add RichFaces namespace/taglib declaration to your VDL/XHTML pages which will use RichFaces components - Use xmlns:a4j="http://richfaces.org/a4j" namespace - +1) Put RichFaces libraries and its dependencies in your application libraries folder: + 1.1) richfaces-commons-api-4.0.0-ALPHA2.jar + 1.2) richfaces-core-api-4.0.0-ALPHA2.jar + 1.3) richfaces-core-impl-4.0.0-ALPHA2.jar + 1.4) richfaces-ui-core-ui-4.0.0-ALPHA2.jar + 1.5) richfaces-ui-iteration-api-4.0.0-ALPHA2.jar + 1.6) richfaces-ui-iteration-impl-4.0.0-ALPHA2.jar + 1.7) richfaces-ui-iteration-ui-4.0.0-ALPHA2.jar + 1.8) richfaces-ui-misc-ui-4.0.0-ALPHA2.jar + 1.9) slf4j-api + 1.10) slf4j-log4j12 (or whatever else - select the implementation according to logging framework that you use) + +2) As opposed to the previous 3.x.y versions of RichFaces, no special configuration steps are necessary. +You don't need to modify web.xml or faces-config.xml + +3) Add RichFaces namespaces/taglibs declaration to your VDL/XHTML pages which will use RichFaces components + Use xmlns:a4j="http://richfaces.org/a4j" namespace for core components + Use xmlns:it="http://richfaces.org/iteration" namespace for Iteration components + Use xmlns:m="http://richfaces.org/misc"namespace for Misc components + 4) Add one of the available RichFaces 4.0.A1 components to your page and try it! - 4.1) Take a look at the RichFaces examples distribution for assistance with usage. + 4.1) Take a look at the RichFaces examples distribution for assistance with usage. -Available Components ---------------------------------- -a4j:ajax -a4j:commandLink -a4j:commandButton -a4j:push -a4j:mediaOutput -a4j:status -a4j:jsFunction -a4j:log +Available Components/Behaviors/Tags/Functions + +--------------------------------- +Core module: +--------------------------------- + +a4j:ajax +a4j:commandLink +a4j:commandButton +a4j:push +a4j:mediaOutput +a4j:status +a4j:jsFunction +a4j:log a4j:outputPanel +a4j:poll +a4j:param +a4j:queue +a4j:attachQueue +a4j:repeat +a4j:region +--------------------------------- +Iteration Module +--------------------------------- +it:dataTable +it:extendedDataTablesubTable +it:dataScroller +it:subTableToggleControl +it:columnGroup +it:column + +--------------------------------- +Misc Module +--------------------------------- +m:clientId +m:element +m:component +m:isUserInRole +m:findComponent +m:componentControl +m:hashParam + Learn more ---------- RichFaces Project - http://www.jboss.org/richfaces Modified: root/examples/core-demo/trunk/readme.txt =================================================================== --- root/examples/core-demo/trunk/readme.txt 2010-06-01 15:24:43 UTC (rev 17452) +++ root/examples/core-demo/trunk/readme.txt 2010-06-01 15:37:15 UTC (rev 17453) @@ -0,0 +1,41 @@ +The core-demo application: application is main test application used in daily development for testing purposes. It's more "rich" than showcase application +from functionality coverage point of view, but the cases not intended to be implemented in user-friendly or meaningfull way. + + +1 Building and Running the application + + +1.1. Requirements + +- Maven 2.1.0 or later +- Apache Tomcat 6.0 +- JDK 1.6 + +1.2 Optional Additional Software +- Eclipse IDE + JBoss Tools (to explore and run the application in IDE). +- You're free to use any other IDE also but we're not checked an application in other environments. + + +1.3 Building the application + +To build the project you need to navigate to the /examples/core-demo and run + +mvn clean install + +When you see the BUILD SUCCESSFUL message you can deploy the application on the server. You can deploy it on the server by copying the wae file from target to +the TOMCAT_HOME/webapps folder. Then, launch the startup.sh or startup.bat script from TOMCAT_HOME/bin/ directory to start the server. + +In order to explore, run and deploy the application in Eclipse IDE you could use of the next options: + + * Just import as maven project if using m2eclipse plugin. + + * without m2eclipse - build it with the + + mvn clean install eclipse:clean eclipse:eclipse + + comand and just import as existent project. + +More details you can find in the RichFaces Getting Started Guide (visit documentation page at http://jboss.org/richfaces) + + + Modified: root/examples/richfaces-showcase/trunk/readme.txt =================================================================== --- root/examples/richfaces-showcase/trunk/readme.txt 2010-06-01 15:24:43 UTC (rev 17452) +++ root/examples/richfaces-showcase/trunk/readme.txt 2010-06-01 15:37:15 UTC (rev 17453) @@ -1,4 +1,6 @@ -The RichFaces application: short description +The richFaces-showcase application: showcase application intended to show RichFaces components in Action. It contains set of small use-cases implemented for every component. +Except basic samples - use-cases for demo choosen from most popular questions at user forums - so you will be able to find much usefull information there and will be able +just to re-use some code to implement the same cases for your applications. 1 Building and Running the application @@ -17,7 +19,7 @@ 1.3 Building the application -To build the project you need to navigate to the /exmaples/richfaces-showcase and run +To build the project you need to navigate to the /examples/richfaces-showcase and run mvn clean install Modified: root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/extendedDataTable/simpleTable.xhtml =================================================================== --- root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/extendedDataTable/simpleTable.xhtml 2010-06-01 15:24:43 UTC (rev 17452) +++ root/examples/richfaces-showcase/trunk/src/main/webapp/richfaces/extendedDataTable/simpleTable.xhtml 2010-06-01 15:37:15 UTC (rev 17453) @@ -16,7 +16,7 @@ <h:form> <it:extendedDataTable value="#{carsBean.allInventoryItems}" var="car" - id="table" frozenColumns="2" style="height:300px; width:500px;" rowClasses="qwe, qe"> + id="table" frozenColumns="2" style="height:300px; width:500px;"> <f:facet name="header"> <h:outputText value="Cars marketplace" /> </f:facet> @@ -64,6 +64,8 @@ </it:column> </it:extendedDataTable> </h:form> + <p>In order to turn on Ajax loading - just specify clientRows attribute with number of rows + to be loaded on the client</p> </ui:composition> </html> \ No newline at end of file Modified: root/ui/core/trunk/readme.txt =================================================================== --- root/ui/core/trunk/readme.txt 2010-06-01 15:24:43 UTC (rev 17452) +++ root/ui/core/trunk/readme.txt 2010-06-01 15:37:15 UTC (rev 17453) @@ -0,0 +1,18 @@ +core module consist of next components: +Since A1 + * a4j:ajax + * a4j:commandButton + * a4j:commandLink + * a4j:jsFunction + * a4j:push + * a4j:outputPanel + * a4j:status + * a4j:mediaOutput + * a4j:log +Since A2 + * a4j:poll + * a4j:param + * a4j:queue + * a4j:attachQueue + * a4j:repeat + * a4j:region Modified: root/ui/iteration/trunk/readme.txt =================================================================== --- root/ui/iteration/trunk/readme.txt 2010-06-01 15:24:43 UTC (rev 17452) +++ root/ui/iteration/trunk/readme.txt 2010-06-01 15:37:15 UTC (rev 17453) @@ -0,0 +1,9 @@ +This module contains of next components: + + +dataTable +extendedDataTablesubTable +dataScroller +subTableToggleControl +columnGroup +column Modified: root/ui/misc/trunk/readme.txt =================================================================== --- root/ui/misc/trunk/readme.txt 2010-06-01 15:24:43 UTC (rev 17452) +++ root/ui/misc/trunk/readme.txt 2010-06-01 15:37:15 UTC (rev 17453) @@ -0,0 +1,12 @@ +misc module contains of next set of components tags and behaviors: + +componentControl +hashParam + +Also there are next functions: + +clientId +element +component +isUserInRole +findComponent