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
                      org.apache.wicket.markup.html.form.FormComponentPanel
                          org.apache.wicket.extensions.yui.calendar.DateTimeField

All Implemented Interfaces:

java.io.Serializable, IClusterable, IConverterLocator, IFormVisitorParticipant, ILabelProvider, IHeaderPartContainerProvider

public class DateTimeField
extends FormComponentPanel

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()).

Author:

eelcohillenius

See Also:

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.FormComponent

FormComponent.AbstractVisitor, FormComponent.IVisitor

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.VisibilityChange

Field Summary

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_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

DateTimeField(java.lang.String id)
Construct.

DateTimeField(java.lang.String id, IModel model)
Construct.

Method Summary

protected void	configure(java.util.Map widgetProperties)
protected void	convertInput() Sets the converted input, which is an instance of Date, possibly null.
org.apache.wicket.extensions.yui.calendar.DateTimeField.AM_PM	getAmOrPm() Gets amOrPm.
protected java.util.TimeZone	getClientTimeZone() Gets the client's time zone.
java.util.Date	getDate() Gets date.
java.lang.Integer	getHours() Gets hours.
java.lang.String	getInput() Gets the request parameter for this component as a string.
java.lang.Integer	getMinutes() Gets minutes.
protected DateTextField	newDateTextField(PropertyModel dateFieldModel) Deprecated. replaced by newDateTextField(String, PropertyModel)
protected DateTextField	newDateTextField(java.lang.String id, PropertyModel dateFieldModel) create a new DateTextField instance to be added to this panel.
protected void	onBeforeRender() Called just before a component is rendered.
void	setAmOrPm(org.apache.wicket.extensions.yui.calendar.DateTimeField.AM_PM amOrPm) Sets amOrPm.
void	setDate(java.util.Date date) Sets date.
void	setHours(java.lang.Integer hours) Sets hours.
void	setMinutes(java.lang.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, newHeaderPartContainer, onComponentTag, onComponentTagBody, renderHead

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

add, clearInput, convertValue, error, getBehaviors, getConvertedInput, getForm, getInputAsArray, getInputName, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, supportsPersistence, trim, updateModel, valid, validate, validateRequired, validateValidators, visitFormComponentsPostOrder

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

getLabel, setLabelInternal

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

getMarkupType, getWebPage

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeginRequest, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeField

public DateTimeField(java.lang.String id)

Construct.

Parameters:

id -

DateTimeField

public DateTimeField(java.lang.String id,
                     IModel model)

Construct.

Parameters:

id -

model -

Method Detail

getAmOrPm

public org.apache.wicket.extensions.yui.calendar.DateTimeField.AM_PM getAmOrPm()

Gets amOrPm.

Returns:

amOrPm

getDate

public java.util.Date getDate()

Gets date.

Returns:

date

getHours

public java.lang.Integer getHours()

Gets hours.

Returns:

hours

configure

protected void configure(java.util.Map widgetProperties)

getInput

public java.lang.String getInput()

Description copied from class: FormComponent

Gets the request parameter for this component as a string.

Overrides:

getInput in class FormComponent

Returns:

The value in the request for this component

See Also:

FormComponent.getInput()

getMinutes

public java.lang.Integer getMinutes()

Gets minutes.

Returns:

minutes

setAmOrPm

public void setAmOrPm(org.apache.wicket.extensions.yui.calendar.DateTimeField.AM_PM amOrPm)

Sets amOrPm.

Parameters:

amOrPm - amOrPm

setDate

public void setDate(java.util.Date date)

Sets date.

Parameters:

date - date

setHours

public void setHours(java.lang.Integer hours)

Sets hours.

Parameters:

hours - hours

setMinutes

public void setMinutes(java.lang.Integer minutes)

Sets minutes.

Parameters:

minutes - minutes

getClientTimeZone

protected java.util.TimeZone getClientTimeZone()

Gets the client's time zone.

Returns:

The client's time zone or null

convertInput

protected 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

See Also:

FormComponent.convertInput()

newDateTextField

protected final DateTextField newDateTextField(PropertyModel dateFieldModel)

Deprecated. replaced by newDateTextField(String, PropertyModel)

newDateTextField

protected DateTextField newDateTextField(java.lang.String id,
                                         PropertyModel dateFieldModel)

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

Parameters:

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.

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.

Overrides:

onBeforeRender in class Component

See Also:

Component.onBeforeRender()

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