er.extensions.components

Class ERXTimeZoneDetector

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

er.extensions.components.ERXNonSynchronizingComponent

er.extensions.components.ERXStatelessComponent

er.extensions.components.ERXTimeZoneDetector

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, Serializable, Cloneable

public class ERXTimeZoneDetector
extends ERXStatelessComponent

This component adds javascript to a page to grab the system time zone from the browser and write the time zone to the timeZone attribute of the session via a call to the setTimeZone() method. The information is sent to the session using an ajax call. This code determines a time zone based on minutes offset from GMT, whether the time zone observes DST, and if DST, whether the time zone is in the northern or southern hemisphere. Since there may be more than one time zone that matches these values, the array of possible values is compared against an array of preferred values if one is supplied. If no preferred values are supplied, the zone selected is pulled from the list of possible options in no particular order. Use of an ERXSession is expected/required.

See Also:

Serialized Form

Author:

Ramsey Gurley

Bindings

Name	Description
preferredTimeZones	an array of preferred TimeZone objects. This array takes precedence over the preferredTimeZoneIDs binding.
preferredTimeZoneIDs	an array of preferred TimeZone id strings

Nested Class Summary

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

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

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

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

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

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

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

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
static String	TIMEZONE_SESSION_KEY

Fields inherited from class er.extensions.components.ERXComponent

_dynamicBindings

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
ERXTimeZoneDetector(com.webobjects.appserver.WOContext context)

Method Summary

Modifier and Type	Method and Description
static NSArray<TimeZone>	allZones()
String	formValueKey()
String	postURL() The ajax request URL for this component.
NSArray<TimeZone>	preferredTimeZones()
boolean	shouldPostData() Returns true if the component should include a script to post time zone data back to the server.
void	takeValuesFromRequest(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context) Overridden to capture the time zone data being sent from the client.
static NSArray<TimeZone>	zonesWithRawOffset(int minutes, boolean dst, boolean southern)
TimeZone	zoneWithRawOffset(int minutes, boolean dst, boolean southern)

Methods inherited from class er.extensions.components.ERXStatelessComponent

isStateless, reset

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

appendToResponse, invokeAction, resetCachedBindingsInStatefulComponent, synchronizesVariablesWithBindings

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, arrayValueForBinding, arrayValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browser, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, shouldCheckAccess, stringValueForBinding, stringValueForBinding, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, 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, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, 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

Field Detail

TIMEZONE_SESSION_KEY

public static final String TIMEZONE_SESSION_KEY

See Also:

Constant Field Values

Constructor Detail

ERXTimeZoneDetector

public ERXTimeZoneDetector(com.webobjects.appserver.WOContext context)

Method Detail

allZones

public static NSArray<TimeZone> allZones()

zonesWithRawOffset

public static NSArray<TimeZone> zonesWithRawOffset(int minutes,
                                                   boolean dst,
                                                   boolean southern)

zoneWithRawOffset

public TimeZone zoneWithRawOffset(int minutes,
                                  boolean dst,
                                  boolean southern)

shouldPostData

public boolean shouldPostData()

Returns true if the component should include a script to post time zone data back to the server. This remains true until the time zone data is captured.

Returns:

true if ajax script should be included

formValueKey

public String formValueKey()

Returns:

key used to identify timezone form value

postURL

public String postURL()

The ajax request URL for this component.

Returns:

the post URL for the ajax post request

takeValuesFromRequest

public void takeValuesFromRequest(com.webobjects.appserver.WORequest request,
                                  com.webobjects.appserver.WOContext context)

Overridden to capture the time zone data being sent from the client.

Overrides:

takeValuesFromRequest in class ERXNonSynchronizingComponent

Parameters:

request - from which the values will be taken

context - of the request

preferredTimeZones

public NSArray<TimeZone> preferredTimeZones()