ICEfaces ACE Components
Tag dateTimeEntry


The DateTime Entry is a component that allows the user to configure and input a date and/or time in various ways.

For more information, see the DateTimeEntry Wiki Documentation.


Client Events
NameDescriptionSupported Classes for ArgumentDefault Event Scopes
dateSelectFired when a date is selected from the calendar (default event).org.icefaces.ace.event.DateSelectEventexecute=@this render=@all
dateTextChangeFired when date text is changed and input field loses focus.org.icefaces.ace.event.DateTextChangeEventexecute=@this render=@all
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.datetimeentry.DateTimeEntryTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
accesskeynotruejava.lang.StringAccess key that, when pressed, transfers focus to this component.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
buttonTextnotruejava.lang.StringThe text to display on the trigger button. Use in conjunction with the showOn option set to "button" or "both". Default = "".
converternotruejavax.faces.convert.ConverterConverter is an interface describing a Java class that can perform Object-to-String and String-to-Object conversions between model data objects and a String representation of those objects that is suitable for rendering.
converterMessagenotruejava.lang.StringIf present, will be used as the text of the converter message, replacing any message that comes from the converter.
disableHoverStylingnotruebooleanSet to true to disable hover styling to improve performance. Default = 'false'.
disablednotruebooleanIf true then this date time entry will be disabled and can not be entered. Default = 'false'.
effectnotruejava.lang.StringName of the animation used to show/hide the calendar. Use "show", "slideDown", "fadeIn", any of the show/hide jQuery UI effects, or "" for no animation. Default = 'show'.
effectDurationnotruejava.lang.StringControl the speed at which the calendar appears, it may be a time in milliseconds or a string representing one of the three predefined speeds ("slow", "normal", "fast"). Default = 'normal'.
highlightedDatesnotruejava.lang.ObjectSpecifies a number of dates that should be highlighted in the client, applying the style class specified by the 'highlightedStyleClass' attribute. The value can be a number of date strings separated by commas, a List of Date objects or an Array of Date objects. If the dates are specified as strings, they are parsed according to the 'pattern' attribute of this component. Dates are taken literally, as they appear in the calendar, without regard for time zones.
highlightedStyleClassnotruejava.lang.StringSpecifies the style class to apply to those dates specified in the 'highlightedDates' attribute.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediatenotruebooleanA flag indicating that conversion and validation of this component's value should occur during Apply Request Values phase instead of Process Validations phase. Default = 'false'.
indicatorPositionnotruejava.lang.StringPosition of input-required or input-optional indicator relative to input field or label. Supported values are "left/right/top/bottom/labelLeft/labelRight/none". Default is "labelRight" if labelPosition is "inField", "right" otherwise.
labelnotruejava.lang.StringA localized user presentable name for this component.
labelPositionnotruejava.lang.StringPosition of label relative to input field. Supported values are "left/right/top/bottom/inField/none". Default is "none".
leftMonthOffsetnotrueintZero-based offset indicating which month should be displayed in the leftmost position. Default = '0'.
lenientParsingnotruebooleanWith lenient parsing, the Java date parser may use heuristics to interpret inputs that do not precisely match this date's format. With strict parsing, inputs must match this date's format. Ignored if the converter attribute is used to do format conversion. Default = 'true'.
localenotruejava.lang.ObjectLocale to be used for labels and conversion. Locale string or java.util.Locale object. Default is locale of view root.
maxDateTimenotruejava.lang.ObjectSet a maximum selectable date and time. Must be java.util.Date object. Default is no limit. This attribute is ignored if 'selectableDateRanges' is specified.
maxHournotrueintSet the hour range. Default = '23'.
maxMinutenotrueintSet the minute range. Default = '59'.
maxSecondnotrueintSet the second range. Default = '59'.
maxdatenotruejava.lang.ObjectSet a maximum selectable date. Date string or java.util.Date object. Default is no limit. This attribute is ignored if 'selectableDateRanges' is specified.
maxlengthnotrueintThe maximum number of characters that may be entered in this field.
minDateTimenotruejava.lang.ObjectSet a minimum selectable date and time. Must be java.util.Date object. Default is no limit. This attribute is ignored if 'selectableDateRanges' is specified.
minHournotrueintSet the hour range. Default = '0'.
minMinutenotrueintSet the minute range. Default = '0'.
minSecondnotrueintSet the second range. Default = '0'.
mindatenotruejava.lang.ObjectSet a minimum selectable date. Date string or java.util.Date object. Default is no limit. This attribute is ignored if 'selectableDateRanges' is specified.
navigatornotruebooleanEnables month/year navigator.
optionalIndicatornotruejava.lang.StringIndicator indicating that the user is NOT required to provide a submitted value for this input component.
pagesnotrueintEnables multiple page rendering. Default = '1'.
patternnotruejava.lang.StringDateFormat pattern for localization. See the DateTimeEntry Wiki Documentation for limitations. Ignored if the converter attribute is used to do format conversion. Default = 'MM/dd/yyyy'.
popupIconnotruejava.lang.StringThe URL for the popup button image. Default is the file "META-INF/resources/icefaces.ace/datetimeentry/calendar_icon.png" in the components jar. showOn attribute must be set to "button" or "both".
popupIconOnlynotruebooleanWhen enabled, popup icon is rendered without it appearing on a button. Default: "false".
readOnlyInputTextnotruebooleanMakes input text of a popup calendar readonly.
readonlynotruebooleanIf true then this date time entry will be read-only and can not be entered.
renderAsPopupnotruebooleanWhether to render the calendar inline or as a popup. Default = 'false'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
requirednotruebooleanA flag indicating whether the user required to provide a non-empty submitted value for this component. Default = 'false'.
requiredIndicatornotruejava.lang.StringIndicator indicating that the user is required to provide a submitted value for this input component.
requiredMessagenotruejava.lang.StringIf present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used.
selectOtherMonthsnotruebooleanEnables selection of days belonging to other months.
selectableDateRangesnotruejava.lang.ObjectSpecifies a number of ranges of selectable dates. The value can be a number of date strings separated by commas, a List of Date objects or an Array of Date objects. These dates are taken in pairs to delimit a range; the first date in the pair is the start date, and the second date in the pair is the end date of that range. These dates are inclusive. If the first date of the pair is null, the empty string, or an invalid date, then the range will be considered to be from any date in the past up to its end date. Likewise, if the second date of the pair is null, an empty string, or an invalid date, then the range will be considered to be from its start date to any date in the future thereafter. If the dates are specified as strings, they are parsed according to the 'pattern' attribute of this component. Dates are taken literally, as they appear in the calendar, without regard for time zones. This attribute takes precedence over the 'mindate', 'maxdate', 'minDateTime', and 'maxDateTime' attributes. This attribute is only used to specify date ranges, not date-time ranges.
showButtonPanelnotruejava.lang.BooleanWhether to show the panel containing today button and close button for popup. Default is false without time component and true with time component.
showOnnotruejava.lang.StringHave the calendar appear automatically when the field receives focus ("focus"), appear only when a button (specified by popupIcon attribute) is clicked ("button"), or appear when either event takes place ("both"). Default = 'focus'.
showOtherMonthsnotruebooleanDisplays days belonging to other months.
showWeeknotruebooleanDisplays the week number next to each week.
sizenotrueintThe number of characters used to determine the width of the input field in a popup calendar. Default is the maximum possible size of a date formatted by the date pattern.
stepHournotrueintIncrement/decrement steps when hour slider is dragged. Default = '1'.
stepMinutenotrueintIncrement/decrement steps when minute slider is dragged. Default = '1'.
stepSecondnotrueintIncrement/decrement steps when second slider is dragged. Default = '1'.
stylenotruejava.lang.Stringstyle will be rendered on a root element of this component
styleClassnotruejava.lang.Stringstyle class will be rendered on a root element of this component
tabindexnotruejava.lang.StringPosition of the text field in the tabbing order for the current page. This value must be an integer between 0 and 32767.
timeOnlynotruebooleanSpecifies whether to display/input time only. Default = 'false'.
timeZonenotruejava.lang.ObjectString or a java.util.TimeZone instance to specify the timezone used for date conversion, defaults to TimeZone.getDefault()
todayNowButtonsAlsoSelectnotruebooleanThe Today (or Now) button can be set to navigate the popup to the current month without selecting date/time, or select the date/time as well. Default = 'false'.
validatornotruejavax.el.MethodExpressionMethodExpression representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void.
validatorMessagenotruejava.lang.StringIf present, will be used as the text of the validator message, replacing any message that comes from the validator.
valuenotruejava.lang.ObjectThe current value of the simple component. The value to be rendered.
valueChangeListenernotruejavax.el.MethodExpressionMethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where a notification is needed that "this value changed".
yearRangenotruejava.lang.StringControl the range of years displayed in the year drop-down: either relative to today's year (-nn:+nn), relative to the currently selected year (c-nn:c+nn), absolute (nnnn:nnnn), or combinations of these formats (nnnn:-nn). Default = 'c-10:c+10'.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.