svn commit: r426903 - /struts/struts2/trunk/core/src/main/java/org/apache/struts2/components/TimePicker.java

[tmjee]

Author: tmjee
Date: Sun Jul 30 10:20:04 2006
New Revision: 426903

URL: http://svn.apache.org/viewvc?rev=426903&view=rev
Log:
WW-1398
  - added snippet to javadoc 


Modified:
    
struts/struts2/trunk/core/src/main/java/org/apache/struts2/components/TimePicker.java

Modified: 
struts/struts2/trunk/core/src/main/java/org/apache/struts2/components/TimePicker.java
URL: 
http://svn.apache.org/viewvc/struts/struts2/trunk/core/src/main/java/org/apache/struts2/components/TimePicker.java?rev=426903&r1=426902&r2=426903&view=diff
==============================================================================
--- 
struts/struts2/trunk/core/src/main/java/org/apache/struts2/components/TimePicker.java
 (original)
+++ 
struts/struts2/trunk/core/src/main/java/org/apache/struts2/components/TimePicker.java
 Sun Jul 30 10:20:04 2006
@@ -23,6 +23,53 @@
 import com.opensymphony.xwork2.util.OgnlValueStack;
 
 /**
+ * <!-- START SNIPPET: javadoc -->
+ * Renders timepicker element.</p>
+ * Format supported by this component are:-
+ * <table border="1">
+ *   <tr>
+ *     <td>Format</td>
+ *     <td>Description</td>
+ *   </tr>
+ *   <tr>
+ *     <td>#HH</td>
+ *     <td>Display hour in two digit format</td>
+ *   </tr>
+ *   <tr>
+ *     <td>#H</td>
+ *     <td>Try to display hour in one digit format, if cannot use 2 digits</td>
+ *   </tr>
+ *   <tr>
+ *     <td>#hh</td>
+ *     <td>Display hour in two digit format</td>
+ *   </tr>
+ *   <tr>
+ *     <td>#h</td>
+ *      <td>Try to display hour in one digit format, if cannot use 2 
digits</td>
+ *   </tr>
+ *   <tr>
+ *      <td>#mm</td>
+ *      <td>Display minutes in 2 digits format</td>
+ *   </tr>
+ *   <tr>
+ *     <td>#m</td>
+ *      <td>Try to display minutes in 2 digits fomrat, if cannot use 2 
digits</td>
+ *   </tr>
+ * </table>
+ * 
+ * <!-- END SNIPPET: javadoc -->
+ * 
+ * 
+ * <pre>
+ * <!-- START SNIPPET: example -->
+ * 
+ * &lt;s:timepicker label="Show Time" name="showTime" value="05:00" 
format="#hh:#mm" /&gt;
+ * 
+ * &lt;s:timepicker label="Dinner Time" name="dinnerTime" format="#hh-#mm" 
/&gt;
+ * 
+ * <!-- END SNIPPET: example -->
+ * </pre>
+ * 
  * @version $Date$ $Id$
  */
 public class TimePicker extends TextField {