org.sakaiproject.wicket.component

Class SakaiDateTimeField

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<ZonedDateTime>

org.sakaiproject.wicket.component.SakaiDateTimeField

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<ZonedDateTime>, org.apache.wicket.markup.html.form.IFormModelUpdateListener, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider<String>, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class SakaiDateTimeField
extends org.apache.wicket.markup.html.form.TextField<ZonedDateTime>

A TextField equipped with a standard Sakai datepicker. This component adds the jquery-ui and lang-datepicker scripts to the page by default, so they do not need to be added separately. If you know JQuery UI is already loaded on the page, call setLoadJQueryUI(false). JQuery is also required but is assumed to already be loaded on the page.

Author:

plukasew

See Also:

Serialized Form

Nested Class Summary

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

org.apache.wicket.markup.html.form.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_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
SakaiDateTimeField(String id, org.apache.wicket.model.IModel<ZonedDateTime> model, ZoneId timeZoneId)

Method Summary

Modifier and Type	Method and Description
<C> org.apache.wicket.util.convert.IConverter<C>	getConverter(Class<C> type)
protected void	onInitialize()
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
SakaiDateTimeField	setAllowEmptyDate(boolean value) Sets whether to allow fields to have no date set.
SakaiDateTimeField	setLoadJQueryUI(boolean value) Sets whether to have the component load the JQueryUI dependency on the page.
SakaiDateTimeField	setUseTime(boolean value) Sets whether to include a time component in the display of the text field and date picker.

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

getInputType, 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, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, 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, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, 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, 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, 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, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, 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 java.lang.Iterable

forEach, spliterator

Constructor Detail

SakaiDateTimeField

public SakaiDateTimeField(String id,
                          org.apache.wicket.model.IModel<ZonedDateTime> model,
                          ZoneId timeZoneId)

Parameters:

id - wicket id

model - a ZonedDateTime. Can be null if no time is set.

timeZoneId - timezone for this time, cannot be null. Should match the model's timezone, if model is non-null.

Method Detail

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

getConverter

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

Specified by:

getConverter in interface org.apache.wicket.IConverterLocator

Overrides:

getConverter in class org.apache.wicket.Component

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.Component

setUseTime

public SakaiDateTimeField setUseTime(boolean value)

Sets whether to include a time component in the display of the text field and date picker. Defaults to true.

Parameters:

value - true if using time

Returns:

this, for method chaining

setAllowEmptyDate

public SakaiDateTimeField setAllowEmptyDate(boolean value)

Sets whether to allow fields to have no date set. Defaults to true.

Parameters:

value - true if empty dates are allowed

Returns:

this, for method chaining

setLoadJQueryUI

public SakaiDateTimeField setLoadJQueryUI(boolean value)

Sets whether to have the component load the JQueryUI dependency on the page. Defaults to true.

Parameters:

value - true if JQueryUI should be loaded by this component

Returns:

this, for method chaining