er.ajax

Class AjaxDatePicker

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.ajax.AjaxComponent

er.ajax.AjaxDatePicker

All Implemented Interfaces:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, IAjaxElement, Serializable, Cloneable

public class AjaxDatePicker
extends AjaxComponent

Shameless port and adoption of Rails Date Kit. This input understands the format symbols %A, %d, %e, %b, %m, %B, %y, and %Y. See the NSTimestampFormatter for what these symbols do. This component can also understand the corresponding symbols from java.text.SimpleDateFormat. The translation from SimpleDateFormat symbols to NSTimestampFormatter symbols may have some defects.

Only one of format or formatter may be bound, if both are unbound the default of %m %d %Y is used. If format is bound, the pattern is used to create an internal formatter for validation. If formatter is bound, its pattern is extracted and used in place of format. The format/formatter is used to control the initial display in the input, the format of the value that the date picker places into the input, and validation of the input contents on form submission. The use of formatter over format is preferred for reasons of efficiency and localization.

FL: The component uses the default Locale to determine the start day of the week. It also uses the current language in ERXLocalizer to translate the day and month names (you must set up the localizations).

NOTE: the AjaxDatePicker does NOT play nice with the AjaxModalDialogOpener. There is some sort of initialization conflict (I think) with Prototype that leaves you with a blank page and the browser waiting forever for something (and I have not been able to determine what it is) as soon as calendar.js loads and initialized. It will work if the page the AMD appears on explicitly loads the calendar.js in it's HEAD:

  public void appendToResponse(WOResponse response, WOContext context) {
       super.appendToResponse(response, context);
       ERXResponseRewriter.addScriptResourceInHead(response, context(), "Ajax", "calendar.js");
   }
 

See Also:

SimpleDateFormat, NSTimestampFormatter, Rails Date Kit, Serialized Form

Author:

ported by Chuck Hill

Bindings

Name	Description
value	the value that will be shown in the input field and set by the date picker (required)
format	the format to use in the input field (only one of format or formatter may be bound)
formatter	the formatter to use with the input field (only one of format or formatter may be bound)
id	HTML ID passed to the input field
class	CSS class passed to the input field
style	CSS style passed to the input field
size	size attribute passed to the input field
maxlength	maxlength attribute passed to the input field
name	name attribute passed to the input field
disabled	passed to the input field
onDateSelect	JavaScript to execute when a date is selected from the calendar
fireEvent	false if the onChange event for the input should NOT be fired when a date is selected in the calendar, defaults to true
manualInput	false if you want to prevent manual input from the user and force him/her to use the date picker, defaults to true
startDay	specify the first day of week to use 0(Sunday)-6(Saturday). The default use the current localizer.
dayNames	list of day names (Sunday to Saturday) for localization, English is the default
monthNames	list of month names for localization, English is the default
imagesDir	directory to take images from, takes them from Ajax.framework by default
locale	FL: locale can be set if ERXLocalizer returns the wrong one. IE the English localizer returns a US Locale. If you want the UK one then set this binding.
showYearControls:	display the prev and next year controls. Default to true.
calendarCSS	name of CSS resource with classed for calendar, defaults to "calendar.css"
calendarCSSFramework	name of framework (null for application) containing calendarCSS resource, defaults to "Ajax"

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
AjaxDatePicker(WOContext context)

Method Summary

Modifier and Type	Method and Description
protected void	addRequiredWebResources(WOResponse response) Includes calendar.css and calendar.js.
void	appendToResponse(WOResponse res, WOContext ctx) Sets up AjaxOptions prior to rendering.
void	awake() Sets up format / formatter values.
protected String	cssFileFrameworkName()
protected String	cssFileName()
NSArray<String>	dayNames()
String	format()
Format	formatter()
WOActionResults	handleRequest(WORequest request, WOContext context) No action so nothing for us to handle.
boolean	isStateless()
Locale	locale()
NSArray<String>	monthNames()
String	onClickScript()
String	onFocusScript()
NSMutableDictionary	options()
String	otherTagString()
void	reset() Clear cached values.
String	showCalendarScript()
Integer	startDay()
String	translateSimpleDateFormatSymbols(String symbols) Quick and rude translation of formatting symbols from SimpleDateFormat to the symbols that this component uses.
void	validationFailedWithException(Throwable t, Object value, String keyPath) Overridden so that parent will handle in the same manner as if this were a dynamic element.

Methods inherited from class er.ajax.AjaxComponent

_containerID, addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, appendTagAttributeToResponse, booleanValueForBinding, invokeAction, safeElementID, shouldHandleRequest, valueForBinding, valueForBinding, valueForBinding

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AjaxDatePicker

public AjaxDatePicker(WOContext context)

Method Detail

isStateless

public boolean isStateless()

Overrides:

isStateless in class WOComponent

Returns:

true

awake

public void awake()

Sets up format / formatter values.

Overrides:

awake in class WOComponent

reset

public void reset()

Clear cached values.

Overrides:

reset in class WOComponent

locale

public Locale locale()

startDay

public Integer startDay()

dayNames

public NSArray<String> dayNames()

monthNames

public NSArray<String> monthNames()

otherTagString

public String otherTagString()

appendToResponse

public void appendToResponse(WOResponse res,
                             WOContext ctx)

Sets up AjaxOptions prior to rendering.

Overrides:

appendToResponse in class AjaxComponent

Parameters:

res - the HTTP response that an application returns to a Web server to complete a cycle of the request-response loop

ctx - context of a transaction

onFocusScript

public String onFocusScript()

Returns:

JavaScript for onFocus binding of HTML input

onClickScript

public String onClickScript()

Returns:

JavaScript for onClick binding of HTML input

showCalendarScript

public String showCalendarScript()

Returns:

JavaScript to load CSS and show calendar display

translateSimpleDateFormatSymbols

public String translateSimpleDateFormatSymbols(String symbols)

Quick and rude translation of formatting symbols from SimpleDateFormat to the symbols that this component uses.

Parameters:

symbols - the date format symbols to translate

Returns:

translated date format symbols

format

public String format()

Returns:

format string used by date picker

formatter

public Format formatter()

Returns:

formatter controlling initial contents of input and validation

options

public NSMutableDictionary options()

Returns:

cached Ajax options for date picker JavaScript

addRequiredWebResources

protected void addRequiredWebResources(WOResponse response)

Includes calendar.css and calendar.js.

Specified by:

addRequiredWebResources in class AjaxComponent

Parameters:

response - the response to write to

handleRequest

public WOActionResults handleRequest(WORequest request,
                                     WOContext context)

No action so nothing for us to handle.

Specified by:

handleRequest in interface IAjaxElement

Specified by:

handleRequest in class AjaxComponent

Parameters:

request - the request

context - the context

validationFailedWithException

public void validationFailedWithException(Throwable t,
                                          Object value,
                                          String keyPath)

Overridden so that parent will handle in the same manner as if this were a dynamic element.

Overrides:

validationFailedWithException in class WOComponent

Parameters:

t - the exception thrown during validation

value - the given value to be validated

keyPath - the key path associated with this value, identifies the property of an object

cssFileName

protected String cssFileName()

Returns:

value for calendarCSS binding, or default of "calendar.css"

cssFileFrameworkName

protected String cssFileFrameworkName()

Returns:

value for calendarCSSFramework binding, or default of "Ajax"