Package org.wicketstuff.datetime.markup.html.form

Class DateTextField

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.AbstractTextComponent<T>

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

org.wicketstuff.datetime.markup.html.form.DateTextField

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<Date,FormComponent<Date>>, IMetadataContext<Serializable,Component>, AbstractTextComponent.ITextFormatProvider, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class DateTextField
extends TextField<Date>
implements AbstractTextComponent.ITextFormatProvider

A TextField that is mapped to a java.util.Date object and that uses Joda time to parse and format values.

You should use on of the factory methods to construct the kind you want or use the public constructor and pass in the converter to use.

This component tries to apply the time zone difference between the client and server. See the date converter of this package for more information on that.

Author:

eelcohillenius

See Also:

StyleDateConverter, DateTime, DateTimeFormat, DateTimeZone, Serialized Form

Nested Class Summary

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

AbstractTextComponent.ITextFormatProvider

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_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor	Description
DateTextField(String id, IModel<Date> model, DateConverter converter)	Construct with a converter.
DateTextField(String id, DateConverter converter)	Construct with a converter, and a null model.

Method Summary

Modifier and Type	Method	Description
protected IConverter<?>	createConverter(Class<?> clazz)
static DateTextField	forDatePattern(String id, String datePattern)	Creates a new DateTextField defaulting to using a short date pattern
static DateTextField	forDatePattern(String id, IModel<Date> model, String datePattern)	Creates a new DateTextField defaulting to using a short date pattern
static DateTextField	forDateStyle(String id, String dateStyle)	Creates a new DateTextField using the provided date style.
static DateTextField	forDateStyle(String id, IModel<Date> model, String dateStyle)	Creates a new DateTextField using the provided date style.
static DateTextField	forShortStyle(String id)	Creates a new DateTextField defaulting to using a short date pattern
static DateTextField	forShortStyle(String id, IModel<Date> model, boolean applyTimeZoneDifference)	Creates a new DateTextField defaulting to using a short date pattern
String	getTextFormat()
static DateTextField	withConverter(String id, IModel<Date> model, DateConverter converter)	Creates a new DateTextField using the provided converter.
static DateTextField	withConverter(String id, DateConverter converter)	Creates a new DateTextField using the provided converter.

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

getInputTypes, onComponentTag

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

convertInput, getConvertEmptyInputStringToNull, isInputNullable, onBeforeRender, setConvertEmptyInputStringToNull

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

add, add, checkRequired, clearInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModelValue, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, 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, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, 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.IGenericComponent

getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DateTextField

public DateTextField(String id,
                     IModel<Date> model,
                     DateConverter converter)

Construct with a converter.

Parameters:

id - The component id

model - The model

converter - The converter to use

DateTextField

public DateTextField(String id,
                     DateConverter converter)

Construct with a converter, and a null model.

Parameters:

id - The component id

converter - The converter to use

Method Detail

forDatePattern

public static DateTextField forDatePattern(String id,
                                           IModel<Date> model,
                                           String datePattern)

Creates a new DateTextField defaulting to using a short date pattern

Parameters:

id - The id of the text field

model - The model

datePattern - The pattern to use. Must be not null. See SimpleDateFormat for available patterns.

Returns:

DateTextField

forDatePattern

public static DateTextField forDatePattern(String id,
                                           String datePattern)

Creates a new DateTextField defaulting to using a short date pattern

Parameters:

id - The id of the text field

datePattern - The pattern to use. Must be not null. See SimpleDateFormat for available patterns.

Returns:

DateTextField

forDateStyle

public static DateTextField forDateStyle(String id,
                                         IModel<Date> model,
                                         String dateStyle)

Creates a new DateTextField using the provided date style.

Parameters:

id - The id of the text field

model - The model

dateStyle - Date style to use. The first character is the date style, and the second character is the time style. Specify a character of 'S' for short style, 'M' for medium, 'L' for long, and 'F' for full. A date or time may be ommitted by specifying a style character '-'. See DateTimeFormat.forStyle(String).

Returns:

DateTextField

forDateStyle

public static DateTextField forDateStyle(String id,
                                         String dateStyle)

Creates a new DateTextField using the provided date style.

Parameters:

id - The id of the text field

dateStyle - Date style to use. The first character is the date style, and the second character is the time style. Specify a character of 'S' for short style, 'M' for medium, 'L' for long, and 'F' for full. A date or time may be ommitted by specifying a style character '-'. See DateTimeFormat.forStyle(String).

Returns:

DateTextField

forShortStyle

public static DateTextField forShortStyle(String id)

Creates a new DateTextField defaulting to using a short date pattern

Parameters:

id - The id of the text field

Returns:

DateTextField

forShortStyle

public static DateTextField forShortStyle(String id,
                                          IModel<Date> model,
                                          boolean applyTimeZoneDifference)

Creates a new DateTextField defaulting to using a short date pattern

Parameters:

id - The id of the text field

model - The model

applyTimeZoneDifference - Whether to apply the time zone difference between client and server

Returns:

DateTextField

withConverter

public static DateTextField withConverter(String id,
                                          DateConverter converter)

Creates a new DateTextField using the provided converter.

Parameters:

id - The id of the text field

converter - the date converter

Returns:

DateTextField

withConverter

public static DateTextField withConverter(String id,
                                          IModel<Date> model,
                                          DateConverter converter)

Creates a new DateTextField using the provided converter.

Parameters:

id - The id of the text field

model - The model

converter - the date converter

Returns:

DateTextField

createConverter

protected IConverter<?> createConverter(Class<?> clazz)

Overrides:

createConverter in class Component

Returns:

The specialized converter.

See Also:

Component.createConverter(java.lang.Class)

getTextFormat

public final String getTextFormat()

Specified by:

getTextFormat in interface AbstractTextComponent.ITextFormatProvider

See Also:

AbstractTextComponent.ITextFormatProvider.getTextFormat()