org.apache.wicket.extensions.yui.calendar

Class DateTimeField

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

org.apache.wicket.markup.html.form.FormComponent<T>

org.apache.wicket.markup.html.form.FormComponentPanel<Date>

org.apache.wicket.extensions.yui.calendar.DateTimeField

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IGenericComponent<Date>, IQueueRegion, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

DateField, TimeField

public class DateTimeField
extends FormComponentPanel<Date>

Works on a Date object. Displays a date field and a DatePicker, a field for hours and a field for minutes, and an AM/PM field. The format (12h/24h) of the hours field depends on the time format of this DateTimeField's Locale, as does the visibility of the AM/PM field (see use12HourFormat()).

Ajaxifying the DateTimeField: If you want to update a DateTimeField with an AjaxFormComponentUpdatingBehavior, you have to attach it to the contained DateTextField by overriding newDateTextField(String, PropertyModel) and calling FormComponent.processInput():

DateTimeField dateTimeField = new DateTimeField(...) {
    protected DateTextField newDateTextField(String id, PropertyModel<Date> dateFieldModel)
    {
      DateTextField dateField = super.newDateTextField(id, dateFieldModel);     
      dateField.add(new AjaxFormComponentUpdatingBehavior("change") {
        protected void onUpdate(AjaxRequestTarget target) {
          processInput(); // let DateTimeField process input too

          ...
        }
      });
      return recorder;
    }
  }
 

Author:

eelcohillenius

See Also:

for a variant with just the date field and date picker, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DateTimeField.AM_PM Enumerated type for different ways of handling the render part of requests.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AM_OR_PM_CHOICE
protected static String	DATE
protected static String	HOURS
protected static String	MINUTES

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
DateTimeField(String id) Construct.
DateTimeField(String id, IModel<Date> model) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
static Date	changeTimeZone(Date date, TimeZone zone) Change a date in another timezone
protected void	configure(Map<String,Object> widgetProperties) Gives overriding classes the option of adding (or even changing/ removing) configuration properties for the javascript widget.
void	convertInput() Sets the converted input, which is an instance of Date, possibly null.
DateTimeField.AM_PM	getAmOrPm() Deprecated. valid during rendering only
protected TimeZone	getClientTimeZone() Gets the client's time zone.
Date	getDate() Deprecated. valid during rendering only
protected DateTextField	getDateTextField()
Integer	getHours() Deprecated. valid during rendering only
String	getInput() Gets the request parameter for this component as a string.
Integer	getMinutes() Deprecated. valid during rendering only
protected Date	newDateInstance() A factory method for the DateTextField's model object.
protected Date	newDateInstance(long time) A factory method for the DateTextField's model object.
protected DatePicker	newDatePicker() The DatePicker that gets added to the DateTimeField component.
protected DateTextField	newDateTextField(String id, PropertyModel<Date> dateFieldModel) create a new DateTextField instance to be added to this panel.
protected TextField<Integer>	newHoursTextField(String id, IModel<Integer> model, Class<Integer> type) create a new TextField instance for hours to be added to this panel.
protected TextField<Integer>	newMinutesTextField(String id, IModel<Integer> model, Class<Integer> type) create a new TextField instance for minutes to be added to this panel.
protected void	onBeforeRender() Called just before a component is rendered only if the component is visible.
void	setAmOrPm(DateTimeField.AM_PM amOrPm) Sets the amOrPm model object associated with the drop down choice.
void	setDate(Date date) Sets the date model object associated with the date TextField.
void	setHours(Integer hours) Sets hours.
void	setMinutes(Integer minutes) Sets minutes.
protected boolean	use12HourFormat() Checks whether the current Locale uses the 12h or 24h time format.

Methods inherited from class org.apache.wicket.markup.html.form.FormComponentPanel

checkRequired, newMarkupSourcingStrategy, onComponentTag

Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

add, add, clearInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onRequired, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, updateCollectionModel, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, getRegionMarkup, newDequeueContext

Field Detail

DATE

protected static final String DATE

See Also:

Constant Field Values

HOURS

protected static final String HOURS

See Also:

Constant Field Values

MINUTES

protected static final String MINUTES

See Also:

Constant Field Values

AM_OR_PM_CHOICE

protected static final String AM_OR_PM_CHOICE

See Also:

Constant Field Values

Constructor Detail

DateTimeField

public DateTimeField(String id)

Construct.

Parameters:

id -

DateTimeField

public DateTimeField(String id,
             IModel<Date> model)

Construct.

Parameters:

id -

model -

Method Detail

newHoursTextField

protected TextField<Integer> newHoursTextField(String id,
                                   IModel<Integer> model,
                                   Class<Integer> type)

create a new TextField instance for hours to be added to this panel.

Parameters:

id - the component id

model - model that should be used by the TextField

type - the type of the text field

Returns:

a new text field instance

newMinutesTextField

protected TextField<Integer> newMinutesTextField(String id,
                                     IModel<Integer> model,
                                     Class<Integer> type)

create a new TextField instance for minutes to be added to this panel.

Parameters:

id - the component id

model - model that should be used by the TextField

type - the type of the text field

Returns:

a new text field instance

getDateTextField

protected final DateTextField getDateTextField()

Returns:

The date TextField

getAmOrPm

public final DateTimeField.AM_PM getAmOrPm()

Deprecated. valid during rendering only

Gets the amOrPm model object of the drop down choice.

Returns:

amOrPm

getDate

public final Date getDate()

Deprecated. valid during rendering only

Gets the date model object for the date TextField. Any associated time information will be ignored.

Returns:

date

getHours

public final Integer getHours()

Deprecated. valid during rendering only

Gets the hours model object for the TextField

Returns:

hours

getMinutes

public final Integer getMinutes()

Deprecated. valid during rendering only

Gets the minutes model object for the TextField

Returns:

minutes

configure

protected void configure(Map<String,Object> widgetProperties)

Gives overriding classes the option of adding (or even changing/ removing) configuration properties for the javascript widget. See the widget's documentation for the available options. If you want to override/ remove properties, you should call super.configure(properties) first. If you don't call that, be aware that you will have to call configure(java.util.Map) manually if you like localized strings to be added.

Parameters:

widgetProperties - the current widget properties

getInput

public String getInput()

Description copied from class: FormComponent

Gets the request parameter for this component as a string.

Overrides:

getInput in class FormComponent<Date>

Returns:

The value in the request for this component

setAmOrPm

public final void setAmOrPm(DateTimeField.AM_PM amOrPm)

Sets the amOrPm model object associated with the drop down choice.

Parameters:

amOrPm - amOrPm

setDate

public final void setDate(Date date)

Sets the date model object associated with the date TextField. It does not affect hours or minutes.

Parameters:

date - date

setHours

public final void setHours(Integer hours)

Sets hours.

Parameters:

hours - hours

setMinutes

public final void setMinutes(Integer minutes)

Sets minutes.

Parameters:

minutes - minutes

getClientTimeZone

protected TimeZone getClientTimeZone()

Gets the client's time zone.

Returns:

The client's time zone or null

convertInput

public void convertInput()

Sets the converted input, which is an instance of Date, possibly null. It combines the inputs of the nested date, hours, minutes and am/pm fields and constructs a date from it.

Note that overriding this method is a better option than overriding FormComponent.updateModel() like the first versions of this class did. The reason for that is that this method can be used by form validators without having to depend on the actual model being updated, and this method is called by the default implementation of FormComponent.updateModel() anyway (so we don't have to override that anymore).

Overrides:

convertInput in class FormComponent<Date>

See Also:

IConverterLocator, Application.newConverterLocator(), IConverter.convertToObject(String, Locale), FormComponent.newValidationError(ConversionException)

newDateInstance

protected Date newDateInstance()

A factory method for the DateTextField's model object.

Returns:

any specialization of java.util.Date

newDateInstance

protected Date newDateInstance(long time)

A factory method for the DateTextField's model object.

Parameters:

time - the time in milliseconds

Returns:

any specialization of java.util.Date

newDateTextField

protected DateTextField newDateTextField(String id,
                             PropertyModel<Date> dateFieldModel)

create a new DateTextField instance to be added to this panel.

Parameters:

id - the component id

dateFieldModel - model that should be used by the DateTextField

Returns:

a new date text field instance

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called just before a component is rendered only if the component is visible.

NOTE: If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Changes to the component tree can be made only before calling super.onBeforeRender().

Overrides:

onBeforeRender in class Component

See Also:

Component.onBeforeRender()

changeTimeZone

public static Date changeTimeZone(Date date,
                  TimeZone zone)

Change a date in another timezone

Parameters:

date - The input date.

zone - The target timezone.

Returns:

A new converted date.

use12HourFormat

protected boolean use12HourFormat()

Checks whether the current Locale uses the 12h or 24h time format. This method can be overridden to e.g. always use 24h format.

Returns:

true, if the current Locale uses the 12h format.
false, otherwise

newDatePicker

protected DatePicker newDatePicker()

The DatePicker that gets added to the DateTimeField component. Users may override this method with a DatePicker of their choice.

Returns:

a new DatePicker instance