[richfaces-svn-commits] JBoss Rich Faces SVN: r11515 - trunk/ui/core/src/main/config/component.

[richfaces-svn-commits at lists.jboss.org]

Author: cluts
Date: 2008-12-03 08:54:35 -0500 (Wed, 03 Dec 2008)
New Revision: 11515

Modified:
   trunk/ui/core/src/main/config/component/queue.xml
Log:
RF-4664 - Descriptions of the attributes and the new information in the "Key attributes and ways of usage" section have been added;

Modified: trunk/ui/core/src/main/config/component/queue.xml
===================================================================
--- trunk/ui/core/src/main/config/component/queue.xml	2008-12-03 13:40:25 UTC (rev 11514)
+++ trunk/ui/core/src/main/config/component/queue.xml	2008-12-03 13:54:35 UTC (rev 11515)
@@ -31,53 +31,68 @@
 		<property>
 			<name>size</name>
 			<classname>int</classname>
+			<description>Defines the number of items allowed in the queue at one time.</description>
 		</property>
 	    <property>
 	        <name>name</name>
 	        <classname>java.lang.String</classname>
+	    	<description>The optional name of this component</description>
 	        <defaultvalue>""</defaultvalue>
 	    </property>
 
 	    <property >
 	        <name>requestDelay</name>
 	        <classname>int</classname>
+	    	<description>Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. 
+	    		When the delay time is over, the request will be sent to the server or removed if the newest &apos;similar&apos; request is in a queue already</description>
 	    </property>
 		<property>
 			<name>ignoreDupResponses</name>
 			<classname>boolean</classname>
+			<description>Attribute allows to ignore an Ajax Response produced by a request if the newest &apos;similar&apos; request is in a queue already.
+				ignoreDupResponses=&quot;true&quot; does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now</description>
 		</property>
 		<property>
 			<name>timeout</name>
 			<classname>int</classname>
+			<description>Response waiting time on a particular request. If a response is not received during this time, the request is aborted</description>
 		</property>
 		<property>
 			<name>disabled</name>
 			<classname>boolean</classname>
+			<description>If &quot;true&quot;, disable this component on page.</description>
 		</property>
 		
 		<property>
 			<name>onsubmit</name>
 	        <classname>java.lang.String</classname>
+			<description>JavaScript code for call before submission of ajax event</description>
 		</property>
 		<property>
 			<name>onbeforedomupdate</name>
 	        <classname>java.lang.String</classname>
+			<description>JavaScript code for call before DOM has been updated on client side</description>
 		</property>
 		<property>
 			<name>oncomplete</name>
 	        <classname>java.lang.String</classname>
+			<description>JavaScript code for call after request completed on client side</description>
 		</property>
 		<property>
 			<name>onerror</name>
 	        <classname>java.lang.String</classname>
+			<description>HTML: a script expression; event fires whenever an JavaScript error occurs</description>
 		</property>
 		<property>
 			<name>sizeExceededBehavior</name>
 	        <classname>java.lang.String</classname>
+			<description>Defines the strategies of the queue's behavior if the number of the requests waiting in the queue is exceeded. 
+				There are four strategies: dropNext (by default), dropNew, fireNext , fireNew.</description>
 		</property>
 		<property>
 			<name>onsizeexceeded</name>
 	        <classname>java.lang.String</classname>
+			<description>A script expression; a size is exceed</description>
 		</property>
 		
 		<property hidden="true">