org.apache.struts2.dojo.components
Class DateTimePicker

java.lang.Object
  extended by org.apache.struts2.components.Component
      extended by org.apache.struts2.components.UIBean
          extended by org.apache.struts2.dojo.components.DateTimePicker

public class DateTimePicker
extends org.apache.struts2.components.UIBean

Renders a date/time picker in a dropdown container.

A stand-alone DateTimePicker widget that makes it easy to select a date/time, or increment by week, month, and/or year.

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.

Syntax supported by 'displayFormat' is (http://www.unicode.org/reports/tr35/tr35-4.html#Date_Format_Patterns):-
Format Description
d Day of the month
D Day of year
M 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.
y Year
h Hour [1-12].
H Hour [0-23].
m Minute. Use one or two for zero padding.
s Second. Use one or two for zero padding.

The value sent to the server is a locale-independent value, in a hidden field as defined by the name attribute. The value will be formatted conforming to RFC3 339 (yyyy-MM-dd'T'HH:mm:ss)

The following formats(in order) will be used to parse the values of the attributes 'value', 'startDate' and 'endDate':

Examples
 
   <sx:datetimepicker name="order.date" label="Order Date" />
   <sx:datetimepicker name="delivery.date" label="Delivery Date" displayFormat="yyyy-MM-dd"  />
   <sx:datetimepicker name="delivery.date" label="Delivery Date" value="%{date}"  />
   <sx:datetimepicker name="delivery.date" label="Delivery Date" value="%{'2007-01-01'}"  />
   <sx:datetimepicker name="order.date" label="Order Date" value="%{'today'}"/>
 
 
<sx:datetimepicker id="picker" label="Order Date" /> <script type="text/javascript"> function setValue() { var picker = dojo.widget.byId("picker"); //string value picker.setValue('2007-01-01'); //Date value picker.setValue(new Date()); } function showValue() { var picker = dojo.widget.byId("picker"); //string value var stringValue = picker.getValue(); alert(stringValue); //date value var dateValue = picker.getDate(); alert(dateValue); } </script> <sx:datetimepicker id="picker" label="Order Date" valueNotifyTopics="/value"/> <script type="text/javascript"> dojo.event.topic.subscribe("/value", function(textEntered, date, widget){ alert('value changed'); //textEntered: String enetered in the textbox //date: JavaScript Date object with the value selected //widet: widget that published the topic }); </script>


Field Summary
protected  java.lang.String adjustWeeks
           
protected  java.lang.String dayWidth
           
protected  java.lang.String displayFormat
           
protected  java.lang.String displayWeeks
           
protected  java.lang.String endDate
           
protected  java.lang.String formatLength
           
protected  java.lang.String iconPath
           
protected  java.lang.String language
           
protected static com.opensymphony.xwork2.util.logging.Logger LOG
           
protected  java.lang.String startDate
           
protected  java.lang.String staticDisplay
           
static java.lang.String TEMPLATE
           
protected  java.lang.String templateCssPath
           
protected  java.lang.String toggleDuration
           
protected  java.lang.String toggleType
           
protected  java.lang.String type
           
protected  java.lang.String valueNotifyTopics
           
protected  java.lang.String weekStartsOn
           
 
Fields inherited from class org.apache.struts2.components.UIBean
accesskey, cssClass, cssErrorClass, cssErrorStyle, cssStyle, defaultTemplateDir, defaultUITheme, disabled, dynamicAttributes, id, javascriptTooltip, key, label, labelPosition, labelSeparator, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateEngineManager, templateSuffix, theme, title, tooltip, tooltipConfig, tooltipCssClass, tooltipDelay, tooltipIconPath, value
 
Fields inherited from class org.apache.struts2.components.Component
actionMapper, COMPONENT_STACK, parameters, stack
 
Constructor Summary
DateTimePicker(com.opensymphony.xwork2.util.ValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 
Method Summary
 void evaluateParams()
           
protected  java.lang.String getDefaultTemplate()
           
 java.lang.String getTheme()
           
 void setAdjustWeeks(java.lang.String adjustWeeks)
           
 void setDayWidth(java.lang.String dayWidth)
           
 void setDisplayFormat(java.lang.String displayFormat)
           
 void setDisplayWeeks(java.lang.String displayWeeks)
           
 void setEndDate(java.lang.String endDate)
           
 void setFormatLength(java.lang.String formatLength)
           
 void setIconPath(java.lang.String iconPath)
           
 void setLanguage(java.lang.String language)
           
 void setStartDate(java.lang.String startDate)
           
 void setStaticDisplay(java.lang.String staticDisplay)
           
 void setTemplateCssPath(java.lang.String templateCssPath)
           
 void setTheme(java.lang.String theme)
           
 void setToggleDuration(java.lang.String toggleDuration)
           
 void setToggleType(java.lang.String toggleType)
           
 void setType(java.lang.String type)
           
 void setValue(java.lang.String arg0)
           
 void setValueNotifyTopics(java.lang.String valueNotifyTopics)
           
 void setWeekStartsOn(java.lang.String weekStartsOn)
           
 
Methods inherited from class org.apache.struts2.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, ensureAttributeSafelyNotEscaped, escape, evaluateExtraParams, evaluateNameValue, getId, getTemplate, getTemplateDir, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssErrorClass, setCssErrorStyle, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setId, setJavascriptTooltip, setKey, setLabel, setLabelposition, setLabelSeparator, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTitle, setTooltip, setTooltipConfig, setTooltipCssClass, setTooltipDelay, setTooltipIconPath
 
Methods inherited from class org.apache.struts2.components.Component
addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getParameters, getStack, popComponentStack, setActionMapper, start, toString, usesBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TEMPLATE

public static final java.lang.String TEMPLATE
See Also:
Constant Field Values

LOG

protected static final com.opensymphony.xwork2.util.logging.Logger LOG

iconPath

protected java.lang.String iconPath

formatLength

protected java.lang.String formatLength

displayFormat

protected java.lang.String displayFormat

toggleType

protected java.lang.String toggleType

toggleDuration

protected java.lang.String toggleDuration

type

protected java.lang.String type

displayWeeks

protected java.lang.String displayWeeks

adjustWeeks

protected java.lang.String adjustWeeks

startDate

protected java.lang.String startDate

endDate

protected java.lang.String endDate

weekStartsOn

protected java.lang.String weekStartsOn

staticDisplay

protected java.lang.String staticDisplay

dayWidth

protected java.lang.String dayWidth

language

protected java.lang.String language

templateCssPath

protected java.lang.String templateCssPath

valueNotifyTopics

protected java.lang.String valueNotifyTopics
Constructor Detail

DateTimePicker

public DateTimePicker(com.opensymphony.xwork2.util.ValueStack stack,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
Method Detail

getDefaultTemplate

protected java.lang.String getDefaultTemplate()
Specified by:
getDefaultTemplate in class org.apache.struts2.components.UIBean

evaluateParams

public void evaluateParams()
Overrides:
evaluateParams in class org.apache.struts2.components.UIBean

setTheme

public void setTheme(java.lang.String theme)
Overrides:
setTheme in class org.apache.struts2.components.UIBean

getTheme

public java.lang.String getTheme()
Overrides:
getTheme in class org.apache.struts2.components.UIBean

setAdjustWeeks

public void setAdjustWeeks(java.lang.String adjustWeeks)

setDayWidth

public void setDayWidth(java.lang.String dayWidth)

setDisplayWeeks

public void setDisplayWeeks(java.lang.String displayWeeks)

setEndDate

public void setEndDate(java.lang.String endDate)

setStartDate

public void setStartDate(java.lang.String startDate)

setStaticDisplay

public void setStaticDisplay(java.lang.String staticDisplay)

setWeekStartsOn

public void setWeekStartsOn(java.lang.String weekStartsOn)

setLanguage

public void setLanguage(java.lang.String language)

setDisplayFormat

public void setDisplayFormat(java.lang.String displayFormat)

setFormatLength

public void setFormatLength(java.lang.String formatLength)

setIconPath

public void setIconPath(java.lang.String iconPath)

setToggleDuration

public void setToggleDuration(java.lang.String toggleDuration)

setType

public void setType(java.lang.String type)

setToggleType

public void setToggleType(java.lang.String toggleType)

setTemplateCssPath

public void setTemplateCssPath(java.lang.String templateCssPath)

setValue

public void setValue(java.lang.String arg0)
Overrides:
setValue in class org.apache.struts2.components.UIBean

setValueNotifyTopics

public void setValueNotifyTopics(java.lang.String valueNotifyTopics)


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.