org.apache.wicket.datetime.markup.html.basic

Class DateLabel

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.markup.html.WebComponent

org.apache.wicket.markup.html.basic.Label

org.apache.wicket.datetime.markup.html.basic.DateLabel

All Implemented Interfaces:

Serializable, IEventSink, IEventSource, IConverterLocator, IGenericComponent<Date>, IHeaderContributor, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

public class DateLabel
extends Label
implements IGenericComponent<Date>

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

You can provide a date pattern in two of the constructors. When not provided, DateTimeFormat.shortDate() will be used.

A special option is applyTimeZoneDifference which is an option that says whether to correct for the difference between the client's time zone and server's time zone. This is true by default.

Author:

eelcohillenius

See Also:

DateTime, DateTimeFormat, DateTimeZone, Serialized Form

Field Summary

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
DateLabel(String id, DateConverter converter) Construct with a converter.
DateLabel(String id, IModel<Date> model, DateConverter converter) Construct with a converter.

Method Summary

Methods

Modifier and Type	Method and Description
static DateLabel	forDatePattern(String id, IModel<Date> model, String datePattern) Creates a new DateLabel defaulting to using a short date pattern
static DateLabel	forDatePattern(String id, String datePattern) Creates a new DateLabel defaulting to using a short date pattern
static DateLabel	forDateStyle(String id, IModel<Date> model, String dateStyle) Creates a new DateLabel defaulting to using a short date pattern
static DateLabel	forDateStyle(String id, String dateStyle) Creates a new DateLabel defaulting to using a short date pattern
static DateLabel	forShortStyle(String id) Creates a new DateLabel defaulting to using a short date pattern
static DateLabel	forShortStyle(String id, IModel<Date> model) Creates a new DateLabel defaulting to using a short date pattern
String	getAfter()
String	getBefore()
<C> org.apache.wicket.util.convert.IConverter<C>	getConverter(Class<C> clazz) Returns the specialized converter.
IModel<Date>	getModel()
Date	getModelObject()
void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag)
void	setAfter(String after)
void	setBefore(String before)
void	setModel(IModel<Date> model)
void	setModelObject(Date object)
static DateLabel	withConverter(String id, DateConverter converter) Creates a new DateLabel using the provided converter.
static DateLabel	withConverter(String id, IModel<Date> model, DateConverter converter) Creates a new DateLabel using the provided converter.

Methods inherited from class org.apache.wicket.markup.html.basic.Label

onComponentTag

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession, onRender

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, get, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, 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, internalInitialize, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onAfterRenderChildren, onBeforeRender, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModel, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, toString, toString, 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

Constructor Detail

DateLabel

public DateLabel(String id,
         DateConverter converter)

Construct with a converter.

Parameters:

id - The component id

converter - The converter to use

DateLabel

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

Construct with a converter.

Parameters:

id - The component id

model - The model

converter - The converter to use

Method Detail

forDatePattern

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

Creates a new DateLabel 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:

new instance

See Also:

TextField

forDatePattern

public static DateLabel forDatePattern(String id,
                       String datePattern)

Creates a new DateLabel 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:

new instance

See Also:

TextField

forDateStyle

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

Creates a new DateLabel defaulting to using a short date pattern

Parameters:

id - The id of the text field

model - The model

dateStyle - style to use in case no pattern is provided. Must be two characters from the set {"S", "M", "L", "F", "-"}. Must be not null. See DateTimeFormat.forStyle(String) for options.

Returns:

new instance

See Also:

TextField

forDateStyle

public static DateLabel forDateStyle(String id,
                     String dateStyle)

Creates a new DateLabel defaulting to using a short date pattern

Parameters:

id - The id of the text field

dateStyle - style to use in case no pattern is provided. Must be two characters from the set {"S", "M", "L", "F", "-"}. Must be not null. See DateTimeFormat.forStyle(String) for options.

Returns:

new instance

See Also:

TextField

forShortStyle

public static DateLabel forShortStyle(String id)

Creates a new DateLabel defaulting to using a short date pattern

Parameters:

id - The id of the text field

Returns:

new instance

See Also:

TextField

forShortStyle

public static DateLabel forShortStyle(String id,
                      IModel<Date> model)

Creates a new DateLabel defaulting to using a short date pattern

Parameters:

id - The id of the text field

model - The model

Returns:

new instance

See Also:

TextField

withConverter

public static DateLabel withConverter(String id,
                      DateConverter converter)

Creates a new DateLabel using the provided converter.

Parameters:

id - The id of the text field

converter - the date converter

Returns:

new instance

See Also:

TextField

withConverter

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

Creates a new DateLabel using the provided converter.

Parameters:

id - The id of the text field

model - The model

converter - the date converter

Returns:

new instance

See Also:

TextField

getAfter

public String getAfter()

Returns:

after append to label or null

getBefore

public String getBefore()

Returns:

before prepend to label or null

getConverter

public <C> org.apache.wicket.util.convert.IConverter<C> getConverter(Class<C> clazz)

Returns the specialized converter.

Specified by:

getConverter in interface IConverterLocator

Overrides:

getConverter in class Component

setAfter

public void setAfter(String after)

Parameters:

after - append to label

setBefore

public void setBefore(String before)

Parameters:

before - prepend to label

onComponentTagBody

public void onComponentTagBody(MarkupStream markupStream,
                      ComponentTag openTag)

Overrides:

onComponentTagBody in class Label

getModel

public IModel<Date> getModel()

Specified by:

getModel in interface IGenericComponent<Date>

setModel

public void setModel(IModel<Date> model)

Specified by:

setModel in interface IGenericComponent<Date>

setModelObject

public void setModelObject(Date object)

Specified by:

setModelObject in interface IGenericComponent<Date>

getModelObject

public Date getModelObject()

Specified by:

getModelObject in interface IGenericComponent<Date>