Google Git
Sign in
apache / struts / 2c0a197cea8fdc7d8cda5eeaa15a1c76507ac0a5 / . / trunk / docs / tags / DatePicker.html
blob: 04604473f5542099bb7030be67d9fc4670cd90f5 [file] [log] [blame]
<html>
<head>
<title>&lt;a2:datepicker /&gt;</title>
</head>
<body>
<h1>Tag Name: &lt;a2:datepicker /&gt;</h1>
<h2>Description</h2>
<p>
Render datepicker
</p>
<p>
<!-- START SNIPPET: javadoc --> Renders datepicker element.</p> Check locale and format settings if you used the old widget in your applications. Be sure to include proper stylesheet as described below if you don't want the calender widget to look transparent.</p> <b>Important:</b> Be sure to set the id attributs if not used within a &lt;a:form /&gt; tag, as it takes care of setting the id for you, being required to copy selected date to text input element.</p> Following a reference for the format parameter (copied from jscalendar documentation): <table border=0><tr><td valign=top ></td></tr> <tr><td valign=top ><tt>%a</tt> </td><td valign=top >abbreviated weekday name </td></tr> <tr><td valign=top ><tt>%A</tt> </td><td valign=top >full weekday name </td></tr> <tr><td valign=top ><tt>%b</tt> </td><td valign=top >abbreviated month name </td></tr> <tr><td valign=top ><tt>%B</tt> </td><td valign=top >full month name </td></tr> <tr><td valign=top ><tt>%C</tt> </td><td valign=top >century number </td></tr> <tr><td valign=top ><tt>%d</tt> </td><td valign=top >the day of the month ( 00 .. 31 ) </td></tr> <tr><td valign=top ><tt>%e</tt> </td><td valign=top >the day of the month ( 0 .. 31 ) </td></tr> <tr><td valign=top ><tt>%H</tt> </td><td valign=top >hour ( 00 .. 23 ) </td></tr> <tr><td valign=top ><tt>%I</tt> </td><td valign=top >hour ( 01 .. 12 ) </td></tr> <tr><td valign=top ><tt>%j</tt> </td><td valign=top >day of the year ( 000 .. 366 ) </td></tr> <tr><td valign=top ><tt>%k</tt> </td><td valign=top >hour ( 0 .. 23 ) </td></tr> <tr><td valign=top ><tt>%l</tt> </td><td valign=top >hour ( 1 .. 12 ) </td></tr> <tr><td valign=top ><tt>%m</tt> </td><td valign=top >month ( 01 .. 12 ) </td></tr> <tr><td valign=top ><tt>%M</tt> </td><td valign=top >minute ( 00 .. 59 ) </td></tr> <tr><td valign=top ><tt>%n</tt> </td><td valign=top >a newline character </td></tr> <tr><td valign=top ><tt>%p</tt> </td><td valign=top >``PM'' or ``AM'' </td></tr> <tr><td valign=top ><tt>%P</tt> </td><td valign=top >``pm'' or ``am'' </td></tr> <tr><td valign=top ><tt>%S</tt> </td><td valign=top >second ( 00 .. 59 ) </td></tr> <tr><td valign=top ><tt>%s</tt> </td><td valign=top >number of seconds since Epoch (since Jan 01 1970 00:00:00 UTC) </td></tr> <tr><td valign=top ><tt>%t</tt> </td><td valign=top >a tab character </td></tr> <tr><td valign=top ><tt>%U, %W, %V</tt> </td><td valign=top >the week number</td></tr> <tr><td valign=top ><tt>%u</tt> </td><td valign=top >the day of the week ( 1 .. 7, 1 = MON )</td></tr> <tr><td valign=top ><tt>%w</tt> </td><td valign=top >the day of the week ( 0 .. 6, 0 = SUN )</td></tr> <tr><td valign=top ><tt>%y</tt> </td><td valign=top >year without the century ( 00 .. 99 )</td></tr> <tr><td valign=top ><tt>%Y</tt> </td><td valign=top >year including the century ( ex. 1979 )</td></tr> <tr><td valign=top ><tt>%%</tt> </td><td valign=top >a literal <tt>%</tt> character </td></tr></table><p> <!-- END SNIPPET: javadoc --> <p/> <b>Examples</b> <pre> <!-- START SNIPPET: expl1 --> Date in application's locale format: &lt;a:datepicker name="order.date" id="order.date" /&gt; Date in german locale, with german texts: &lt;a:datepicker name="delivery.date" id="delivery.date" template="datepicker_js.ftl" language="de" /&gt; Date in german locale, with german texts and custom date format, including time: &lt;a:datepicker name="invoice.date" id="invoice.date" template="datepicker_js.ftl" language="de" format="%d. %b &Y %H:%M" showstime="true" /&gt; <!-- END SNIPPET: expl1 --> </pre> <p/> <!-- START SNIPPET: expldesc2 --> If you use this jscalendar based datepicker widget, you might want to use one of the standard stylesheets provided with jscalendar (all distribution stylesheets are included in struts jar). The easiest way to do so is to place the &lt;a:head/&gt; tag in the head of your html page, as it takes care of including calendar css. Otherwise, to manually activate the calendar-blue style, include the following in your stylesheet definition: <!-- END SNIPPET: expldesc2 --> <pre> <!-- START SNIPPET: expl2 --> &lt;link href="&lt;a:url value="/struts/jscalendar/calendar-blue.css" /&gt;" rel="stylesheet" type="text/css" media="all"/&gt; <!-- END SNIPPET: expl2 --> </pre>
</p>
<h2>Attributes</h2>
<p>
<!-- START SNIPPET: tagattributes -->
<table width="100%">
<tr>
<th align="left" valign="top"><h4>Name</h4></th>
<th align="left" valign="top"><h4>Required</h4></th>
<th align="left" valign="top"><h4>Default</h4></th>
<th align="left" valign="top"><h4>Type</h4></th>
<th align="left" valign="top"><h4>Description</h4></th>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">language</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">The language of the current Locale</td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">The language to use for the widget texts and localization presets.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">format</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">Dateformat specified by language preset (%Y/%m/%d for en)</td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">The format to use for date field.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">showstime</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">false</td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">Whether time selector is to be shown. Valid values are &quot;true&quot;, &quot;false&quot;, &quot;24&quot; and &quot;12&quot;.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">singleclick</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">true</td>
<!-- Type -->
<td align="left" valign="top">Boolean</td>
<!-- Description -->
<td align="left" valign="top">Whether to use selected value after single or double click.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">maxlength</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Integer</td>
<!-- Description -->
<td align="left" valign="top">HTML maxlength attribute</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">maxLength</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Deprecated. Use maxlength instead.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">readonly</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">false</td>
<!-- Type -->
<td align="left" valign="top">Boolean</td>
<!-- Description -->
<td align="left" valign="top">Whether the input is readonly</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">size</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Integer</td>
<!-- Description -->
<td align="left" valign="top">HTML size attribute</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">templateDir</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The template directory.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">theme</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The theme (other than default) to use for rendering the element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">template</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The template (other than default) to use for rendering the element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">cssClass</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The css class to use for element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">cssStyle</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The css style definitions for element ro use</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">title</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html title attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">disabled</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html disabled attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">label</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Label expression used for rendering a element specific label</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">labelposition</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">define label position of form element (top/left)</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">requiredposition</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">define required position of required form element (left|right)</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">name</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The name to set for element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">required</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">false</td>
<!-- Type -->
<td align="left" valign="top">Boolean</td>
<!-- Description -->
<td align="left" valign="top">If set to true, the rendered element will indicate that input is required</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">tabindex</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html tabindex attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">value</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Preset the value of input element.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onclick</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onclick attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">ondblclick</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html ondblclick attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmousedown</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmousedown attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmouseup</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmouseup attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmouseover</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmouseover attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmousemove</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmousemove attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmouseout</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmouseout attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onfocus</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onfocus attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onblur</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onblur attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onkeypress</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onkeypress attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onkeydown</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onkeydown attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onkeyup</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onkeyup attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onselect</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onselect attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onchange</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onchange attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">accesskey</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html accesskey attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">tooltip</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top"></td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">Set the tooltip of this particular component</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">tooltipConfig</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top"></td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">Set the tooltip configuration</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">id</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">id for referencing element. For UI and form tags it will be used as HTML id attribute</td>
</tr>
</table>
<!-- END SNIPPET: tagattributes -->
</p>
<p>
<center><a href="index.html">Back to Taglib Index</a></center>
</p>
</body>
</html>