| /* |
| * $Id$ |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.apache.struts2.components; |
| |
| import java.text.ParseException; |
| import java.text.MessageFormat; |
| import java.text.SimpleDateFormat; |
| import java.util.Calendar; |
| import java.util.Date; |
| |
| import javax.servlet.http.HttpServletRequest; |
| import javax.servlet.http.HttpServletResponse; |
| |
| import org.apache.commons.logging.Log; |
| import org.apache.commons.logging.LogFactory; |
| import org.apache.struts2.views.annotations.StrutsTag; |
| import org.apache.struts2.views.annotations.StrutsTagAttribute; |
| |
| import com.opensymphony.xwork2.util.ValueStack; |
| |
| /** |
| * <!-- START SNIPPET: javadoc --> |
| * <p> |
| * Renders a date/time picker in a dropdown container. |
| * </p> |
| * <p> |
| * A stand-alone DateTimePicker widget that makes it easy to select a date/time, or increment by week, month, |
| * and/or year. |
| * </p> |
| * |
| * <p> |
| * It is possible to customize the user-visible formatting with either the |
| * 'formatLength' (long, short, medium or full) or 'displayFormat' attributes. By defaulty current |
| * locale will be used.</p> |
| * </p> |
| * |
| * Syntax supported by 'displayFormat' is (http://www.unicode.org/reports/tr35/tr35-4.html#Date_Format_Patterns):- |
| * <table border="1"> |
| * <tr> |
| * <td>Format</td> |
| * <td>Description</td> |
| * </tr> |
| * <tr> |
| * <td>d</td> |
| * <td>Day of the month</td> |
| * </tr> |
| * <tr> |
| * <td>D</td> |
| * <td>Day of year</td> |
| * </tr> |
| * <tr> |
| * <td>M</td> |
| * <td>Month - Use one or two for the numerical month, three for the abbreviation, or four for the full name, or 5 for the narrow name.</td> |
| * </tr> |
| * <tr> |
| * <td>h</td> |
| * <td>Hour [1-12].</td> |
| * </tr> |
| * <tr> |
| * <td>H</td> |
| * <td>Hour [0-23].</td> |
| * </tr> |
| * <tr> |
| * <td>m</td> |
| * <td>Minute. Use one or two for zero padding.</td> |
| * </tr> |
| * <tr> |
| * <td>s</td> |
| * <td>Second. Use one or two for zero padding.</td> |
| * </tr> |
| * </table> |
| * |
| * <p> |
| * The value sent to the server is |
| * typically a locale-independent value in a hidden field as defined by the name |
| * attribute. RFC3339 representation is the format used. |
| * </p> |
| * |
| * <p/> |
| * |
| * <!-- END SNIPPET: javadoc --> |
| * |
| * <b>Examples</b> |
| * |
| * <pre> |
| * <!-- START SNIPPET: expl1 --> |
| * |
| * Example 1: |
| * <s:datetimepicker name="order.date" label="Order Date" /> |
| * Example 2: |
| * <s:datetimepicker name="delivery.date" label="Delivery Date" format="yyyy-MM-dd" /> |
| * |
| * <!-- END SNIPPET: expl1 --> |
| * </pre> |
| * <p/> |
| * |
| * <!-- START SNIPPET: expldesc2 --> |
| * |
| * The css could be changed by using the following :- |
| * |
| * <!-- END SNIPPET: expldesc2 --> |
| * |
| * <pre> |
| * <!-- START SNIPPET: expl2 --> |
| * |
| * <s:datetimepicker name="birthday" label="Birthday" templateCss="...." /> |
| * |
| * <!-- END SNIPPET: expl2 --> |
| * </pre> |
| * |
| */ |
| @StrutsTag(name="datetimepicker", tldTagClass="org.apache.struts2.views.jsp.ui.DateTimePickerTag", description="Render datetimepicker") |
| public class DateTimePicker extends UIBean { |
| |
| final public static String TEMPLATE = "datetimepicker"; |
| // Backported changes from s2 trunk (r657936) |
| // final private static SimpleDateFormat RFC3339_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss"); |
| final private static String RFC3339_FORMAT = "yyyy-MM-dd'T'HH:mm:ss"; |
| final private static String RFC3339_PATTERN = "{0,date," + RFC3339_FORMAT + "}"; |
| final protected static Log LOG = LogFactory.getLog(DateTimePicker.class); |
| |
| protected String iconPath; |
| protected String formatLength; |
| protected String displayFormat; |
| protected String toggleType; |
| protected String toggleDuration; |
| protected String type; |
| |
| protected String displayWeeks; |
| protected String adjustWeeks; |
| protected String startDate; |
| protected String endDate; |
| protected String weekStartsOn; |
| protected String staticDisplay; |
| protected String dayWidth; |
| protected String language; |
| protected String templateCssPath; |
| |
| public DateTimePicker(ValueStack stack, HttpServletRequest request, HttpServletResponse response) { |
| super(stack, request, response); |
| } |
| |
| protected String getDefaultTemplate() { |
| return TEMPLATE; |
| } |
| |
| public void evaluateParams() { |
| super.evaluateParams(); |
| |
| if(displayWeeks != null) |
| addParameter("displayWeeks", findString(displayWeeks)); |
| if(adjustWeeks != null) |
| addParameter("adjustWeeks", findValue(adjustWeeks, Boolean.class)); |
| if(startDate != null) |
| addParameter("startDate", findString(startDate)); |
| if(endDate != null) |
| addParameter("endDate", findString(endDate)); |
| if(weekStartsOn != null) |
| addParameter("weekStartsOn", findString(weekStartsOn)); |
| if(staticDisplay != null) |
| addParameter("staticDisplay", findValue(staticDisplay, Boolean.class)); |
| if(dayWidth != null) |
| addParameter("dayWidth", findValue(dayWidth, Integer.class)); |
| if(language != null) |
| addParameter("language", findString(language)); |
| if(value != null) |
| addParameter("value", findString(value)); |
| if(iconPath != null) |
| addParameter("iconPath", findString(iconPath)); |
| if(formatLength != null) |
| addParameter("formatLength", findString(formatLength)); |
| if(displayFormat != null) |
| addParameter("displayFormat", findString(displayFormat)); |
| if(toggleType != null) |
| addParameter("toggleType", findString(toggleType)); |
| if(toggleDuration != null) |
| addParameter("toggleDuration", findValue(toggleDuration, |
| Integer.class)); |
| if(type != null) |
| addParameter("type", findString(type)); |
| else |
| addParameter("type", "date"); |
| if(templateCssPath != null) |
| addParameter("templateCssPath", findString(templateCssPath)); |
| |
| // format the value to RFC 3399 |
| if(parameters.containsKey("value")) { |
| parameters.put("nameValue", format(parameters.get("value"))); |
| } else { |
| if(name != null) { |
| String expr = name; |
| if(altSyntax()) { |
| expr = "%{" + expr + "}"; |
| } |
| addParameter("nameValue", format(findValue(expr))); |
| } |
| } |
| } |
| |
| @StrutsTagAttribute(description="If true, weekly size of calendar changes to acomodate the month if false," + |
| " 42 day format is used", type="Boolean", defaultValue="false") |
| public void setAdjustWeeks(String adjustWeeks) { |
| this.adjustWeeks = adjustWeeks; |
| } |
| |
| @StrutsTagAttribute(description="How to render the names of the days in the header(narrow, abbr or wide)", defaultValue="narrow") |
| public void setDayWidth(String dayWidth) { |
| this.dayWidth = dayWidth; |
| } |
| |
| @StrutsTagAttribute(description="Total weeks to display", type="Integer", defaultValue="6") |
| public void setDisplayWeeks(String displayWeeks) { |
| this.displayWeeks = displayWeeks; |
| } |
| |
| @StrutsTagAttribute(description="Last available date in the calendar set", type="Date", defaultValue="2941-10-12") |
| public void setEndDate(String endDate) { |
| this.endDate = endDate; |
| } |
| |
| @StrutsTagAttribute(description="First available date in the calendar set", type="Date", defaultValue="1492-10-12") |
| public void setStartDate(String startDate) { |
| this.startDate = startDate; |
| } |
| |
| @StrutsTagAttribute(description="Disable all incremental controls, must pick a date in the current display", type="Boolean", defaultValue="false") |
| public void setStaticDisplay(String staticDisplay) { |
| this.staticDisplay = staticDisplay; |
| } |
| |
| @StrutsTagAttribute(description="Adjusts the first day of the week 0==Sunday..6==Saturday", type="Integer", defaultValue="0") |
| public void setWeekStartsOn(String weekStartsOn) { |
| this.weekStartsOn = weekStartsOn; |
| } |
| |
| @StrutsTagAttribute(description="Language to display this widget in", defaultValue="brower's specified preferred language") |
| public void setLanguage(String language) { |
| this.language = language; |
| } |
| |
| @StrutsTagAttribute(description="A pattern used for the visual display of the formatted date, e.g. dd/MM/yyyy") |
| public void setDisplayFormat(String displayFormat) { |
| this.displayFormat = displayFormat; |
| } |
| |
| @StrutsTagAttribute(description="Type of formatting used for visual display. Possible values are " + |
| "long, short, medium or full", defaultValue="short") |
| public void setFormatLength(String formatLength) { |
| this.formatLength = formatLength; |
| } |
| |
| @StrutsTagAttribute(description="Path to icon used for the dropdown") |
| public void setIconPath(String iconPath) { |
| this.iconPath = iconPath; |
| } |
| |
| @StrutsTagAttribute(description="Duration of toggle in milliseconds", type="Integer", defaultValue="100") |
| public void setToggleDuration(String toggleDuration) { |
| this.toggleDuration = toggleDuration; |
| } |
| |
| @StrutsTagAttribute(description="Defines the type of the picker on the dropdown. Possible values are 'date'" + |
| " for a DateTimePicker, and 'time' for a timePicker", defaultValue="date") |
| public void setType(String type) { |
| this.type = type; |
| } |
| |
| @StrutsTagAttribute(description="oggle type of the dropdown. Possible values are plain,wipe,explode,fade", defaultValue="plain") |
| public void setToggleType(String toggleType) { |
| this.toggleType = toggleType; |
| } |
| |
| @StrutsTagAttribute(description="Template css path") |
| public void setTemplateCssPath(String templateCssPath) { |
| this.templateCssPath = templateCssPath; |
| } |
| |
| private String format(Object obj) { |
| if(obj == null) |
| return null; |
| |
| if(obj instanceof Date) { |
| return MessageFormat.format(RFC3339_PATTERN, (Date) obj); |
| } else if(obj instanceof Calendar) { |
| return MessageFormat.format(RFC3339_PATTERN, ((Calendar) obj).getTime()); |
| } else { |
| // try to parse a date |
| String dateStr = obj.toString(); |
| if(dateStr.equalsIgnoreCase("today")) |
| return MessageFormat.format(RFC3339_PATTERN, new Date()); |
| |
| try { |
| Date date = null; |
| if(this.displayFormat != null) { |
| SimpleDateFormat format = new SimpleDateFormat( |
| (String) getParameters().get("displayFormat")); |
| date = format.parse(dateStr); |
| return MessageFormat.format(RFC3339_PATTERN, date); |
| } else { |
| // last resource to assume already in correct/default format |
| return dateStr; |
| } |
| } catch (ParseException e) { |
| LOG.error("Could not parse date", e); |
| return dateStr; |
| } |
| } |
| } |
| |
| } |
